Ens.Enterprise.MsgBank.MessageHeader
persistent class Ens.Enterprise.MsgBank.MessageHeader extends %Library.Persistent, Ens.MessageHeaderBase, %XML.Adaptor, %Library.IndexBuilder
SQL Table Name: Ens_Enterprise_MsgBank.MessageHeader
Subclass of Ens.MessageHeader that lives only on the Message Bank Server, incorporating the original header from the client plus a record of the client node it came fromProperty Inventory
- ClientBodyClassName
- ClientBodyId
- ClientCorrespondingMessageId
- ClientId
- ClientSessionId
- ID
- NodeId
- TimeBanked
Method Inventory
- ClientCorrespondingMessageIdGet()
- ClientIdGet()
- ClientSessionIdGet()
- NodeIdGet()
- Purge()
- PurgeSetTemp()
- ResendDuplicatedMessage()
Parameters
parameter EXTENTSIZE = 20000000;
Inherited description: The EXTENTSIZE parameter is used to inform the SQL Query Optimizer
of the approximate number of instances in the extent containing instances of this class.
For example, a class that expects to have about 1,000,000 instances should define:
parameter EXTENTSIZE = 1000000;
parameter INDEXBUILDERFILTER = NodeIdTime,NodeId,NTrg,NSrc;
parameter XMLTYPE = MsgBankHeader;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property ClientBodyClassName as %String (MAXLEN = 128, XMLPROJECTION = "NONE");
Property methods: ClientBodyClassNameDisplayToLogical(), ClientBodyClassNameGet(), ClientBodyClassNameGetStored(), ClientBodyClassNameIsValid(), ClientBodyClassNameLogicalToDisplay(), ClientBodyClassNameLogicalToOdbc(), ClientBodyClassNameNormalize(), ClientBodyClassNameSet()
property ClientBodyId as %String (COLLATION = "EXACT");
Property methods: ClientBodyIdDisplayToLogical(), ClientBodyIdGet(), ClientBodyIdGetStored(), ClientBodyIdIsValid(), ClientBodyIdLogicalToDisplay(), ClientBodyIdLogicalToOdbc(), ClientBodyIdNormalize(), ClientBodyIdSet()
property ClientCorrespondingMessageId as %Integer (MINVAL = 1, XMLPROJECTION = "NONE") [ Calculated , Transient , ReadOnly ];
Property methods: ClientCorrespondingMessageIdCompute(), ClientCorrespondingMessageIdDisplayToLogical(), ClientCorrespondingMessageIdIsValid(), ClientCorrespondingMessageIdLogicalToDisplay(), ClientCorrespondingMessageIdNormalize(), ClientCorrespondingMessageIdSQLCompute(), ClientCorrespondingMessageIdXSDToLogical()
property ClientId as %Integer (MINVAL = 1, XMLPROJECTION = "NONE") [ Calculated , ReadOnly ];
Property methods: ClientIdCompute(), ClientIdDisplayToLogical(), ClientIdIsValid(), ClientIdLogicalToDisplay(), ClientIdNormalize(), ClientIdSQLCompute(), ClientIdXSDToLogical()
property ClientSessionId as %Integer (MINVAL = 1, XMLPROJECTION = "NONE") [ Calculated , Transient , ReadOnly ];
Property methods: ClientSessionIdCompute(), ClientSessionIdDisplayToLogical(), ClientSessionIdIsValid(), ClientSessionIdLogicalToDisplay(), ClientSessionIdNormalize(), ClientSessionIdSQLCompute(), ClientSessionIdXSDToLogical()
property ID as %Integer (MINVAL = 1, XMLPROJECTION = "NONE") [ Required ];
Property methods: IDDisplayToLogical(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDSet(), IDXSDToLogical()
property NodeId as %Integer (MAXVAL = 999, MINVAL = 100, XMLPROJECTION = "NONE") [ Calculated , ReadOnly ];
Message Bank Client
Property methods: NodeIdCompute(), NodeIdDisplayToLogical(), NodeIdIsValid(), NodeIdLogicalToDisplay(), NodeIdNormalize(), NodeIdSQLCompute(), NodeIdXSDToLogical()
property TimeBanked as Ens.DataType.UTC (XMLPROJECTION = "NONE") [ InitialExpression = $ZDT($ZTS,3,,3) ];
Property methods: TimeBankedDisplayToLogical(), TimeBankedGet(), TimeBankedGetStored(), TimeBankedIsValid(), TimeBankedLogicalToDisplay(), TimeBankedLogicalToOdbc(), TimeBankedNormalize(), TimeBankedOdbcToLogical(), TimeBankedSet(), TimeBankedStorageToLogical(), TimeBankedtimeCmp(), TimeBankedtimeDiff(), TimeBankedtimeLocal(), TimeBankedtimeLocaltoUTC(), TimeBankedtimeUTC(), TimeBankedtimeUTCH(), TimeBankedtimeUTCHtoUTC(), TimeBankedtimeUTCtoLocal(), TimeBankedtimeUTCtoUTCH()
Methods
method ClientCorrespondingMessageIdGet() as %Integer
method ClientIdGet() as %Integer
method ClientSessionIdGet() as %Integer
method NodeIdGet() as %Integer
classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pKeepIntegrity As %Boolean = 1, pBodiesToo As %Boolean = 1, pBitmapPurgeRunLimit As %Integer = 600) as %Status
classmethod PurgeSetTemp(pType As %Integer, pMsg As %String, pSC As %Status, pSC2 As %Status) as %Status
Deprecated. No longer used by InterSystems Code.
Replaced by ReportPurgeError in Ens.MessageHeader
Log a warning in the Event Log; add to tSC status; set error/warning in a temp global as below:
Total error count is in subscript 0.
Errors while deleting message headers are in subscript 1.
Errors while deleting message bodies are in subscript 2.
Errors while deleting search table entries are in subscript 3.
Total error count is in subscript 0.
Errors while deleting message headers are in subscript 1.
Errors while deleting message bodies are in subscript 2.
Errors while deleting search table entries are in subscript 3.
classmethod ResendDuplicatedMessage(ByRef pWSClientObjs, pBankHeaderId As %String, Output pNewHeaderId As %String, pNewTarget As %String = "", pNewBody As %RegisteredObject = $$$NULLOREF, pNewSource As %String = "", pHeadOfQueue As %Boolean = 0, pUseOriginalClientBody As %Boolean = 0) as %Status
Called from MsgBank server side only. Invoke a SOAP call to resend a message on the chosen MsgBank client node / SOAP Resend service provider.
There must exist a MonitorClient configured that matches the WebAddress of the chosen NodeId
Indexes
index (Extent on ) [Extent, Type = bitmap];
Index methods: ExtentClose(), ExtentExecute(), ExtentFetch(), ExtentFetchRows(), ExtentFunc(), ExtentGetInfo(), ExtentGetODBCInfo(), ExtentPrepare(), ExtentSendODBC()
index (ID on ID) [IdKey, Type = key];
Index methods: IDCheck(), IDDelete(), IDDisplayToLogical(), IDExists(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint(), IDSet(), IDXSDToLogical()
index (MessageBodyClassName on MessageBodyClassName) [Type = bitmap];
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
Index methods: MessageBodyClassNameDisplayToLogical(), MessageBodyClassNameGet(), MessageBodyClassNameGetStored(), MessageBodyClassNameIsValid(), MessageBodyClassNameLogicalToDisplay(), MessageBodyClassNameLogicalToOdbc(), MessageBodyClassNameNormalize(), MessageBodyClassNameSet()
index (MessageBodyId on MessageBodyId);
Index methods: MessageBodyIdDisplayToLogical(), MessageBodyIdExists(), MessageBodyIdGet(), MessageBodyIdGetStored(), MessageBodyIdIsValid(), MessageBodyIdLogicalToDisplay(), MessageBodyIdLogicalToOdbc(), MessageBodyIdNormalize(), MessageBodyIdSet()
index (MessageBodyNode on MessageBodyId,MessageBodyClassName,NodeId);
Used in SearchTable queries.
A tuple of these three columns uniquely identifies a message body.
Index methods: MessageBodyNodeExists()
index (NSrc on NodeId,SourceConfigName) [Type = bitmap];
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
index (NTrg on NodeId,TargetConfigName) [Type = bitmap];
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
index (NodeClientId on NodeId,ClientId);
Index methods: NodeClientIdExists()
index (NodeId on NodeId) [Type = bitmap];
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
Index methods: NodeIdCompute(), NodeIdDisplayToLogical(), NodeIdGet(), NodeIdIsValid(), NodeIdLogicalToDisplay(), NodeIdNormalize(), NodeIdSQLCompute(), NodeIdTimeExists(), NodeIdXSDToLogical()
index (NodeIdTime on NodeId,TimeCreated);
Index methods: NodeIdTimeExists()
index (NodeSourceTime on NodeId,SourceConfigName,TimeCreated);
Used in multi-node searching.
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
Index methods: NodeSourceTimeExists()
index (NodeTargetTime on NodeId,TargetConfigName,TimeCreated);
Used in multi-node searching.
This index is being used by Ens.Enterprise.Portal.MsgFilter.Assistant
Index methods: NodeTargetTimeExists()
index (SessionId on SessionId);
Index methods: SessionIdDisplayToLogical(), SessionIdExists(), SessionIdGet(), SessionIdGetStored(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet(), SessionIdXSDToLogical()
index (SourceConfigName on SourceConfigName) [Type = bitmap];
Index methods: SourceConfigNameDisplayToLogical(), SourceConfigNameGet(), SourceConfigNameGetStored(), SourceConfigNameIsValid(), SourceConfigNameLogicalToDisplay(), SourceConfigNameLogicalToOdbc(), SourceConfigNameNormalize(), SourceConfigNameSet()
index (SrcN on SourceConfigName,NodeId) [Type = bitmap];
Used to find DISTINCT NodeId for the SourceConfigName during query pre-processing.
index (Status on Status) [Type = bitmap];
Index methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet(), StatusXSDToLogical()
index (TargetConfigName on TargetConfigName) [Type = bitmap];
Index methods: TargetConfigNameDisplayToLogical(), TargetConfigNameGet(), TargetConfigNameGetStored(), TargetConfigNameIsValid(), TargetConfigNameLogicalToDisplay(), TargetConfigNameLogicalToOdbc(), TargetConfigNameNormalize(), TargetConfigNameSet()
index (TimeBanked on TimeBanked);
Index methods: TimeBankedDisplayToLogical(), TimeBankedExists(), TimeBankedGet(), TimeBankedGetStored(), TimeBankedIsValid(), TimeBankedLogicalToDisplay(), TimeBankedLogicalToOdbc(), TimeBankedNormalize(), TimeBankedOdbcToLogical(), TimeBankedSet(), TimeBankedStorageToLogical(), TimeBankedtimeCmp(), TimeBankedtimeDiff(), TimeBankedtimeLocal(), TimeBankedtimeLocaltoUTC(), TimeBankedtimeUTC(), TimeBankedtimeUTCH(), TimeBankedtimeUTCHtoUTC(), TimeBankedtimeUTCtoLocal(), TimeBankedtimeUTCtoUTCH()
index (TimeCreated on TimeCreated);
Index methods: TimeCreatedDisplayToLogical(), TimeCreatedExists(), TimeCreatedGet(), TimeCreatedGetStored(), TimeCreatedIsValid(), TimeCreatedLogicalToDisplay(), TimeCreatedLogicalToOdbc(), TimeCreatedNormalize(), TimeCreatedOdbcToLogical(), TimeCreatedSet(), TimeCreatedStorageToLogical(), TimeCreatedtimeCmp(), TimeCreatedtimeDiff(), TimeCreatedtimeLocal(), TimeCreatedtimeLocaltoUTC(), TimeCreatedtimeUTC(), TimeCreatedtimeUTCH(), TimeCreatedtimeUTCHtoUTC(), TimeCreatedtimeUTCtoLocal(), TimeCreatedtimeUTCtoUTCH()
index (TrgN on TargetConfigName,NodeId) [Type = bitmap];
Used to find DISTINCT NodeId for the TargetConfigName during query pre-processing.
Triggers
trigger OnDelete (BEFORE event DELETE);
Inherited Members
Inherited Properties
- BusinessProcessId
- CorrespondingMessageId
- Description
- ErrorStatus
- Invocation
- IsError
- MessageBodyClassName
- MessageBodyId
- Priority
- Resent
- ReturnQueueName
- SessionId
- SourceBusinessType
- SourceConfigName
- Status
- SuperSession
- TargetBusinessType
- TargetConfigName
- TargetQueueName
- TimeCreated
- TimeProcessed
- Type
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %ConstructIndicesParallel()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- PurgeBitmaps()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (Ens.Enterprise.MsgBank.MessageHeader)
^Ens.EntMsgBank.MessageHeaderD(ID) |
= | %%CLASSNAME
Type
Priority
Invocation
TimeCreated
TimeProcessed
Status
IsError
ErrorStatus
CorrespondingMessageId
SessionId
SourceConfigName
TargetConfigName
ClientBodyClassName
ClientBodyId
BusinessProcessId
TargetQueueName
ReturnQueueName
MessageBodyClassName
MessageBodyId
Description
SourceBusinessType
TargetBusinessType
TimeBanked
SuperSession
Resent
|