Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

If you are creating an EDI Template, ensure that you have created an EDI Partner and Data Dictionary.

Info
Only a Company administrator and an IT User can create a Template. However, it is recommended that 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. Click Continue to select the network for which you are creating the Template.

  4. Select the Template access and Network.

     

    NameDescription
    Access To template

    Public: Template is used by the Company and self onboarded Partners.

    Private: Template is used by the Company only.

    Network

    Selection of Network(s) will depend on the type of access you have chosen in the previous option.

    If the access to template is Private, then by default, only Internal Network is selected and you can't add or change the Network.

    If the access to template is Public, you can select the Network(s) from the drop-down list. To select multiple Networks from the drop-down list, click on the networks one by one. Only the Partners of selected Network(s) will be able to access this Template.

  5. Click Next to provide the configuration details.

  6. Provide the configuration details for the Template. 

    Image RemovedImage Added

    1. Anchor
      File_App
      File_App
      In the Select template type, select one from the following options:



      App: Select this option if your Partner is using an application, for example, QuickBooks.

      File & Message: Select this option if your Partner is using a file system, for example, File Source, or message type application, for example, Email or JMS.

      EDI: Select this option if your Partner wants to send or receive EDI files.

    2. Anchor
      Inbound_Outbound
      Inbound_Outbound
      In the Select direction, select Inbound to receive data from the Partner. In this option, Partner will define the Source application account and configuration details.


      Anchor
      Configuration
      Configuration
      The list of applications in the /wiki/spaces/AC2/pages/655669 and /wiki/spaces/AC2/pages/655497 application screen differs based on the option selected in the Select template type drop-down list. The applications will be listed as per the following table:

      Application TypeTemplate TypeList of Applications
      Source ApplicationAppList of all app-based application will appear, for example, Facebook, QuickBooks, HubSpot, FreshBooks, and so on.
      FileList of all file-based application will appear, for example, File, FTP, Email, and so on.
      EDIFTP, File, and JMS.
      Target ApplicationAppAll the supported applications will appear irrespective of the option selected.
      File
      EDIFTP, File, Database, and JMS.
  7. Click Next to continue further.

    Field NameDescription

    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. This option is not applicable for EDI template type.

    When to notify the contact?

    Always: Send an email whenever the execution of the Transaction is successful.

    On Error: Send an email if an error occurred during the execution of the Transaction.

    This option is not applicable for EDI template type.

    Data EncodingCharacter-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1.
  8. Anchor
    Parameters
    Parameters
    Click Next to define the additional parameters for the Partners. This is an optional screen and not applicable for EDI template type. 
  9. Click Add Parameter to define the parameters. 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.

    Parameter NameDescription
    Group TitleUnique name to identify a group.
    Parameter NameName of the parameters of the group.
    Parameter TypeType of the input parameter to be received from the Partner.
    Provide Input OptionsList of options for combo and radio button parameter type.
    Live PreviewPreview of the group.
    Click Next to define EDI settings. This screen appears only for EDI template type. 
  10. Select the EDI standard from the EDI Standard drop-down list. The available options are X12 and EDIFACT. 

  11. 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. 
  12. Provide the assigned code in the Association Assigned Code text box.    
  13. 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.
  14. Select the indicator from the Test/Production Indicator drop-down list. The available options are T-Test and P-Production.

  15. Select the option from the Generate Acknowledgement drop-down list to generate acknowledgment for the inbound messages sent. Following are the available options:

    Option Name
    Description
    No - Do not generate acknowledgmentsSelect this option if you don't want to generate the acknowledgment for the inbound messages sent.
    Yes - No error detailSelect this option to generate the acknowledgment for an inbound message sent without error details.
    Yes - With error detailSelect 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 /wiki/spaces/AC2/pages/655660. 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.

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

  17. Expand Interchange Properties.
  18. Select the type of sequence checking from the Sequence Checking drop-down list. 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 text box. 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 text box. The value in the Last Used Control No text box is populated automatically. Image Removed
    Expand Group Properties.
  19. Functional ID is populated automatically based on Transaction Set Code you have selected.
  20. Define the sequence checking and control numbers in the similar way as defined in the Interchange Properties.
    Image Removed

     

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

    Image Removed

     

  22. Expand Advanced Properties.

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

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

  23. Click Next to select the Source application.

    Next Step

    /wiki/spaces/AC2/pages/655669 

    Next Step

    Defining the Source application of the Template