Configuring and Using the Template
August 2017 - Applies to DSP 6.6.1 and above
To allow the DSP to monitor the execution of Boomi processes it triggers from Collect, Integrate or Page Events, processes should be built using the Syniti Connect Template. The template contains steps that write status data to a table which the DSP monitors.
The Syniti Connect template will be deployed to your Boomi account by the Syniti Connect provisioning team, if it is missing contact email@example.com.
The template is called IG Universal Connect 1.0 Template and is located in a folder called Process Templates.
Configuring the Template
The delivered template must be configured to use a DSP database connection before it can be used. As Syniti Connect is licensed by connections, it is cost-effective to use a connection that will be used to connect to a DSP database (dg*, sdb*, dsw*, dge*) in the template. Any DSP database connection can be used in the template if the database user configured in the connection has the correct permissions on the Syniti Connect interface table.
To configure the connection follow the steps below.
1. Create a new database connection. The connection can be configured to reference any DSP project database.
2. Ensure that the User Name configured in the database connection has permissions to INSERT and UPDATE the table DSPCommon.dbo.ttBoomiExecution.
3. In the template, open the Program Command Shape labeled Update DSP with ExecID and choose the database connection created in the previous steps. Click OK.
4. Open the remaining 2 Program Command Shapes and choose the same database connection.
5. Save the template.
Testing the Template
Once the database connection has been configured in the 3 Program Command shapes, the template should be tested. When a process is executed by the DSP it passes a LinkID parameter in a dynamic process property. To test the process from the build tab, we can simulate this behaviour, as shown below.
1. Check the contents of the status table. To do this, create a new query in SQL Server Management Studio and execute the following command
select * from DSPcommon.dbo.ttBoomiExecution
Assuming this is a new DSP installation, there will be no rows in the table.
2. Generate a new LinkID by executing the following command
3. Copy the generated value and switch back to Boomi.
4. Execute the process in Test mode. Select an Atom with connectivity to the SQL Server hosting the DSP, paste the generated value as the value for the Dynamic Process Property called LinkID, and click Run Test.
5. Switch back to SQL Server Management Studio and execute the following command
select * from DSPcommon.dbo.ttBoomiExecution
If a row now exists with a LinkID value matching the one used, the test was successful.
Using the Template
Once the template has been successfully tested, it is ready to use. When building processes that will be invoked by the DSP via Collect, Integrate or Page Events, replicate the template for each new process and add specific process logic in the Try path, as shown below.
1. In the component explorer, navigate the folder structure to the Process Templates folder
2. Click on the arrow preceding the process IG Universal Connect 1.0 Template and select Copy from the context menu
3. In the Copy Component dialog box, leave the Copy to Account as the current account, Copy Passwords Across All Accounts will be disabled, important - uncheck Copy Component Dependents, and select a Destination Folder.
4. Click OK to duplicate the template.
5. Navigate to the selected destination folder and open the new process. It will be be called IG Universal Connect 1.0 Template. If a process with the same name already exists in the folder, it will be suffixed with a number.
6. Rename the process and give it a suitable name, for example prefixing it with INT for an Integrate process, or COL for a Collect process. See the KB article Syniti Connect Best Practices for process naming recommendations.
7. To add your specific content to the process, disconnect the Try path and add the required shapes.
In the example below, we added 3 shapes to extract data from Salesforce, map it to a database profile, and insert the data into a DSP table.
NOTE: Refer to the KB article Boomi Data Profile Generates Invalid SQL for a workaround that you may need.
8. If you are passing parameters from the DSP into a process, they can be exposed for information and debugging by adding them to the Notify shape labeled Write DSP Parameters.
9. Save the process.
10. Once tested, deploy the process. It is now ready to be invoked from the DSP.