Skip to main content


class HS.Types.XMLSummaryType extends %Library.RegisteredObject, %XML.Adaptor

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 Code as %String;
Used in the XSLT file named SDA-to-XMLSummaryScan that extracts data for this type of document from SDA. Custom codes begin with "Z"
Property methods: CodeDisplayToLogical(), CodeGet(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeSet()
property Description as %String (MAXLEN = 256);
Full description
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property FormatCode as %String (MAXLEN = 1024);
for XML transformations
Property methods: FormatCodeDisplayToLogical(), FormatCodeGet(), FormatCodeIsValid(), FormatCodeLogicalToDisplay(), FormatCodeLogicalToOdbc(), FormatCodeNormalize(), FormatCodeSet()
property FormatScheme as %String (MAXLEN = 1024);
for XML transformations
Property methods: FormatSchemeDisplayToLogical(), FormatSchemeGet(), FormatSchemeIsValid(), FormatSchemeLogicalToDisplay(), FormatSchemeLogicalToOdbc(), FormatSchemeNormalize(), FormatSchemeSet()
property ResourceRequired as %String;
If specified, this choice will be suppressed unless the user has this resource.
Property methods: ResourceRequiredDisplayToLogical(), ResourceRequiredGet(), ResourceRequiredIsValid(), ResourceRequiredLogicalToDisplay(), ResourceRequiredLogicalToOdbc(), ResourceRequiredNormalize(), ResourceRequiredSet()
property SDAVersion as %String (VALUELIST = ",2,3") [ InitialExpression = 2 ];
Whether using SDA2 or SDA3
Property methods: SDAVersionDisplayToLogical(), SDAVersionGet(), SDAVersionIsValid(), SDAVersionLogicalToDisplay(), SDAVersionLogicalToOdbc(), SDAVersionNormalize(), SDAVersionSet()
property SectionTypes as list of %String;
A list of section types used for dynamic filtering
Property methods: SectionTypesBuildValueArray(), SectionTypesCollectionToDisplay(), SectionTypesCollectionToOdbc(), SectionTypesDisplayToCollection(), SectionTypesDisplayToLogical(), SectionTypesGet(), SectionTypesGetObject(), SectionTypesGetObjectId(), SectionTypesGetSwizzled(), SectionTypesIsValid(), SectionTypesLogicalToDisplay(), SectionTypesLogicalToOdbc(), SectionTypesNormalize(), SectionTypesOdbcToCollection(), SectionTypesSet(), SectionTypesSetObject(), SectionTypesSetObjectId()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab