Skip to main content

HS.Message.Analytics.QueryRequest

persistent class HS.Message.Analytics.QueryRequest extends HS.Util.EnsRequest, HS.Types.RequestInfo, HS.Types.AsyncMessage, HS.Types.Analytics.QueryInstance

SQL Table Name: HS_Message_Analytics.QueryRequest

Analytics query request

Property Inventory

Method Inventory

Properties

property Evaluator as HS.Types.Grid.Evaluator;
List of expressions to evaluate
Property methods: EvaluatorGet(), EvaluatorGetObject(), EvaluatorGetObjectId(), EvaluatorGetStored(), EvaluatorGetSwizzled(), EvaluatorIsEmpty(), EvaluatorIsValid(), EvaluatorNewObject(), EvaluatorSet(), EvaluatorSetObject(), EvaluatorSetObjectId(), EvaluatorUnSwizzle()
property ExecutionStatus as %String (DISPLAYLIST = ",Executing,Inconsistent", VALUELIST = ",E,I");
Execution status for analytics. Used to flag running queries as inconsistent when a transmit starts.
null
The query is not executing
Executing
The query is executing (fetching rows from the database)
Inconsistent
Analytics transmit started before the query could finish executing
Property methods: ExecutionStatusDisplayToLogical(), ExecutionStatusGet(), ExecutionStatusGetStored(), ExecutionStatusIndexExists(), ExecutionStatusIsValid(), ExecutionStatusLogicalToDisplay(), ExecutionStatusLogicalToOdbc(), ExecutionStatusNormalize(), ExecutionStatusSet()
property ResponseFormat as %String (VALUELIST = ",All,Filtered,EvaluateOnly");
Specifies the amount of data to return.
All (or null)
Return column definitions and all rows of the query result
Filtered
Return column definitions and only rows of the query result that pass at least one expression
Evaluate only
Query result not returned, only the evaluator calculations
Property methods: ResponseFormatDisplayToLogical(), ResponseFormatGet(), ResponseFormatGetStored(), ResponseFormatIsValid(), ResponseFormatLogicalToDisplay(), ResponseFormatLogicalToOdbc(), ResponseFormatNormalize(), ResponseFormatSet()

Methods

classmethod FlagInconsistent() as %Status
Mark all executing queries as inconsistent
classmethod GetExecutingCount() as %Integer
Return the number of executing queries
classmethod ResetInconsistent() as %Status
Clear inconsistence flags

Indexes

index (ExecutionStatusIndex on ExecutionStatus);
Index methods: ExecutionStatusIndexExists()
index (TrackingIDIndex on TrackingID);
Index methods: TrackingIDIndexExists()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (HS.Util.EnsRequest)

^Ens.MessageBodyD(ID,"EnsRequest")
=
HSCoreVersion
HSMinVersion
%ClearFields

Storage Model: Storage (HS.Message.Analytics.QueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.Analytics.QueryRequest.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.Analytics.QueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.Analytics.QueryRequest.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.Analytics.QueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.Analytics.QueryRequest.Parameters",n)
=
Parameters(n)

Storage Model: Storage (HS.Message.Analytics.QueryRequest)

^Ens.MessageBodyD(ID,"QueryRequest")
=
Evaluator
HSAAID
AuthBy
AuthType
BTGReason
RequestingUser
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
SAMLData
BreakTheGlass
ClinicalTypes
Consent
Context
MPIID
Name
RequestingConfigName
RequestingSessionId
ResponseFormat
TrackingID
ExecutionStatus
FeedbackOpens in a new tab