Skip to main content


persistent class HS.Types.XMLMessage extends HS.Util.EnsRequest, %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Types.XMLMessage

Generic XML message

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 = inputonly;
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 Action as %String (MAXLEN = 32) [ SqlFieldName = MsgAction ];
Property methods: ActionDisplayToLogical(), ActionGet(), ActionGetStored(), ActionIsValid(), ActionLogicalToDisplay(), ActionLogicalToOdbc(), ActionNormalize(), ActionSet()
property Content as %String);
XML Content -- this is a long string!
Property methods: ContentDisplayToLogical(), ContentGet(), ContentGetStored(), ContentIsValid(), ContentLogicalToDisplay(), ContentLogicalToOdbc(), ContentNormalize(), ContentSet()
property ContentStream as %Stream.GlobalCharacter;
XML Content Stream, for cases > 3.8MB
Property methods: ContentStreamDelete(), ContentStreamGet(), ContentStreamGetObject(), ContentStreamGetObjectId(), ContentStreamGetStored(), ContentStreamGetSwizzled(), ContentStreamIsValid(), ContentStreamNewObject(), ContentStreamOid(), ContentStreamOpen(), ContentStreamSet(), ContentStreamSetObject(), ContentStreamSetObjectId(), ContentStreamUnSwizzle()
property QuickStreamId as %String;
This can hold the ID of an HS.SDA3.QuickStream, instead of placing the stream data in the ContentStream property, for quick messaging
Property methods: QuickStreamIdDisplayToLogical(), QuickStreamIdGet(), QuickStreamIdGetStored(), QuickStreamIdIsValid(), QuickStreamIdLogicalToDisplay(), QuickStreamIdLogicalToOdbc(), QuickStreamIdNormalize(), QuickStreamIdSet()
property StreamContentType as %String [ InitialExpression = "SDA2" ];
What is being carried in the contentstream or the quickstream SDA2, or SDA3, or Streamlets
Property methods: StreamContentTypeDisplayToLogical(), StreamContentTypeGet(), StreamContentTypeGetStored(), StreamContentTypeIsValid(), StreamContentTypeLogicalToDisplay(), StreamContentTypeLogicalToOdbc(), StreamContentTypeNormalize(), StreamContentTypeSet()

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)


Storage Model: Storage (HS.Util.EnsRequest)


Storage Model: Storage (HS.Types.XMLMessage)



FeedbackOpens in a new tab