Creating an EDI Schema

Owned by Akash Kumar Jaiswal (Unlicensed)
Last updated: Sept 09, 2020Version comment
4 min read

This section will assist you in creating EDI schema. While creating EDI Schemas, some record definitions may be common across schemas. You can create and define the record definitions, commonly used in EDI schema, in an EDI Data Dictionary. Thus, while creating an EDI Schema, you can select the EDI Data Dictionary and display the required records.  

Prerequisites

Ensure that you have created an EDI Data Dictionary to be uploaded. 

Creating an EDI Schema

You can use EDI Schema to define the layout of an EDI message. To create an EDI schema: 

  1. Go to Develop > Services > Schema > EDI to view Manage EDI Schema page.



  2. Click CreateNew to create new EDI Schema.

  3. Provide a unique EDI name and description in the text boxes.

  4. Select Skip Compliance Check check box to skip the compliance check for an EDI input file. It is applicable only for EDI Schema's Test and Data Mapper's Preview feature. 

  5. Select the EDI Data Dictionary.

  6. Click Select Transaction to select the EDI transaction. On the Select EDI Specification, select the transaction and click OK.



    The details of the selected Transaction are displayed in the Segment Definition section.  



  7. Expand Separator Definition. Provide the details if you are creating an EDI schema in standalone mode (using process flow). EDI Schema will be generated using the details specified in this section.

    It is mandatory to provide details in this section if you are creating an EDI Schema for HL7.
  8. Click Save. This displays a screen confirming that the EDI Schema has been created successfully.

While using the EDI schema in a process flow, you may need to set a context variable, operationMode, that determines the mode in which the EDI schema will be processed.

There are three possible values for the operationMode variable as described below. Each type of value accounts for the triggering the EDI schema in a different way. 

  • If operationMode is defined with value "test" then EDI Schema will run in test mode. The "test" value makes the EDI schema run in the same manner as it runs when you click Test button in EDI schema interface.
  • If operationMode is defined with value "normal" then EDI schema will run as a simple schema such as Text schema, XML schema, etc.
  • If operationMode is defined with value "solution"  then EDI schema will run as EDI solution schema. 

If the operationMode contect variable is not defined in a process flow then it works as "normal" mode.

Testing Schema Activity

After creating an EDI schema, you can test it and verify that the source file is free from errors. When a schema is tested, it parses the source file as per the EDI standards and generates the Target and/or Error file(s), depending on your selection of the Skip Compliance Check option while creating or editing the Schema. To test an EDI schema. 

  1. Go to Develop > Services > Schema > EDI.

  2. On the Manage EDI schema screen, click the name of the schema activity. The activity then opens in an Edit mode. Alternatively, under the Actions column, click More Actions, and then click Edit..



  3. Click Test. 



  4. In the Type drop-down list, keep the default selection - Source.
  5. Click Browse and select the EDI source file that you want to test.
  6. Click Submit. This tests the specified source file according to the defined schema and provides you the links to the generated files. If the Skip Compliance Check option is:
    • Enabled: A Target file is generated with all the transaction sets, ignoring the transaction level errors. In this case, no Error file is generated, even if the source file contains transaction level errors.
    • Disabled: A Target file is generated only for the correct transaction sets. In this case, an Error file is generated for erroneous transaction sets.

     

    The same principle applies for the Data Mapper's Preview feature. If the EDI Schema's Skip Compliance Check option is: 

    • Enabled: All the Transaction sets are displayed in the Data Mapper's Tree View tab, ignoring the transaction level errors. Even if the source file contains transaction level errors, no Error records are displayed in the Data Mapper's Error tab. 
    • Disabled: The correct Transaction sets are displayed in the Data Mapper's Tree View tab. Whenever a source file contains transaction level errors, the error records are displayed in the Data Mapper's Error tab.
  7.  To view the files, click the link of the file that you want to view.