Class %CSP.UI.Portal.EMS

class %CSP.UI.Portal.EMS extends %CSP.UI.Portal.Template

Created using the page template: Default

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	28

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	CanBeRemoved	CanBeResumed	CanBeSuspended
Certificate	CurrentPage	HelpAddress	ISREADONLY
LocatorHeader	ParentURL	SecurityPolicy	StdTitle
aboutPage	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	cssLevel
currSortMode	currStep	currViewMode	disabled
dragAndDrop	dragEnabled	dropEnabled	emsStatus
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	hidden	hint
hintClass	hintStyle	home	homePage
id	index	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
lblTitle	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	pageModified
parent	searchKey	showLabel	slice
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet
%ApplyURLParms	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetPageName
%GetParameter	%GetProductName	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetPageName
%OnGetProductName	%OnGetSmallMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	ChangeEnabled	ChangeEnabledWrapper	CheckAllBlanks
ConvertParameter	Decrypt	DoLogout	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	GetCSPURL	GetContextLinks	GetDocPage
GetEMSStatus	GetEMSStatusText	GetHomePage	GetNewURL
GetQuickLinks	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	InitializeForm	InsertHiddenField
InsertHiddenFields	IsPrivate	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RegisterRecent	RemoveEMS
RemoveEMSWrapper	RequestManagement	RequestManagementWrapper	RequestPolicy
RequestPolicyWrapper	RewriteURL	SetErrorText	ShowError
StartTimer	StopTimer	SwitchPage	ThrowError
UnescapeHTML	UnescapeURL	UpdateButtons	ValidateCertificate
ValidatePassword	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	activate	addChild
addChildAfter	addChildBefore	back	cancelPopup
changePassword	changeServerUseSSL	childrenMutated	correctIELayering
createComponent	createComponentNS	deleteComponent	disable
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enable	endModal
exposeComponent	findElement	fireOnLoadEvent	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getTitleAreaHeight	getType	goHome
goMenu	gotoNamespace	gotoPage	invokeSuper
isOfType	launchPopupWindow	loadingText	logout
makeId	navigate	next	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	remove	removeChild
render	renderContents	renderSVG	resetMsg
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setHidden	setModified
setOverlayMode	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/%CSP.UI.Portal.EMS.cls";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter PAGENAME = "Enterprise Management";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.cls";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RESOURCE = "%Admin_Secure,%Admin_Manage";

Security requirement

Properties

• property CanBeRemoved as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

• property CanBeResumed as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

• property CanBeSuspended as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

• property Certificate as %String;

• property CurrentPage as %Integer;

• property SecurityPolicy as %Integer;

• property emsStatus as %Numeric(VALUELIST=",0,1,2,3,4,5") [ InitialExpression = $$$EuiUnknown ];

emsStatus EuiUnknown - The clients record does not exist EuiNotAccepted - The client has not yet been accepted EuiAccepted - The client has been accepted, but not assigned EuiPending -The client has been assigned to a group, but not integrated EuiManaged - The client is begin actively managed by EMS EuiDisabled - The client has been assigned to a group, but is disabled

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• classmethod %OnPreHTTP() as %Boolean

Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.

• method ChangeEnabled(newState As %Boolean) as %Status [ ZenMethod ]

• method ChangeEnabledWrapper(newState As %Boolean) [ ZenMethod ]

• method GetEMSStatus(ByRef Enabled As %Integer) as %Integer [ ZenMethod ]

Test whether this system is an EMS client.

Return Value: emsStatus EuiUnknown - The clients record does not exist EuiNotAccepted - The client has not yet been accepted EuiAccepted - The client has been accepted, but not assigned EuiPending -The client has been assigned to a group, but not integrated EuiManaged - The client is begin actively managed by EMS EuiDisabled - The client has been assigned to a group, but is disabled

• classmethod GetEMSStatusText(EMSStatus As %Integer) as %String

emsStatus EuiUnknown - The clients record does not exist EuiNotAccepted - The client has not yet been accepted EuiAccepted - The client has been accepted, but not assigned EuiPending -The client has been assigned to a group, but not integrated EuiManaged - The client is begin actively managed by EMS EuiDisabled - The client has been assigned to a group, but is disabled Return localized text representing the current EMS status.

• method InitializeForm(firstLoad As %Boolean) as %Status [ ZenMethod ]

InitializeForm is called when we need to change the page's state. firstLoad = true indicates that this is on the initial page load

• method RemoveEMS() as %Status [ ZenMethod ]

• method RemoveEMSWrapper() [ ZenMethod ]

• method RequestManagement() as %Status

• method RequestManagementWrapper() [ ZenMethod ]

• method RequestPolicy() as %Status

• method RequestPolicyWrapper() [ ZenMethod ]

• method SetErrorText(Component As %String, Text As %String = "", IsError As %Boolean = 1, Fields As %List = "") as %Status

• method SwitchPage(page) [ ZenMethod ]

• method UpdateButtons() as %Status [ ZenMethod ]

• method ValidateCertificate() as %Status [ ZenMethod ]

• method ValidatePassword() as %Status [ ZenMethod ]

• method activate() [ Language = javascript ]

• method back() [ Language = javascript ]

• method changeServerUseSSL(cb) [ Language = javascript ]

• method disable() [ Language = javascript ]

• method enable() [ Language = javascript ]

• method loadingText() [ Language = javascript ]

• method next() [ Language = javascript ]

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method remove() [ Language = javascript ]


[USER] > [%CSP] > [UI] > [Portal] > [EMS]		Private Storage