Skip to main content


class EnsPortal.FindMsgBank extends EnsPortal.Template.standardPage

Page for configuring the link to the Message Bank for the current namespace. The data required to build the link are stored in ^Ens.MsgBank("Link"). If no data is present in that node, the code will attempt to retrieve the data from the nodes used by the Message Bank client code, and copy those values into the "Link" data location.

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_MsgBankConfig:WRITE;
User needs WRITE permissions on the %Ens_MsgBankConfig resource to make changes on this page.
parameter PAGENAME = Configure Message Bank Link;
Inherited description: Displayed name of this page.
parameter RESOURCE = %Ens_MsgBankConfig:READ;
User needs READ permissions on the %Ens_MsgBankConfig resource to view this page.


property bankLocation as %ZEN.Datatype.uri [ InitialExpression = ..GetBankLink() ];
Full URL of the Message Bank Status Monitor. If this is the empty string, the bank is not correctly configured.
Property methods: bankLocationDisplayToLogical(), bankLocationGet(), bankLocationIsValid(), bankLocationLogicalToDisplay(), bankLocationLogicalToOdbc(), bankLocationNormalize(), bankLocationSet()


method %OnAfterCreatePage() as %Status
Populate the controls as needed.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
Return the current link
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.
Build the constituent parts of the link into a single URL.
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.
method SaveLinkData(pData As %ZEN.proxyObject) as %String [ ZenMethod ]
Save the values and update the value of bankLocation.
classmethod SetBankAddress(pWebServer As %String, pWebPort As %String, pInstancePrefix As %String, pBankNS As %String, pUseSSL As %Boolean) as %Status
Physically set the values into the ^Ens.MsgBank("Link") node. This method is the API for changing this.
clientmethod goToBank() [ Language = javascript ]
Redirect the client to the Message Bank.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod saveValues() [ Language = javascript ]
Actually save the values to the server.
clientmethod updateGoButton() [ Language = javascript ]
clientmethod validate() [ Language = javascript ]
Validate the contents of the form.
clientmethod validatePort() [ Language = javascript ]
Ensure that the port is a positive integer.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab