Articles in this section

Create EDI profiles for EDI X12 data in flows

To streamline EDI data processing, the trading partner configurations are centrally stored within the EDI profiles resource that can be used in your exports and imports, avoiding scattered configurations across flows, file definition rules, and mappings. This centralized approach reduces configuration time, minimizes errors, and offers a global view of EDI-related validations and values at the header level, allowing easy updates for specific trading partner configurations.

Note

The EDI profiles component is available if you have subscribed to B2B Manager as part of the integrator.io license subscription.

Create EDI profiles based on EDI X12 files

  1. Sign in to your integrator.io account.

  2. From the left navigation, go to Resources > EDI profiles to create a standalone resource that you can later include in your export or import flow steps.

    resources-edi-profiles.png

    Or

  3. From the left navigation pane, go to ResourcesExport or Import+Create export or +Create import to create the EDI profile resource in a standalone export or import. Or, go to Flow builder (ToolsFlow builder) to create the EDI profile resource in a source or destination flow step. Click How would you like to parse filesEDI profile in the export; or, click How would you like to generate filesEDI profile in the import as shown below.

    edi-profile-parser-x12.png
    edi-profile-generator-x12.png

Two ways to create your EDI profile

In the EDI profiles page, you can create the EDI profile in either of the following ways:

  • By automatically extracting values from a sample file: You can upload a sample EDI file, and try the EDI profile extractor to automatically extract header segment values. This option is very quick, easy, and reduces errors of manually entering values.

  • By manually entering values: You can manually enter header segment values in the settings. This option is slow but is helpful If you don't have a valid EDI file or prefer to enter the EDI profile values.

Option 1: Automatically extract values from a sample file to create EDI profile

edi-profile-extractor.png
  1. In the Create EDI profile from a sample file section, click Upload and try the EDI profile extractor.

  2. Select and upload a valid file from your system. The values for the header segments are automatically extracted from the uploaded sample file.

    Important

    Make sure that your sample EDI file is valid before you upload it.

  3. Enter a name for your EDI profile, and check all the extracted values in the settings. Note that you cannot preview the sample output.

  4. Click Save and close.

If your file is not valid, then you will receive an error. You can check your file, and retry the upload. If the error persists, click Skip file upload. See Option 2 below and enter the values manually.

Option 2: Manually enter values to create an EDI profile

On the EDI profiles page, on the top-right, click Create EDI profile.

General

Create_EDI_general.jpg

On the Create EDI profile window, in the General section, enter the appropriate details in the respective fields:

  • Name: This is a mandatory field. Enter a name for the EDI profile.

  • Description: Enter the description for the EDI profile.

  • EDI file type: This is a mandatory field and is non-editable. The field shows the EDI file type, currently, X12 is the file type supported.

Identification
Create_EDI_identification.jpg

In this section, you can find the information on the permitted value for a given trading partner in the EDI enveloping section of a file.

Interchange identification

  • ISA01 (Authorization information qualifier): A code to identify the information type in the Authorization Qualifier. You can choose one option from the drop-down menu.

  • ISA02 (Authorization information): This is used for identifying the authorization code information about the interchange sender or the data in the interchange. Enter an appropriate value.

  • ISA03 (Security information qualifier): A code to identify the information type in the Security Information. You can choose one option from the drop-down menu.

  • ISA04 (Security information): This is used for identifying the security information about the interchange sender or the data in the interchange. This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier ISA03.

  • Trading Partner ID qualifier: A code indicating the system of code structure used to designate the Trading Partner ID element being qualified. This field is to be used as ISA05 for Inbound documents from trading partners for EDI Parsing and ISA07 for Outbound documents to trading partners for EDI generation.

  • Trading Partner interchange ID: An identification code published by the trading partner for other parties to use as the ID to exchange data. This field is to be used as ISA06 for Inbound documents from trading partners for EDI Parsing and ISA08 for Outbound documents to trading partners for EDI generation.

  • My ID qualifier: A code indicating the system of code structure used to designate the Trading Partner ID element being qualified. This field is to be used as ISA07 for Inbound documents from trading partners for EDI Parsing and ISA05 for Outbound documents to Ttrading partners for EDI generation. You can choose one option from the drop-down menu.

  • My interchange ID: A code published for you for the other parties to use as the ID to exchange data. This field is to be used as ISA08 for Inbound documents from trading partners for EDI parsing and ISA06 for Outbound documents to trading partners for EDI generation.

