Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [MsgRouter] >  [RoutingEngineST]
Private  Storage   

persistent class EnsLib.MsgRouter.RoutingEngineST extends EnsLib.MsgRouter.RoutingEngine

A simple RoutingEngine that populates a SearchTable entry for each message received

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 1


Summary

This is a Business Process class.

RequestResponse
%Library.Persistent %Library.Persistent

Properties
%ConfigName %ConfigQueueName %CurrentResponseHeader
%ErrorStatus %IsCompleted %IsTerminated
%IsTimerInterrupted %LastActionTime %LastHandledTime
%LastReportedError %MasterPendingResponses %MasterPendingResponsesOld
%MessagesReceived %MessagesReceivedOld %MessagesSent
%MessagesSentOld %PrimaryRequestHeader %PrimaryResponseHeader
%QuitTask %RepliedStatus %ResponseList
%SessionId %StatusCode %SuperSession
%TimeCompleted %TimeCreated %TimedOut
%WaitAll %WarnedLatest %isShadow
%request %response %responseClassName
%responseId ActOnTransformError ActOnValidationError
ActionTargets Adapter AlertGroups
AlertOnBadMessage AlertOnError AlertRetryGracePeriod
BadMessageHandler BusinessPartner BusinessRuleName
Document FailureTimeout ForceSyncSend
ForwardGeneratedResponseToTargets InactivityTimeout MsgClass
QueueCountAlert QueueWaitAlert ReplyCodeActions
ResponseFrom ResponseTargetConfigNames ResponseTimeout
Retry RetryInterval RuleActionReason
RuleActionUserData RuleActionUserDataArray RuleLogging
RuleReason RuleUserData SearchTableClass
Source SuspendMessage ThrottleDelay
Validation aRespFrom

Methods
%%CLASSNAMELogicalToStorage %%CLASSNAMEStorageToLogical %AddToSaveSet %AddToSyncSet
%BMEBuilt %BuildIndicesAsync %BuildIndicesAsyncResponse %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnClose
%OnDeleteFinally %OnDetermineClass %OnNew %OnOpenFinally
%OnSaveFinally %Open %OpenId %OriginalNamespace
%PackageName %PhysicalAddress %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %Save
%SaveDirect %SaveIndices %SerializeObject %SetModified
%SortBegin %SortEnd %SuperSessionSet %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject %ValidateTable AdapterName AssignOneSetting
ClearAllPendingResponses DeferResponse EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch GenerateSuperSession GetDeferredResponseToken GetDelegateConnections
GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance IsErrorResponse IsResponsePending
OnComplete OnError OnErroredResponse OnFailureTimeout
OnGenerateSuperSession OnGetConnections OnGetReplyAction OnInit
OnKeepalive OnMonitor OnPrepareReply OnProductionStart
OnProductionStop OnRequest OnResponse OnTearDown
OnTimeout OnValidate QueueName RemovePendingResponse
Reply ReplyError RuleLoggingSet SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync SetTimer
WillHandleErroredResponse doOneAction normalizeValSpec


Parameters

• parameter SETTINGS = "SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.MsgRouter.RoutingEngineST}";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property SearchTableClass as %String(MAXLEN=100);
Store a set of searchable properties associated with each document processed.
These records will be stored in the named SearchTable class, if any.

Methods

• method OnValidate(pDoc As %Persistent, pValSpec As %String, Output pStatus As %Status = $$$OK) as %Boolean
Override this method to implement your own method for validating a Document Return non-zero to prevent default validation of the message (if any); return an error code in pStatus to indicate a validation failure.


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