X12 Connector - CData Arc Documentation

X12 connectors support generating X12 files from XML and converting X12 files into XML.

Key Capabilities

Complete bidirectional EDI X12 to XML document processing with all transaction sets
Interchange and functional group header validation and generation
Support for 997/999 functional acknowledgments with automatic routing
Advanced features like SNIP validation for HIPAA compliance

Overview

When receiving X12 documents, X12 connectors validate X12 interchange headers and convert the X12 document into XML. This is useful as a staging step, because XML is the primary format that uses to manipulate data in a flow. The X12 connector automatically reads the input file to determine the appropriate X12 schema, then parses the document according to this schema. When generating X12 documents, X12 connectors convert XML into X12 document syntax and apply the appropriate X12 interchange headers. This is useful as the final step for creating an X12 document, after the XML data has been fetched and transformed elsewhere in the flow.

Interchange header validation can be avoided by selecting Test Data in the Usage Indicator connector setting.

An X12 connector can also automatically generate acknowledgments for incoming X12 documents. For more information, see Acknowledgments.

Prerequisites

Before you begin, make sure you have the correct schema installed for the document type you need to process. The X12 connector natively supports the following schema definitions: 00401, 00403 and 00501. You can find them in the app_data/x12_schemas directory of your installation. If you need different schemas, you can download the additional schema files from the website for free. After you download and extract the zip archive, place the entire folder into an appropriately named subdirectory of the app_data/x12_schemas directory.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Translation Configuration

Settings related to the core operation of the connector.

Setting	Description
Connector Id	The static, unique identifier for the connector.
Connector Type	Displays the connector name and a description of what it does.
Connector Description	An optional field to provide a free-form description of the connector and its role in the flow.
Translation Type	Whether the connector is converting an X12 document into XML, or XML data into an X12 document.
Dynamically process partners	When enabled, the connector automatically identifies and tracks trading partner relationships from EDI transactions. When disabled, you must manually define the partner relationship. See EDI Partners Tab for more information.

EDI Partner

Setting	Description
Partner Identifier (ISA06)	Identifies the sending party in the X12 communication (when generating an X12 document, this should be your identifier). Only applicable when Dynamically process partners is unchecked.
Personal Identifier (ISA08)	Identifies the receiving party in the X12 communication (when generating an X12 document, this should be your partner’s identifier). Only applicable when Dynamically process partners is unchecked.

Interchange Settings

Settings related to the interchange headers of X12 documents. When generating documents, these settings are applied as interchange headers in the resulting document. When parsing documents, the interchange settings are used to validate the incoming document.

Setting	Description
Partner Id Qualifier (ISA05)	Qualifies the Partner Identifier by providing context to the value.
Personal Id Qualifier (ISA07)	Qualifies the Personal Identifier by providing context to the value.
Control Version Number (ISA12)	Identifies the control version for the interchange.
Usage Indicator (ISA15)	Whether the data exchanged represents test data, production data, or general information. When this is set to Test Data, interchange headers are not validated.
Functional Group	Check this to automatically add the sender and receiver identifiers to the Functional Group Settings on the Advanced tab.

Acknowledgments

Settings related to generating and requesting acknowledgments.

Setting	Description
TA1 Acknowledgment	Whether to send TA1 interchange acknowledgments.
Functional ACK	Whether a functional ACK should be returned (when receiving) and requested (when sending). A functional acknowledgment serves as an indication of acceptance or rejection of the received interchange and transaction set.
Functional ACK Type	Check this to specify whether to use a 997 or 999 functional acknowledgment.

Sample Files Tab

Advanced Tab

EDI Delimiters

Settings that specify which characters separate elements, segments, and so on.

Setting	Description
Data Element Separator	The character that separates individual data elements in the document.
Component Element Separator	The character that separates elements within a composite data structure in the document.
Segment Terminator	The character that indicates the end of a segment in the document.
Suffix	Appended to the Segment Terminator to distinguish segments.

Interchange Settings

Additional settings related to the X12 interchange headers.

Setting	Description
Authorization Qualifier (ISA01)	Qualifies the Authorization Id setting by providing context for the value.
Authorization Id (ISA02)	Identifies the authorization level associated with the interchange.
Security Qualifier (ISA03)	Qualifies the Security Password setting by providing context for the value.
Security Password (ISA04)	Represents security information about the interchange.
Control Standards Identifier (ISA11)	Identifies the X12 standard. The only valid value is U.

Functional Group Settings

Settings related to the functional group headers of X12 documents. These optional identifiers can help group similar interchanges or facilitate sub-addressing in an organization.

Setting	Description
Partner Identifier (GS02)	Identifies the sending party in the X12 communication.
Personal Identifier (GS03)	Identifies the receiving party in the X12 communication.
Date Format (GS04)	How the datestamp should be formatted.
Time Format (GS05)	How the timestamp should be formatted.
Responsible Agency Code (GS07)	Identifies the issuer of the X12 standard.
Identifier Code (GS08)	Identifies the version, release, and industry of the X12 standard.

Advanced Settings

Settings not included in the previous categories.

Setting	Description
Batch Transactions	An interchange can contain multiple transactions. When this is not checked, the connector creates a separate output file for each transaction in the interchange. When checked, the connector groups all transactions into a single output file. Only applicable when the Translation Type is X12 to XML.
Use Reference Id	When checked, when you are translating X12 into XML, reference Ids are used to name XML elements. Only applicable when the Translation Type is X12 to XML. For example: `<_143>value</_143>`. If this is unchecked, the Reference designator is used to name XML elements: `<BEG03>value</BEG03>`
Encoding	Specifies the character encoding (such as ASCII or UTF-8).
Expand Qualifier Values	When checked, XML elements containing an EDI qualifier include child elements containing the qualifier code and value. For example: `<N101>` `<Code>ST</Code>` `<Value>Ship To</Value>` `</N101>`
Functional Acks	By default, all functional acknowledgments (997, 999) are routed to the connector selected in the flow diagram, and XML translations are not received in the Transactions tab. Check this to have the translated acknowledgment also be included in the Transactions tab. This allows functional acknowledgments to be integrated into a destination source in addition to new EDI documents.
Generate Description As	When translating X12 into XML, descriptions of the X12 segments and elements can be provided as context for the X12 data. Use this dropdown to choose whether to add this context as an XML comment or as XML attributes.
HIPAA Schemas	When checked, the connector uses a separate set of EDI schemas with HIPAA constraints applied when translating and validating documents. This setting is ignored for EDI documents other than healthcare documents subject to HIPAA.
HIPAA 278	Two separate schemas can be used for 278 documents, depending on whether these should be interpreted as requests or responses. When checked, the request schema is used; otherwise the response schema is used.
Local File Scheme	A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros.
Nest Loops	When checked, the connector detects EDI structures that have hierarchical relationships embedded in the EDI data, and generates XML with these hierarchical relationships represented as parent-child relationships. See Master-Detail Hierarchy: Translating HLLoops for more information.
Processing Delay	The amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.
SNIP Validation	When enabled, the connector performs the first three levels of SNIP Validation for HIPAA compliance: (1) the syntactical integrity of the document, (2) the presence of required segments and appropriate repetitions for repeated segments, and (3) the correct mathematical relationship between claim line items and claim totals. Higher levels of SNIP Validation (4+) might require a Validate connector or custom script. Read this knowledgebase article for more details on how to use SNIP Validation.
Strict Schema Validation	Whether the connector should Ignore, Warn, or Fail when the following are detected: repeat counts above the allowed number, missing required elements or segments, invalid qualifier and code values, disallowed element lengths, and invalid element values. Choosing Disable turns off the schema validation checks.
Track ISA06	Whether to add ISA06 values as tracked headers to processed messages.
Track ISA08	Whether to add ISA08 values as tracked headers to processed messages.
Track Transaction Types	Whether to add transaction types as tracked headers to processed messages.
Validate Identifiers	Check this to ensure that the identifiers in the translated document match the identifiers in the connector’s configuration.
Duplicate File Action	How the connector should behave when it receives a message with a control number that the connector has seen before (a duplicate). When set to `Ignore`, the connector silently skips the duplicate and continues processing. When set to `Warn`, the connector processes the file but returns a warning. When set to `Fail`, the connector does not accept the file and returns an error.
Upload Schema	Use this to upload a schema and install it in the connector’s Schema folder. If a schema already exists, you are asked if you want to overwrite it.
Reset State	EDI connectors keep track of control numbers that have been used and increment that number to ensure that future runs do not duplicate data. Use this button to reset the counter to its initial state without changing any of the configured settings.

Message

Logging

Miscellaneous

EDI Partners Tab

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Setting	Description
Send	A toggle that instructs the connector to automatically send files when they are ready.
Resend Interval	The interval the connector waits before resending a file that received a negative ACK. For example, if a trading partner receives the file but something is wrong with it and they send back a negative ACK, this setting specifies how long to wait before sending the file again.
Max Attempts (async)	The maximum number of times the connector processes the input file when a functional ACK is requested. Success is based on the return of a functional ACK within the Resend Interval. If a successful functional ACK is not returned, the connector resends the file until Max Attempts is reached. If this is set to 0, the connector resends the file indefinitely.

Performance

Alerts Tab

SLAs Tab

Converting Formats

The following sections detail the process of converting X12 to XML and vice versa.

X12 to XML

Setting the Translation Type to X12 to XML instructs the connector to parse incoming X12 documents into XML. The connector first reads all of the header information for the Interchange and Functional Group sections of the document and validates them against the configured connector settings (unless Usage Indicator is set to Test Data). The connector then parses out the specific X12 schema used in the document and loads the schema from the x12_schemas folder on disk (additional schema files can be downloaded from our website for free). Using the schema, the connector generates XML representing the X12 structure of the document, populates the XML with the values from the document, and provides context to each value either as XML comments or as attributes in the XML elements (based on the value of Generate Descriptions As). To see this process with a set of test X12 documents, navigate to the Transactions tab of an X12 connector (with Translation Type set to X12 to XML) and select More > Create Test Files. X12 documents for an invoice, purchase order, purchase order acknowledgment, and shipping notice are automatically generated and placed in the Transactions directory. After these test files are processed by the connector, navigate to the Transactions tab to see the resulting XML. Once X12 documents are converted to XML, the data can be transformed and manipulated in many ways. Commonly, X12 data needs to be stored in a database or other back-end application system. Since uses XML to represent inserts into these back-end systems, storing the X12 data becomes a matter of mapping one XML structure onto another. This is typically done with the visual designer-driven XML Map connector.

XML to X12

Setting the Translation Type to XML to X12 instructs the connector to generate an X12 document out of an XML representation of the document. After the connector has constructed the X12 message out of the data parsed from the XML, it adds functional group and interchange headers according to the configured connector settings. To see this process with a set of test XML files, navigate to the Transactions tab of an X12 connector (with Translation Type set to XML to X12) and select More > Create Test Files. XML files representing an invoice, purchase order, purchase order acknowledgment, and shipping notice are automatically generated and placed in the Transactions directory. After these test files are processed by the connector, navigate to the Transactions tab to see the resulting X12 document.

Print View

Use With the XML Map Connector

Upload Test File

X12 Acknowledgments

The following sections detail the three types of X12 acknowledgments (ACKs), and how expects, processes, and generates ACKs.

Interchange ACKs, 997s, and 999s

A TA1 is the commonly accepted form of interchange acknowledgment. It is an indication that an interchange has taken place between the two parties, although not necessarily that any individual message has been exchanged. These serve as a receipt to the sender indicating that the EDI message was successfully received, but it does not specify whether there were any issues while processing the content of the message. The 997 (Version 4010), 997 (Version 5010), or 999 acknowledgements are considered functional ACKs: acknowledgements that an individual message (such as an invoice or purchase order) has been accepted. These are generated in response to a bidirectional agreement by both parties.

Expecting, Processing, and Generating Acknowledgments

Expecting Acknowledgements

X12 connectors, while operating in XML to X12 mode, can be configured so that both interchange and functional acknowledgments can be requested for an interchange. When TA1 Acknowledgment or Functional ACK is checked in the Acknowledgments section of the Settings tab, the connector maintains a Pending ACK status for a transmission until the appropriate ACKs have been returned and processed. This means that the connector status can be used to determine whether the recipient has confirmed that they received the interchange. The following diagram shows the logical flow involved when expecting an ACK from an invoice document:

In the illustration above, an X12 connector operating in XML to X12 mode generates the document to be exchanged (1) and holds it in a Pending ACK state while the document is transmitted to the trading partner. The trading partner processes the transmission according to their business logic and creates acknowledgments in accordance with the configured exchange parameters (2). When the acknowledgments are returned, they are processed according to the information in the next section (3).

Processing Acknowledgments

In a typical flow, X12 ACKs arrive at an X12 connector operating in X12 to XML mode. This X12 connector can be configured to automatically route any received acknowledgments to the X12 connector that originally generated the document being acknowledged. Routing ACKs between X12 connectors is configured visually on the Flows canvas by dragging the gray dot at the bottom of the X12 connector in X12 to XML mode onto the X12 connector that is in XML to X12 mode. Once the X12 connector in XML to X12 mode receives the routed ACK, it pairs the ACK to the original message and changes its state from Pending ACK to Sent.

