Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

%CSP.UI.Portal.Dialog.EMS

class %CSP.UI.Portal.Dialog.EMS extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

EMS Wizard for Management Portal

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter AUTONS = 0;
Inherited description: If $NAMESPACE is set, auto switch namespace
parameter CSPURL = /csp/sys/%CSP.UI.Portal.Dialog.EMS.zen;
Inherited description: 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 DOMAIN = %EMSMessages;
Localization Domain
parameter HELPID = GSA_config_enterprisemanager_applying;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGENAME = EMSWizard;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage,%Admin_Secure;
User must hold at least operator privilege to use this dialog.

Properties

property AlreadyManaged as %String (ZENURL = "MANAGED");
Property methods: AlreadyManagedDisplayToLogical(), AlreadyManagedGet(), AlreadyManagedIsValid(), AlreadyManagedLogicalToDisplay(), AlreadyManagedLogicalToOdbc(), AlreadyManagedNormalize(), AlreadyManagedSet()
property ConnectionEstablished as %Boolean [ InitialExpression = 0 ];
Property methods: ConnectionEstablishedDisplayToLogical(), ConnectionEstablishedGet(), ConnectionEstablishedIsValid(), ConnectionEstablishedLogicalToDisplay(), ConnectionEstablishedLogicalToXSD(), ConnectionEstablishedNormalize(), ConnectionEstablishedSet(), ConnectionEstablishedXSDToLogical()
property FirstFailed as %String;
Keeps track of the first form field that failed during validation.
Property methods: FirstFailedDisplayToLogical(), FirstFailedGet(), FirstFailedIsValid(), FirstFailedLogicalToDisplay(), FirstFailedLogicalToOdbc(), FirstFailedNormalize(), FirstFailedSet()
property SecurityPolicy as %String;
Property methods: SecurityPolicyDisplayToLogical(), SecurityPolicyGet(), SecurityPolicyIsValid(), SecurityPolicyLogicalToDisplay(), SecurityPolicyLogicalToOdbc(), SecurityPolicyNormalize(), SecurityPolicySet()
property ValidationErrorMsg as %String [ InitialExpression = $$$Text("There was a problem with the form. See the highlighted fields below.") ];
Property methods: ValidationErrorMsgDisplayToLogical(), ValidationErrorMsgGet(), ValidationErrorMsgIsValid(), ValidationErrorMsgLogicalToDisplay(), ValidationErrorMsgLogicalToOdbc(), ValidationErrorMsgNormalize(), ValidationErrorMsgSet()

Methods

method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
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.
classmethod CheckForValidCredentials(pPolicyType As %String) as %Boolean [ ZenMethod ]
classmethod DrawPageTitle(pSeed As %String) as %Status
method RequestManagement(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
classmethod RequestPolicy(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
clientmethod 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.
clientmethod 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.
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod disableAllButtons() [ Language = javascript ]
Toggle disable of all buttons.
clientmethod doCheckForValidCredentials(policy) [ Language = javascript ]
clientmethod doSave() as %Boolean [ Language = javascript ]
Process save and create new db. Return true if success. OW return false.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons.
If this returns false, then the action is cancelled.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed;
This provides a chance to load the last filetype, etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
This is implemented by subclasses.
clientmethod validate1() as %Boolean [ Language = javascript ]
clientmethod validate2(policy) as %Boolean [ Language = javascript ]
clientmethod validate3() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab