Skip to main content


serial class %CSP.Mgr.Helper.CachedForms 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 CacheActivity as %Integer;
Number of hits for forms held in the Gateway cache.
Property methods: CacheActivityDisplayToLogical(), CacheActivityGet(), CacheActivityIsValid(), CacheActivityLogicalToDisplay(), CacheActivityNormalize(), CacheActivitySet(), CacheActivityXSDToLogical()
property CachedData as %Integer;
Amount (in bytes) of cached form dat held in the Gateway.
Property methods: CachedDataDisplayToLogical(), CachedDataGet(), CachedDataIsValid(), CachedDataLogicalToDisplay(), CachedDataNormalize(), CachedDataSet(), CachedDataXSDToLogical()
property Form as array of %CSP.Mgr.Helper.Form (XMLKEYNAME = "id", XMLPROJECTION = "ELEMENT");
Information about individual forms in the Gateway cache.
Property methods: FormBuildValueArray(), FormCollectionToDisplay(), FormCollectionToOdbc(), FormDisplayToCollection(), FormGet(), FormGetObject(), FormGetObjectId(), FormGetSwizzled(), FormIsValid(), FormOdbcToCollection(), FormSet(), FormSetObject(), FormSetObjectId()
property FormsInCache as %Integer;
Number of CSP forms cached by the Gateway
Property methods: FormsInCacheDisplayToLogical(), FormsInCacheGet(), FormsInCacheIsValid(), FormsInCacheLogicalToDisplay(), FormsInCacheNormalize(), FormsInCacheSet(), FormsInCacheXSDToLogical()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab