Defining an EDI Inbound 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, Inbound from the direction, and click Next. 

   

7. Select the Network for which you are creating the Template. To select multiple Networks, click the networks one by one. Only the 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.  
   
   
   
   

   Clear the Partner will define this step check box to define this step else allow your Partner to define this step. The Partner will define this step while creating a Transaction using this Template.

   
   

   1. Select the EDI standard in the EDI Standard field. The available options are X12, HIPAA, 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 Generate Acknowledgement field to generate acknowledgment for the inbound messages sent. Following are the available options:

      Option Name	Description
      No - Do not generate acknowledgments	Select this option if you don't want to generate the acknowledgment for the inbound messages sent.
      Yes - No error detail	Select this option to generate the acknowledgment for an inbound message sent without error details.
      Yes - With error detail	Select this option to generate the acknowledgment for an inbound message sent with error details.

      To send an acknowledgment for the inbound messages received, you need to create an EDI Outbound Transaction either using pre-built EDI Outbound Template or creating a new EDI Outbound Template. While creating an EDI Outbound Transaction, following fields must have the same values provided while creating EDI Inbound 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. Provide the details in the other fields.

   7. Select Compliance Check check box to execute a compliance check on the document.

   8. Select Data encryption at rest in the Data encryption at rest field.

   9. Expand Translation Properties if you want to set multiple target and mapping from a single source. A Translation is a combination of mapping and target. You will have to set up same number of Destinations (apps and mappings) for the number of translations you select. You can select minimum 1 and maximum 3 translations. For example, if you choose 2 Translations, then while setting up the template you will have to set 2 Destinations (mapping and apps) in 2 different steps. 

      However, you can select only 1 Translation Property if you have chosen as 997 or 999 Transaction Set Code with Acknowledgment Processing Type set to Reconcile. 

      
      
      

   10. Expand Interchange Properties.

   11. Select the type of sequence checking in the Sequence Checking field. Following are the available options:

       Option Name	Description
       None	No sequence checking is done on the control number.
       Duplicate	Duplicate means inbound document contains duplicate control numbers. If you select this option then control numbers of inbound messages should not be duplicated. In case, control number is duplicated then the inbound message is not processed and an error message is generated in the EDI Interchange inbound log.
       Incremental	Incremental means control numbers should be in the incremental order. If you select this option then control numbers of inbound messages should be in the incremental order. In case, control number of any message is not in the incremental order then the inbound message is processed but a warning message is generated in the EDI Interchange Inbound Log.
       Chronological	Chronological means control number should be greater than the previous control number. If you select this option then control numbers of inbound messages should be in the chronological order. In case, control number of any message is not in the chronological order then the message is processed but a warning message is generated in the EDI Interchange Inbound Log.

       
       For Incremental and Chronological sequence checking, provide the values in the Use Global Control No check box and Last Used Control No field. Select Use Global Control No check box to use the control number defined while adding a Partner else provide the last used control number in the field. The value of the Last Used Control No field is populated automatically. 

       
       

   12. Expand Group Properties.
       1. Functional ID is populated automatically based on Transaction Set Code you have selected.
       2. Define the sequence checking and control numbers in the similar way as defined in the Interchange Properties.
          
          

       
       

   13. Expand Document Properties. Define the sequence checking and control numbers in the similar way as defined in the Interchange Properties.

   14. Expand Advanced Properties.

       

       1. Set the number of transaction sets to process at a time within a group in the Transaction sets Process Count field, default is 2000.

       2. Set the number of concurrent processes that can run at a time in the Concurrent Processes field, default is 1.

10. Click Next to go to Template Settings step.

11. 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.

       
       
       
       

12. Click Next to select the Source application.
    
    

    Next Step

    Defining the source application of the Template