Skip to main content


serial class %CSP.Mgr.Helper.AlternativeServer extends %Library.SerialObject, %XML.Adaptor

Load-Balancing is implemented in a round robin fashion. Each new user session will be connected to the next available 'alternative' server (including the 'Default' Server). Once a user session is established on a server, the Gateway will endeavor to maintain the session on that server unless it becomes unavailable, in which case the session will be failed-over to the next available server in the list. State-aware sessions (preserve mode = 1) cannot be failed-over under any circumstances and, consequently, the session will be closed if the hosting server becomes unavailable.
This object is part of the %CSP.Mgr.GatewaySystemStatus object.

Property Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
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 Activity as %String;
Property methods: ActivityDisplayToLogical(), ActivityGet(), ActivityIsValid(), ActivityLogicalToDisplay(), ActivityLogicalToOdbc(), ActivityNormalize(), ActivitySet()
property CacheServerName as %String;
Property methods: CacheServerNameDisplayToLogical(), CacheServerNameGet(), CacheServerNameIsValid(), CacheServerNameLogicalToDisplay(), CacheServerNameLogicalToOdbc(), CacheServerNameNormalize(), CacheServerNameSet()
property Status as %String;
The purpose for which this server is being used.

Use for Load-Balancing. (Fail-over in implied for this option).

Use for Fail-over only. (Use the alternatives only if the main (i.e. default) server becomes unavailable.)

Disable. (Do not connect to the alternative servers under any circumstances.)

Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab