Skip to main content


class HS.Types.Analytics.QueryDefinition extends %Library.RegisteredObject, %XML.Adaptor, HS.Util.CopyFrom

Common properties for a query definition, used by the query registry and query handler classes.

Property Inventory

Method Inventory


property ColumnHeaders as list of HS.Types.Grid.Axis;
The query column headers, used by the filter UI for pick-lists and validation For pivots this is only a suggestion of the possible columns as the headers may change based on query result over time, or the mdx/detail defintion may change without updating the registry (via Analyzer).
Property methods: ColumnHeadersBuildValueArray(), ColumnHeadersCollectionToDisplay(), ColumnHeadersCollectionToOdbc(), ColumnHeadersDisplayToCollection(), ColumnHeadersGet(), ColumnHeadersGetObject(), ColumnHeadersGetObjectId(), ColumnHeadersGetSwizzled(), ColumnHeadersIsValid(), ColumnHeadersOdbcToCollection(), ColumnHeadersSet(), ColumnHeadersSetObject(), ColumnHeadersSetObjectId()
property Description as %String (MAXLEN = 500);
Built in documentation, also shown in push filter UI
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Mode as %String (DISPLAYLIST = ",Custom,MDX Pivot,SQL Query", VALUELIST = ",CUSTOM,MDX,SQL") [ Required ];
Specifies if this is a SQL or MDX pivot
Property methods: ModeDisplayToLogical(), ModeGet(), ModeIsValid(), ModeLogicalToDisplay(), ModeLogicalToOdbc(), ModeNormalize(), ModeSet()
property Name as %String (MAXLEN = 256) [ Required ];
Queries must have unique name, as this is what is passed in a query request
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Parameters as array of HS.Types.Analytics.QueryParameter;
The parameters used by this query, subscripted by parameter name :MPIID and :HSAAID parameters are always available and not part of this list
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property PivotGateway as %String (MAXLEN = 256);
The gateway to run the query on, required when type == Pivot since pivots are not synced
Property methods: PivotGatewayDisplayToLogical(), PivotGatewayGet(), PivotGatewayIsValid(), PivotGatewayLogicalToDisplay(), PivotGatewayLogicalToOdbc(), PivotGatewayNormalize(), PivotGatewaySet()
property PivotName as %String (MAXLEN = 500);
The pivot name, required when type == Pivot
Property methods: PivotNameDisplayToLogical(), PivotNameGet(), PivotNameIsValid(), PivotNameLogicalToDisplay(), PivotNameLogicalToOdbc(), PivotNameNormalize(), PivotNameSet()
property QueryClass as %String (MAXLEN = 220);
The query class, required when type == Custom
Property methods: QueryClassDisplayToLogical(), QueryClassGet(), QueryClassIsValid(), QueryClassLogicalToDisplay(), QueryClassLogicalToOdbc(), QueryClassNormalize(), QueryClassSet()
property QueryText as %String);
The query text, required when type == SQL
Property methods: QueryTextDisplayToLogical(), QueryTextGet(), QueryTextIsValid(), QueryTextLogicalToDisplay(), QueryTextLogicalToOdbc(), QueryTextNormalize(), QueryTextSet()
property RowHeaders as list of HS.Types.Grid.Axis;
The query row headers, used by the filter UI for pick-lists and validation Same caveats as column headers for pivots apply here too
Property methods: RowHeadersBuildValueArray(), RowHeadersCollectionToDisplay(), RowHeadersCollectionToOdbc(), RowHeadersDisplayToCollection(), RowHeadersGet(), RowHeadersGetObject(), RowHeadersGetObjectId(), RowHeadersGetSwizzled(), RowHeadersIsValid(), RowHeadersOdbcToCollection(), RowHeadersSet(), RowHeadersSetObject(), RowHeadersSetObjectId()


method AddParam(pName As %String, pType As %String, pDescription As %String, pLabel As %String) as %Status

Inherited Members

Inherited Methods


FeedbackOpens in a new tab