%CSP.UI.Portal.Templateabstract class %CSP.UI.Portal.Template
Template for System Management Portal (used by System Operation, System Explorer, System Administration).
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.
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.") ];
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. method %OnAfterCreatePage() as %Status
Subclasses with extra layers of locator links or other than "Configuration" please override.
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
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.