| Field | Description |
|---|---|
Form and validation | X12 form and validation (standard X12, HIPAA SNIP Type 1, or HIPAA SNIP Type 2) |
Schema definitions | Manually create or edit the list of schema definitions for the message structures to use. They all need to use the same form (either X12 or HIPAA). |
Character encoding | X12 character encoding, used for both send and receive messages |
Character set | X12 character set allowed in string data (BASIC, EXTENDED, or UNRESTRICTED) |
Substitution character | String substitution character, used to replace invalid characters in string data |
Version identifier suffix | Version identifier code suffix, specifying a value appended to the base schema version in the GS08 Version / Release / Industry Identifier Code field |
| Field | Description |
|---|---|
Enforce length limits | Enforce minimum and maximum lengths for receive values |
Enforce character set | Enforce allowed character set |
Enforce value repeats | Enforce repetition count limits for receive values |
Allow unknown segments | Allow unknown segments in a transaction set |
Enforce segment order | Enforce segment order in a transaction set |
Allow unused segments | Allow segments marked as Unused in a transaction set |
Enforce segment repeats | Enforce segment repetition count limits in a transaction set |
Require unique interchanges | Require unique ISA Interchange Control Numbers (ISA13) |
Require unique groups | Enforce globally unique Group Control Numbers (GS06) for received functional groups |
Require unique transactions | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets |
Store time-to-live | Set the minimum number of days to store interchange, group, and transaction set numbers for checking uniqueness |
Acknowledge every transaction | Include a separate AK2/AK5 (997) or AK2/IK5 (999) acknowledgment for every received transaction set. Instead of using implicit acknowledgments for transaction sets without errors |
Generate 999 acknowledgments | Generate 999 Implementation Acknowledgments, rather than the 997 Functional Acknowledgments default. The support for 999 Implementation Acknowledgments does not include CTX segment generation. |
Report segment details | Report segment error details to sender in the generated 997 or 999 acknowledgments |
Include Acknowledgement schema | Automatically include a standard 997 or 999 schema that matches the generated acknowledgment in the configuration for received messages |
Acknowledgment schema path | Set the path to a Functional Acknowledgment schema to be used for generated acknowledgments such as |
Enforce conditional rules | Enforce conditional rules for receive values |
| Field | Description |
|---|---|
Data element separator | Specify characters when writing messages |
Component element separator | Specify characters when writing messages |
Repetition separator | Specify characters when writing messages |
Segment terminator | Specify characters when writing messages |
Segment line ending | Line ending written between segments, used to make the output more readable |
Unique group numbers | Whether to generate unique GS group control numbers across interchanges |
Unique transaction numbers | Whether to generate unique ST transaction set control numbers across groups and interchanges |
Implementation reference | An implementation convention reference (ST03) value |
Initial interchange number | The starting interchange control number. Only used when no current value is found in the object store |
Initial group number | The starting group control number. Only used when no current value is found in the object store |
Initial transaction number | The starting transaction set control number. Only used when no current value is found in the object store |
Request acknowledgments | Whether to request interchange acknowledgments (ISA14) |
Default usage indicator | The default interchange usage indicator (ISA15). Used when no value is present in the message data |
Use supplied values | Whether to use supplied values for control segment information (control numbers, in particular). The default behavior is always generate control numbers when writing. This allows you to use chosen values |
Output mime type | Whether to use the default output MIME type |
Enforce length limits | Whether to enforce length limits on input data |
Enforce conditional rules | Whether to enforce conditional rules on input data. The default is to ignore conditional rules |
Interchange number key | The key-value pair of the interchange control key and interchange control number |
Group number key | The key-value pair of group control key and group control number |
Transaction number key | The key-value pair of the transaction control key and transaction control number |
| Field | Description |
|---|---|
Form and validation | X12 form and validation (standard X12, HIPAA SNIP Type 1, or HIPAA SNIP Type 2) |
Schema definitions | Manually create or edit the list of schema definitions for the message structures to use. They all need to use the same form (either X12 or HIPAA). |
Character encoding | X12 character encoding, used for both send and receive messages |
Character set | X12 character set allowed in string data (BASIC, EXTENDED, or UNRESTRICTED) |
Substitution character | String substitution character, used to replace invalid characters in string data |
Version identifier suffix | Version identifier code suffix, specifying a value appended to the base schema version in the GS08 Version / Release / Industry Identifier Code field |
| Field | Description |
|---|---|
Enforce length limits | Enforce minimum and maximum lengths for receive values |
Enforce character set | Enforce allowed character set |
Enforce value repeats | Enforce repetition count limits for receive values |
Allow unknown segments | Allow unknown segments in a transaction set |
Enforce segment order | Enforce segment order in a transaction set |
Allow unused segments | Allow segments marked as Unused in a transaction set |
Enforce segment repeats | Enforce segment repetition count limits in a transaction set |
Require unique interchanges | Require unique ISA Interchange Control Numbers (ISA13) |
Require unique groups | Enforce globally unique Group Control Numbers (GS06) for received functional groups |
Require unique transactions | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets |
Store time-to-live | Set the minimum number of days to store interchange, group, and transaction set numbers for checking uniqueness |
Acknowledge every transaction | Include a separate AK2/AK5 (997) or AK2/IK5 (999) acknowledgment for every received transaction set. Instead of using implicit acknowledgments for transaction sets without errors |
Generate 999 acknowledgments | Generate 999 Implementation Acknowledgments, rather than the 997 Functional Acknowledgments default. The support for 999 Implementation Acknowledgments does not include CTX segment generation. |
Report segment details | Report segment error details to sender in the generated 997 or 999 acknowledgments |
Include Acknowledgement schema | Automatically include a standard 997 or 999 schema that matches the generated acknowledgment in the configuration for received messages |
Acknowledgment schema path | Set the path to a Functional Acknowledgment schema to be used for generated acknowledgments such as |
Enforce conditional rules | Enforce conditional rules for receive values |
| Field | Description |
|---|---|
Data element separator | Specify characters when writing messages |
Component element separator | Specify characters when writing messages |
Repetition separator | Specify characters when writing messages |
Segment terminator | Specify characters when writing messages |
Segment line ending | Line ending written between segments, used to make the output more readable |
Unique group numbers | Whether to generate unique GS group control numbers across interchanges |
Unique transaction numbers | Whether to generate unique ST transaction set control numbers across groups and interchanges |
Implementation reference | An implementation convention reference (ST03) value |
Initial interchange number | The starting interchange control number. Only used when no current value is found in the object store |
Initial group number | The starting group control number. Only used when no current value is found in the object store |
Initial transaction number | The starting transaction set control number. Only used when no current value is found in the object store |
Request acknowledgments | Whether to request interchange acknowledgments (ISA14) |
Default usage indicator | The default interchange usage indicator (ISA15). Used when no value is present in the message data |
Use supplied values | Whether to use supplied values for control segment information (control numbers, in particular). The default behavior is always generate control numbers when writing. This allows you to use chosen values |
Output mime type | Whether to use the default output MIME type |
Enforce length limits | Whether to enforce length limits on input data |
Enforce conditional rules | Whether to enforce conditional rules on input data. The default is to ignore conditional rules |
Interchange number key | The key-value pair of the interchange control key and interchange control number |
Group number key | The key-value pair of group control key and group control number |
Transaction number key | The key-value pair of the transaction control key and transaction control number |
| Field | Description |
|---|---|
Form and validation | X12 form and validation (standard X12, HIPAA SNIP Type 1, or HIPAA SNIP Type 2) |
Schema definitions | Manually create or edit the list of schema definitions for the message structures to use. They all need to use the same form (either X12 or HIPAA). |
Character encoding | X12 character encoding, used for both send and receive messages |
Character set | X12 character set allowed in string data (BASIC, EXTENDED, or UNRESTRICTED) |
Substitution character | String substitution character, used to replace invalid characters in string data |
Version identifier suffix | Version identifier code suffix, specifying a value appended to the base schema version in the GS08 Version / Release / Industry Identifier Code field |
| Field | Description |
|---|---|
Enforce length limits | Enforce minimum and maximum lengths for receive values |
Enforce character set | Enforce allowed character set |
Enforce value repeats | Enforce repetition count limits for receive values |
Allow unknown segments | Allow unknown segments in a transaction set |
Enforce segment order | Enforce segment order in a transaction set |
Allow unused segments | Allow segments marked as Unused in a transaction set |
Enforce segment repeats | Enforce segment repetition count limits in a transaction set |
Require unique interchanges | Require unique ISA Interchange Control Numbers (ISA13) |
Require unique groups | Enforce globally unique Group Control Numbers (GS06) for received functional groups |
Require unique transactions | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets |
Store time-to-live | Set the minimum number of days to store interchange, group, and transaction set numbers for checking uniqueness |
Acknowledge every transaction | Include a separate AK2/AK5 (997) or AK2/IK5 (999) acknowledgment for every received transaction set. Instead of using implicit acknowledgments for transaction sets without errors |
Generate 999 acknowledgments | Generate 999 Implementation Acknowledgments, rather than the 997 Functional Acknowledgments default. The support for 999 Implementation Acknowledgments does not include CTX segment generation. |
Report segment details | Report segment error details to sender in the generated 997 or 999 acknowledgments |
Include Acknowledgment schema | Automatically include a standard 997 or 999 schema that matches the generated acknowledgment in the configuration for received messages |
Acknowledgment schema path | Set the path to a Functional Acknowledgment schema to be used for generated acknowledgments such as |
Enforce conditional rules | Enforce conditional rules for receive values |
| Field | Description |
|---|---|
Data element separator | Specify characters when writing messages |
Component element separator | Specify characters when writing messages |
Repetition separator | Specify characters when writing messages |
Segment terminator | Specify characters when writing messages |
Segment line ending | Line ending written between segments, used to make the output more readable |
Unique group numbers | Whether to generate unique GS group control numbers across interchanges |
Unique transaction numbers | Whether to generate unique ST transaction set control numbers across groups and interchanges |
Implementation reference | An implementation convention reference (ST03) value |
Initial interchange number | The starting interchange control number. Only used when no current value is found in the object store |
Initial group number | The starting group control number. Only used when no current value is found in the object store |
Initial transaction number | The starting transaction set control number. Only used when no current value is found in the object store |
Request acknowledgments | Whether to request interchange acknowledgments (ISA14) |
Default usage indicator | The default interchange usage indicator (ISA15). Used when no value is present in the message data |
Use supplied values | Whether to use supplied values for control segment information (control numbers, in particular). The default behavior is to always generate control numbers when writing. This option enables use of selected values. |
Output mime type | Whether to use the default output MIME type |
Enforce length limits | Whether to enforce length limits on input data |
Enforce conditional rules | Whether to enforce conditional rules on input data. The default is to ignore conditional rules |
Interchange number key | The key-value pair of the interchange control key and interchange control number |
Group number key | The key-value pair of group control key and group control number |
Transaction number key | The key-value pair of the transaction control key and transaction control number |
| Field | Description |
|---|---|
Form and validation | X12 form and validation (standard X12, HIPAA SNIP Type 1, or HIPAA SNIP Type 2) |
Schema definitions | Manually create or edit the list of schema definitions for the message structures to use. They all need to use the same form (either X12 or HIPAA). |
Character encoding | X12 character encoding, used for both send and receive messages |
Character set | X12 character set allowed in string data (BASIC, EXTENDED, or UNRESTRICTED) |
Substitution character | String substitution character, used to replace invalid characters in string data |
Version identifier suffix | Version identifier code suffix, specifying a value appended to the base schema version in the GS08 Version / Release / Industry Identifier Code field |
| Field | Description |
|---|---|
Enforce length limits | Enforce minimum and maximum lengths for receive values |
Enforce character set | Enforce allowed character set |
Enforce value repeats | Enforce repetition count limits for receive values |
Allow unknown segments | Allow unknown segments in a transaction set |
Enforce segment order | Enforce segment order in a transaction set |
Allow unused segments | Allow segments marked as Unused in a transaction set |
Enforce segment repeats | Enforce segment repetition count limits in a transaction set |
Require unique interchanges | Require unique ISA Interchange Control Numbers (ISA13) |
Require unique groups | Enforce globally unique Group Control Numbers (GS06) for received functional groups |
Require unique transactions | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets |
Store time-to-live | Set the minimum number of days to store interchange, group, and transaction set numbers for checking uniqueness |
Acknowledge every transaction | Include a separate AK2/AK5 (997) or AK2/IK5 (999) acknowledgment for every received transaction set. Instead of using implicit acknowledgments for transaction sets without errors |
Generate 999 acknowledgments | Generate 999 Implementation Acknowledgments, rather than the 997 Functional Acknowledgments default. The support for 999 Implementation Acknowledgments does not include CTX segment generation. |
Report segment details | Report segment error details to sender in the generated 997 or 999 acknowledgments |
Include Acknowledgment schema | Automatically include a standard 997 or 999 schema that matches the generated acknowledgment in the configuration for received messages |
Acknowledgment schema path | Set the path to a Functional Acknowledgment schema to be used for generated acknowledgments such as |
Enforce conditional rules | Enforce conditional rules for receive values |
| Field | Description |
|---|---|
Data element separator | Specify characters when writing messages |
Component element separator | Specify characters when writing messages |
Repetition separator | Specify characters when writing messages |
Segment terminator | Specify characters when writing messages |
Segment line ending | Line ending written between segments, used to make the output more readable |
Unique group numbers | Whether to generate unique GS group control numbers across interchanges |
Unique transaction numbers | Whether to generate unique ST transaction set control numbers across groups and interchanges |
Implementation reference | An implementation convention reference (ST03) value |
Initial interchange number | The starting interchange control number. Only used when no current value is found in the object store |
Initial group number | The starting group control number. Only used when no current value is found in the object store |
Initial transaction number | The starting transaction set control number. Only used when no current value is found in the object store |
Request acknowledgments | Whether to request interchange acknowledgments (ISA14) |
Default usage indicator | The default interchange usage indicator (ISA15). Used when no value is present in the message data |
Use supplied values | Whether to use supplied values for control segment information (control numbers, in particular). The default behavior is to always generate control numbers when writing. This option enables use of selected values. |
Output mime type | Whether to use the default output MIME type |
Enforce length limits | Whether to enforce length limits on input data |
Enforce conditional rules | Whether to enforce conditional rules on input data. The default is to ignore conditional rules |
Interchange number key | The key-value pair of the interchange control key and interchange control number |
Group number key | The key-value pair of group control key and group control number |
Transaction number key | The key-value pair of the transaction control key and transaction control number |
| Structure Key/Section | Description |
|---|---|
id | Structure identifier |
name | Structure name |
class | A class of structure that is equivalent to an X12 functional group identifier. This is ignored in EDIFACT structure definitions. |
heading | List of segments and groups within the heading section of the structure. |
detail | List of segments and groups within the detail section of the structure. |
summary | List of segments and groups within the heading section of the structure. |
| Segment Property | Description |
|---|---|
idRef | The referenced segment ID. |
position | The segment position within the section. With the EDI convention these are numeric values that can include leading zeros, so these are quoted and handled as strings. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Value | Description |
|---|---|
groupId | The group identifier |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
items | List of segments and potentially nested groups that comprise the group. |
| Section | Description |
|---|---|
id | segment identifier |
name | segment name |
values | list of elements and composites within the segment |
| Section | Description |
|---|---|
idRef | The referenced element or composite ID. |
position | The value position within the segment starts at 1 and increases by 1 for each successive value. Generally not used. |
name | The name of the value in the segment, by default the element or composite name is used. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Name | Description |
|---|---|
id | composite identifier |
name | composite name |
values | list of elements and composites within the composite |
| Name | Description |
|---|---|
idRef | The referenced element or composite ID |
position | The value position within the segment, starts at 1 and increases by 1 for each successive value. Generally not used. |
usage | Usage code definition:
|
| Name | Description |
|---|---|
id | Element identifier |
name | Element name |
type | Value type code (Binary data type is not currently supported):
|
minLength | Minimum number of significant characters in the value. |
maxLength | Maximum number of significant characters in the value. |
| Key | Description |
|---|---|
idRef | The ID for the transaction set being modified. |
name | The transaction set name, if used. |
heading, detail, summary | List of segment and group modifications within each section of the structure. If used, each is only used when there are modifications to that section. |
| Key | Description |
|---|---|
idRef | The referenced segment ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify segments within the section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value, which may be a number or the special value |
| Key | Description |
|---|---|
groupIdRef | The referenced group ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify a group within a section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. The count value and a base definition value is used if a value is not specified. |
items | List of segments and potentially nested loops making up the loop. |
| Key | Description |
|---|---|
idRef | Segment identifier. |
trim | Trim position in segment, if used, all values from this point on are marked as unused. |
values | List of individual value modifications. |
| Key | Description |
|---|---|
position | The value position within the segment. |
name | The name of the value in the segment, if used. The base definition value used if not specified. |
usage | Usage code, |
count | Maximum repetition count value, which may be any number or the special value |
| Key Name | Description |
|---|---|
Delimiters | An optional set of delimiters used in the message. If used in a read operation, the delimiters are based on the most recent interchange processed by a read operation. If used for a write operation, the delimiters override the values in the module configuration. The characters in the string of delimiters are interpreted based on their position in string, in the following order: data separator, subelement separator, repetition separator, and segment terminator, with a value of |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
FunctionalAcksGenerated (read only) | A list of |
Group (write only) | A map of GS group header segment values used as defaults when writing groups |
Interchange (write only) | A map of ISA interchange header segment values used as defaults during an interchange write operation. |
InterchangeAcksGenerated (read only) | A list of TA1 acknowledgments that were generated by the module during the read operation. |
InterchangeAcksReceived (read only) | A list of TA1 acknowledgments that were received by the module during the read operation. |
InterchangeAcksToSend (write only) | A list of TA1 acknowledgments that are sent by the module during the write operation. |
Transactions | A hierarchy of the transaction sets that are either read by the module during a read operation or sent by the module during a write operation. The value of this top-level key is a map with standard versions as keys, in the form of |
| Key | Description |
|---|---|
Detail | A map of segments or loops from the detail section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for segments or loops that occur more than once. |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
Group | A map containing GS group header segment values. For a read message, the map is the actual data from the enclosing group. It is a single map linked from all transaction sets in the group. For a write message, the map value creates the enclosing group. If there are no values for this map, then the default is the value(s) taken from the Group map at the message level. |
Heading | A map of segments or loops from the heading section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for values that occur more than once. |
Id | The Transaction ID must match the key of the containing transaction list. |
Interchange | A map of ISA interchange header segment values. For a read message, the map is the actual data from the enclosing interchange. It is a single map linked from all transaction sets in the interchange. For a write message, the map value creates the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
Name | Transaction set name |
SetHeader | A map of ST transaction set header segment values. This provides the actual header data for a Read operation, and enables you to provide overrides for Write operation configuration settings. |
Summary | A map of segments or loops from the summary section of the transaction set. These values are maps for segments or loops that occur once. The list of maps are for values that are repeated. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For functional acknowledgments generated by receive processing, this map is a copy of the data for the containing interchange with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For TA1 acknowledgments generated by receive processing, this map is a copy of the data for the interchange matching the TA1 with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. It gathers transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) are taken from the Interchange map at the message level. |
| X12 Version | Supported Transaction Sets |
|---|---|
005010X210 | 275 |
005010X212 | 276 277 |
005010X214 | 277 |
005010X215 | 278RQ, 278RS |
005010X216 | 278RQ, 278RS |
005010X217 | 278RQ, 278RS |
005010X218 | 820 |
005010X220A1 | 834 |
005010X221A1 | 835 |
005010X222A1 | 837 |
005010X222A2 | 837 |
005010X223A2 | 837 |
005010X223A3 | 837 |
005010X224A2 | 837 |
005010X224A3 | 837 |
005010X228 | 277 |
005010X231A1 | 999 |
005010X279A1 | 270 271 |
005010X298 | 837 |
005010X299 | 837 |
005010X300 | 837 |
005010X306 | 820 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Expiration Policy | ExpirationPolicy | 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 |
| 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. |
|
Type | Object |
| 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. |
|
Type | Binary |
| 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. |
|
Type | Binary |
| 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. |
| 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. |
| 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. |
| Property | Description | Default Value |
|---|---|---|
| Enables strict validation for the year | false |
| XML Value (default) | Studio Option |
|---|---|
formValidation="X12"/"HIPAA_SNIP1"/"HIPAA_SNIP2" | The schema form and validation level can be either X12 or HIPAA. The default is X12. |
schemas=list of values | List of schema paths the connector can use. These paths can be either a file system or |
characterEncoding="PLATFORM"/"ASCII"/"ISO8859_1"/"IBM1047"/"UTF8" | The character encoding used for both send and receive messages. The default |
stringCharacterSet="BASIC"/"EXTENDED"/"UNRESTRICTED" | Use a substitution character for invalid characters, or reject them as errors if set to |
stringSubstitutionChar="?" | Substitution character used to replace invalid characters in string values. The default is |
versionIdentifierSuffix="XYZ" | Version identifier code suffix for the group (GS). Setting this value affects both Send and Receive message handling. On the Receive side, the GS08 version code must contain X12 schema version (for example, |
lockMechanism="AUTO"/"RUNTIME_LOCK_MANAGER"/"OBJECT_STORE" | Mechanism to use to manage locks for control number sequencing. |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for Mule in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="MULE" | The ID qualifier for Mule runtime engine in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="MULEAPP" | Application code for Mule runtime engine in a group (GS segment). |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="PARTNER" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="PARTNERAPP" | Application Code for a partner in a group (GS segment) |
| XML Value (default) | Studio Option |
|---|---|
enforceLengthLimits="true" | Enforce the minimum and maximum lengths for receive values. |
truncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCharacterSet="true" | Enforce the allowed character set. |
enforceValueRepeats="true" | Enforce the repetition count limits for receive values. |
allowUnknownSegments="false" | Allow unknown segments in a transaction set. |
enforceSegmentOrder="true" | Enforce the segment order in a transaction set. |
allowUnusedSegments="false" | Allow segments marked as |
enforceSegmentRepeats="true" | Enforce segment repetition count limits in a transaction set. |
requireUniqueInterchanges="true" | Require unique ISA Interchange Control Numbers (such as ISA13). The default behavior records the interchange numbers previously processed and rejects duplicate interchange numbers from the same partner. It is derived from the interchange Sender and Receiver identification. Setting to |
requireUniqueGroups="false" | Enforce globally unique Group Control Numbers (GS06) for received functional groups. By default, group numbers need to be unique within an interchange. Setting to |
requireUniqueTransactionSets="false" | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets. By default, transaction set control numbers need to be unique only within a particular functional group. Setting to |
daysToStore="30" | Minimum number of days to store interchange, group, and transaction set numbers for uniqueness checking. |
ackAllSets="false" | Include a separate AK2/AK5 ( |
generate999Acks="false" | Generate |
reportSegmentErrors="true" | Report segment error details to the sender in the |
includeFASchema="true" | Expect |
setAckSchemaByInboundMessage="false" | If the acknowledgmentSchemaPath is |
acknowledgmentSchemaPath="" | Expect the path either from the file system or the |
enforceConditionalRules="false" | Enforce conditional rules for Receive values. |
enforceCodeSetValidationsParse="false" | Enforce code set validations on the Read operation. |
reportWarningMessagesInACK="true" | Report non-fatal errors in acknowledgments. |
includeTrailerSegments="false" | Include 'InterchangeTrailer' and 'GroupTrailer' in each transaction |
includeElementsFromIgnoredSegments="false" | Whether to include data elements from segments with Ignore as the usage type in the output map and metadata. |
| XML Value (default) | Studio Option |
|---|---|
dataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
componentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
repetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
segmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
lineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
writeUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
sendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
sendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
implementationConventionReference="" | Implementation convention reference for transactions (ST segment). Setting this value uses the ST Implementation Convention Reference unless overridden in the message parameters. |
initialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
initialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
initialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
ackRequested="false" | Request acknowledgments for sent transactions flag. If true, |
defaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
useSuppliedValues="false" | Use values from supplied data for control segment identifiers (ISA/IEA, GS/GE, ST/SE segments). |
outputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
writeEnforceLengthLimits="true" | Enforce minimum and maximum lengths for write values. The default of |
writeTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceConditionalRulesOnWriter="false" | Enforce conditional rules for write values. |
interchangeNumberKey="" | Interchange number key name for the object store. |
enforceCodeSetValidationsWrite="false" | Enforce code set validations on the Write operation. |
| XML Value (default) | Studio Option |
|---|---|
batchDataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchComponentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchRepetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchSegmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchLineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
batchUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
batchSendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
batchSendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
batchInitialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
batchInitialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
batchInitialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
batchAckRequested="false" | Request acknowledgments for sent transactions flag. If true, |
batchDefaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
batchOutputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
batchInterchangeNumberKey="" | Interchange number key name for object store. |
batchGroupNumberKey="" | Group number key name for object store. |
batchTransactionNumberKey="" | Transaction number key name for object store. |
batchEnforceLengthLimits="TRUE" | Enforce minimum and maximum lengths for received values. |
batchTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCodeSetValidationsBatch="false" | Enforce code set validations on the Write Batch operation. |
| Structure Key/Section | Description |
|---|---|
id | Structure identifier |
name | Structure name |
class | A class of structure that is equivalent to an X12 functional group identifier. This is ignored in EDIFACT structure definitions. |
heading | List of segments and groups within the heading section of the structure. |
detail | List of segments and groups within the detail section of the structure. |
summary | List of segments and groups within the heading section of the structure. |
| Segment Property | Description |
|---|---|
idRef | The referenced segment ID. |
position | The segment position within the section. With the EDI convention these are numeric values that can include leading zeros, so these are quoted and handled as strings. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Value | Description |
|---|---|
groupId | The group identifier |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
items | List of segments and potentially nested groups that comprise the group. |
| Section | Description |
|---|---|
id | segment identifier |
name | segment name |
values | list of elements and composites within the segment |
| Section | Description |
|---|---|
idRef | The referenced element or composite ID. |
position | The value position within the segment starts at 1 and increases by 1 for each successive value. Generally not used. |
name | The name of the value in the segment, by default the element or composite name is used. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Name | Description |
|---|---|
id | composite identifier |
name | composite name |
values | list of elements and composites within the composite |
| Name | Description |
|---|---|
idRef | The referenced element or composite ID |
position | The value position within the segment, starts at 1 and increases by 1 for each successive value. Generally not used. |
usage | Usage code definition:
|
| Name | Description |
|---|---|
id | Element identifier |
name | Element name |
type | Value type code (Binary data type is not currently supported):
|
minLength | Minimum number of significant characters in the value. |
maxLength | Maximum number of significant characters in the value. |
| Key | Description |
|---|---|
idRef | The ID for the transaction set being modified. |
name | The transaction set name, if used. |
heading, detail, summary | List of segment and group modifications within each section of the structure. If used, each is only used when there are modifications to that section. |
| Key | Description |
|---|---|
idRef | The referenced segment ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify segments within the section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value, which may be a number or the special value |
| Key | Description |
|---|---|
groupIdRef | The referenced group ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify a group within a section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. The count value and a base definition value is used if a value is not specified. |
items | List of segments and potentially nested loops making up the loop. |
| Key | Description |
|---|---|
idRef | Segment identifier. |
trim | Trim position in segment, if used, all values from this point on are marked as unused. |
values | List of individual value modifications. |
| Key | Description |
|---|---|
position | The value position within the segment. |
name | The name of the value in the segment, if used. The base definition value used if not specified. |
usage | Usage code, |
count | Maximum repetition count value, which may be any number or the special value |
| Key Name | Description |
|---|---|
Delimiters | An optional set of delimiters used in the message. If used in a read operation, the delimiters are based on the most recent interchange processed by a read operation. If used for a write operation, the delimiters override the values in the module configuration. The characters in the string of delimiters are interpreted based on their position in string, in the following order: data separator, subelement separator, repetition separator, and segment terminator, with a value of |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
FunctionalAcksGenerated (read only) | A list of |
Group (write only) | A map of GS group header segment values used as defaults when writing groups |
Interchange (write only) | A map of ISA interchange header segment values used as defaults during an interchange write operation. |
InterchangeAcksGenerated (read only) | A list of TA1 acknowledgments that were generated by the module during the read operation. |
InterchangeAcksReceived (read only) | A list of TA1 acknowledgments that were received by the module during the read operation. |
InterchangeAcksToSend (write only) | A list of TA1 acknowledgments that are sent by the module during the write operation. |
Transactions | A hierarchy of the transaction sets that are either read by the module during a read operation or sent by the module during a write operation. The value of this top-level key is a map with standard versions as keys, in the form of |
| Key | Description |
|---|---|
Detail | A map of segments or loops from the detail section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for segments or loops that occur more than once. |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
Group | A map containing GS group header segment values. For a read message, the map is the actual data from the enclosing group. It is a single map linked from all transaction sets in the group. For a write message, the map value creates the enclosing group. If there are no values for this map, then the default is the value(s) taken from the Group map at the message level. |
Heading | A map of segments or loops from the heading section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for values that occur more than once. |
Id | The Transaction ID must match the key of the containing transaction list. |
Interchange | A map of ISA interchange header segment values. For a read message, the map is the actual data from the enclosing interchange. It is a single map linked from all transaction sets in the interchange. For a write message, the map value creates the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
Name | Transaction set name |
SetHeader | A map of ST transaction set header segment values. This provides the actual header data for a Read operation, and enables you to provide overrides for Write operation configuration settings. |
Summary | A map of segments or loops from the summary section of the transaction set. These values are maps for segments or loops that occur once. The list of maps are for values that are repeated. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For functional acknowledgments generated by receive processing, this map is a copy of the data for the containing interchange with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For TA1 acknowledgments generated by receive processing, this map is a copy of the data for the interchange matching the TA1 with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. It gathers transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) are taken from the Interchange map at the message level. |
| X12 Version | Supported Transaction Sets |
|---|---|
005010X210 | 275 |
005010X212 | 276 277 |
005010X214 | 277 |
005010X215 | 278RQ, 278RS |
005010X216 | 278RQ, 278RS |
005010X217 | 278RQ, 278RS |
005010X218 | 820 |
005010X220A1 | 834 |
005010X221A1 | 835 |
005010X222A1 | 837 |
005010X222A2 | 837 |
005010X223A2 | 837 |
005010X223A3 | 837 |
005010X224A2 | 837 |
005010X224A3 | 837 |
005010X228 | 277 |
005010X231A1 | 999 |
005010X279A1 | 270 271 |
005010X298 | 837 |
005010X299 | 837 |
005010X300 | 837 |
005010X306 | 820 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Expiration Policy | ExpirationPolicy | 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 | |
Require unique transactions in group | Boolean | Whether to enforce globally unique transaction set control numbers (ST02) for received transaction sets that are scoped within the functional group:
| true | |
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 |
| 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. |
|
Type | Object |
| 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. |
|
Type | Binary |
| 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. |
|
Type | Binary |
| 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. |
| 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. |
| 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. |
| Property | Description | Default Value |
|---|---|---|
| Enables strict validation for the year | false |
| XML Value (default) | Studio Option |
|---|---|
formValidation="X12"/"HIPAA_SNIP1"/"HIPAA_SNIP2" | The schema form and validation level can be either X12 or HIPAA. The default is X12. |
schemas=list of values | List of schema paths the connector can use. These paths can be either a file system or |
characterEncoding="PLATFORM"/"ASCII"/"ISO8859_1"/"IBM1047"/"UTF8" | The character encoding used for both send and receive messages. The default |
stringCharacterSet="BASIC"/"EXTENDED"/"UNRESTRICTED" | Use a substitution character for invalid characters, or reject them as errors if set to |
stringSubstitutionChar="?" | Substitution character used to replace invalid characters in string values. The default is |
versionIdentifierSuffix="XYZ" | Version identifier code suffix for the group (GS). Setting this value affects both Send and Receive message handling. On the Receive side, the GS08 version code must contain X12 schema version (for example, |
lockMechanism="AUTO"/"RUNTIME_LOCK_MANAGER"/"OBJECT_STORE" | Mechanism to use to manage locks for control number sequencing. |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for Mule in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="MULE" | The ID qualifier for Mule runtime engine in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="MULEAPP" | Application code for Mule runtime engine in a group (GS segment). |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="PARTNER" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="PARTNERAPP" | Application Code for a partner in a group (GS segment) |
| XML Value (default) | Studio Option |
|---|---|
enforceLengthLimits="true" | Enforce the minimum and maximum lengths for receive values. |
truncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCharacterSet="true" | Enforce the allowed character set. |
enforceValueRepeats="true" | Enforce the repetition count limits for receive values. |
allowUnknownSegments="false" | Allow unknown segments in a transaction set. |
enforceSegmentOrder="true" | Enforce the segment order in a transaction set. |
allowUnusedSegments="false" | Allow segments marked as |
enforceSegmentRepeats="true" | Enforce segment repetition count limits in a transaction set. |
requireUniqueInterchanges="true" | Require unique ISA Interchange Control Numbers (such as ISA13). The default behavior records the interchange numbers previously processed and rejects duplicate interchange numbers from the same partner. It is derived from the interchange Sender and Receiver identification. Setting to |
requireUniqueGroups="false" | Enforce globally unique Group Control Numbers (GS06) for received functional groups. By default, group numbers need to be unique within an interchange. Setting to |
requireUniqueTransactionSets="false" | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets. By default, transaction set control numbers need to be unique only within a particular functional group. Setting to |
daysToStore="30" | Minimum number of days to store interchange, group, and transaction set numbers for uniqueness checking. |
ackAllSets="false" | Include a separate AK2/AK5 ( |
generate999Acks="false" | Generate |
reportSegmentErrors="true" | Report segment error details to the sender in the |
includeFASchema="true" | Expect |
setAckSchemaByInboundMessage="false" | If the acknowledgmentSchemaPath is |
acknowledgmentSchemaPath="" | Expect the path either from the file system or the |
enforceConditionalRules="false" | Enforce conditional rules for Receive values. |
enforceCodeSetValidationsParse="false" | Enforce code set validations on the Read operation. |
reportWarningMessagesInACK="true" | Report non-fatal errors in acknowledgments. |
includeTrailerSegments="false" | Include 'InterchangeTrailer' and 'GroupTrailer' in each transaction |
includeElementsFromIgnoredSegments="false" | Whether to include data elements from segments with Ignore as the usage type in the output map and metadata. |
| XML Value (default) | Studio Option |
|---|---|
dataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
componentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
repetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
segmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
lineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
writeUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
sendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
sendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
implementationConventionReference="" | Implementation convention reference for transactions (ST segment). Setting this value uses the ST Implementation Convention Reference unless overridden in the message parameters. |
initialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
initialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
initialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
ackRequested="false" | Request acknowledgments for sent transactions flag. If true, |
defaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
useSuppliedValues="false" | Use values from supplied data for control segment identifiers (ISA/IEA, GS/GE, ST/SE segments). |
outputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
writeEnforceLengthLimits="true" | Enforce minimum and maximum lengths for write values. The default of |
writeTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceConditionalRulesOnWriter="false" | Enforce conditional rules for write values. |
interchangeNumberKey="" | Interchange number key name for the object store. |
enforceCodeSetValidationsWrite="false" | Enforce code set validations on the Write operation. |
| XML Value (default) | Studio Option |
|---|---|
batchDataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchComponentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchRepetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchSegmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchLineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
batchUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
batchSendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
batchSendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
batchInitialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
batchInitialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
batchInitialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
batchAckRequested="false" | Request acknowledgments for sent transactions flag. If true, |
batchDefaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
batchOutputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
batchInterchangeNumberKey="" | Interchange number key name for object store. |
batchGroupNumberKey="" | Group number key name for object store. |
batchTransactionNumberKey="" | Transaction number key name for object store. |
batchEnforceLengthLimits="TRUE" | Enforce minimum and maximum lengths for received values. |
batchTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCodeSetValidationsBatch="false" | Enforce code set validations on the Write Batch operation. |
| Structure Key/Section | Description |
|---|---|
id | Structure identifier |
name | Structure name |
class | A class of structure that is equivalent to an X12 functional group identifier. This is ignored in EDIFACT structure definitions. |
heading | List of segments and groups within the heading section of the structure. |
detail | List of segments and groups within the detail section of the structure. |
summary | List of segments and groups within the heading section of the structure. |
| Segment Property | Description |
|---|---|
idRef | The referenced segment ID. |
position | The segment position within the section. With the EDI convention these are numeric values that can include leading zeros, so these are quoted and handled as strings. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Value | Description |
|---|---|
groupId | The group identifier |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
items | List of segments and potentially nested groups that comprise the group. |
| Section | Description |
|---|---|
id | segment identifier |
name | segment name |
values | list of elements and composites within the segment |
| Section | Description |
|---|---|
idRef | The referenced element or composite ID. |
position | The value position within the segment starts at 1 and increases by 1 for each successive value. Generally not used. |
name | The name of the value in the segment, by default the element or composite name is used. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Name | Description |
|---|---|
id | composite identifier |
name | composite name |
values | list of elements and composites within the composite |
| Name | Description |
|---|---|
idRef | The referenced element or composite ID |
position | The value position within the segment, starts at 1 and increases by 1 for each successive value. Generally not used. |
usage | Usage code definition:
|
| Name | Description |
|---|---|
id | Element identifier |
name | Element name |
type | Value type code (Binary data type is not currently supported):
|
minLength | Minimum number of significant characters in the value. |
maxLength | Maximum number of significant characters in the value. |
| Key | Description |
|---|---|
idRef | The ID for the transaction set being modified. |
name | The transaction set name, if used. |
heading, detail, summary | List of segment and group modifications within each section of the structure. If used, each is only used when there are modifications to that section. |
| Key | Description |
|---|---|
idRef | The referenced segment ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify segments within the section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value, which may be a number or the special value |
| Key | Description |
|---|---|
groupIdRef | The referenced group ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify a group within a section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. The count value and a base definition value is used if a value is not specified. |
items | List of segments and potentially nested loops making up the loop. |
| Key | Description |
|---|---|
idRef | Segment identifier. |
trim | Trim position in segment, if used, all values from this point on are marked as unused. |
values | List of individual value modifications. |
| Key | Description |
|---|---|
position | The value position within the segment. |
name | The name of the value in the segment, if used. The base definition value used if not specified. |
usage | Usage code, |
count | Maximum repetition count value, which may be any number or the special value |
| Key Name | Description |
|---|---|
Delimiters | An optional set of delimiters used in the message. If used in a read operation, the delimiters are based on the most recent interchange processed by a read operation. If used for a write operation, the delimiters override the values in the module configuration. The characters in the string of delimiters are interpreted based on their position in string, in the following order: data separator, subelement separator, repetition separator, and segment terminator, with a value of |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
FunctionalAcksGenerated (read only) | A list of |
Group (write only) | A map of GS group header segment values used as defaults when writing groups |
Interchange (write only) | A map of ISA interchange header segment values used as defaults during an interchange write operation. |
InterchangeAcksGenerated (read only) | A list of TA1 acknowledgments that were generated by the module during the read operation. |
InterchangeAcksReceived (read only) | A list of TA1 acknowledgments that were received by the module during the read operation. |
InterchangeAcksToSend (write only) | A list of TA1 acknowledgments that are sent by the module during the write operation. |
Transactions | A hierarchy of the transaction sets that are either read by the module during a read operation or sent by the module during a write operation. The value of this top-level key is a map with standard versions as keys, in the form of |
| Key | Description |
|---|---|
Detail | A map of segments or loops from the detail section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for segments or loops that occur more than once. |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
Group | A map containing GS group header segment values. For a read message, the map is the actual data from the enclosing group. It is a single map linked from all transaction sets in the group. For a write message, the map value creates the enclosing group. If there are no values for this map, then the default is the value(s) taken from the Group map at the message level. |
Heading | A map of segments or loops from the heading section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for values that occur more than once. |
Id | The Transaction ID must match the key of the containing transaction list. |
Interchange | A map of ISA interchange header segment values. For a read message, the map is the actual data from the enclosing interchange. It is a single map linked from all transaction sets in the interchange. For a write message, the map value creates the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
Name | Transaction set name |
SetHeader | A map of ST transaction set header segment values. This provides the actual header data for a Read operation, and enables you to provide overrides for Write operation configuration settings. |
Summary | A map of segments or loops from the summary section of the transaction set. These values are maps for segments or loops that occur once. The list of maps are for values that are repeated. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For functional acknowledgments generated by receive processing, this map is a copy of the data for the containing interchange with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For TA1 acknowledgments generated by receive processing, this map is a copy of the data for the interchange matching the TA1 with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. It gathers transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) are taken from the Interchange map at the message level. |
| X12 Version | Supported Transaction Sets |
|---|---|
005010X210 | 275 |
005010X212 | 276 277 |
005010X214 | 277 |
005010X215 | 278RQ, 278RS |
005010X216 | 278RQ, 278RS |
005010X217 | 278RQ, 278RS |
005010X218 | 820 |
005010X220A1 | 834 |
005010X221A1 | 835 |
005010X222A1 | 837 |
005010X222A2 | 837 |
005010X223A2 | 837 |
005010X223A3 | 837 |
005010X224A2 | 837 |
005010X224A3 | 837 |
005010X228 | 277 |
005010X231A1 | 999 |
005010X279A1 | 270 271 |
005010X298 | 837 |
005010X299 | 837 |
005010X300 | 837 |
005010X306 | 820 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Expiration Policy | ExpirationPolicy | 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 | |
Require unique transactions in group | Boolean | Whether to enforce globally unique transaction set control numbers (ST02) for received transaction sets that are scoped within the functional group:
| true | |
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 to report segment error details to the sender in 997/999 Functional Acknowledgments:
| 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 acknowledgment schema by inbound message | Boolean | If the acknowledgmentSchemaPath is | false | |
Acknowledgment 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 acknowledgments:
| 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 | |
Interchange control version | String | The interchange control version (ISA12) from the incoming payload will be applied if present; otherwise, the provided value will be used to override the default setting specified in the X12 schema. Allowed values are 5 characters in length. |
| 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. |
|
Type | Object |
| 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. |
|
Type | Binary |
| 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. |
|
Type | Binary |
| 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. |
| 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. |
| 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. |
| Property | Description | Default Value |
|---|---|---|
| Enables strict validation for the year | false |
| XML Value (default) | Studio Option |
|---|---|
formValidation="X12"/"HIPAA_SNIP1"/"HIPAA_SNIP2" | The schema form and validation level can be either X12 or HIPAA. The default is X12. |
schemas=list of values | List of schema paths the connector can use. These paths can be either a file system or |
characterEncoding="PLATFORM"/"ASCII"/"ISO8859_1"/"IBM1047"/"UTF8" | The character encoding used for both send and receive messages. The default |
stringCharacterSet="BASIC"/"EXTENDED"/"UNRESTRICTED" | Use a substitution character for invalid characters, or reject them as errors if set to |
stringSubstitutionChar="?" | Substitution character used to replace invalid characters in string values. The default is |
versionIdentifierSuffix="XYZ" | Version identifier code suffix for the group (GS). Setting this value affects both Send and Receive message handling. On the Receive side, the GS08 version code must contain X12 schema version (for example, |
lockMechanism="AUTO"/"RUNTIME_LOCK_MANAGER"/"OBJECT_STORE" | Mechanism to use to manage locks for control number sequencing. |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for Mule in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="MULE" | The ID qualifier for Mule runtime engine in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="MULEAPP" | Application code for Mule runtime engine in a group (GS segment). |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="PARTNER" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="PARTNERAPP" | Application Code for a partner in a group (GS segment) |
| XML Value (default) | Studio Option |
|---|---|
enforceLengthLimits="true" | Enforce the minimum and maximum lengths for receive values. |
truncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCharacterSet="true" | Enforce the allowed character set. |
enforceValueRepeats="true" | Enforce the repetition count limits for receive values. |
allowUnknownSegments="false" | Allow unknown segments in a transaction set. |
enforceSegmentOrder="true" | Enforce the segment order in a transaction set. |
allowUnusedSegments="false" | Allow segments marked as |
enforceSegmentRepeats="true" | Enforce segment repetition count limits in a transaction set. |
requireUniqueInterchanges="true" | Require unique ISA Interchange Control Numbers (such as ISA13). The default behavior records the interchange numbers previously processed and rejects duplicate interchange numbers from the same partner. It is derived from the interchange Sender and Receiver identification. Setting to |
requireUniqueGroups="false" | Enforce globally unique Group Control Numbers (GS06) for received functional groups. By default, group numbers need to be unique within an interchange. Setting to |
requireUniqueTransactionSets="false" | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets. By default, transaction set control numbers need to be unique only within a particular functional group. Setting to |
daysToStore="30" | Minimum number of days to store interchange, group, and transaction set numbers for uniqueness checking. |
ackAllSets="false" | Include a separate AK2/AK5 ( |
generate999Acks="false" | Generate |
reportSegmentErrors="true" | Report segment error details to the sender in the |
includeFASchema="true" | Expect |
setAckSchemaByInboundMessage="false" | If the acknowledgmentSchemaPath is |
acknowledgmentSchemaPath="" | Expect the path either from the file system or the |
enforceConditionalRules="false" | Enforce conditional rules for Receive values. |
enforceCodeSetValidationsParse="false" | Enforce code set validations on the Read operation. |
reportWarningMessagesInACK="true" | Report non-fatal errors in acknowledgments. |
includeTrailerSegments="false" | Include 'InterchangeTrailer' and 'GroupTrailer' in each transaction |
includeElementsFromIgnoredSegments="false" | Whether to include data elements from segments with Ignore as the usage type in the output map and metadata. |
| XML Value (default) | Studio Option |
|---|---|
dataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
componentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
repetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
segmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
lineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
writeUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
sendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
sendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
implementationConventionReference="" | Implementation convention reference for transactions (ST segment). Setting this value uses the ST Implementation Convention Reference unless overridden in the message parameters. |
initialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
initialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
initialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
ackRequested="false" | Request acknowledgments for sent transactions flag. If true, |
defaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
useSuppliedValues="false" | Use values from supplied data for control segment identifiers (ISA/IEA, GS/GE, ST/SE segments). |
outputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
writeEnforceLengthLimits="true" | Enforce minimum and maximum lengths for write values. The default of |
writeTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceConditionalRulesOnWriter="false" | Enforce conditional rules for write values. |
interchangeNumberKey="" | Interchange number key name for the object store. |
enforceCodeSetValidationsWrite="false" | Enforce code set validations on the Write operation. |
| XML Value (default) | Studio Option |
|---|---|
batchDataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchComponentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchRepetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchSegmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchLineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
batchUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
batchSendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
batchSendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
batchInitialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
batchInitialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
batchInitialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
batchAckRequested="false" | Request acknowledgments for sent transactions flag. If true, |
batchDefaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
batchOutputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
batchInterchangeNumberKey="" | Interchange number key name for object store. |
batchGroupNumberKey="" | Group number key name for object store. |
batchTransactionNumberKey="" | Transaction number key name for object store. |
batchEnforceLengthLimits="TRUE" | Enforce minimum and maximum lengths for received values. |
batchTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCodeSetValidationsBatch="false" | Enforce code set validations on the Write Batch operation. |
| Structure Key/Section | Description |
|---|---|
id | Structure identifier |
name | Structure name |
class | A class of structure that is equivalent to an X12 functional group identifier. This is ignored in EDIFACT structure definitions. |
heading | List of segments and groups within the heading section of the structure. |
detail | List of segments and groups within the detail section of the structure. |
summary | List of segments and groups within the heading section of the structure. |
| Segment Property | Description |
|---|---|
idRef | The referenced segment ID. |
position | The segment position within the section. With the EDI convention these are numeric values that can include leading zeros, so these are quoted and handled as strings. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Value | Description |
|---|---|
groupId | The group identifier |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
items | List of segments and potentially nested groups that comprise the group. |
| Section | Description |
|---|---|
id | segment identifier |
name | segment name |
values | list of elements and composites within the segment |
| Section | Description |
|---|---|
idRef | The referenced element or composite ID. |
position | The value position within the segment starts at 1 and increases by 1 for each successive value. Generally not used. |
name | The name of the value in the segment, by default the element or composite name is used. |
usage | Usage code definition:
|
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. A count value of 1 is used if not specified. |
| Name | Description |
|---|---|
id | composite identifier |
name | composite name |
values | list of elements and composites within the composite |
| Name | Description |
|---|---|
idRef | The referenced element or composite ID |
position | The value position within the segment, starts at 1 and increases by 1 for each successive value. Generally not used. |
usage | Usage code definition:
|
| Name | Description |
|---|---|
id | Element identifier |
name | Element name |
type | Value type code (Binary data type is not currently supported):
|
minLength | Minimum number of significant characters in the value. |
maxLength | Maximum number of significant characters in the value. |
| Key | Description |
|---|---|
idRef | The ID for the transaction set being modified. |
name | The transaction set name, if used. |
heading, detail, summary | List of segment and group modifications within each section of the structure. If used, each is only used when there are modifications to that section. |
| Key | Description |
|---|---|
idRef | The referenced segment ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify segments within the section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value, which may be a number or the special value |
| Key | Description |
|---|---|
groupIdRef | The referenced group ID. Verified if provided, but otherwise ignored. The position value is used to uniquely identify a group within a section. |
position | The segment position within the transaction set section. |
usage | Usage code, |
count | Maximum repetition count value that can be a number or the special value >1 . This means any number of repeats. The count value and a base definition value is used if a value is not specified. |
items | List of segments and potentially nested loops making up the loop. |
| Key | Description |
|---|---|
idRef | Segment identifier. |
trim | Trim position in segment, if used, all values from this point on are marked as unused. |
values | List of individual value modifications. |
| Key | Description |
|---|---|
position | The value position within the segment. |
name | The name of the value in the segment, if used. The base definition value used if not specified. |
usage | Usage code, |
count | Maximum repetition count value, which may be any number or the special value |
| Key Name | Description |
|---|---|
Delimiters | An optional set of delimiters used in the message. If used in a read operation, the delimiters are based on the most recent interchange processed by a read operation. If used for a write operation, the delimiters override the values in the module configuration. The characters in the string of delimiters are interpreted based on their position in string, in the following order: data separator, subelement separator, repetition separator, and segment terminator, with a value of |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
FunctionalAcksGenerated (read only) | A list of |
Group (write only) | A map of GS group header segment values used as defaults when writing groups |
Interchange (write only) | A map of ISA interchange header segment values used as defaults during an interchange write operation. |
InterchangeAcksGenerated (read only) | A list of TA1 acknowledgments that were generated by the module during the read operation. |
InterchangeAcksReceived (read only) | A list of TA1 acknowledgments that were received by the module during the read operation. |
InterchangeAcksToSend (write only) | A list of TA1 acknowledgments that are sent by the module during the write operation. |
Transactions | A hierarchy of the transaction sets that are either read by the module during a read operation or sent by the module during a write operation. The value of this top-level key is a map with standard versions as keys, in the form of |
| Key | Description |
|---|---|
Detail | A map of segments or loops from the detail section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for segments or loops that occur more than once. |
Errors (read only) | A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
Group | A map containing GS group header segment values. For a read message, the map is the actual data from the enclosing group. It is a single map linked from all transaction sets in the group. For a write message, the map value creates the enclosing group. If there are no values for this map, then the default is the value(s) taken from the Group map at the message level. |
Heading | A map of segments or loops from the heading section of the transaction set. Values are maps for segments or loops that occur once. Lists of maps exist for values that occur more than once. |
Id | The Transaction ID must match the key of the containing transaction list. |
Interchange | A map of ISA interchange header segment values. For a read message, the map is the actual data from the enclosing interchange. It is a single map linked from all transaction sets in the interchange. For a write message, the map value creates the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
Name | Transaction set name |
SetHeader | A map of ST transaction set header segment values. This provides the actual header data for a Read operation, and enables you to provide overrides for Write operation configuration settings. |
Summary | A map of segments or loops from the summary section of the transaction set. These values are maps for segments or loops that occur once. The list of maps are for values that are repeated. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For functional acknowledgments generated by receive processing, this map is a copy of the data for the containing interchange with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. For example, gathering transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) taken from the Interchange map at the message level. |
| Key name | Description |
|---|---|
Interchange | A map of ISA interchange header segment values. For TA1 acknowledgments generated by receive processing, this map is a copy of the data for the interchange matching the TA1 with sender and receiver identification components (ISA05/ISA06 and ISA07/ISA08) interchanged. When writing a message, these values are used for creating the enclosing interchange. It gathers transactions with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value(s) are taken from the Interchange map at the message level. |
| HIPAA Version | Supported Transaction Sets |
|---|---|
005010X210 | 275 |
005010X212 | 276, 277 |
005010X214 | 277 |
005010X215 | 278RQ, 278RS |
005010X216 | 278RQ, 278RS |
005010X217 | 278RQ, 278RS |
005010X218 | 820 |
005010X220A1 | 834 |
005010X221A1 | 835 |
005010X222A1 | 837 |
005010X222A2 | 837 |
005010X223A2 | 837 |
005010X223A3 | 837 |
005010X224A2 | 837 |
005010X224A3 | 837 |
005010X228 | 277 |
005010X231A1 | 999 |
005010X279A1 | 270, 271 |
005010X298 | 837 |
005010X299 | 837 |
005010X300 | 837 |
005010X306 | 820 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Expiration Policy | ExpirationPolicy | 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 | |
Require unique transactions in group | Boolean | Whether to enforce globally unique transaction set control numbers (ST02) for received transaction sets that are scoped within the functional group:
| true | |
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 to report segment error details to the sender in 997/999 Functional Acknowledgments:
| 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 acknowledgment schema by inbound message | Boolean | If the acknowledgmentSchemaPath is | false | |
Acknowledgment 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 acknowledgments:
| 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 | |
Interchange control version | String | The interchange control version (ISA12) from the incoming payload will be applied if present; otherwise, the provided value will be used to override the default setting specified in the X12 schema. Allowed values are 5 characters in length. |
| 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. |
|
Type | Object |
| 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. |
|
Type | Binary |
| 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. |
|
Type | Binary |
| 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. |
| 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. |
| 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. |
| Property | Description | Default Value |
|---|---|---|
| Enables strict validation for the year | false |
| XML Value (default) | Studio Option |
|---|---|
formValidation="X12"/"HIPAA_SNIP1"/"HIPAA_SNIP2" | The schema form and validation level can be either X12 or HIPAA. The default is X12. |
schemas=list of values | List of schema paths the connector can use. These paths can be either a file system or |
characterEncoding="PLATFORM"/"ASCII"/"ISO8859_1"/"IBM1047"/"UTF8" | The character encoding used for both send and receive messages. The default |
stringCharacterSet="BASIC"/"EXTENDED"/"UNRESTRICTED" | Use a substitution character for invalid characters, or reject them as errors if set to |
stringSubstitutionChar="?" | Substitution character used to replace invalid characters in string values. The default is |
versionIdentifierSuffix="XYZ" | Version identifier code suffix for the group (GS). Setting this value affects both Send and Receive message handling. On the Receive side, the GS08 version code must contain X12 schema version (for example, |
lockMechanism="AUTO"/"RUNTIME_LOCK_MANAGER"/"OBJECT_STORE" | Mechanism to use to manage locks for control number sequencing. |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for Mule in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="MULE" | The ID for Mule runtime engine in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="MULEAPP" | Application code for Mule runtime engine in a group (GS segment). |
| XML Value (default) | Studio Option |
|---|---|
interchangeIdQualifierSelf="ZZ" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
interchangeIdSelf="PARTNER" | The ID qualifier for a partner in Exchange (known as the ISA segment). Use this value in combination with the |
groupIdSelf="PARTNERAPP" | Application Code for a partner in a group (GS segment) |
| XML Value (default) | Studio Option |
|---|---|
enforceLengthLimits="true" | Enforce the minimum and maximum lengths for receive values. |
truncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCharacterSet="true" | Enforce the allowed character set. |
enforceValueRepeats="true" | Enforce the repetition count limits for receive values. |
allowUnknownSegments="false" | Allow unknown segments in a transaction set. |
enforceSegmentOrder="true" | Enforce the segment order in a transaction set. |
allowUnusedSegments="false" | Allow segments marked as |
enforceSegmentRepeats="true" | Enforce segment repetition count limits in a transaction set. |
requireUniqueInterchanges="true" | Require unique ISA Interchange Control Numbers (such as ISA13). The default behavior records the interchange numbers previously processed and rejects duplicate interchange numbers from the same partner. It is derived from the interchange Sender and Receiver identification. Setting to |
requireUniqueGroups="false" | Enforce globally unique Group Control Numbers (GS06) for received functional groups. By default, group numbers need to be unique within an interchange. Setting to |
requireUniqueTransactionSets="false" | Enforce globally unique Transaction Set Control Numbers (ST02) for received transaction sets. By default, transaction set control numbers need to be unique only within a particular functional group. Setting to |
daysToStore="30" | Minimum number of days to store interchange, group, and transaction set numbers for uniqueness checking. |
ackAllSets="false" | Include a separate AK2/AK5 ( |
generate999Acks="false" | Generate |
reportSegmentErrors="true" | Report segment error details to the sender in the |
includeFASchema="true" | Expect |
setAckSchemaByInboundMessage="false" | If the acknowledgmentSchemaPath is |
acknowledgmentSchemaPath="" | Expect the path either from the file system or the |
enforceConditionalRules="false" | Enforce conditional rules for Receive values. |
enforceCodeSetValidationsParse="false" | Enforce code set validations on the Read operation. |
reportWarningMessagesInACK="true" | Report non-fatal errors in acknowledgments. |
includeTrailerSegments="false" | Include 'InterchangeTrailer' and 'GroupTrailer' in each transaction |
includeElementsFromIgnoredSegments="false" | Whether to include data elements from segments with Ignore as the usage type in the output map and metadata. |
| XML Value (default) | Studio Option |
|---|---|
dataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
componentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
repetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
segmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
lineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
writeUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
sendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
sendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
implementationConventionReference="" | Implementation convention reference for transactions (ST segment). Setting this value uses the ST Implementation Convention Reference unless overridden in the message parameters. |
initialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
initialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
initialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
ackRequested="false" | Request acknowledgments for sent transactions flag. If true, |
defaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
useSuppliedValues="false" | Use values from supplied data for control segment identifiers (ISA/IEA, GS/GE, ST/SE segments). |
outputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
writeEnforceLengthLimits="true" | Enforce minimum and maximum lengths for write values. The default of |
writeTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceConditionalRulesOnWriter="false" | Enforce conditional rules for write values. |
interchangeNumberKey="" | Interchange number key name for the object store. |
enforceCodeSetValidationsWrite="false" | Enforce code set validations on the Write operation. |
| XML Value (default) | Studio Option |
|---|---|
batchDataSeparator="*" | Data element separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchComponentSeparator=">" | Component separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchRepetitionSeparator="U" | Repetition separator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchSegmentTerminator="~" | Segment terminator character. The default uses the configured value for all output messages and can be overridden at the message level. |
batchLineEnding="NONE"/"LF"/"CRLF"/"CR" | Line ending to add between segments. The default is |
batchUseCRLFLastLine="false" | Use configured 'Segment Line Ending' at the end of the last line. |
batchSendUniqueGroupNumbers="false" | Send unique Group Control Numbers. |
batchSendUniqueTransactionNumbers="false" | Send unique Transaction Set Control Numbers. |
batchInitialInterchangeNumber="1" | The initial Interchange Control Number used for outgoing messages. |
batchInitialGroupNumber="1" | The initial Group Control Number used for outgoing messages. |
batchInitialSetNumber="1" | The initial Transaction Set Control Number used for outgoing messages. |
batchAckRequested="false" | Request acknowledgments for sent transactions flag. If true, |
batchDefaultUsageIndicator="P" | Default ISA15 interchange usage indicator: |
batchOutputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIX12" | Output MIME type to be set for the message, either the default |
batchInterchangeNumberKey="" | Interchange number key name for object store. |
batchGroupNumberKey="" | Group number key name for object store. |
batchTransactionNumberKey="" | Transaction number key name for object store. |
batchEnforceLengthLimits="TRUE" | Enforce minimum and maximum lengths for received values. |
batchTruncateExceedingMaxLength="false" | Truncate to the maximum lengths for received values. |
enforceCodeSetValidationsBatch="false" | Enforce code set validations on the Write Batch operation. |