Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.MsgRouter.VDocRoutingEngine
Private  Storage   

EnsLib.MsgRouter.VDocRoutingEngine


persistent class EnsLib.MsgRouter.VDocRoutingEngine extends
EnsLib.MsgRouter.RoutingEngine

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 6


Summary


This is a Business Process class.

RequestResponse
Ens.VDoc.Interface Ens.VDoc.Interface

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 DocName DocType Document
FailureTimeout ForceSyncSend InactivityTimeout MsgClass
QueueCountAlert QueueWaitAlert ReplyCodeActions ResponseFrom
ResponseTargetConfigNames ResponseTimeout Retry RetryInterval
RuleLogging RuleReason RuleUserData Source
SuspendMessage ThrottleDelay Validation aRespFrom

Methods
%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 %OnDetermineClass %OnNew
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SuperSessionSet %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
AdapterName AssignOneSetting ClearAllPendingResponses DeferResponse
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession
GetDeferredResponseToken GetDelegateConnections GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetRequestClassList GetResponseClassList GetSettings
GetShadowInstance IsErrorResponse IsResponsePending OnComplete
OnConstructReply OnError 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 doOneAction
normalizeValSpec

Subclasses
EnsLib.EDI.X12.MsgRouter.RoutingEngine

Parameters


• parameter SETTINGS = "Validation:Basic";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property DocName as %String(MAXLEN="") [ Transient ];
• property DocType as %String(MAXLEN=128) [ Transient ];
• property Validation as %String(MAXLEN=20) [ InitialExpression = "m",Transient ];
String specifying types of Validation to perform

Set to 1 to block documents that don't pass default validation. Default validation checks for DocType assignment and successful BuildMapStatus.

This is equivalent to 'dm'
'd' - require DocType
'm' - require successful BuildMap status


Methods


• classmethod GetRequestClassList() as %String
• classmethod GetResponseClassList(pRequest As %String = "") as %String
• method OnConstructReply(Output pReplyDoc As Ens.VDoc.Interface, pOriginalDoc As Ens.VDoc.Interface, ByRef pSC As %Status) as %Status
Override this method to construct a customized reply document. Inputs are the original document and the status code that the framework produced in processing the original document. If you change the status code but do not construct a reply document, the framework will use the new value to construct a standard reply document.
• method OnPrepareReply(request As %Persistent, ByRef response As %Persistent)
• method OnRequest(request As %Persistent, Output response As %Persistent) as %Status
Handle a 'Request'
• 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.