Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Template
Private  Storage   


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

Template for System Management Portal (used by System Operation, System Explorer, System Administration).


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 9 15


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

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

%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 %EvalC
%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 CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RegisterRecent RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore afterSave afterValidate cancelPopup
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doModified dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
render renderContents renderSVG resetMsg
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp showMsg
startModal startProgressBar stopProgressBar switchNamespace
trimSpace validateRequired

%CSP.UI.Portal.About %CSP.UI.Portal.Applications.ClientList %CSP.UI.Portal.Applications.DocDB
%CSP.UI.Portal.Applications.EditTemplate %CSP.UI.Portal.Applications.PrivRoutineList %CSP.UI.Portal.Audit.ActionTemplate
%CSP.UI.Portal.Audit.EventsTemplate %CSP.UI.Portal.Audit.UserEvent %CSP.UI.Portal.Authentication
%CSP.UI.Portal.CSPSessions %CSP.UI.Portal.Config.AdvancedTable %CSP.UI.Portal.Config.Cluster
%CSP.UI.Portal.Config.Device %CSP.UI.Portal.Config.Devices %CSP.UI.Portal.Config.IO
%CSP.UI.Portal.Config.MagTape %CSP.UI.Portal.Config.MagTapes %CSP.UI.Portal.Config.SQLDataType
%CSP.UI.Portal.Config.SQLDataTypes %CSP.UI.Portal.Config.SubType %CSP.UI.Portal.Config.SubTypes
%CSP.UI.Portal.Config.Telnet %CSP.UI.Portal.Config.ValueEditor %CSP.UI.Portal.DatabaseTemplate
%CSP.UI.Portal.DatabaseTruncate %CSP.UI.Portal.Default %CSP.UI.Portal.ECP
%CSP.UI.Portal.EncryptionCreate %CSP.UI.Portal.EncryptionDatabase %CSP.UI.Portal.EncryptionManage
%CSP.UI.Portal.EncryptionManaged %CSP.UI.Portal.EnsembleMonitor %CSP.UI.Portal.Install
%CSP.UI.Portal.Installs %CSP.UI.Portal.Instance %CSP.UI.Portal.InstanceUpdate
%CSP.UI.Portal.Instances %CSP.UI.Portal.JDBCGatewayServer %CSP.UI.Portal.Journal
%CSP.UI.Portal.Kit %CSP.UI.Portal.Kits %CSP.UI.Portal.LDAP
%CSP.UI.Portal.LDAPRO %CSP.UI.Portal.LDAPTest %CSP.UI.Portal.LDAPs
%CSP.UI.Portal.LDAPsRO %CSP.UI.Portal.License.Key %CSP.UI.Portal.LicenseServers
%CSP.UI.Portal.MFT.Authorize %CSP.UI.Portal.MFT.Connection %CSP.UI.Portal.MFT.ConnectionList
%CSP.UI.Portal.Machine %CSP.UI.Portal.Machines %CSP.UI.Portal.Manifest
%CSP.UI.Portal.Manifests %CSP.UI.Portal.Mappings %CSP.UI.Portal.MemoryStartup
%CSP.UI.Portal.Mirror.Create %CSP.UI.Portal.Mirror.EditAsync %CSP.UI.Portal.Mirror.EditFailover
%CSP.UI.Portal.Mirror.JoinAsync %CSP.UI.Portal.Mirror.JoinFailover %CSP.UI.Portal.Monitoring
%CSP.UI.Portal.NLS %CSP.UI.Portal.NLSConfigDefs %CSP.UI.Portal.NLSEdit
%CSP.UI.Portal.NLSImport %CSP.UI.Portal.Namespace %CSP.UI.Portal.NamespaceEdit
%CSP.UI.Portal.OAuth2.Administration %CSP.UI.Portal.OAuth2.Client.Configuration %CSP.UI.Portal.OAuth2.Client.ConfigurationList
%CSP.UI.Portal.OAuth2.Client.ServerConfiguration %CSP.UI.Portal.OAuth2.Client.ServerList %CSP.UI.Portal.OAuth2.Server.Client
%CSP.UI.Portal.OAuth2.Server.ClientList %CSP.UI.Portal.OAuth2.Server.Configuration %CSP.UI.Portal.ObjectGateway
%CSP.UI.Portal.ObjectGatewayActivities %CSP.UI.Portal.ObjectGatewayStart %CSP.UI.Portal.ObjectGatewayStop
%CSP.UI.Portal.ObjectGateways %CSP.UI.Portal.ObjectSettings %CSP.UI.Portal.PKI
%CSP.UI.Portal.Parameters %CSP.UI.Portal.PhoneProvider %CSP.UI.Portal.PhoneProviders
%CSP.UI.Portal.Reports %CSP.UI.Portal.ReportsPrintServer %CSP.UI.Portal.ReportsPrintServers
%CSP.UI.Portal.ReportsRenderServer %CSP.UI.Portal.ReportsRenderServers %CSP.UI.Portal.Role
%CSP.UI.Portal.RoutineCompare %CSP.UI.Portal.SQL.Configure.ISQL %CSP.UI.Portal.SQL.Configure.SQL
%CSP.UI.Portal.SQL.Configure.TSQL %CSP.UI.Portal.SSL %CSP.UI.Portal.SSLList
%CSP.UI.Portal.Services %CSP.UI.Portal.Shadow %CSP.UI.Portal.Sharding.Configuration
%CSP.UI.Portal.User %CSP.UI.Portal.UserProfile %CSP.UI.Portal.Users
%CSP.UI.Portal.Utils %CSP.UI.Portal.ViewLog %CSP.UI.Portal.WQMCategories
%CSP.UI.Portal.WQMCategory %CSP.UI.Portal.X509Credential %CSP.UI.Portal.X509Credentials
%CSP.UI.Portal.XSLTGatewayServer %CSP.UI.Template.Property