Interchange control information

Create_EDI_ICI.jpg
  • ISA11 (Interchange standards ID): This field provides the delimiter used to separate repeated occurrences of a simple data element; this value must be different than the data element separator, component element separator, and segment terminator.

  • ISA12 (Interchange version number): A code specifying the version number of the interchange control segments.

  • ISA14 (Acknowledgement requested): A code indicating the sender's request for an interchange acknowledgment.

  • ISA15 (Usage indicator): A code to indicate whether data enclosed by this interchange envelope is test data or production data.

  • ISA16 (Component Element Separator): This field provides the delimiter used to separate component data elements. This value must be different from the data element separator and the segment terminator.

Group identification

Create_EDI_Grouo_identification.jpg
  • Trading Partner group ID: An identification code published by the trading partner for other parties to use as the ID to exchange data. This field is used as GS02 for Inbound documents from Trading Partners and GS03 for Outbound documents to trading partners.

  • My group ID: An identification code published by Celigo’s customer for other parties to use as the ID to exchange data. This field is used as GS03 for Inbound documents from trading partners and GS02 for Outbound documents to trading partners.

  • GS07 (Responsible agency code): A code identifying the issuer of the standard; this code is used in conjunction with Data Element GS08. You can choose one option from the drop-down menu.

  • GS08 (Version): A code indicating the version, release, sublease, and industry identifier of the EDI standard being used

Control numbers

Control_numbers.jpg

Control number sequence - Value: The control number, sequentially used in EDI messages for Interchange and Group level segments in fields ISA13, GS06, GE02, and IEA02, starts with a default value of '1'. This initial value is applied to the first EDI file, with each subsequent file's control number incrementing by 1. When the control number hits 999,999,999 (nine nines), it resets to the initially configured value by the user.

After you enter the details and click Save on the Create EDI profile window, a new entry is created on the EDI profiles page.

EDI_profile_created.jpg

Note

The control number sequence is not supported for each document type.

View the audit log

Audit logs maintain a record of specific activities in your flows, including the fields that were changed, the type of change, and who is responsible for the change. You can view your audit logs at a flow or EDI profile level. For more information, see View or download audit logs.

In integrator.io, on the EDI profile page, next to the appropriate profile, from the Actions overflow (…) menu, select View audit log.

View_audit_log.jpg

In audit logs, pageProcessors and pageGenerators represent imports and exports, respectively. It’s just a system naming convention that doesn’t affect your integrations or flows.

Audit_log.jpg

Edit an EDI profile

You can edit an already-created user profile. While editing an EDI profile, the EDI file can’t be edited.

In integrator.io, on the EDI profile page, next to the appropriate profile, from the Actions overflow (…) menu, select Edit EDI profile.

After you edit the profile, on the EDI profiles page, the Last updated field will be updated with the latest timestamp.

EDI profile preview

Before executing the EDI profile at the flow level, you can preview the profile for validations. In integrator.io, on the Flow builder page, from the export or import steps, after you select the Parser/Generation definition, click Launch to view the ‘EDI parser helper/EDI generator helper’ Advanced Field Editor (AFE).

For the EDI parser helper or EDI generator helper, the EDI profile execution at the flow level is similar to that of the preview. When you open AFE, by default, the Auto preview is enabled, and the EDI profile is executed.

  • In the EDI parser helper, the AFE must validate the EDI data received from the trading partner and convert the data to a JSON format. The preview and Auto preview options are applicable for the execution of the EDI profiles.

  • In the EDI generator helper, the AFE must recognize the EDI profile selection from import, replace the EDI data received from the tading partner, and convert the data to a target ERP format. The preview and Auto preview options are applicable for the execution of the EDI profiles.