Skip to main content


persistent class HS.Gateway.Config extends %Library.Persistent, HS.Types.GatewayInfo, %XML.Adaptor, HS.Sync.BaseClass, %Library.GlobalIdentifier

SQL Table Name: HS_Gateway.Config

Property Inventory

Method Inventory


parameter RESOURCE;
Inherited description: If specified, this RESOURCE:PERMISSION is checked before any operation on this class via Zen MVC. (Create, Read, Update, or Delete.)
parameter SYNCORDER = 20;
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.


relationship Facilities as array of HS.Facility.Config (ZENHIDDEN = 1) [ InitialExpression = $listbuild("HS.Facility.Config","Gateway",+$this,"many",1,1) , Transient , Inverse = Gateway , Cardinality = many ];
Property methods: FacilitiesGet(), FacilitiesGetObject(), FacilitiesGetObjectId(), FacilitiesGetSwizzled(), FacilitiesIsEmpty(), FacilitiesIsValid(), FacilitiesNewObject(), FacilitiesRClose(), FacilitiesRExec(), FacilitiesRFetch(), FacilitiesRelate(), FacilitiesSQLCompute(), FacilitiesSet(), FacilitiesUnRelate()
property LastSeen as %TimeStamp (ZENREADONLY = 1);
Property methods: LastSeenDisplayToLogical(), LastSeenGet(), LastSeenGetStored(), LastSeenIsValid(), LastSeenLogicalToDisplay(), LastSeenLogicalToXSD(), LastSeenNormalize(), LastSeenOdbcToLogical(), LastSeenSet(), LastSeenXSDToLogical()


classmethod FindByName(Name As %String, ByRef ID As %Integer) as %Status
classmethod FindNameByURL(pURL As %String, ByRef pName) as %Status
Returns the version number for a gateway, for a given URL/Endpoint
classmethod FindVersionByURL(pURL As %String, ByRef pVersion) as %Status
Returns the version number for a gateway, for a given URL/Endpoint


query ListGateways(pName As %String = "", pType As %String = "", pShowDisabled As %Boolean = 0)
SQL Query:
SELECT %ID,Name,Type,Status,LastSeen,EndPoint,CacheType,FeedAnalytics,Version FROM HS_Gateway.Config WHERE (Name %STARTSWITH :pName) And (Type %STARTSWITH :pType) And ((Status <> 'Disabled') OR (:pShowDisabled = 1)) ORDER BY Type, Name


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (NameIndex on Name) [Unique];
Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()
index (URLIndex on EndPoint,LastSeen);
To enable us to find the gateway for that URL. We're not requiring the index to be unique, but only one should be active (the last seen)
Index methods: URLIndexExists()

Inherited Members

Inherited Properties

Inherited Methods


Storage Model: Storage (HS.Gateway.Config)

FeedbackOpens in a new tab