Ensemble X12 Development Guide
Settings for X12 Business Operations
Provides reference information for settings of an X12 business operation.
X12 business operations have the following settings:
The remaining settings are either common to all business operations or are determined by the type of adapter. For information, see:
only) If True, when writing a document that has a batch parent, output the batch header segments first, then child documents, then follow up with the batch trailer segments when triggered by the final batch header document object or by a file name change. If False, omit headers and trailers and output child documents only. The default for X12 is True.
The number of seconds during which to continue retry attempts. After this number of seconds has elapsed, the business operation gives up and returns an error code. X12 business operations automatically set this value to 1 for never time out
to ensure that no X12 document is skipped.
only) Output file name. This setting can include Ensemble time stamp specifiers. If you leave File Name
blank, the default value is %f_%Q
is the name of the data source, in this case the input filename
is the literal underscore character, which will appear in the output filename
indicates ODBC format date and time
In substituting a value for the format code %f
, Ensemble strips out any of the characters |,?,\,/,:,[,],<,>,&,,,;,NUL,BEL,TAB,CR,LF, replacing spaces with underscores (_), slashes (/) with hyphens (-), and colons (:) with dots (.).
No Fail While Disconnected
only) When the adapter setting Get Reply
is True, this setting allows you to supply a comma-separated list of code-action pairs, specifying which action the business operation will take on receipt of various types of acknowledgment documents. The format of the list is:
represents a literal value found in field TA1:4, AK5:1, or AK9:1 of the acknowledgment document. The following table lists the expected values for code
||Accepted, But Errors Were Noted
||Rejected; Message Authentication Code (MAC) Failed
|| Rejected; Failed Validity Tests
||Rejected; Content Decryption Failed
||The tilde character matches replies that do not contain a TA1, AK5 or AK9 segment
||The underscore character matches replies with an empty value in the field. An empty or whitespace code value is the same as _
||The asterisk character matches any value not matched otherwise (default=S)
||Matches the case in which the reply ControlId does not match the ControlId of the original document
The following values for action
may be used alone or combined to form strings. S is the default action
if no other is given, except for A whose default action is C:
||Treat the document as Completed OK. Code A has a default action of C.
||Log a warning but treat the document as Completed OK.
||Retry the document according to the configured RetryInterval and FailureTimeout; finally Fail unless a different action is also specified
||Suspend the document, log an error, and move on to try the next document. S is the default action for all codes except for code A, which has a default action of C.
||Disable the business operation, log an error and restore the outbound document to the front of the business operation’s queue
||Fail with an error and move on to try the next document
The default value for this setting string is:
When the action is accepted, treat the document as Completed OK.
When the reply ControlId does not match the ControlId of the original document, log a warning but treat the document as Completed OK.
In all other cases, including when replies that do not contain a TA1, AK5 or AK9 segment, suspend the document, log an error, and move on to try the next document.
A string of separator characters which Ensemble assigns to X12 separators in left to right order as described below.
If the Separators
string is empty, the default is to use the current default separators and segment terminators for X12, plus a carriage return (ASCII 13) and line feed (ASCII 10).
An X12 document uses special characters to organize its raw contents. These characters may vary from one clinical application to another. For non-empty values of Separators
, positions 1 through 3 (left to right) are interpreted as follows:
Data Element Separator (ES)
Data Element Repeat Separator (RS)
The default values for positions 1 through 3 are:
, you must supply a string of three characters which Ensemble assigns to X12 separators in left to right order: ES, CS, RS, as described in the previous list.
Any characters in positions 4 through 6 override the default segment terminator character, which is ~
(tilde). You may specify from 0 to 3 characters in positions 4 through 6 using the following:
for the carriage return (ASCII 13)
for the line feed (ASCII 10)
for the array record separator (ASCII 30)
You can use \x
in positions 1 through 3 if you need to specify segment terminators in positions 4 and higher but want your output documents to use fewer than 3 separators. Separators designated by \x
in positions 1 through 3 are not used. The purpose of \x
is simply to extend the length of the list of separators so that position 4 is interpreted correctly as the first segment terminator.
Any non-empty string triggers basic validation of the outgoing document. If the Validation
field is left empty, no validation of the outgoing document is performed.