Generating Acknowledgements

When an X12 connector in X12 to XML mode receives a message and generates the corresponding XML, it can automatically generate acknowledgments for the received message. To accomplish this, check TA1 Acknowledgment and/or Functional ACK expected in the Acknowledgments section of the Settings tab. These acknowledgments must be routed to another X12 connector (in XML to X12 mode) to finalize the ACK. The connector to which the ACK is routed applies interchange headings and passes the ACK along to the next connector in the flow like any other X12 message. To route the ACK appropriately, drag the gray dot at the bottom edge of the X12 connector in X12 to XML mode onto the X12 connector that is in XML to X12 mode. The following diagram shows the logical flow involved when creating an ACK for a received invoice document:

As shown in the illustration above, after a trading partner sends a message expecting an acknowledgment (1), the X12 connector in X12 to XML mode that parses the document automatically generates an ACK (2). This ACK is an XML file containing the transactional information relevant for the transaction. Then, this XML acknowledgment is routed back to an X12 connector in XML to X12 mode (3) so that the interchange headers (and any other X12 party agreement settings) are applied before the ACK is sent back to the trading partner.

Master-Detail Hierarchy: Translating HLLoops

In EDI documents, most hierarchical relationships are represented by the order of EDI segments. Some EDI structures, like HLLoops (which are found in Advance Shipment Notifications, or X12 856s), do not follow this convention and instead have the hierarchical relationships embedded in the EDI element data itself. This can make it difficult to preserve these hierarchical relationships when converting the EDI data to XML. The X12 connector supports preserving hierarchical relationships in HLLoops via the Nest Loops setting in the Advanced Settings portion of the Advanced tab. When enabled, the connector parses the elements in the HLLoop segments to determine which segments “belong to” other segments in a hierarchical relationship. These hierarchical relationships are reflected in the output XML as parent-child relationships; in other words, this setting converts hierarchy implied by the EDI content into hierarchy represented by the XML structure. This section explains how hierarchy is encoded in HLLoop data, and how this hierarchy is converted into XML when Nest Loops is enabled.

HLLoop Hierarchy

All HL segments have two values that help establish hierarchy:

an Id value, which identifies the current HL segment (this value is stored in HL01, or the first element in an HL segment)
a parent-Id value, which identifies the current HL segment’s hierarchical parent (this value is stored in HL02, or the second element in an HL segment)

For example, an HL segment has an Id value of ‘2’. If the next HL segment should “belong to” this prior segment in a hierarchical relationship, then the next HL segment’s parent-Id should also be ‘2’. If an HL segment’s parent-Id is ‘0’, the segment does not have a parent (it is at the top level of the hierarchy).

HLLoop Example

To further clarify the hierarchical relationships in HLLoop data, take the following EDI snippet as sample input (only the lines beginning with HL are relevant to determining the data hierarchy; the remaining segments are included to more closely represent actual EDI data):

HL*1*0*S      // First HL loop, the shipment loop
TD3*RR*SEAU*1234567
HL*2*1*O      // Second HL loop, the order loop
PRF*PO111111
HL*3*2*P      // Third HL loop, the first package loop
MAN*UC*PACKAGE1
HL*4*3*I      // Fourth HL loop, the first item loop
MAN*UC*ITEM_1
HL*5*3*I      // Fifth HL loop, the second item loop
MAN*UC*ITEM_2
HL*6*2*P      // Sixth HL loop, the second package loop
MAN*UC*PACKAGE_2
HL*7*6*I      // Seventh HL loop, the third item loop
MAN*UC*ITEM_1
HL*8*6*I      // Eighth HL loop, the fourth item loop
MAN*UC*ITEM_3

In this data, the second HL segment “belongs to” the first HL segment in a hierarchical relationship. This can be determined by looking at the HL01 and HL02 values for these segments:

The HL01 (Id) value for the first HL segment is ‘1’
The HL02 (parent-Id) value for the second HL segment is also ‘1’

The same process of matching parent-Id values to Id values can be used to determine all of the hierarchical relationships in the data.

Converting HLLoop Hierarchy to XML

When Nest Loops is enabled, the X12 connector handles the conversion of HL hierarchy to XML hierarchy automatically. The connector parses the HL01 and HL02 element values from the EDI input and ensures that XML elements are appropriately nested (indented) inside the elements representing their parents. To see how the HL hierarchy is converted into XML hierarchy, the following XML output is generated from the above sample HL data when Nest Loops is enabled:

