Skip to main content

HS.Message.Crawler.ATNARequest

class HS.Message.Crawler.ATNARequest extends %Library.RegisteredObject, %XML.Adaptor

Each ATNA Request contains three parameters:

  1. EventType: each request is for a single event type
  2. RowLimit: default is 1000 records
  3. MaxIdProcessed: each request stores where it left off

Property Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
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.

Properties

property EventType as %String);
Property methods: EventTypeDisplayToLogical(), EventTypeGet(), EventTypeIsValid(), EventTypeLogicalToDisplay(), EventTypeLogicalToOdbc(), EventTypeNormalize(), EventTypeSet()
property MaxIdProcessed as %Integer (XMLPROJECTION = "ATTRIBUTE");
Property methods: MaxIdProcessedDisplayToLogical(), MaxIdProcessedGet(), MaxIdProcessedIsValid(), MaxIdProcessedLogicalToDisplay(), MaxIdProcessedNormalize(), MaxIdProcessedSet(), MaxIdProcessedXSDToLogical()
property PropertySelectList as list of %String (MAXLEN = 255, XMLITEMNAME = "PropertyName", XMLNAME = "PropertySelectList", XMLPROJECTION = "COLLECTION");
Property methods: PropertySelectListBuildValueArray(), PropertySelectListCollectionToDisplay(), PropertySelectListCollectionToOdbc(), PropertySelectListDisplayToCollection(), PropertySelectListDisplayToLogical(), PropertySelectListGet(), PropertySelectListGetObject(), PropertySelectListGetObjectId(), PropertySelectListGetSwizzled(), PropertySelectListIsValid(), PropertySelectListLogicalToDisplay(), PropertySelectListLogicalToOdbc(), PropertySelectListNormalize(), PropertySelectListOdbcToCollection(), PropertySelectListSet(), PropertySelectListSetObject(), PropertySelectListSetObjectId()
property RowLimit as %Integer (XMLPROJECTION = "ATTRIBUTE");
Property methods: RowLimitDisplayToLogical(), RowLimitGet(), RowLimitIsValid(), RowLimitLogicalToDisplay(), RowLimitNormalize(), RowLimitSet(), RowLimitXSDToLogical()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab