Page Comparison

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.

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.

   Info
   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 Pass-Thru 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 on 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 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.

   
   

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

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

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

12. Anchor
    #Step12 #Step12

    Select the Routing Type from here. Ensure that the routing type you choose, should be dropped in the process flow you had selected for this template. 
    Select None if you don't want any routing type for this template.

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.
       Image Modified

       
       

       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 following values will be set for logging  level, repository file retention, and activities logging retention for a Transaction you create using this Template: When Routing Type is set to None: Logging Level : ERROR Repository File Retention : DELETE ON SUCCESS EXCEPT SOURCE DATA Activities Logging Retention : DONT DELETE   When Routing Type is set to Content or Context Based: Repository File Retention : DELETE ON SUCCESS EXCEPT SOURCE DATA

       
       

       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 Image Modifiedicon 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.

       
       
       
       
       The Logging Level and Activity Logging Retention appear on this screen only when you select the Routing Type (Step12) as Content Based or  Context Based. When you select Routing Type as None, these options appear while you create a Transaction using this Template. 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