<HLLoop1_S>
  <HL><HL01>1</HL01><HL02>0</HL02><HL03>S</HL03></HL>
  <TD3><TD301>RR</TD301><TD302>SEAU</TD302><TD303>1234567</TD303></TD3>
  <HLLoop1_O>
    <HL><HL01>2</HL01><HL02>1</HL02><HL03>O</HL03></HL>
    <PRF><PRF01>PO111111</PRF01></PRF>
    <HLLoop1_P>
      <HL><HL01>3</HL01><HL02>2</HL02><HL03>P</HL03></HL>
      <MAN><MAN01>UC</MAN01><MAN02>PACKAGE1</MAN02></MAN>
      <HLLoop1_I>
        <HL><HL01>4</HL01><HL02>3</HL02><HL03>I</HL03></HL>
        <MAN><MAN01>UC</MAN01><MAN02>ITEM_1</MAN02></MAN>
      </HLLoop1_I>
      <HLLoop1_I>
        <HL><HL01>5</HL01><HL02>3</HL02><HL03>I</HL03></HL>
        <MAN><MAN01>UC</MAN01><MAN02>ITEM_2</MAN02></MAN>
      </HLLoop1_I>
    </HLLoop1_P>
    <HLLoop1_P>
      <HL><HL01>6</HL01><HL02>2</HL02><HL03>P</HL03></HL>
      <MAN><MAN01>UC</MAN01><MAN02>PACKAGE2</MAN02></MAN>
      <HLLoop1_I>
        <HL><HL01>7</HL01><HL02>6</HL02><HL03>I</HL03></HL>
        <MAN><MAN01>UC</MAN01><MAN02>ITEM_1</MAN02></MAN>
      </HLLoop1_I>
      <HLLoop1_I>
        <HL><HL01>8</HL01><HL02>6</HL02><HL03>I</HL03></HL>
        <MAN><MAN01>UC</MAN01><MAN02>ITEM_3</MAN02></MAN>
      </HLLoop1_I>
    </HLLoop1_P>
  </HLLoop1_O>
</HLLoop1_S>

Macros

Examples

X12 Operations

In addition to the Operations provided with , connectors can provide operations that extend functionality into Script. These connector operations can be called just like any other Script operation, except that they must be called through the connector.rsc endpoint and must include an auth token. Operations specific to the functionality of the X12 connector are listed below.

x12Scan

Scans header values from the headers of an X12 document.

Required Parameters

file: The path to the X12 file.

Optional Parameters

format: The file format. The default value is ‘X12’.

Output Attributes

InterchangeSenderIdQualifier: The interchange qualifier of the sender Id (ISA05).
InterchangeSenderId: The interchange sender Id (ISA06).
InterchangeReceiverIdQualifier: The interchange qualifier of the receiver Id (ISA07).
InterchangeReceiverId: The interchange receiver Id (ISA08).
InterchangeControlNumber: The value that uniquely identifies the EDI interchange (ISA13).
FunctionalGroupSenderId: The functional group sender Id (GS02).
FunctionalGroupReceiverId: The functional group receiver Id (GS03).
DocumentType: The document type or transaction set Identifier code (ST01).
StandardVersion: The major version of the X12 Standard used in this interchange (e.g. 00401, 00501).

Common Errors

Following is a list of common errors, their causes, and the recommended solution.

Error: Schema file not found ([schema major version] [schema document type])

Cause When parses an X12 file, it first scans the file for the EDI version and document type to determine which schema to use during parsing. The application includes an extensive set of X12 schemas in JSON format. They are stored in the schemas folder in the application directory (next to the data folder). This error indicates that the application could not find a schema file matching the major version and document type reported by the file. If the [schema major version] value or [schema document type] value are missing in the error message, the EDI document does not contain the major version or document type. Otherwise, this error indicates that the appropriate document schema is not included in the set of schema definitions automatically included with . Resolution If the EDI file does not contain the schema major version or document type, contact the trading partner (or other source of the EDI document) and inform them that these values must be included in the message header. Otherwise, find the appropriate schema version from our free download page. Download the schema folder and place it in one of the following locations:

Inside the schema folder on disk (for example, <ConnectorDirectory>/Resources/Schemas/)
If a schema is used by multiple connectors, CData recommends you use a folder structure like this: <ApplicationDirectory>/schemas/<type>_schemas/<major version>. In this example, <type> should be x12.

