InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsPortal.ProductionShutdownGroup


class EnsPortal.ProductionShutdownGroup extends EnsPortal.Template.standardPage

This page is used to set the ShutdownGroup of the production.
Note: Setting ShutdownGroup to a value other than default or empty value can lead to extending the time it takes to stop the instance in a controlled manner. This can have implications for time sensitive failovers

Productions are requested to be shutdown in parallel when the system is stopped in a controlled manner
It is possible to control the shutdown order in separate parallel groups by entering an integer.
Running productions will be shutdown in parallel grouped by this integer.
The default if not specified will be taken as $$$ensDefaultShutdownGroup (2).

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Admin_Manage:USE;
User needs WRITE permissions on the %Ens_ProductionConfig resource to make changes on this page. as well as canAccessAll.
parameter PAGENAME = Production Shutdown Group;
Displayed name of this page.
parameter RESOURCE = %Ens_ProductionConfig:READ;
User needs READ permissions on the %Ens_ProductionConfig resource to access this page.


property canAccessAll as %Boolean [ InitialExpression = 0 ];
If user cannot access Ens.Configuration in all namespaces we will not show the table and the user will not be able to make changes.
Property methods: canAccessAllDisplayToLogical(), canAccessAllGet(), canAccessAllIsValid(), canAccessAllLogicalToDisplay(), canAccessAllLogicalToXSD(), canAccessAllNormalize(), canAccessAllSet(), canAccessAllXSDToLogical()
property currentProduction as %String;
Property methods: currentProductionDisplayToLogical(), currentProductionGet(), currentProductionIsValid(), currentProductionLogicalToDisplay(), currentProductionLogicalToOdbc(), currentProductionNormalize(), currentProductionSet()


method %OnAfterCreatePage() as %Status [ Language = objectscript ]
This class method callback is called just before the server-side page object is created.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod ApplyID(id, group) as %String [ Language = objectscript, ZenMethod ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
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 GetShutdownGroup(id) as %Integer [ Language = objectscript, ZenMethod ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
clientmethod doApply() [ Language = javascript ]
clientmethod doWarning() [ Language = javascript ]
clientmethod getrecommendAndWarn() [ Language = javascript ]
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.

Inherited Members

Inherited Properties

Inherited Methods