Home > Class Reference > ENSLIB namespace > Ens.Config.Item


persistent class Ens.Config.Item extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Ens_Config.Item

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


property AlertGroups as %String (MAXLEN = 2500, XMLPROJECTION = "NONE");
A computed property to reflect the values specified in the AlertGroups setting in Settings. The primary purpose of this property is to allow us to build the AlertGroup index on all the individual group values in the string. The actual breaking down of this value is performed in AlertGroupBuildValueArray()().
Property methods: AlertGroupsBuildValueArray(), AlertGroupsCompute(), AlertGroupsDisplayToLogical(), AlertGroupsGet(), AlertGroupsGetStored(), AlertGroupsIsValid(), AlertGroupsLogicalToDisplay(), AlertGroupsLogicalToOdbc(), AlertGroupsNormalize(), AlertGroupsSQLCompute(), AlertGroupsSet(), AlertGroupsSetT()
property Category as %String (MAXLEN = 2500, XMLPROJECTION = "ATTRIBUTE");
Optional list of categories this item belongs to, comma-separated. This is only used for display purposes and does not affect the behavior of this item.
Property methods: CategoryDisplayToLogical(), CategoryGet(), CategoryGetStored(), CategoryIsValid(), CategoryLogicalToDisplay(), CategoryLogicalToOdbc(), CategoryNormalize(), CategorySet()
property ClassName as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE") [ Required ];
Class name of this config item.
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameGetStored(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()
property Comment as %String (MAXLEN = 512, XMLPROJECTION = "ATTRIBUTE");
Optional comment text for this component.
Property methods: CommentDisplayToLogical(), CommentGet(), CommentGetStored(), CommentIsValid(), CommentLogicalToDisplay(), CommentLogicalToOdbc(), CommentNormalize(), CommentOrClassnameDisplayToLogical(), CommentOrClassnameGet(), CommentOrClassnameIsValid(), CommentOrClassnameLogicalToDisplay(), CommentOrClassnameLogicalToOdbc(), CommentOrClassnameNormalize(), CommentSet()
property CommentOrClassname as %String (XMLPROJECTION = "NONE") [ Calculated , Transient , ReadOnly ];
Calculated comment-or-classname property.
Property methods: CommentOrClassnameDisplayToLogical(), CommentOrClassnameGet(), CommentOrClassnameIsValid(), CommentOrClassnameLogicalToDisplay(), CommentOrClassnameLogicalToOdbc(), CommentOrClassnameNormalize()
property DisableErrorTraps as %Boolean (XMLPROJECTION = "ATTRIBUTE");
Deprecated - Always 0 : Whether to disable error traps for the job or not.
Property methods: DisableErrorTrapsDisplayToLogical(), DisableErrorTrapsGet(), DisableErrorTrapsGetStored(), DisableErrorTrapsIsValid(), DisableErrorTrapsLogicalToDisplay(), DisableErrorTrapsLogicalToXSD(), DisableErrorTrapsNormalize(), DisableErrorTrapsSet(), DisableErrorTrapsXSDToLogical()
property Enabled as %Boolean (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
Whether this config item is enabled or not.
Property methods: EnabledDisplayToLogical(), EnabledGet(), EnabledGetStored(), EnabledIsValid(), EnabledLogicalToDisplay(), EnabledLogicalToXSD(), EnabledNormalize(), EnabledSet(), EnabledXSDToLogical()
property Foreground as %Boolean (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0 ];
Whether to run the job of this config item in the foreground or background.
Property methods: ForegroundDisplayToLogical(), ForegroundGet(), ForegroundGetStored(), ForegroundIsValid(), ForegroundLogicalToDisplay(), ForegroundLogicalToXSD(), ForegroundNormalize(), ForegroundSet(), ForegroundXSDToLogical()
property InactivityTimeout as %Numeric (MINVAL = 0, XMLIO = "IN", XMLPROJECTION = "ATTRIBUTE") [ Calculated , Transient ];
This property is now a shadow of a Host Config Setting of the same name.
Property methods: InactivityTimeoutDisplayToLogical(), InactivityTimeoutGet(), InactivityTimeoutIsValid(), InactivityTimeoutLogicalToDisplay(), InactivityTimeoutNormalize(), InactivityTimeoutSet(), InactivityTimeoutXSDToLogical()
property LogTraceEvents as %Boolean (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0 ];
Whether to log trace events for this item.
Property methods: LogTraceEventsDisplayToLogical(), LogTraceEventsGet(), LogTraceEventsGetStored(), LogTraceEventsIsValid(), LogTraceEventsLogicalToDisplay(), LogTraceEventsLogicalToXSD(), LogTraceEventsNormalize(), LogTraceEventsSet(), LogTraceEventsXSDToLogical()
property ModifiedSettings as list of Ens.Config.Setting (XMLPROJECTION = "NONE") [ Transient ];
Same format as Settings. You must call PopulateModifiedSettings() to populate this collection. The collection contains the list of settings that are either defined in the production, or have default setting overrides.
Property methods: ModifiedSettingsBuildValueArray(), ModifiedSettingsCollectionToDisplay(), ModifiedSettingsCollectionToOdbc(), ModifiedSettingsDisplayToCollection(), ModifiedSettingsGet(), ModifiedSettingsGetObject(), ModifiedSettingsGetObjectId(), ModifiedSettingsGetSwizzled(), ModifiedSettingsIsValid(), ModifiedSettingsOdbcToCollection(), ModifiedSettingsSet(), ModifiedSettingsSetObject(), ModifiedSettingsSetObjectId()
property Name as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE") [ Required ];
The name of this config item. Default is the class name.
Property methods: NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property PoolSize as %Integer (MINVAL = 0, XMLPROJECTION = "ATTRIBUTE");
Number of jobs to start for this config item.
Default value:
0 for Business Processes (i.e. use shared Actor Pool)
1 for FIFO message router Business Processes (i.e. use a dedicated job)
1 for Business Operations
0 for adapterless Business Services
1 for others
For TCP based Services with JobPerConnection=1, this value is used to limit the number of connection jobs if its value is greater than 1. A value of 0 or 1 places no limit on the number of connection jobs.
Property methods: PoolSizeDisplayToLogical(), PoolSizeGet(), PoolSizeGetStored(), PoolSizeIsValid(), PoolSizeLogicalToDisplay(), PoolSizeNormalize(), PoolSizeSet(), PoolSizeXSDToLogical()
property Production as Ens.Config.Production (XMLPROJECTION = "NONE");
Reference to the Production object.
Property methods: ProductionGet(), ProductionGetObject(), ProductionGetObjectId(), ProductionGetStored(), ProductionGetSwizzled(), ProductionIsValid(), ProductionNewObject(), ProductionSet(), ProductionSetObject(), ProductionSetObjectId(), ProductionUnSwizzle()
property Schedule as %String);
Specifies times when this item should be stopped and restarted. You may enter a string formatted as a comma-separated list of event specifications, or you may enter the name of a schedule specification preceded by the @ symbol. To create a named schedule specification, use the Ensemble > Configure > Schedule Specs page.

If you wish to simply enter an event specification string in this field, it must use the following format:


Where each item in the event specification, from left to right, has