This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class EnsPortal.Credentials extends EnsPortal.Template.standardPage

This is the Credentials page of the ZEN Ensemble application.

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_Credentials:WRITE;
User needs WRITE permissions on the %Ens_Credentials resource to make changes on this page.
parameter PAGENAME = Credentials;
Displayed name of this page.
parameter RESOURCE = %Ens_Credentials:READ;
User needs READ permissions on the %Ens_Credentials resource to view this page.


property credentialsId as %String (ZENURL = "ID");
ID of credentials to display.
Property methods: credentialsIdDisplayToLogical(), credentialsIdGet(), credentialsIdIsValid(), credentialsIdLogicalToDisplay(), credentialsIdLogicalToOdbc(), credentialsIdNormalize(), credentialsIdSet()
property idExists as %ZEN.Datatype.boolean;
Whether or not the URL supplied a valid credentials ID value
Property methods: idExistsDisplayToLogical(), idExistsGet(), idExistsIsValid(), idExistsLogicalToDisplay(), idExistsLogicalToOdbc(), idExistsLogicalToXSD(), idExistsNormalize(), idExistsSet(), idExistsXSDToLogical()
property passwordChanged as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Whether or not the user has modified the password
Property methods: passwordChangedDisplayToLogical(), passwordChangedGet(), passwordChangedIsValid(), passwordChangedLogicalToDisplay(), passwordChangedLogicalToOdbc(), passwordChangedLogicalToXSD(), passwordChangedNormalize(), passwordChangedSet(), passwordChangedXSDToLogical()
property skipWarning as %ZEN.Datatype.boolean;
Whether or not the page should warn upon reload
Property methods: skipWarningDisplayToLogical(), skipWarningGet(), skipWarningIsValid(), skipWarningLogicalToDisplay(), skipWarningLogicalToOdbc(), skipWarningLogicalToXSD(), skipWarningNormalize(), skipWarningSet(), skipWarningXSDToLogical()


method %OnAfterCreatePage() as %Status
Decorate the page.
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 DeleteID(id) as %String [ ZenMethod ]
Delete the given id.
method DrawDescription(pSeed As %String) as %Status
Draw the contents of the description panel.
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
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
This callback, if implemented returns information used to display the standard ribbon bar.
classmethod SaveItem(pItem As %ZEN.proxyObject, pPWChanged As %Boolean) as %String [ ZenMethod ]
Save the given item.
classmethod UpdateDetails(id) [ ZenMethod ]
UpdateDetails: Update contents of details pane.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod deleteItem() [ Language = javascript ]
User clicked Delete button.
clientmethod doNew() [ Language = javascript ]
clientmethod editPassword(visible) [ Language = javascript ]
A keystroke was entered in the Password field
clientmethod onlayoutHandler(load) [ Language = javascript ]
This client event is fired when the page is resized.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod resetFieldState() [ Language = javascript ]
Reset the fields that control whether or not to warn the user about leaving the page
clientmethod resetForm() [ Language = javascript ]
Reset the form programmatically
clientmethod rowSelected(table, unselect) [ Language = javascript ]
User selected a row in the table
clientmethod save() [ Language = javascript ]
Save the contents of the form.
clientmethod showPartnerDetails() [ Language = javascript ]
Launch the profile info dialog.
clientmethod togglePasswordVisibility() [ Language = javascript ]
Switch between visible and obfuscated password fields

Inherited Members

Inherited Properties

Inherited Methods