Home > Class Reference > ENSLIB namespace > %CSP.Portal.Template

%CSP.Portal.Template

abstract class %CSP.Portal.Template extends %ZEN.Portal.standardPage, %ZEN.Portal.Utils

Template for Management Portal which System Management Portal, Ensemble, or HS can extend to.

Parameters

parameter APPLICATION = %CSP.Portal.Application;
Class name of application this page belongs to.
parameter AUTONS = 1;
Allow pages to auto-switch namespaces if $NAMESPACE is specified
parameter DOMAIN = %Utility;
Domain used for localization.
parameter PAGENAME = Template for Management Portal;
Displayed name of this page.
parameter PARENTPAGE;
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.

Properties

property HelpAddress as %ZEN.Datatype.string;
The help address that links to the "Help" (next to the "Logout" link) documentation
Property methods: HelpAddressDisplayToLogical(), HelpAddressGet(), HelpAddressIsValid(), HelpAddressLogicalToDisplay(), HelpAddressLogicalToOdbc(), HelpAddressNormalize(), HelpAddressSet()
property ISREADONLY as %Boolean [ InitialExpression = 0 ];
Indicates whether the page is read only due to EMS control.
Property methods: ISREADONLYDisplayToLogical(), ISREADONLYGet(), ISREADONLYIsValid(), ISREADONLYLogicalToDisplay(), ISREADONLYLogicalToXSD(), ISREADONLYNormalize(), ISREADONLYSet(), ISREADONLYXSDToLogical()
property LocatorHeader as %ZEN.Datatype.caption;
The text that is shown in TitlePane above the license
Property methods: LocatorHeaderDisplayToLogical(), LocatorHeaderGet(), LocatorHeaderIsValid(), LocatorHeaderLogicalToDisplay(), LocatorHeaderLogicalToOdbc(), LocatorHeaderNormalize(), LocatorHeaderSet()
property ParentURL as %String [ InitialExpression = ..Link($ZCVT(..#PARENTPAGE,"O","URL")) ];
Parent URL that Cancel and Save should return to
Property methods: ParentURLDisplayToLogical(), ParentURLGet(), ParentURLIsValid(), ParentURLLogicalToDisplay(), ParentURLLogicalToOdbc(), ParentURLNormalize(), ParentURLSet()
property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown on page or browser tab header
Property methods: StdTitleDisplayToLogical(), StdTitleGet(), StdTitleIsValid(), StdTitleLogicalToDisplay(), StdTitleLogicalToOdbc(), StdTitleNormalize(), StdTitleSet()
property home as %ZEN.Datatype.string (ZENURL = "home");
home value to return to Home page to.
Property methods: homeDisplayToLogical(), homeGet(), homeIsValid(), homeLogicalToDisplay(), homeLogicalToOdbc(), homeNormalize(), homePageDisplayToLogical(), homePageGet(), homePageIsValid(), homePageLogicalToDisplay(), homePageLogicalToOdbc(), homePageNormalize(), homePageSet(), homeSet()
property lblTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown between locator bar and details pane (form or table)
Property methods: lblTitleDisplayToLogical(), lblTitleGet(), lblTitleIsValid(), lblTitleLogicalToDisplay(), lblTitleLogicalToOdbc(), lblTitleNormalize(), lblTitleSet()

Methods

Utility method. Add the locator links defined by the LOCATORINFO parameter to the given locator bar.
pLocalize is an array from calling DocLocalize for a page. (optional)
pParam contains extra parameters for the last or current page link. (optional) pIsNew is the flag indicating this page is for "Add" rather than "Edit". If it's true then we use a different locator text if defined.
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 %GetHomeParam() as %String
Used to return "home" parameter for building return home links in sub-classes.
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.
classmethod %GetProductName() as %String
Get the product name for the page.Called from none-Zen classes in SMP.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
classmethod EvalResult(pSC) as %String
Return tmsg. 1 means success. Otherwise error message in HTML.
classmethod GetHomePage() as %String [ ZenMethod ]
This method allows us to get the home page URL from JavaScript.
classmethod RegisterRecent(pTitle)
Recent item is only registered at the Home level.
clientmethod showDocumentation(topic, anchor, url) [ Language = javascript ]

Inherited Methods

%AddChild() %RemoveComponent() enableCommandButton()
%AddChildAfter() %RemoveFromSaveSet() endModal()
%AddChildBefore() %RunBackgroundMethod() exposeComponent()
%AddComponent() %Self() findElement()
%AddImportedComponents() %SerializeObject()