Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [MessageHeaderBase]
Private  Storage   

abstract class Ens.MessageHeaderBase extends Ens.Util.BitmapPurge

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 22


Summary

Properties
BusinessProcessId CorrespondingMessageId Description ErrorStatus
Invocation IsError MessageBodyClassName MessageBodyId
Priority Resent ReturnQueueName SessionId
SourceBusinessType SourceConfigName Status SuperSession
TargetBusinessType TargetConfigName TargetQueueName TimeCreated
TimeProcessed Type

Methods
PurgeBitmaps

Subclasses
Ens.Enterprise.MsgBank.MessageHeader Ens.MessageHeader

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 CorrespondingMessageId as %Integer;
Id of the corresponding request or response
• property Description as %String(MAXLEN="");
Description of the message
• property ErrorStatus as %Status [ InitialExpression = $$$OK ];
Error status if IsError is set to true
• property Invocation as Ens.DataType.MessageInvocation [ InitialExpression = $$$eMessageInvocationQueue ];
Invocation type of the message - Queue or InProc
• property IsError as %Boolean [ InitialExpression = 0 ];
Does ErrorStatus contain an error status?
• property MessageBodyClassName as %String(MAXLEN=220);
The ClassName of the message body
• property MessageBodyId as %String(COLLATION="EXACT",MAXLEN="");
Id of the message body
• property Priority as Ens.DataType.MessagePriority;
Priority of the message
• property Resent as %String(VALUELIST=",,r,b");
Message original, resent, or MsgBank resent
• property ReturnQueueName as %String(MAXLEN=128);
Queue name where responses to this message should be sent
• property SessionId as %Integer;
Id of the original request that launched the current session. Used for tracing messages
• property SourceBusinessType as Ens.DataType.MessageBusinessType [ InitialExpression = 0 ];
The business type of the source
• property SourceConfigName as %String(MAXLEN=128);
Config name of the business host that created this message or that this message is responding to
• property Status as Ens.DataType.MessageStatus [ InitialExpression = $$$eMessageStatusCreated ];
Integer code denoting the current status of processing of this message
• property SuperSession as %String(MAXLEN=300);
Identifier of a multi-server session that this message's session is part of
• property TargetBusinessType as Ens.DataType.MessageBusinessType [ InitialExpression = 0 ];
The business type of the target
• property TargetConfigName as %String(MAXLEN=128);
Config name of the business host this message is sent to
• property TargetQueueName as %String(MAXLEN=128);
Queue name to which this message should be sent
• property TimeCreated as Ens.DataType.UTC;
Time the message was created
• property TimeProcessed as Ens.DataType.UTC;
Last time the message status changed
• property Type as Ens.DataType.MessageType;
Specifies if it is request or response


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.