Skip to main content


class HS.Push.Types.FilterInfo extends %Library.RegisteredObject, HS.Util.DataModel.Adaptor, %XML.Adaptor, HS.Util.CopyFrom

Filter to be applied to a policy to determine whether its applicable

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 AnalyticsColumn as %String (MAXLEN = 500);
Property methods: AnalyticsColumnDisplayToLogical(), AnalyticsColumnGet(), AnalyticsColumnIsValid(), AnalyticsColumnLogicalToDisplay(), AnalyticsColumnLogicalToOdbc(), AnalyticsColumnNormalize(), AnalyticsColumnSet()
property AnalyticsCustomClass as %String (MAXLEN = 256);
Property methods: AnalyticsCustomClassDisplayToLogical(), AnalyticsCustomClassGet(), AnalyticsCustomClassIsValid(), AnalyticsCustomClassLogicalToDisplay(), AnalyticsCustomClassLogicalToOdbc(), AnalyticsCustomClassNormalize(), AnalyticsCustomClassSet()
property AnalyticsCustomMethod as %String (MAXLEN = 256);
Property methods: AnalyticsCustomMethodDisplayToLogical(), AnalyticsCustomMethodGet(), AnalyticsCustomMethodIsValid(), AnalyticsCustomMethodLogicalToDisplay(), AnalyticsCustomMethodLogicalToOdbc(), AnalyticsCustomMethodNormalize(), AnalyticsCustomMethodSet()
property AnalyticsOperator as HS.Types.Grid.Operator;
Property methods: AnalyticsOperatorDisplayToLogical(), AnalyticsOperatorGet(), AnalyticsOperatorIsValid(), AnalyticsOperatorLogicalToDisplay(), AnalyticsOperatorLogicalToOdbc(), AnalyticsOperatorNormalize(), AnalyticsOperatorSet()
property AnalyticsQuery as %String (MAXLEN = 256);
Name of the query registry item to run
Property methods: AnalyticsQueryDisplayToLogical(), AnalyticsQueryGet(), AnalyticsQueryIsValid(), AnalyticsQueryLogicalToDisplay(), AnalyticsQueryLogicalToOdbc(), AnalyticsQueryNormalize(), AnalyticsQuerySet()
property AnalyticsRow as %String (MAXLEN = 500);
Property methods: AnalyticsRowDisplayToLogical(), AnalyticsRowGet(), AnalyticsRowIsValid(), AnalyticsRowLogicalToDisplay(), AnalyticsRowLogicalToOdbc(), AnalyticsRowNormalize(), AnalyticsRowSet()
property AnalyticsService as %String (MAXLEN = 255);
Analytics service name to send the query to
Property methods: AnalyticsServiceDisplayToLogical(), AnalyticsServiceGet(), AnalyticsServiceIsValid(), AnalyticsServiceLogicalToDisplay(), AnalyticsServiceLogicalToOdbc(), AnalyticsServiceNormalize(), AnalyticsServiceSet()
property AnalyticsType as %String (DISPLAYLIST = ",Immediate,Transfer,Sync", VALUELIST = ",I,T,S");
When to execute the filter
Property methods: AnalyticsTypeDisplayToLogical(), AnalyticsTypeGet(), AnalyticsTypeIsValid(), AnalyticsTypeLogicalToDisplay(), AnalyticsTypeLogicalToOdbc(), AnalyticsTypeNormalize(), AnalyticsTypeSet()
property Context as %String (MAXLEN = 500);
XPath context for the expression
Property methods: ContextDisplayToLogical(), ContextGet(), ContextIsValid(), ContextLogicalToDisplay(), ContextLogicalToOdbc(), ContextNormalize(), ContextSet()
property CustomMethod as %String;
Name of the method to use for a custom filter (in the custom class in the \Push\Filter\Custom setting in HS.Registry.Config
Property methods: CustomMethodDisplayToLogical(), CustomMethodGet(), CustomMethodIsValid(), CustomMethodLogicalToDisplay(), CustomMethodLogicalToOdbc(), CustomMethodNormalize(), CustomMethodSet()
property DefaultOperator as %String (DISPLAYLIST = ",Contains,Custom,Equals,Exists,Greater Than,In,Less Than,Starts With,Not Contain,Not Equal,Not Exist,Not Greater Than,Not In,Not Less Than,Not Start With", VALUELIST = ",CON,CUS,EQ,EX,GT,IN,LT,ST,NCN,NEQ,NEX,NGT,NIN,NLT,NST");
The default operator suggested for this filter
Property methods: DefaultOperatorDisplayToLogical(), DefaultOperatorGet(), DefaultOperatorIsValid(), DefaultOperatorLogicalToDisplay(), DefaultOperatorLogicalToOdbc(), DefaultOperatorNormalize(), DefaultOperatorSet()
property Description as %String (MAXLEN = 500);
Textual description of the filter
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property FilterType as %String (DISPLAYLIST = ",Topic,Detail,Analytics", VALUELIST = ",T,D,A", ZENREADONLY = 1);
Type of Filter -- (T)opic or (D)etail or (A)nalytics
Property methods: FilterTypeDisplayToLogical(), FilterTypeGet(), FilterTypeIsValid(), FilterTypeLogicalToDisplay(), FilterTypeLogicalToOdbc(), FilterTypeNormalize(), FilterTypeSet()
property Name as %String;
Name of filter
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Parameters as list of %String (MAXLEN = 256);
Names of parameters to be filled into the XPath expression of the filter or compared against the result
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersDisplayToLogical(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersLogicalToDisplay(), ParametersLogicalToOdbc(), ParametersNormalize(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property XPathExpression as %String (MAXLEN = 500);
XPath expression to be applied to the SDA. May contain parameters expressed as %1, %2, etc.
Property methods: XPathExpressionDisplayToLogical(), XPathExpressionGet(), XPathExpressionIsValid(), XPathExpressionLogicalToDisplay(), XPathExpressionLogicalToOdbc(), XPathExpressionNormalize(), XPathExpressionSet()

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab