Defining a Custom Outbound Source Application
- Ankit Gandhi (Unlicensed)
- Shruti Pasayat
- 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.
However, depending upon the routing type you chose while defining the template list of available apps will vary:
For Content Based Routing: Box, Dropbox, Email, FTP, File, Google Drive, REST WebHook, SOAP WebHook, JMS, Database
For Context Based Routing: Box, Dropbox, Email, FTP, File, Google Drive, REST WebHook, SOAP WebHook (as context based routing needs file names, these are the applications that support file transfer).
No Routing: All apps
The next screen differs depending on the chosen Source application.
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 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.
Click Next.
On the Choose Trigger screen, select the trigger event to trigger the data transfer and click Next.
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.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 in the Action on Misfire Event field. 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 field 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.
Select 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 in the Connector field.
Click Next to define the Routing Criteria. This is applicable only if you have selected context based routing as a Routing Type.
Select the routing criteria based on which different data files will be sent to the Partners.
On the Routing Criteria screen:
Select the file name in the Criteria field.
Select the type of condition in the Condition field.
Enter the parameter name in the Parameter field.
Select the Ignore Case check box if you want the search to be case insensitive.
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 field 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_transactionNameSelect the type of access policy in Access Policy field. 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.
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. in the Schema Type field. 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.
Repeat all the above steps to define the subsequent source application(s). You can also allow your Partner to define this step or all steps of the application by clicking Partner will define this step check box. The Partner will define this step while creating a Transaction using this Template.
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.
Next Step
