Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Before start creating a Custom Template, ensure that you have created a Process Flow and published it in Adeptia Connect

A Process Flow may have following activities - Data Security (Encryption and Decryption), Miscellaneous (Mail Notification and Stored procedure), Extensions (Native Call and Custom Plugin), Source and Target activities, Source and Target layout and schema, Data mapping, Web Services, and Polling. Depending upon the activities used in the Process Flow, you need to provide the definition of all the activities while creating a Template.

We have considered a Process Flow with multiple source/target activities, layouts, and mappings to define the Custom template. Since our Process Flow has source activity, source layout, target activity, target layout, and mapping, we need to provide the definition of all these activities while creating a Custom Template.

A Process Flow may also have multiple source or target activities. Only those activities will be displayed whose eventContextEnable property is set to True in the Process Designer. You will be prompted to select which source or target activity will trigger or perform an action by clicking Trigger and Action check box. Only one source or target activity can be triggered or perform an action.

A Process Flow may also have multiple source/target activities with multiple source/target layouts. It is mandatory to have source/target layout name in the following format: <Source/Target_Activity_Name> <Layout_Name>. For instance, if the Source activity name is FileSource and layout name is TextSchema, then Source layout name must be FileSource TextSchema. This is to identify which layout is created for which activity.

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.

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 selfonboarded 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 templateis Private, then by default, only Internal Network is selected and you can't add or change the Network.

    If the access to templateis 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. Select the following:

    1. Select template type: Custom.

    2. Select direction: Inbound.   

     

  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.

    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.
  8. Click Next to select the process flow. 
  9. Select the process flow from the drop-down list. This will list all the published process flows. 



     You can either select from an existing published Process Flows or create a new one by clicking 
    1. On the Create Process Flow window, provide a unique process flow name and description, and click Continue
    2. A file - startPD.jnlp will get downloaded to your computer. Double-click to open the Process Flow Designer
    3. In the Process Designer, arrange all the activities in a sequence to create a Process Flow.
  10. Click Next to select the activities.
  11. Select the activities to use in the Template. This will list all the activities used in the process flow. 

      

     

    NameDescription
    Process StepList of activities used in the process flow.
    Base TypeType of activity - source, layout, mapping, and so on.
    Trigger/ActionApplicable for the multiplesourceor target activities.
  12. Click Next to define the parameters. 

     

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

    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.
  14. Click Next to define the values of the Template parameters. This screen appears only if you have provided Template Parameters in the previous step.
  15. Click Next to provide the definition of the activities.

Next Step

Defining a Custom Inbound Source Application

  • No labels