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.
If you are creating an EDI Template, ensure that you have created an EDI Partner and Data Dictionary.
| 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:
Click Configure > Templates > Create Template.
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.
Click Continue to select the network .
Select the Network for which you are creating the Template.
Select the Template access and Network.
Name Description Access 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. ToTo select multiple Networks from the drop-down list, click on the networks one by one.
OnlyOnly the Partners of the selected Network(s) will be able to access this Template.
Click Next to provide choose the configuration detailstemplate type.
Provide the configuration details for the Template.
Anchor File_App File_App In the SelectSelect Custom from the template type,
select one from the following options:
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.Anchor Inbound_Outbound Inbound_Outbound In the Select direction, select Inbound to receive data from the Partner. In this option, Partner will define the Source application account and configuration details.
Anchor Configuration Configuration The 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 Type Template Type List of Applications Source Application App List of all app-based application will appear, for example, Facebook, QuickBooks, HubSpot, FreshBooks, and so on. File List of all file-based application will appear, for example, File, FTP, Email, and so on. EDI FTP, File, and JMS. Target Application App All the supported applications will appear irrespective of the option selected. File EDI FTP, File, Database, and JMS. Click Next to continue further.
Inbound from the direction, and click Next.
Click Next to configure template settings.
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. This option is not applicable for EDI template type
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.This option is not applicable for EDI template type.
Data Encoding Character-set encoding for your source data. The available options are UTF-8, UTF-16, UTF-32, and ISO-8859-1. Anchor Parameters Parameters- Click Next to define the additional parameters for the Partners. This is an optional screen and not applicable for EDI template type.
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.
Parameter Name Description Group Title Unique name to identify a group. Parameter Name Name of the parameters of the group. Parameter Type Type of the input parameter to be received from the Partner. Provide Input Options List of options for combo and radio button parameter type. Live Preview Preview of the group. - Click Next to define EDI settings. This screen appears only for EDI template type.
Select the EDI standard from the EDI Standard drop-down list. The available options are X12 and EDIFACT.
Select the version from the EDI Standard Version dropselect the process flow. Select the process flow from the drop-down list. This will list
will have all the EDI versions you have created in the Data Dictionary. You will find 004010 and 005010 as a default EDI version.- Provide the assigned code in the Association Assigned Code text box.
- On the basis of the selected EDI version, the list of transaction set codes is populated in the Transaction Set Code drop-down list. Select the code from the drop-down list.
Select the indicator from the Test/Production Indicator drop-down list. The available options are T-Test and P-Production.
Select the option from the Generate Acknowledgement drop-down list to generate acknowledgment for the inbound messages sent. Following are the available options:
Option NameDescriptionNo - Do not generate acknowledgments Select this option if you don't want to generate the acknowledgment for the inbound messages sent. Yes - No error detail Select this option to generate the acknowledgment for an inbound message sent without error details. Yes - With error detail Select this option to generate the acknowledgment for an inbound message sent with error details. To send an acknowledgment for the inbound messages received, you need to create an EDI Outbound Transaction either using pre-built EDI Outbound Template or /wiki/spaces/AC2/pages/655660. While creating an EDI Outbound Transaction, following fields must have the same values provided while creating EDI Inbound Template.
Partner Name
EDI Standard Version
Association Assigned Code
Test/Production Indicator
After you have selected the values in the above fields, select 997 in the Transaction Set Code. Provide the details in the other fields.
Select Compliance Check check box to execute a compliance check on the document.
- Expand Interchange Properties.
- Functional ID is populated automatically based on Transaction Set Code you have selected. Define the sequence checking and control numbers in the similar way as defined in the Interchange Properties.
Expand Document Properties. Define the sequence checking and control numbers in the similar way as defined in the Interchange Properties.
Expand Advanced Properties.
Set the number of transaction sets to process at a time within a group in the Transaction sets Process Count text box, default is 2000.
Set the number of concurrent processes that can run at a time in the Concurrent Processes text box, default is 1.
Click Next - On the Create Process Flow window, provide a unique process flow name and description, and click Continue.
- A file - startPD.jnlp will get downloaded to your computer. Double-click to open the Process Flow Designer.
- Now, create a Process Flow as per your requirements.
Click Next to select the activities.
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.
Name Description Process Step List of activities used in the process flow. Base Type Type of activity - source, layout, mapping, and so on. Trigger/Action Shows 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. Click Next to define the parameters.
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.
Parameter Name Description Group Title Unique name to identify a group. Parameter Name Name of the parameters of the group. Parameter Type Type of the input parameter to be received from the Partner. Provide Input Options List of options for combo and radio button parameter type. - Click Next to define the values of the Template parameters. This screen appears only if you have provided Template Parameters in the previous step.
Click Next to select the Source application.
Select the type of sequence checking from the Sequence Checking drop-down list. Following are the available options:
Option Name | Description |
|---|---|
None | No sequence checking is done on the control number. |
Duplicate | Duplicate means inbound document contains duplicate control numbers. If you select this option then control numbers of inbound messages should not be duplicated. In case control number is duplicated then the inbound message is not processed and an error message is generated in the EDI Interchange inbound log. |
Incremental | Incremental means control numbers should be in the incremental order. If you select this option then control numbers of inbound messages should be in the incremental order. In case control number of any message is not in the incremental order then the inbound message is processed but a warning message is generated in the EDI Interchange Inbound Log. |
Chronological | Chronological means control number should be greater than the previous control number. If you select this option then control numbers of inbound messages should be in the chronological order. In case control number of any message is not in the chronological order then the message is processed but a warning message is generated in the EDI Interchange Inbound Log. |
Expand Group Properties.
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 follow the guidelines for creating a Process Flow for a Custom Template. Click here to view the guidelines. |
Next Step
...