EnsLib.EDI.X12.Operation.ReplyStandard
abstract class EnsLib.EDI.X12.Operation.ReplyStandard extends EnsLib.EDI.X12.Operation.Standard, EnsLib.EDI.ServiceInterface
Property Inventory
Method Inventory
- GetSegmentTerminator()
- IOLogDiscard()
- OnGetReplyAction()
- OnInit()
- OnMessage()
- OnReplyDocument()
- SendMessage()
- buildReplyActionMap()
Parameters
Properties
A comma-separated list of codes specifying what action this Operation will take on receipt of various types of acknowledgement messages and other reply status conditions.
The format of the list is:
<code>=<action>,<code>=<action>,...
A <code> value starting with a colon - e.g. :<char> represents a literal value found in field TA1:4,AK5:1,or AK9:1 of the response message.
The expected values in these fields include:
- :A - Accepted
- :E - Accepted, but Errors Were Noted
- :P - Partially Accepted
- :R - Rejected
- :M - Rejected; Message Authentication Code (MAC) Failed
- :W - Rejected; Failed Validity Tests
- :X - Rejected; Content Decryption Failed
- :~ - matches replies that do not contain a TA1, AK5 or AK9 segment
- :_ - matches replies with an empty value in the field
- :* - matches any value not matched otherwise
- :E? - matches any literal value except :A
- :R? - matches any literal value except :A, :E or :P
- :I? - matches where the reply ControlId does not match the ControlId of the original message
The default behavior is ':A=C,:E=WC,:P=WC,:*=S,:~=S,:I?=W'
This means for responses with TA1 code E or P issue a warning, while all other codes except A suspend the current outbound
message and move on to the next.
Also, the following standard status conditions may be used:
- E - Error status returned from message handler
- E#<statuscode> - Error status returned from message handler has status code equal to <statuscode>
- E*<text> - Error status returned from message handler contains text string <text>
- X - there is no reply message at all
The following values for <actions> may be used alone or in combinations:
- C - Treat the message as Completed OK.
- W - Log a warning. If no other non-warning <actions> are triggered, the message will be treated as Completed OK.
- R - Retry the message according to the configured RetryInterval and FailureTimeout; finally Fail unless a different action is also specified. Note this setting is separate from the Retry property.
- S - Suspend the message, log an error, and move on to try the next message.
- D - Disable the Operation, log an error and restore the message to the front of the Operation's queue.
- F - Fail with an error and move on to try the next message from the Operation's queue subject to the Retry property value set in the code. If the Retry property is set in the code then moving on to try the next message will be subject to the configured RetryInterval and FailureTimeout. The X12 TCP outbound adapter sets the operation's Retry property to true when there are network connection errors.
All codes where <actions> consists of only 'W' (for 'log a Warning') will be evaluated, and a warning will be generated for each matching <code>. Other <code> values will be evaluated in left-to-right order, executing the first matching <code> that has a non-warning <actions> value. As noted in the details for the 'W' flag, an error that only triggers 'W' <actions> will be treated as Completed OK.
Methods
Inherited Members
Inherited Properties
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %WarnedLatest
- %isShadow
- %outFraming
- Adapter
- AlertGroups
- AlertOnError
- AlertRetryGracePeriod
- ArchiveIO
- BusinessPartner
- DefCharEncoding
- DeferResponse
- FailureTimeout
- Framing
- IOLogEntry
- InactivityTimeout
- NoFailWhileDisconnected
- QueueCountAlert
- QueueWaitAlert
- Retry
- RetryCount
- RetryInterval
- SearchTableClass
- SendSuperSession
- Separators
- SuspendMessage
- ThrottleDelay
- Validation
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnClose()
- %OnNew()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %SuperSessionSet()
- %ValidateObject()
- AdapterName()
- AssignOneSetting()
- CloseIOLogEntry()
- DeferResponse()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GenerateSuperSession()
- GetDeferredResponseToken()
- GetMessageList()
- GetMsgHdrRequestKey()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- IncludeSuperSession()
- NewIOLogEntry()
- OnDocumentEnd()
- OnDocumentStart()
- OnError()
- OnFailureTimeout()
- OnGenerateSuperSession()
- OnGetConnections()
- OnKeepalive()
- OnMonitor()
- OnParsingError()
- OnPostDocument()
- OnPreDocument()
- OnProductionStart()
- OnProductionStop()
- OnTearDown()
- OnValidate()
- OutputFramedToDevice()
- OutputFramedToIOStream()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()
- SetOutFraming()
- resolveDocType()
- validateAndIndex()