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

persistent class EnsLib.EDI.X12.MsgRouter.RoutingEngine extends EnsLib.EDI.MsgRouter.SegmentedRoutingEngine

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1


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 ForwardGeneratedResponseToTargets
InactivityTimeout MsgClass QueueCountAlert
QueueWaitAlert ReplyCodeActions ResponseFrom
ResponseTargetConfigNames ResponseTimeout Retry
RetryInterval RuleActionReason RuleActionUserData
RuleActionUserDataArray RuleLogging RuleReason
RuleUserData Segment 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
GetRequestClassList GetResponseClassList GetSettings GetShadowInstance
IsErrorResponse IsResponsePending OnComplete OnConstructReply
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


Properties

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

Set to 1 to block documents that don't pass default validation. Default validation requires a DocType and blocks messages with any other error encountered while mapping the document's sequence of segments using the X12 schema structure specified by the document's DocType. This is equivalent to 'dm'.

All flags relating to fields/components apply only if 's'/'c' also specified (eg. if set to 'dmslt' then the length and datatype of fields will be checked, but the length and datatype of components will not be)

'd' - require DocType
'm' - don't tolerate BuildMap segment mapping errors
's' - enforce segment structures (number and repetition of fields)
'c' - enforce composite structures (number of components)
'r' - enforce required fields/components being present
'u' - enforce non-use of fields/components marked 'Not Used' - Note this is not available when using a new-style only schema
'l' - enforce field/component length restrictions
't' - enforce correct datatypes used for field/component values
'v' - enforce correct code table values used where specified in the schema - Note this is not available when using a new-style only schema
'x' - enforce X12 relational conditions where specified in the schema - Note this is not available when using a new-style only schema
'n' - perform all validation available to new style schemas. This is equivalent to 'dmscrlt'
'a' - perform all available validation. This is equivalent to 'dmscrultv'
'e' - continue validating after errors are encountered - specify this to scan the entire document and report all errors


Methods

• method OnValidate(pDoc As EnsLib.EDI.X12.Document, 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; 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.