This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


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

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;
Number of transactions (hits) the connection has processed.
Property methods: ActivityDisplayToLogical(), ActivityGet(), ActivityIsValid(), ActivityLogicalToDisplay(), ActivityLogicalToOdbc(), ActivityNormalize(), ActivitySet()
property CacheServerName as %String;
Name of the Caché system connected to.
Property methods: CacheServerNameDisplayToLogical(), CacheServerNameGet(), CacheServerNameIsValid(), CacheServerNameLogicalToDisplay(), CacheServerNameLogicalToOdbc(), CacheServerNameNormalize(), CacheServerNameSet()
property CacheServerPID as %String;
Process ID on the Caché server.
Property methods: CacheServerPIDDisplayToLogical(), CacheServerPIDGet(), CacheServerPIDIsValid(), CacheServerPIDLogicalToDisplay(), CacheServerPIDLogicalToOdbc(), CacheServerPIDNormalize(), CacheServerPIDSet()
property IPAddress as %String;
IP address of the Caché
Property methods: IPAddressDisplayToLogical(), IPAddressGet(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()
property IdleTime as %String;
Formatted as 'number1/number2'. The first number is the idle time. The second number is the timeout time.
Property methods: IdleTimeDisplayToLogical(), IdleTimeGet(), IdleTimeIsValid(), IdleTimeLogicalToDisplay(), IdleTimeLogicalToOdbc(), IdleTimeNormalize(), IdleTimeSet()
property Status as %String;
Indicates whether information is being sent to or from the Caché system. If this column reads 'Free', no information is being sent and the connection is read to process the next request. If it reads 'In Use', information is being transmitted through the connection. If it reads 'Private', the connection is state-aware (preserve mode 1) and is not free for general use.
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property TCPPort as %String;
TCP port on the Caché server through which the connection communicates.
Property methods: TCPPortDisplayToLogical(), TCPPortGet(), TCPPortIsValid(), TCPPortLogicalToDisplay(), TCPPortLogicalToOdbc(), TCPPortNormalize(), TCPPortSet()
property WebServerPID as %String;
The Gateway (or hosting web server) process ID for the connection.
Property methods: WebServerPIDDisplayToLogical(), WebServerPIDGet(), WebServerPIDIsValid(), WebServerPIDLogicalToDisplay(), WebServerPIDLogicalToOdbc(), WebServerPIDNormalize(), WebServerPIDSet()

Inherited Members

Inherited Methods