Skip to main content


class HS.Types.GatewayInfo extends %Library.RegisteredObject, HS.Util.DataModel.Adaptor, %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 CacheType as %String;
see HS.Util.AbstractEdgeProduction
Property methods: CacheTypeDisplayToLogical(), CacheTypeGet(), CacheTypeIsValid(), CacheTypeLogicalToDisplay(), CacheTypeLogicalToOdbc(), CacheTypeNormalize(), CacheTypeSet()
property ConsumeAndForward as %Boolean;
no longer used, replaced by CacheType
Property methods: ConsumeAndForwardDisplayToLogical(), ConsumeAndForwardGet(), ConsumeAndForwardIsValid(), ConsumeAndForwardLogicalToDisplay(), ConsumeAndForwardLogicalToXSD(), ConsumeAndForwardNormalize(), ConsumeAndForwardSet(), ConsumeAndForwardXSDToLogical()
property EndPoint as HS.Types.EndPoint (ZENREADONLY = 1);
Gateway endpoint (the web service URL) e.g. http://philhp:57773/csp/hsgateway/ensemble/HS.Gateway.WebServices.cls
Property methods: EndPointDisplayToLogical(), EndPointGet(), EndPointIsValid(), EndPointLogicalToDisplay(), EndPointLogicalToOdbc(), EndPointNormalize(), EndPointSet()
property FeedAnalytics as %Boolean;
This property is set by the gateway registration request, based on a production setting
Property methods: FeedAnalyticsDisplayToLogical(), FeedAnalyticsGet(), FeedAnalyticsIsValid(), FeedAnalyticsLogicalToDisplay(), FeedAnalyticsLogicalToXSD(), FeedAnalyticsNormalize(), FeedAnalyticsSet(), FeedAnalyticsXSDToLogical()
deprecated property GatewayNamespace as %String [ InitialExpression = $Namespace ];
Deprecated Used to store the local namespace name for this gateway and to derive the REST service endpoint Now REST services endpoints are configured by the federation registry instead
Property methods: GatewayNamespaceDisplayToLogical(), GatewayNamespaceGet(), GatewayNamespaceIsValid(), GatewayNamespaceLogicalToDisplay(), GatewayNamespaceLogicalToOdbc(), GatewayNamespaceNormalize(), GatewayNamespaceSet()
property Name as %String (MAXLEN = 320);
Gateway name, e.g. philhp:HSGATEWAY (MAXLEN consistent with HSComponentName now)
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property OID as %String (MAXLEN = 64);
Property methods: OIDDisplayToLogical(), OIDGet(), OIDIsValid(), OIDLogicalToDisplay(), OIDLogicalToOdbc(), OIDNormalize(), OIDSet()
property Status as %String (DISPLAYLIST = ",Registered,Unregistered,Disabled,NotifyQuery", VALUELIST = ",R,U,D,NQ", ZENHIDDEN = 1);
Gateway status R = Registered : The Gateway is running U = Unregistered : The Gateway is stopped (not currently implemented) D = Disabled : The Gateway is disabled NQ = NotifyQuery : Notify and Query Gateway Reset flag
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property Type as %String (DISPLAYLIST = ",Edge,Access,Bus,Registry,Flash,SysIndex,EventLog", VALUELIST = ",E,A,B,R,F,S,L", ZENREADONLY = 1);
Gateway Type. As of version 10, the Hub/Registry is also treated as a gateway
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property Version as %String;
The HealthShare (HSCORE) version for this gateway
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab