Home > Class Reference > ENSLIB namespace > Ens.Director

Ens.Director

abstract class Ens.Director

Method Inventory

Parameters

parameter DOMAIN = Ensemble;

Methods

classmethod Console(pTarget As %String = $NAMESPACE)
Console for managing/monitoring Ensemble from a terminal prompt.
classmethod CreateBusinessService(pTargetDispatchName As %String, Output pBusinessService As Ens.BusinessService) as %Status
This method creates a Business Service object from which you can send messages. pTargetDispatchName: is the configuration name of the business service. pBusinessService: is an output parameter that contains the business service object.
classmethod DeleteProduction(pProdId As %String) as %Status
This method permanently deletes the specified production and its underlying class.
classmethod EnableConfigItem(pConfigItemName As %String, pEnable As %Boolean = 1, pDoUpdate As %Boolean = 1) as %Status
Enable or disable a ConfigItem in a Production. The Production may be running or not. The pConfigItemName argument gives the name of the config item to be enabled or disabled In the case of multiple matching items with the same config name, if any is already enabled then the pEnable=1 option will do nothing and the pEnable=0 option will disable the running matching production item, or if not running then the first matching enabled item that it finds. See method Ens.Director.ParseConfigName() for full syntax of the ConfigItem name specification string.
classmethod GetActiveProductionName() as %String
Get the name of the current running or last used production
classmethod GetAdapterSettingValue(pConfigItemName As %String, pSetting As %String, Output pStatus As %Status) as %String
classmethod GetAdapterSettings(pConfigItemName As %String, Output pSettings) as %Status
classmethod GetCurrProductionSettingValue(pSetting As %String, Output pStatus As %Status) as %String
This method is deprecated. Please call GetProductionSettingValue("",tSetting,.tStatus) instead
classmethod GetCurrProductionSettings(Output pSettings) as %Status
This method is deprecated. Please call GetProductionSettings("",.tSettings) instead
classmethod GetHostSettingValue(pConfigItemName As %String, pSetting As %String, Output pStatus As %Status) as %String
classmethod GetHostSettings(pConfigItemName As %String, Output pSettings) as %Status
classmethod GetItemSettingValue(pConfigItemName As %String, pType As %String, pSetting As %String, Output pStatus As %Status) as %String
classmethod GetItemSettings(pConfigItemName As %String, pType As %String, Output pSettings) as %Status
classmethod GetProductionSettingValue(pProd As %String, pSetting As %String, Output pStatus As %Status) as %String
classmethod GetProductionSettings(pProd As %String, Output pSettings) as %Status
classmethod GetProductionStatus(Output pProductionName As %String, Output pState As %Integer, pLockTimeout As %Numeric = 10, pSkipLockIfRunning As %Boolean = 0) as %Status
This method returns the production status via the output parameters. pProductionName: Returns the production name when the status is running, suspended or troubled. pState: Outputs production status. The valid values are: $$$eProductionStateRunning $$$eProductionStateStopped $$$eProductionStateSuspended $$$eProductionStateTroubled
classmethod GetProductionSummary(ByRef pInfo, pNamespace As %String = $ZU(5))
classmethod GetRunningProductionShutdownTimeout() as %Integer
classmethod GetRunningProductionUpdateTimeout() as %Integer
classmethod GetSystemProductionSummary(ByRef pInfo) as %Status
classmethod IsItemEnabled(pConfigItemName As %String, pStatus As %Status) as %Boolean