EnsPortal.DefaultSettings

class EnsPortal.DefaultSettings extends EnsPortal.Template.listPage

Zen based UI for InterSystems IRIS Interoperability

Property Inventory

LocatorHeader
msgRestrictedSetting
msgTable

Method Inventory

%OnAfterCreatePage()
%OnGetPageName()
DeleteData()
FormatDeployable()
GetHyperEventResources()
OnGetRibbonInfo()
addSetting()
checkTable()
deleteSetting()
editSetting()
onloadHandler()
refreshTable()

Parameters

parameter EDITRESOURCE = %Ens_SystemDefaultConfig:WRITE;

User needs WRITE permissions on the %Ens_SystemDefaultConfig resource to make changes on this page.

parameter PAGENAME = System Default Settings;

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 LocatorHeader as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Configuration Defaults") ];

The text that is shown in TitlePane

Property methods: LocatorHeaderDisplayToLogical(), LocatorHeaderGet(), LocatorHeaderIsValid(), LocatorHeaderLogicalToDisplay(), LocatorHeaderLogicalToOdbc(), LocatorHeaderNormalize(), LocatorHeaderSet()

property msgRestrictedSetting as %ZEN.Datatype.caption [ InitialExpression = ##class(EnsPortal.DefaultSettings).restrictedMessage() ];

Property methods: msgRestrictedSettingDisplayToLogical(), msgRestrictedSettingGet(), msgRestrictedSettingIsValid(), msgRestrictedSettingLogicalToDisplay(), msgRestrictedSettingLogicalToOdbc(), msgRestrictedSettingNormalize(), msgRestrictedSettingSet()

property msgTable as %ZEN.Datatype.caption;

Message that is built with the namespace in it.

Property methods: msgTableDisplayToLogical(), msgTableGet(), msgTableIsValid(), msgTableLogicalToDisplay(), msgTableLogicalToOdbc(), msgTableNormalize(), msgTableSet()

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 %OnGetPageName() as %String

Get the (localized) name of the page.

classmethod DeleteData(pid) as %String [ ZenMethod ]

Delete an association context

method FormatDeployable(table As %ZEN.Component.tablePane, depl As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status

Method to convert the Deployable field from 0/1 to "No/Yes".

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

Get information to display in the ribbon bar.

clientmethod addSetting() [ Language = javascript ]

Enable edit fields. Clear table selection and initialize all fields.

clientmethod checkTable() [ Language = javascript ]

Check if table is populated and there is a row selected.

clientmethod deleteSetting() [ Language = javascript ]

Delete existing Setting definition.

clientmethod editSetting() [ Language = javascript ]

Edit existing Setting definition.

clientmethod onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

clientmethod refreshTable() [ Language = javascript ]

This method is called after a Setting is saved or deleted.

Queries

query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)

Selects ID, ProductionName, ItemName, HostClassName, SettingName, SettingValue, Deployable

Class query with filter added. Override this in order to add rowspec specific to the list being displayed