This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.DefaultSetting

EnsPortal.DefaultSetting

class EnsPortal.DefaultSetting extends EnsPortal.Template.standardPage

Zen based System Default Settings page for add or edit

Property Inventory

Method Inventory

Parameters

parameter EDITRESOURCE = %Ens_SystemDefaultConfig:WRITE;
User needs WRITE permissions on the %Ens_SystemDefaultConfig resource to make changes on this page.
parameter JSINCLUDES = zenCSLM.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter PAGENAME = Default Setting;
Displayed name of this page.
parameter RESOURCE = %Ens_SystemDefaultConfig:READ;
User needs READ permissions on the %Ens_SystemDefaultConfig resource to view this page.

Properties

property PID as %ZEN.Datatype.string (ZENURL = "PID");
The last selected PID
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isNew as %String (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewNormalize(), isNewSet()
property msgTable as %ZEN.Datatype.caption;
Message that is built with the namespace in it.
Property methods: msgTableDisplayToLogical(), msgTableGet(), msgTableIsValid(), msgTableLogicalToDisplay(), msgTableLogicalToOdbc(), msgTableNormalize(), msgTableSet()
property settingsExpanded as %Boolean [ InitialExpression = 1 ];
Property methods: settingsExpandedDisplayToLogical(), settingsExpandedGet(), settingsExpandedIsValid(), settingsExpandedLogicalToDisplay(), settingsExpandedLogicalToXSD(), settingsExpandedNormalize(), settingsExpandedSet(), settingsExpandedXSDToLogical()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
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 %OnDrawHTMLHead() as %Status
Inherited description: Add the EnsException error handling on the client.
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.
classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
classmethod GetAffectedCount() as %String
Get the total count of configuration items affected by the definition currently shown.
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.
classmethod GetTempGlobal() as %String
Return the temporary global name.
classmethod GetTreeGlobal() as %String
Return the temporary global name of the dynaTree.
classmethod GetTreeInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the data source tree and temp globals.
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.
classmethod SaveData(pid, production, itemname, hostclassname, settingname, settingvalue, description, deployable) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server
method UpdateDetails(pid) as %Boolean [ ZenMethod ]
Update contents of setting. This method is called when user clicked a row to "Edit". Load data into the fields.
clientmethod adjustSettingName(selector) [ Language = javascript ]
Get only the first piece of white space from the Setting Name value.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod cancelSetting() [ Language = javascript ]
Cancel out of Add/Edit and return to the previous page.
clientmethod resetSetting() [ Language = javascript ]
Reset out of Add/Edit, reinitializing all fields and information on the page (the trees are rebuilt too).
clientmethod saveSetting() [ Language = javascript ]
Get user selection and send to server to save settings.
clientmethod showExpand() [ Language = javascript ]
clientmethod toggleSettings() [ Language = javascript ]
Toggle display of settings pane.
clientmethod treeClick(tree) [ Language = javascript ]
Click on a tree's item.
clientmethod treeContractAll(tree) [ Language = javascript ]
Contract the tree.
clientmethod treeExpandAll(tree) [ Language = javascript ]
Expand the tree.

Inherited Members

Inherited Properties

Inherited Methods

Feedback