ExpirationPolicy
X12 EDI Connector 2.17 Reference - Mule 4
Default Configuration
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate. |
|||
Mule ID qualifier |
String |
ID qualifier for Mule in the exchange (ISA) segment. This value is used in combination with the Self Identification Interchange ID value, and if one is set, the other must also be set.
|
||
Mule interchange ID |
String |
ID for Mule in the exchange (ISA) segment. This value is used in combination with the Self Identification Interchange ID qualifier value, and if one is set the other must also be set.
|
||
Mule application code |
String |
Application Code for Mule in the group (GS segment).
|
||
Partner ID qualifier |
String |
ID qualifier for the partner in the exchange (ISA segment). This value is used in combination with the Partner Identification Interchange ID value, and if one is set the other must also be set.
|
||
Partner interchange ID |
String |
ID for the partner in the exchange (ISA segment). This value is used in combination with the Partner Identification Interchange ID qualifier value, and if one is set the other must also be set.
|
||
Partner application code |
String |
Application Code for the partner in the group (GS segment).
|
||
Form and validation |
Enumeration, one of:
|
Schema form and validation level. Schemas used in the configuration must match the selected form. SNIP Type 1 and SNIP Type 2 validation applies to HIPAA schemas only. |
X12 |
|
Schema definitions |
Array of String |
List of paths for the schemas that the connector uses. The paths can be file systems or classpaths. |
x |
|
Character encoding |
Enumeration, one of:
|
Character encoding for messages. This character encoding is always used for both send and receive messages. |
PLATFORM |
|
Character set |
Enumeration, one of:
|
Characters allowed in string data. Invalid characters are replaced by the substitution character, if specified, or rejected as errors if no substitution character is set or enabled for receive messages in parser options. Either way, the invalid characters are logged. For receive messages, the invalid characters are reported in 997 functional acknowledgments. |
UNRESTRICTED |
|
Substitution character |
String |
Substitution character used to replace invalid characters in string values. |
||
Version identifier suffix |
String |
Version identifier code suffix for the group (GS segment).
|
||
Timezone offset |
String |
Timezone offset from the UTC to apply to the date and time elements in the Interchange Header (ISA) segment. This field accepts only values compliant with ISO 8601, which are UTC-based; for example, |
||
Enforce length limits |
Boolean |
Whether to enforce minimum and maximum lengths for parser and writer values:
In either case the error is logged and reported in 997/999 acknowledgments.
|
true |
|
Enforce character set |
Boolean |
Whether to enforce the allowed character sets:
In either case, the error is reported in 997/999 acknowledgments. |
true |
|
Enforce value repeats |
Boolean |
Whether to enforce repetition count limits for receive values:
In either case the error is reported in 997/999 acknowledgments. |
true |
|
Allows unknown segments |
Boolean |
Whether to allow unknown segments in a transaction set:
In either case, the error is reported in 997/999 acknowledgments. |
false |
|
Enforce segment order |
Boolean |
Whether to enforce the segment order in a transaction set:
In either case the error is reported in 997/999 acknowledgments. |
true |
|
Allow unused segments |
Boolean |
Whether to allow segments marked as
In either case, the error is reported in 997/999 acknowledgments. |
false |
|
Enforce segment repeats |
Boolean |
Whether to enforce segment repetition count limits in transaction sets.
In either case the error is reported in 997/999 acknowledgments. |
true |
|
Require unique interchanges |
Boolean |
Whether to require unique Interchange Control Numbers (ISA13) for received interchanges:
|
true |
|
Require unique groups |
Boolean |
Whether to enforce globally unique Group Control Numbers (GS06) for received functional groups:
|
false |
|
Require unique transactions |
Boolean |
Whether to enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets:
|
false |
|
Store time-to-live |
Number |
Minimum number of days to store interchange, group, and transaction set numbers for checking uniqueness. This value is used only when the configuration requires unique interchange, group, or transaction set numbers.
|
30 |
|
Acknowledge every transaction |
Boolean |
Whether to include a separate AK2/AK5 (997) or AK2/IK5 (999) acknowledgment for every received transaction set:
|
false |
|
Generate 999 acknowledgments |
Boolean |
Whether to generate 999 Implementation Acknowledgments rather than 997 Functional Acknowledgments:
|
false |
|
Report segment details |
Boolean |
Whether Report segment error details to the sender in 997/999 Functional Acknowledgements:
|
true |
|
Include Acknowledgment schema |
Boolean |
Whether to expect 997 or 999 Functional Acknowledgments and to include the 997 or 999 schema:
|
true |
|
Data element separator |
String |
Data element separator character. The configured value is used by default for all output messages, but can be overridden at the message level. |
* |
|
Component element separator |
String |
Component element separator character. The configured value is used by default for all output messages, but can be overridden at the message level. |
> |
|
Repetition separator |
String |
Repetition separator character (if used). The configured value is used by default for all output messages, but can be overridden at the message level. The value |
U |
|
Segment terminator |
String |
Segment terminator character. The configured value is used by default for all output messages, but can be overridden at the message level. |
~ |
|
Segment line ending |
Enumeration, one of:
|
Line ending to add between segments to improve the readability of the output message text. |
NONE |
|
Unique group numbers |
Boolean |
Whether to send globally unique Group Control Numbers (GS06):
|
false |
|
Unique transaction numbers |
Boolean |
Whether to send globally unique Transaction Set Control Numbers (ST02):
|
false |
|
Implementation reference |
String |
Implementation convention reference for transactions (ST03). If this value is set, it is used as the ST03 Implementation Convention Reference unless it is overridden in the message parameters. |
||
Initial interchange number |
Number |
Initial Interchange Control Number used for outgoing messages. |
1 |
|
Initial group number |
Number |
Initial Group Control Number used for outgoing messages. |
1 |
|
Initial transaction number |
Number |
Initial Transaction Set Control Number used for outgoing messages. |
1 |
|
Requests acknowledgments |
Boolean |
Whether to request acknowledgments such as TA1 for the sent transactions flag (ISA14):
|
false |
|
Default usage indicator |
String |
Default interchange usage indicator (ISA15):
|
P |
|
Set acknowledgement schema by inbound message |
Boolean |
If the acknowledgmentSchemaPath is |
false |
|
Acknowledgement schema path |
String |
The path from the file system or the |
||
Enforce conditional rules |
Boolean |
Whether to apply conditional rules in transactions:
|
false |
|
Truncate values exceeding the length limits |
Boolean |
Whether to truncate values that exceed the length limits when the Enforce length limits field is
|
false |
|
Enforce code set validations |
Boolean |
Whether to enforce code set validations:
|
false |
|
Use segment line ending in last line |
Boolean |
Whether to use the configured line ending in the last line of the IEA segment:
|
false |
|
Report non-fatal errors in acknowledgments |
Boolean |
Whether to report non-fatal errors in acknowledgements:
|
true |
|
Include trailer segment details |
Boolean |
Whether to include interchange and group trailer details in the map:
|
false |
|
Lock Mechanism |
Enumeration, one of:
|
Determines the mechanism used to manage locks for control number sequencing:
|
AUTO |
|
Include ignored segments |
Boolean |
Whether to include data elements from segments with
|
false |
Read
<x12:read>
Transforms an input stream of EDI text into the maps and lists structure of the EDI data.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Read Content |
Binary |
Input payload. |
|
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
Write
<x12:write>
Transforms the maps and lists structure of EDI data into an EDI text stream.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Write Content |
Object |
Output payload. |
|
|
Streaming Strategy |
Enumeration, one of:
|
Configures how Mule processes streams. |
Repeatable file store stream |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
Write batch
<x12:write-batch>
Merges individual X12 messages created and accumulated over a period of time into a single interchange (UNB).
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Write Content |
Object |
Output payload. |
|
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
Expiration Policy Type
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit that qualifies the Max Idle Time field. |
Repeatable In Memory Stream Type
Configures the in-memory streaming strategy by which the request fails if the data exceeds the Max Buffer Size field value. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields. |
Repeatable File Store Stream Type
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
Maximum memory size. If more memory is consumed, then the connector buffers the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Max In Memory Size field. |
System Properties
You can configure the following system property for the connector:
Property | Description | Default Value |
---|---|---|
|
Enables strict validation for the year |
false |
For more information about system properties, refer to System Properties.