Defining an EDI Outbound Template

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.

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 in the Select Project field.

   By default, the Select Project field 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, click on the networks one by one. Only the EDI Partners of the selected Network(s) will be able to access this Template. 

    

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 in the EDI Standard field. The available options are X12 and EDIFACT.

   2. Select the version in the EDI Standard Version field. 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 field. 
   4. On the basis of the selected EDI version, the list of transaction set codes is populated in the Transaction Set Code field. Select the code in the field.

   5. Select the indicator in the Test/Production Indicator field. The available options are T-Test and P-Production. 

   6. Select the option in the Expect Acknowledgement field. 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 field.

      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 field appears. Following are the available options:

      Option Name	Description
      Reconcile	Sends acknowledgment for receiving the acknowledgment of an outbound message sent.
      Transform	Transforms 997 EDI Transaction Set Code to another EDI Transaction Set Code.
      Reconcile and Transform	Sends 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 field. 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 in the Batch Mode field. 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 fields.
       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 field.

       4. Select the days of the week on which the event should fire in the Firing Days field. 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
    Group	Unique name to identify a group.
    Name	Name of the parameter.
    Display Name	Display name for the Parameter. This display name will be visible instead of the Parameter's actual name on the Parameter Values page.
    Tooltip	Message that you want to show as a tooltip for the Parameter.
    Parameter Type	Type of the input parameter to be received from the Partner.
    Mandatory	Parameter may be mandatory or optional. By default, the parameters are mandatory.
    Default Value	Default 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 go to Template Settings step.

14. On the Settings screen, do the followings:

    1. Enter the details as described in the following table.
       

       Field Name		Description
       Contact User		Email id(s) listed here will receive a notification email whenever the Transaction is executed successfully or if there is an error during execution. Multiple email ids are separated by a comma. If Adeptia Connect is running on multiple environments and you want to receive environment name in the emails, then you need to specify the environment name in the relevant property (Account > Settings > Server Nodes Settings > Systems > Personalization).
       When to notify the contact?		Always: Send an email whenever the execution of the transaction associated with this template is successful. On Error: Send an email if an error occurred during the execution of the transaction associated with this template. Do Not Notify: Select this option if you do not want to receive an email notification after the execution of the transaction associated with this template.
       Email Notification Format		This field is visible only when you have selected Always or On Error option to send the notification to the user. You can choose the Email Notification Format to used in the email notification to be sent to the user on successful and failed Transaction. There are two possible values for this: Default and Customized Notification Format. By default, the value of this field is set to Default.  If you select the Customized Notification Format, you need to provide the following details: Select the custom success email notification format from the Custom Success Notification Format field. You can also create a new email notification format by clicking . The existing email notification format can also be copied and edited by clicking the  and  icons respectively. Use refresh  icon to refresh the list. This field is visible only when you have selected Always option to send the notification to the user. Select the custom error email notification format from the Custom Error Notification Format field. You can also create a new email notification format by clicking . The existing email notification format can also be copied and edited by clicking the  and  icons respectively. Use refresh  icon to refresh the list. This field is visible only when you have selected On Error or Always option to send the notification to the user.
       Data Encoding		Character-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1. You can also add and use a valid custom Data Encoding.
       Data encryption at rest		Select the particular option from Data encryption at rest field. You can enable, or disable, and use global Property value to configure EAR for Template. Use Global Policy: Select 'Use Global Policy' to use Global Property value for Template. Yes: Select 'Yes' to enable EAR for Template. It will not use Global Property value. No: Select 'No' to disable EAR for Template. It will not use Global Property value.
       Enable External Mapping Validation		You can use this function to validate the REST API in mapping. Follow the steps to enable the External Mapping Validation: Select the Enable External Mapping Validation checkbox to configure the REST account for external mapping validation.  Select the Rest Account in the Provide REST Consumer information field. You can also create a new REST Account by clicking . Select the Do Not Persist Mapping In Case Validation Failed checkbox if you want to restrict saving the mapping until the external mapping validation succeeds. When this checkbox is selected, the external mapping validation will be triggered every time the system/user tries to save the mapping. 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: Select the Enable External Mapping Function(s) checkbox to select the REST account. Select the Rest Account in the 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 either the Definition page or the Settings page. If you choose to hide the Definition Page:  The template definition will be treated as the definition for the transaction. The transaction name will be a combination of the template name and the partner name.  If you choose to hide the Settings Page:  The settings done on the Template Settings page will be treated as the settings for the transaction  By default the value for repository file retention will be set to DELETE ON SUCCESS EXCEPT SOURCE DATA  for a Transaction you create using this Template.

       Once External Mapping Function is enabled, then you can choose Available Functions from the Destination elements of mapping to apply the custom function as a mapping expression.
       
       Once External Mapping Validation is enabled, then icon is visible on the toolbar of mapper to validate the REST API.
    2. Expand Advanced Settings to set the Logging Level and Activity Logging Retention. The available options for the fields are as follows:

       • Logging Level- INFO, DEBUG, and ERROR

       • Activity Logging Retention- DONT DELETE, DELETE ON SUCCESS, and NO LOGGING
         To learn more about these options, refer to this page.

       
       
       
       

15. Click Next to select the Source application.

    Next Step

    Defining the source application of the Template