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 provide the definition of create a Template:

  1. Click Configure > Templates > Create Template
    Image Removed
    Image Added

     

  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.

    Image RemovedImage Added

     

  3. Click Continue to select the network .

  4. Select the Network for which you are creating the Template.

    Select the Template access and Network.

    Image Removed

     

    NameDescriptionAccess 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

     To select multiple Networks from the drop-down list, click on the networks one by one.

    Only

     Only the Partners of the selected Network(s) will be able to access this Template.

    Image Added

     

  5. Click Next to provide choose the configuration detailstemplate type.

    Provide the configuration details for the Template. 

    Image Removed

    Anchor
  6. File_AppFile_AppIn the Select

    Select Custom from the template type,

    select one from the following options:Image Removed

    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.
    AnchorInbound_OutboundInbound_OutboundIn the Select direction, select Inbound to receive data from the Partner. In this option, Partner will define the Source application account and configuration details.
    Image Removed
    AnchorConfigurationConfigurationThe 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.

    Click Next to continue further.

    Image Removed

     Inbound from the direction, and click Next.

    Image Added

     

  7. Click Next to configure template settings.

    Image Added

     

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

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

    Info

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

    1. On the Create Process Flow window, provide a unique process flow name and description, and click Continue.
    AnchorParametersParameters
    1.  
    2. A file - startPD.jnlp will get downloaded to your computer. Double-click to open the Process Flow Designer
    3. Now, create a Process Flow as per your requirements.

     

  10. Click Next to select the activities. 

  11. The screen will display all the activities used in the Process Flow. In case of multiple destinations, select the destination by clicking Destination check box in Trigger/Action column. 

    Here, as an example of two Source and Destinations have been used in a custom template. 

    Image Added  

    NameDescription
    Process StepList of activities used in the process flow.
    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. You can also select the destination in case of multiple targets.
  12. Click Next to define the

    additional

    parameters

    for the Partners

    Image Added

     

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

    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.
     
  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 select the Source application.

Next Step

Defining the

...

source application of the

...

template