• parameter APPLICATION = "%CSP.UI.Portal.Application";
Class name of application this page belongs to.
• parameter EMSSERVICE;
• parameter HELPADDRESS;
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "System Management Portal Template";
Displayed name of this page.
• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.zen";
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.


• property FirstFailed as %String;
Keeps track of the first form field that failed during validation.
• property HelpAddress as %ZEN.Datatype.string [ InitialExpression = ..#HELPADDRESS ];
This property overrides %CSP.Portal.Template to use parameter HELPADDRESS that every SMP pages has.
• property InvalidParam as %Boolean [ InitialExpression = 0 ];
Set to 1 in %OnAfterCreatePage if a URI parameter is invalid. Used to disable command buttons in onloadHandler().
• property IsEMSReadOnly as %Boolean [ InitialExpression = ##class(%SYS.EMS).IsReadOnly($classname()) ];
1 if we are on an EMS manager and viewing group data or on a managed instance, 0 otherwise.
• property IsEditForm as %Boolean [ InitialExpression = 0 ];
If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
• property OnclickArray as %ArrayOfDataTypes;
Keeps track of currently disabled buttons' onclick events.
• property PID as %String(ZENURL="PID");
ID for edit.
• property ParentURL as %String [ InitialExpression = ..Link($ZCVT(..#PARENTPAGE,"O","URL")) ];
Parent URL that Cancel and Save should return to
• property ValidationErrorMsg as %String [ InitialExpression = $$$Text("There was a problem with the form. See the highlighted fields below.") ];


• classmethod %GetHomePage() as %String
This method is used by SMP to return home page. Set home to %session if not null for later use.
• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
Subclasses with extra layers of locator links or other than "Configuration" please override.
• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. Subclass can override.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method afterSave(result As %ZEN.proxyObject) [ Language = javascript ]
This method can be called by the doSave() function to handle what the ZenMethod of server Save returned. The method expects a proxy object to be passed. result.ok = 1 indicates save is successful. result.Message is a message (not an error message) that should be displayed. result.ok = 0 indicates save has failed. result.ErrorMessage should be displayed. If result.ok = 1 and result.Message is null then the edit form is closed and the ParentURL is displayed.
• method afterValidate() [ Language = javascript ]
This method can be called after validation (where validateRequired has failed) fails. Display standard error message and set focus to the FirstFailed field.
• method doCancel() [ Language = javascript ]
This method resets the modified indicator and return user to the parent page.
• method doModified() [ Language = javascript ]
This method is called when a field is modified. setModified(true) will cause the modified indicator (a star) to show next to the page name.
• method isButtonDisabled(buttonName) [ Language = javascript ]
This method returns true if a ribbon button is disabled; false otherwise.
• method onloadHandler() [ Language = javascript ]
Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
• method resetMsg() [ Language = javascript ]
Clear message from idRespond html (usually placed above the editing portion of the page, but could be anywhere).
• method showMsg(msg, isErr) [ Language = javascript ]
Display message in idRespond html (usually placed above the editing portion of the page, but could be anywhere). isErr: if 1 is passed in then the color will be changed to red; If 0 is passed in then the color is changed to #4D3926; If 2 is passed in then the color is changed to green, i.e. success If nothing is passed in, then the color is unchanged. This allows developers to set their own style/class and still be able to use showMsg.
• method trimSpace(zenProp) [ Language = javascript ]
trim space from both outside and inside a string of a passed in zen property and then set back into the zen property
• method validateRequired(ctl, pass, type, checkRange, minVal, maxVal) as %Boolean [ Language = javascript ]
Validate the control value. pass is either "true" or "false" indicating if there is already a field that failed validation. Type is "N" for numeric or "S" for string. If numeric, if checkRange is true, we additionally validate that the number is between minVal and maxVal, inclusive.