This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Ens.MessageHeaderBase

abstract class Ens.MessageHeaderBase extends Ens.Util.BitmapPurge

Property Inventory

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter XMLIGNORENULL = 1;
Ensure that we don't get $C(0) for values that are empty strings

Properties

property BusinessProcessId as %Integer;
Id of the business process that sent this message or that
Property methods: BusinessProcessIdDisplayToLogical(), BusinessProcessIdGet(), BusinessProcessIdIsValid(), BusinessProcessIdLogicalToDisplay(), BusinessProcessIdNormalize(), BusinessProcessIdSet()
property CorrespondingMessageId as %Integer;
Id of the corresponding request or response
Property methods: CorrespondingMessageIdDisplayToLogical(), CorrespondingMessageIdGet(), CorrespondingMessageIdIsValid(), CorrespondingMessageIdLogicalToDisplay(), CorrespondingMessageIdNormalize(), CorrespondingMessageIdSet()
property Description as %String);
Description of the message
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property ErrorStatus as %Status [ InitialExpression = $$$OK ];
Error status if IsError is set to true
Property methods: ErrorStatusGet(), ErrorStatusIsValid(), ErrorStatusLogicalToOdbc(), ErrorStatusSet()
property Invocation as Ens.DataType.MessageInvocation [ InitialExpression = $$$eMessageInvocationQueue ];
Invocation type of the message - Queue or InProc
Property methods: InvocationDisplayToLogical(), InvocationGet(), InvocationIsValid(), InvocationLogicalToDisplay(), InvocationNormalize(), InvocationSet()
property IsError as %Boolean [ InitialExpression = 0 ];
Does ErrorStatus contain an error status?
Property methods: IsErrorDisplayToLogical(), IsErrorGet(), IsErrorIsValid(), IsErrorLogicalToDisplay(), IsErrorNormalize(), IsErrorSet()
property MessageBodyClassName as %String (MAXLEN = 220);
The ClassName of the message body
Property methods: MessageBodyClassNameDisplayToLogical(), MessageBodyClassNameGet(), MessageBodyClassNameIsValid(), MessageBodyClassNameLogicalToDisplay(), MessageBodyClassNameLogicalToOdbc(), MessageBodyClassNameNormalize(), MessageBodyClassNameSet()
property MessageBodyId as %String (COLLATION = "EXACT");
Id of the message body
Property methods: MessageBodyIdDisplayToLogical(), MessageBodyIdGet(), MessageBodyIdIsValid(), MessageBodyIdLogicalToDisplay(), MessageBodyIdLogicalToOdbc(), MessageBodyIdNormalize(), MessageBodyIdSet()
property Priority as Ens.DataType.MessagePriority;
Priority of the message
Property methods: PriorityDisplayToLogical(), PriorityGet(), PriorityIsValid(), PriorityLogicalToDisplay(), PriorityNormalize(), PrioritySet()
property Resent as %String (VALUELIST = ",,r,b");
Message original, resent, or MsgBank resent
Property methods: ResentDisplayToLogical(), ResentGet(), ResentIsValid(), ResentLogicalToDisplay(), ResentLogicalToOdbc(), ResentNormalize(), ResentSet()
property ReturnQueueName as %String (MAXLEN = 128);
Queue name where responses to this message should be sent
Property methods: ReturnQueueNameDisplayToLogical(), ReturnQueueNameGet(), ReturnQueueNameIsValid(), ReturnQueueNameLogicalToDisplay(), ReturnQueueNameLogicalToOdbc(), ReturnQueueNameNormalize(), ReturnQueueNameSet()
property SessionId as %Integer;
Id of the original request that launched the current session. Used for tracing messages
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet()
property SourceBusinessType as Ens.DataType.MessageBusinessType [ InitialExpression = 0 ];
The business type of the source
Property methods: SourceBusinessTypeDisplayToLogical(), SourceBusinessTypeGet(), SourceBusinessTypeIsValid(), SourceBusinessTypeLogicalToDisplay(), SourceBusinessTypeNormalize(), SourceBusinessTypeSet()
property SourceConfigName as %String (MAXLEN = 128);
Config name of the business host that created this message or that this message is responding to
Property methods: SourceConfigNameDisplayToLogical(), SourceConfigNameGet(), SourceConfigNameIsValid(), SourceConfigNameLogicalToDisplay(), SourceConfigNameLogicalToOdbc(), SourceConfigNameNormalize(), SourceConfigNameSet()
property Status as Ens.DataType.MessageStatus [ InitialExpression = $$$eMessageStatusCreated ];
Integer code denoting the current status of processing of this message
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet()
property SuperSession as %String (MAXLEN = 300);
Identifier of a multi-server session that this message's session is part of
Property methods: SuperSessionDisplayToLogical(), SuperSessionGet(), SuperSessionIsValid(), SuperSessionLogicalToDisplay(), SuperSessionLogicalToOdbc(), SuperSessionNormalize(), SuperSessionSet()
property TargetBusinessType as Ens.DataType.MessageBusinessType [ InitialExpression = 0 ];
The business type of the target
Property methods: TargetBusinessTypeDisplayToLogical(), TargetBusinessTypeGet(), TargetBusinessTypeIsValid(), TargetBusinessTypeLogicalToDisplay(), TargetBusinessTypeNormalize(), TargetBusinessTypeSet()
property TargetConfigName as %String (MAXLEN = 128);
Config name of the business host this message is sent to
Property methods: TargetConfigNameDisplayToLogical(), TargetConfigNameGet(), TargetConfigNameIsValid(), TargetConfigNameLogicalToDisplay(), TargetConfigNameLogicalToOdbc(), TargetConfigNameNormalize(), TargetConfigNameSet()
property TargetQueueName as %String (MAXLEN = 128);
Queue name to which this message should be sent
Property methods: TargetQueueNameDisplayToLogical(), TargetQueueNameGet(), TargetQueueNameIsValid(), TargetQueueNameLogicalToDisplay(), TargetQueueNameLogicalToOdbc(), TargetQueueNameNormalize(), TargetQueueNameSet()
property TimeCreated as Ens.DataType.UTC;
Time the message was created
Property methods: TimeCreatedDisplayToLogical(), TimeCreatedGet(), TimeCreatedIsValid(), TimeCreatedLogicalToDisplay(), TimeCreatedLogicalToOdbc(), TimeCreatedNormalize(), TimeCreatedOdbcToLogical(), TimeCreatedSet(), TimeCreatedStorageToLogical(), TimeCreatedtimeCmp(), TimeCreatedtimeDiff(), TimeCreatedtimeLocal(), TimeCreatedtimeLocaltoUTC(), TimeCreatedtimeUTC(), TimeCreatedtimeUTCH(), TimeCreatedtimeUTCHtoUTC(), TimeCreatedtimeUTCtoLocal(), TimeCreatedtimeUTCtoUTCH()
property TimeProcessed as Ens.DataType.UTC;
Last time the message status changed
Property methods: TimeProcessedDisplayToLogical(), TimeProcessedGet(), TimeProcessedIsValid(), TimeProcessedLogicalToDisplay(), TimeProcessedLogicalToOdbc(), TimeProcessedNormalize(), TimeProcessedOdbcToLogical(), TimeProcessedSet(), TimeProcessedStorageToLogical(), TimeProcessedtimeCmp(), TimeProcessedtimeDiff(), TimeProcessedtimeLocal(), TimeProcessedtimeLocaltoUTC(), TimeProcessedtimeUTC(), TimeProcessedtimeUTCH(), TimeProcessedtimeUTCHtoUTC(), TimeProcessedtimeUTCtoLocal(), TimeProcessedtimeUTCtoUTCH()
property Type as Ens.DataType.MessageType;
Specifies if it is request or response
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeNormalize(), TypeSet()

Inherited Members

Inherited Methods

Subclasses

Feedback