Defining a File Inbound Template

Owned by Akash Kumar Jaiswal (Unlicensed)
Last updated: Oct 15, 2019Version comment
4 min read

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

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.

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



  3. Click Continue.

  4. Select File & Message from the template type, Inbound from the direction, and click Next. 

  5. 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 Partners of the selected Network(s) will be able to access this Template.



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

  7. Click Next to define the additional parameters for the Partners. 



  8. Click Add Parameter to define the parameters.



    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.
    Input OptionsList of options for combo and radio button parameter type.
    Default ValueDefault value of the parameter
    PreviewPreview of the group.
    You can define the parameters mandatory or optional with the Mandatory checkbox. Uncheck the mandatory checkbox to define the parameters 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.

  9. Click Next to configure the template settings.

    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.

    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 property (Configure > Developer Studio > Proceed > Administer > Setup > Update System Properties > Systems > Personalization).

    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.

    Data EncodingCharacter-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1.
    Data encryption at restSelect the particular option from drop-down list of Data encryption at rest. 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

    Select this checkbox if you want to enable the external mapping validation in the mapping.

    To use this feature in mapping:
    Select the REST account from the drop-down list of Provide REST account information field that contains the REST API validation URL and the authentication parameters. Or,
    Create a new REST account by clicking .

    Enable External Mapping Function(s)

    Select this checkbox if you want to enable the external mapping function in the mapping.

    Select the REST account from the drop-down list of Provide REST account information field that contains the REST API URL and the authentication parameters. Or,
    Create a new REST account by clicking .

    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.


  10. Click Next to select the Source application.

Next Step

Defining the source application of the Template