The first step while creating a Template is to provide Template definition. The definition includes details, such as name, description, and other information about the Template.

Ensure that you have created an EDI Partner and Data Dictionary.

Only a Company administrator and an IT User can create a Template. However, it is recommended that only an IT User creates a Template.

To provide the definition of a Template:

  1. Click Configure > Templates > Create Template

     

  2. On the Create New Template screen, provide the name and description of the Template. The name should be a unique name and can be up to 48 characters long. The description of the Template can be up to 300 characters long.

  3. Select the project from the Select Project drop-down list.

    By default, the Select Project drop-down box displays the default project of the logged-in user as the selected project. 
  4. Provide a display name for the Template.

  5. Click Continue.

  6. Select EDI from the template type, Outbound from the direction, and click Next

  7. Select the Network for which you are creating the Template. To select multiple Networks from the drop-down list, click on the networks one by one. Only the EDI Partners of the selected Network(s) will be able to access this Template. 

    Select Network.png 

  8. Select the checkbox Allow Import Partner(s) which allow you to select a Web Form to import Partners while configuring the Transaction.

  9. Click Next to define EDI settings.

    1. Select the EDI standard from the EDI Standard drop-down list. The available options are X12 and EDIFACT.

    2. Select the version from the EDI Standard Version drop-down list. This list will have all the EDI versions you have created in the Data Dictionary. You will find 004010 and 005010 as a default EDI version.
    3. Provide the assigned code in the Association Assigned Code text box. 
    4. On the basis of the selected EDI version, the list of transaction set codes is populated in the Transaction Set Code drop-down list. Select the code from the drop-down list.
    5. Select the indicator from the Test/Production Indicator drop-down list. The available options are T-Test and P-Production. 

    6. Select the option from the Expect Acknowledgement drop-down list. Select Yes to receive an acknowledgment for the outbound messages sent. Provide the number of hours elapse before an expected functional acknowledgment is considered as overdue in the Hours Overdue text box.

      To receive an acknowledgment for the outbound messages sent, you need to create an EDI Inbound Transaction either using pre-built EDI Inbound Template or creating a new EDI Inbound Template. While creating an EDI Inbound Template, following fields must have the same values provided while creating EDI Outbound Template.

      • Partner Name
      • EDI Standard Version
      • Association Assigned Code
      • Test/Production Indicator

      After you have selected the values in the above fields, select 997 in the Transaction Set Code. When you select 997 in the Transaction Set Code, an Acknowledgment Processing Type drop-down list appears. Following are the available options:

      Option Name

      Description

      ReconcileSends acknowledgment for receiving the acknowledgment of an outbound message sent.
      TransformTransforms 997 EDI Transaction Set Code to another EDI Transaction Set Code.
      Reconcile and TransformSends acknowledgment for receiving the acknowledgment of an outbound message sent and transform 997 EDI Transaction Set Code to another EDI Transaction Set Code.
    7. Select Use Global Transaction Control No check box to use the control number defined while adding a Partner.

    8. Type the last used transaction control number in the Last used Transaction Control No text box. The value is populated automatically based on the selected Transaction Set Code defined in Step d.
    9. The value in the Responsible Agency Code is populated automatically based on the Transaction Set Code you have selected.
    10. Select Compliance Check check box to execute a compliance check on your document. 
    11. Select the mode of transfer from the Batch Mode drop-down list. Select Yes to define the schedule for the batch process to send the outbound EDI message at defined intervals to the Partner. For this, you need to create a Calendar Event. Click  to create a Calendar Event. On the Calendar Event window:

      1. Provide the name and description of the Calendar Event in the text boxes.
      2. Select the date from which Calendar event will start and stop triggering in the Event Start Date and Event Expiry Date. Click  to select the date from the calendar. The date must be in MM/dd/yyyy format. 
      3. Select the start and expiry time from the Time drop-down list.
      4. Select the days of the week on which the event should fire from the Firing Days drop-down list. Following are the available options:

        Option

        Description

        All Days

        The event will fire on all days (Mon to Sun) of the week.

        Business Days

        The event will fire from Monday to Friday excluding holidays.

        Week Days

        The event will fire from Monday to Friday even if there are any holidays.

      5. Define the frequency of execution in the Firing Schedule. You need to define the frequency using Cron Expression. Click Help to know more about Cron Expressions. 
    12. Select Content Based Routing check box to select the Partner (to send the data) based on the content of the outbound source file. For example, based on the value of a particular field of the source file you want to decide to which Partner outbound message should be sent. Content-based routing is used when data of one source file should go to the multiple Partners.
  10. Click Next to define the additional parameters for Template and Transaction.

    These are the parameters whose value you want to get while creating a Template or Transaction. 

    • Template Parameters: Company Users will define the value of these parameters while creating a Template.

    • Transaction Parameters: Business Users or IT Users will define the value of these parameters while creating a Transaction using this Template.


  11. Click Add Parameter to define the parameters.

    Fields

    Description

    GroupUnique name to identify a group.
    NameName of the parameter.
    Display NameDisplay name for the Parameter. This display name will be visible instead of the Parameter's actual name on the Parameter Values page.
    TooltipMessage that you want to show as a tooltip for the Parameter.
    Parameter TypeType of the input parameter to be received from the Partner.
    MandatoryParameter may be mandatory or optional. By default, the parameters are mandatory.
    Default ValueDefault value of the parameter.

    Depending on the Parameter Type you have selected, you may have to define some additional fields/options or settings while defining a parameter. Refer to the Templates and Transactions Parameters page for more information on fields and their possible values.

    You can define the parameters mandatory or optional with the Mandatory check box. Clear the Mandatory check box to define the parameter as optional. By default, parameters are mandatory.

    The Partner who will use this Template to create a Transaction will define the values of these specified parameters that will be stored in the context of the process flow. Add as many parameters you want by clicking Add Parameter.

  12. Click Next to define the values of the Template parameters. This screen appears only if you have provided Template Parameters in the previous step.

  13. Click Next to configure template settings.



    Field NameDescription
    Data EncodingCharacter-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1.
    Enable External Mapping Validation

    You can use this function to validate the REST API in the Mapping. Follow the steps to enable the External Mapping Validation:

      1. Select the Enable External Mapping Validation check box to configure the REST account for external mapping validation. 

      2. Select the Rest Account from the drop-down list of Provide REST Consumer information field. You can also create a new REST Account by clicking  .

    Click here to get more details on using Validation Option in Mapping.

    Enable External Mapping Function(s)

    You can use this function to apply the external map function in the mapping through REST API. Follow the steps to enable the External Mapping Function:

      1. Select the Enable External Mapping Function(s) checkbox to select the REST account.

      2. Select the Rest Account from the dropdown list of Provide REST Consumer information field. You can also create a new REST Account by clicking .

    Click here to get more details on using Available Functions in Mapping.

    Select the steps which you want to hide at the time of Transaction creation

    Select the step that you want to hide while creating a Transaction by using this Template. You can hide the Definition page.

    If you choose to hide the Definition Page: 

    1. The template definition will be treated as the definition for the transaction.

    2. The transaction name will be a combination of the template name and the partner name. 

  14. Click Next to select the Source application.