Error: The segment at line [line number] with tag [segment name] is not in a valid position in the specified schema ([schema major version] [schema document type]). This may indicate that the input file contains segments that are out of order.

Cause When parses an X12 file, it first scans the file for the EDI version and document type to determine which schema to use during parsing. The application includes an extensive set of X12 schemas in JSON format, stored in the www\app_data folder of the root installation directory. This error indicates that the parser encountered an EDI segment in the file that does not match the order of segments defined in the relevant document schema. This can indicate a few different issues:

The EDI file was generated incorrectly by the trading partner
The EDI file was generated using a different schema version than what is indicated in the file
The EDI file was generated using a custom schema

Resolution If the EDI file was generated using a custom schema, place the custom schema file (in JSON format) in the folder where reads EDI schemas. The connector searches for schemas by checking the following locations in this order:

Inside its folder on disk (for example, <ConnectorDirectory>/Resources/Schemas/)
If a schema is used by multiple connectors, CData recommends you use a folder structure like this: <ApplicationDirectory>/schemas/<type>_schemas/<major version>. In this example, <type> should be x12.

If the EDI file was not generated using a custom schema, there are two approaches to resolving the discrepancy between the EDI file generated by the partner and the EDI schema used to parse it.

Manually edit the appropriate EDI schema file (found in the filepath above) to adjust the segment order so that it matches the partner’s EDI files. The error message indicates the line in the file where the segments diverge from the schema definition. Trace through the JSON definition of segment order until the divergence is found, and re-order the segments in the JSON to match the file provided by the partner.
Contact the trading partner about the EDI file. Confirm that the file was generated according to the major version that is reported by the file, and explain that the order of the segments in the file is not recognized.

Which approach to use depends on your familiarity with EDI segments for the particular document type (to correctly edit the JSON schema according to the partner’s file) and the partner’s flexibility (to adjust the EDI file in response to informing them about the error).

​Key Capabilities

​Overview

​Prerequisites

​Connector Configuration

​Settings Tab

​Translation Configuration

​EDI Partner

​Interchange Settings

​Acknowledgments

​Sample Files Tab

​Advanced Tab

​EDI Delimiters

​Interchange Settings

​Functional Group Settings

​Advanced Settings

​Message

​Logging

​Miscellaneous

​EDI Partners Tab

​Automation Tab

​Automation Settings

​Performance

​Alerts Tab

​SLAs Tab

​Converting Formats

​X12 to XML

​XML to X12

​Print View

​Use With the XML Map Connector

​Upload Test File

​X12 Acknowledgments

​Interchange ACKs, 997s, and 999s

​Expecting, Processing, and Generating Acknowledgments

​Expecting Acknowledgements

​Processing Acknowledgments

​Generating Acknowledgements

​Master-Detail Hierarchy: Translating HLLoops

​HLLoop Hierarchy

​HLLoop Example

​Converting HLLoop Hierarchy to XML

​Macros

​Examples

​X12 Operations

​x12Scan

​Required Parameters

​Optional Parameters

​Output Attributes

​Common Errors

​Error: Schema file not found ([schema major version] [schema document type])

​Error: The segment at line [line number] with tag [segment name] is not in a valid position in the specified schema ([schema major version] [schema document type]). This may indicate that the input file contains segments that are out of order.

Key Capabilities

Overview

Prerequisites

Connector Configuration

Settings Tab

Translation Configuration

EDI Partner

Interchange Settings

Acknowledgments

Sample Files Tab

Advanced Tab

EDI Delimiters

Interchange Settings

Functional Group Settings

Advanced Settings

Message

Logging

Miscellaneous

EDI Partners Tab

Automation Tab

Automation Settings

Performance

Alerts Tab

SLAs Tab

Converting Formats

X12 to XML

XML to X12

Print View

Use With the XML Map Connector

Upload Test File

X12 Acknowledgments

Interchange ACKs, 997s, and 999s

Expecting, Processing, and Generating Acknowledgments

Expecting Acknowledgements

Processing Acknowledgments

Generating Acknowledgements

Master-Detail Hierarchy: Translating HLLoops

HLLoop Hierarchy

HLLoop Example

Converting HLLoop Hierarchy to XML

Macros

Examples

X12 Operations

x12Scan

Required Parameters

Optional Parameters

Output Attributes

Common Errors

Error: Schema file not found ([schema major version] [schema document type])

Error: The segment at line [line number] with tag [segment name] is not in a valid position in the specified schema ([schema major version] [schema document type]). This may indicate that the input file contains segments that are out of order.