Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

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.

Info
Only a Company administrator and an IT User can create a Template. However, it is recommended that only IT User creates a Template.

To create a Partner to Partner Exchange 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.

  4. Select Custom from the template type and Partner to Partner Exchange from the direction.


     

    Info

    Select the Single Page checkbox if you want to create Partner to Partner Exchange Transaction in a single page. You can not change its value once a Transaction has been created using this Template. 


  5. Click Next to select the process flow. 

  6. Select the process flow from the drop-down list. This will list all the process flows published as a template. 


    You can either select from an existing published Process Flows or create a new one by clicking 

    Info

    If you are creating a new Process Flow, you must know the guidelines for defining the Process Flow in the Custom Template. Click here to view the guidelines.

    1. On the Create Process Flow window,
      1. Provide a unique process flow name and description
      2. Select the project from the drop-down list of Project and click Done
    2. Now, create a Process Flow as per your requirements.
  7. Click Next to select the activities.
     

    Info
    You may get an alert message if there is a change in the selected process flow. Click Sync to view the updated list of activities.


  8. The screen will display all the activities used in the Process Flow. 

     

    NameDescription
    NameList of services used in the process flow. You can update and give an appropriate and meaningful name to these services in this template.

    The names you provide here will reflect as the steps in the template.
    DescriptionDescription of the services used in the process flow. It helps you understand what exactly does the service do and it appears as a tooltip for that service.
    Configure in template?

    Selecting or deselecting these checkboxes determines whether you would be able to configure or override the services predefined in the process flow or not. If you clear the check box against a service, that service wouldn't reflect as a step in the template.

    Note
    Nevertheless. you will not be able to apply this rule for Trigger, selected Destination, and Routing (if it is Content based routing).


    Base TypeType of activity - source, layout, mapping, and so on.
    Trigger/ActionShows the Source which will act as a trigger in case there are multiple sources. In case of multiple destinations, select the destination by clicking Destination check box in Trigger/Action column.

      

  9. Anchor
    Parameters
    Parameters
    Click Next to define the parameters. 

     

  10. Click Add Parameter to add either Template or Transaction Parameters. 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.


    FieldsDescription
    GroupUnique name to identify a group.
    NameName of the parameter.
    Display NameDisplay name for the Parameter. This display name will be visible instead of the Parameter's actual name on the Parameter Values page.
    TooltipMessage that you want to show as a tooltip for the Parameter.
    Parameter TypeType of the input parameter to be received from the Partner.
    MandatoryParameter may be mandatory or optional. By default, the parameters are mandatory.
    Default ValueDefault 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.

  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. Click Next to select the routing.

  13. The routing option is selected by default depending on the selected Process Flow. If the Process Flow contains Content Based routing activity then by default Content Based routing option is selected otherwise Context Based routing option. 

     

  14. Click Next to configure 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.

    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.

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

      Note
      This field is visible only when you have selected On Error or Always option to send the notification to the user.


    Data EncodingCharacter-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1.
    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 rest You can select the relevant option for data encryption at rest. The available options are Use Global Policy, Yes, and No.
    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:

      1. Select the Enable External Mapping Validation checkbox to configure the REST account for external mapping validation. 

      2. Select the Rest Account from the dropdown list of Provide REST account information field. You can also create a new REST Account by clicking .


    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:

      1. Select the Enable External Mapping Function(s) checkbox to select the REST account.

      2. Select the Rest Account from the dropdown list of Provide REST account 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 creationSelect the step that you want to hide while creating a Transaction by using this Template.