Mastering Document Tracking In Boomi

Overview

Document Tracking lets you designate specific pieces of information within your processed documents as searchable tags, enabling you to easily locate and monitor those individual documents within Process Reporting, which is particularly valuable for following a single transaction or record as it moves through your automated workflows.

Think of Document Tracking as creating custom search labels for your business documents within your automated processes. For example, if you’re processing sales orders, you could designate the “Order Number” and “Customer ID” as Tracked Fields. Then, if a customer calls asking about order number “SO-1234“, you can quickly search for that specific order in Process Reporting and see exactly where it is in your system and what steps have been taken.

How document tracking works?

Document Tracking works by allowing you to select specific pieces of data within your business documents as they are being processed and then making that data searchable and viewable in a reporting or monitoring tool. Here’s a step-by-step breakdown of how it typically works:

Step 1: Configuration – Identifying Key Data Points

• You identify crucial data fields: You determine which pieces of information within your documents are most important for tracking and troubleshooting. This could be things like order numbers, customer IDs, invoice numbers, transaction IDs, shipment tracking numbers, etc.
• You configure your integration platform/tool: Within the settings of your integration platform (like an iPaaS – Integration Platform as a Service), you specify which connector operations (the specific actions your integrations take, like sending data to an application) should have Document Tracking enabled.
• You define the Tracked Fields: For each enabled connector operation, you tell the system where to find the specific data points you identified in the first step. This usually involves:
  • Selecting the data source: Indicating whether the data is in the input to the operation, the output, or perhaps within a specific document structure (like a JSON or XML payload).
  • Specifying the data path: Providing the exact location of the desired data within the chosen source. This might involve using expressions or paths (like XPath for XML or JSON Path for JSON) to pinpoint the field.
  • Assigning a name to the Tracked Field: Giving each tracked data point a user-friendly name that will appear in your reporting tool (e.g., “Order Number”, “Customer ID”).

Step 2: Accessing and Utilizing Tracked Data in Reporting

• You access the Process Reporting tool: You log into your integration platform’s reporting or monitoring interface.
• You can search and filter by Tracked Fields: The reporting tool allows you to search for specific process executions based on the values of your Tracked Fields. For example, you can search for all executions where the “Order Number” is “SO-1234“.
• You can view Tracked Field values: When you examine a specific process execution in the reporting tool, the values of the Tracked Fields that were captured during that execution are displayed.

 

How to Configure

In this example we will show how to configure Document Tracking to capture the “OMS_ORDER_ID” value when syncing Orders from OMS to Snowflake.

Step 1: Define Tracked Fields

Note: Before proceeding further you will need to have Account Administration privileges to manage Document Tracking. To define a new Tracked Field in your Boomi Platform account.

1. Open Boomi Platform https://platform.boomi.com/
   2. Provide Necessary Credentials i.e., Username and Password
   3. Select service as Integration
   4. Navigate to Settings > User Information > Document Tracking
   5. In Document Tracking click on (+) sign add new field
   6. Provide the Field Label and select the Data Type.
   

 

Step 2: Configure Tracked Fields In Connection Operations

1.Open Connector > Operation > Tracking > Add New Tracked Filed

1. Add the “OMS_ORDER_ID” Tracked Field as shown by the above picture
2. Set the value to populate the Tracked Field by selecting the “Name” field from the response JSON profile, which is shown on the operation’s Options tab.
3. Save the operation.

Step 3: Process Reporting: Check Execution Details

Deploy and run the process, then navigate to Process Reporting to review the execution details.

Here are the steps to follow in order to do that

1. Navigate to Manage > Process Reporting and find the populate result in Executions
2. Click On Execution > Select Past hour > 24 Hours> Date Range > Filter By Process Under Add Filter

Step 4: Process Reporting: Search Through Documents

1.Look Find a specific Tracked Field value throughout all documents and executions.

2. Navigate To Documents > Filter By Hour > Add Filter > Tracked Fields >
   Add Tracked Field > User Defined as Source Type > Property > Choose Specific ID
   
3. Documents matching the Tracked Field search term are displayed across connector operations and process executions in the results.

Conclusion:

In conclusion, Document Tracking in Boomi is a powerful tool for efficiently monitoring and managing business documents throughout automated workflows. By designating specific data points as Tracked Fields, you can quickly search, filter, and view critical document information in the Process Reporting interface. This enables seamless tracking of transactions such as order numbers or customer IDs, making it easier to troubleshoot and gain insights into your processes. The steps outlined above provide a comprehensive guide to configuring and utilizing Document Tracking, from identifying key data fields to reviewing execution details in the reporting tool.

If you have any questions or need further assistance, feel free to reach out to me.