Defining a Custom Partner to Partner Exchange Source Application
- Saurabh Gupta (Unlicensed)
- Rohan Dhanwade (Deactivated)
After you have provided the definition of the Template, the next step while creating a Template is to define the Source application. A Source application is an application from where data is received. After defining the Source application, you must choose a Trigger.
A Trigger is an event that initiates the data exchange. For example, in an FTP Source application, if you choose On File Created as a trigger, then data exchange will initiate when the new file is created to the source FTP.
You need to define and configure all the source applications if the Process Flow has multiple source activities. Following are the steps to define and configure the Source application. Follow the same steps to configure other source applications.
To select and configure the Source application of the Template:
Select the Source application and click Next.
If you are using REST WebHook application then you can also test this application on your REST Client by clicking
> Copy URL option after activating the Template.The list of applications differs depending on the routing type (Context based or Content based).The next steps differ depending on the chosen Source application.Select the Network of the Partner who is sending data to the Partner. Only Partners of the selected Network are allowed to access this Template and can send a file.
Select the checkbox Allow Import Partner(s) which allow you to select a Web Form to import Partners while configuring the Transaction.
Uncheck the Partner will define this step (if checked) checkbox and then select the Source application account. You can click Test to test the connection to your account.
You can either use an existing account or create a new one. Click
to add a new account. For information on how to add an account, refer to Appendix C: Supported Applications.You can also allow the Partner to define this step by clicking Partner will define this step check box. The Partner will define this step while Creating a Transaction using this Template.
In case you have selected Content/Context based routing then only company can define this step.
Click Next.
Select the trigger from the drop-down list and click Next.
The list of triggers differs for chosen Source application. For the complete list of triggers of the supported applications, refer to Appendix C: Supported Applications.
Click Next to add the configuration details.
Provide the configuration details of your account.
You can allow your partner to define this step by selecting Partner will define this step check box. Partner will define these steps while Creating a Transaction using this Template.In case you have selected Content/Context based routing then only company can define this step.If you are defining this step then for FTP or DropBox applications only, you can define the folder location using Partner parameters in the following format:
$$Partner.{PartnerParameterName}$$
where,
PartnerParameterName is the name of the parameter that you have configured for the Partner.
Ensure that you have configured the specified parameter for the Partner for which you are creating this Template.
Field Name
Description
Folder Location Folder location from where to pick files. Process all the existing records/files To process all the existing files from the specified location. Send mail notification for no data on trigger Selecting this option will send the mail notification whenever there is no data found on trigger. Send mail notification for error on trigger Selecting this option will send the mail notification whenever there is an error on trigger. Delete file on success Delete the file once it is processed. File type File format to process the files. Multiple file formats are separated by a comma. Use *.* to process all file formats. File exclude Type the file format to exclude the file type while transaction is running. Multiple file formats are separated by a comma. For example if you want to exclude text files from the FTP location, type .txt in the text box. Trigger Type You can set trigger through POLLING and CRON EXPRESSION.
POLLING: The time interval during which the Transaction triggers. By default, Transaction triggers after every 10 minutes. Select No polling option to trigger Transaction manually.
CRON EXPRESSION: Define the specific time schedule for the Transaction to trigger. For more information on how to define Cron Expression, click here.
File Stable Time You can set file stable time in the text box and select time unit from the drop-down list. This option is applicable for On File Created and On File Modified Trigger Type. The trigger will wait for the specified time for the file to become stable. For example, if you choose 30 Seconds in the stable time then system will wait for 30 seconds for the file to go stable before it triggers the transaction.
The Source application account and configuration details screen differ depending on the chosen Source application.
Expand Other Settings and provides the detail.
Select Trigger in Sequence check box to trigger the Transaction in sequential manner. If you do not select the Trigger in Sequence check box then the associated Transaction will trigger concurrently.
If you want to enable misfire handling for your file event then, select the Run Once option from the Action on Misfire Event drop-down list. If you do not wish to enable misfire handling for your file event then, select the Ignore Misfire option. For more details, refer to Handling Misfire Event.
The Run Once option will run only one collective instance of all the misfires for a particular event. Whereas the Ignore Misfire option will not run a misfired event.
The default value for Action on Misfire Event field is set to Run Once for all of the earlier events.The Connector drop-down lists the APIs to connect to the FTP Server. The options changes as per your selection of the protocols that you want to use to establish FTP connection.
Protocol
Options
FTP
Native
Secured Inet FactorySFTP
J2SCH (VFS)
Secured Inet Factory
J2SSHFTPS
J2SCH (VFS)
Secured Inet FactorySelect Verbose check box, if you want to create a log file of your FTP activity. This check box is enabled only if you select Secure Inet Factory from the Connector drop-down list box.
Click Next to select the routing criteria. This screen appears for Context Based routing.
Select the routing criteria based on which different data files will be sent to the Partners.
Criteria Condition Parameter Currently, only File Name is supported. A condition to filter the files.
Equals: Select this option to allow your Partner to provide the exact file name with its extension.
Contains: Select this option to allow your Partner to provide any part of the file name.
A variable name for the specified condition. For example, here in the example, cust_id is specified as a variable name. The Partner needs to specify the value for the variable name (cust_id) at the time of creating a Transaction. Suppose, the value specified is CUST147. When the Transaction will execute, it will fetch all the records containing CUST147 such as CUST14789.txt, CUST1478.xls, CUST147.docx.
If you have specified Equals in the Condition drop-down list then Transaction will fetch all the records containing CUST147 only such as CUST147.txt, CUST147.docx.
Click Next to select the source layout and format. This screen appears only if you have selected a file application, for example, FTP, Google Drive or REST WebHook application.
Select the source data format and source data layout for the Source application. Source data format is the format in which the data of the source file exists, for example, text, excel. Source data layout is the layout of the source file. You can either use the existing layout or create a new layout. To create a new layout, click
. For more information, refer to Layouts. 
You can also allow the Partner to define this step by clicking Partner will define this step check box. The Partner will define this step while creating a Transaction using this Template.
Once you select this option, you need to follow the steps given below:
Select Auto generate layout name and description checkbox if you want to auto generate the activity name and description while creating the Transaction. You can not change the automatically generated name and description.
The defined format of the auto generated name and description are explained below:
Name : Layout_transactionId_sequenceId
Description : Layout_transactionNameBy default, this checkbox is enabled for Create New and Select from the List or Create New policy and disabled for Default policy.- Select the type of access policy from the drop-down list. It helps the user to define the policy to displays the activity at the time of creating the transactions by another user of the same partner. The following policies are:
- Default Policy : Using this policy, user can view all layouts and also can create a new layout while creating a Transaction.
- Create New : User can only create a new layout while creating a Transaction. No layout is displayed from the drop-down list of layout field.
- Select from the List or Create New : Using this policy, user can create a new layout or user can define a custom list of layouts which will appear at transaction end.
You can select the type of schema like Text, Excel, etc. from the drop-down list of Schema Type. You can also search the schema from the Search box.
Click Next to define the subsequent source application. This screen appears only if the Process Flow is using multiple source applications.
You can choose from the following applications only - Database, Email, FTP, File, and JMS.Repeat all the above steps to define the subsequent source application(s).
Click Next to provide the definition of other activities, if any.
The next step differs depending on the selected process flow. If the process flow has content based routing activity then in the next step, you need to define the routing else define the Destination application.