Overview

The ConfigBot for ServiceNow Integration Document enables users to efficiently reverse, analyse, and compare integration configurations across ServiceNow instances. The module supports key integration components, including Connection & Credential Aliases, Connections, Step Instances, Connection Attributes, SOAP Messages, SOAP Message Functions, SOAP Message Imports, REST Messages, REST Message Headers, SOAP Variable Substitutions, HTTP Methods, HTTP Headers, HTTP Query Parameters, and REST Variable Substitutions.  
This module provides a centralized way to review and identify configuration differences across these integration components, eliminating the need to manually navigate through multiple ServiceNow screens and records. Additionally, the module enables users to compare different iterations seamlessly, helping them quickly identify missing, modified, or inconsistent integration configurations without manual effort. 

1. Log in to ConfigBot 

Enter your username and password, then click Submit to access the portal.

2. Access the Integration Document Module 

From the Home Screen, click on the Integration Document Module tile

3. Select a Workspace / or create new Iteration & Set Config to fetch records 

Choose the workspace that best fits your needs, or Click the Add Iteration button

• Enter the Iteration Number 
• Select the Workspace 
• Enter Host Address 
• Choose the Instance Type 
• Enter your Company ID and Username 
• Add a short Description  
• Then click Submit to create the iteration. 

Once the iteration is created, open the workbook and navigate to Config Sheet and select filter type, in fig below, I have selected fetch All filter type so it will fetch all records present in the instance

You can also select other filter type  

• Fetch All: will fetched all the records from the instance 
• Fetch All, except these: will fetch all records except those that are mentioned in the next column. 
• Fetch Only: will fetch the records that are mentioned in the next column. 
• Fetch Active Only: will only fetch active records. 
• Fetch In Active Only: will only fetch inactive records. 
• Fetch By Query: will only fetch records that are associated with the query 

Or you can use the Dependent Functionality by selecting "Yes" in Column B "Dependent"

When Dependent is set to Yes, records are fetched based on their parent record. This ensures that only the child records associated with the selected parent configuration are retrieved. 
Dependency Relationships: 
SOAP Messages → Records are fetched using the configured filter.  

• SOAP Message Functions → Records are fetched based on the related SOAP Message records.  
• SOAP Variable Substitutions → Records are fetched based on the related SOAP Message records.  

REST Messages → Records are fetched using the configured filter.  

• REST Message Headers → Records are fetched based on the related REST Message records.  
• HTTP Methods → Records are fetched based on the related REST Message records.  
• HTTP Headers → Records are fetched based on the related REST Message records.  
• HTTP Query Parameters → Records are fetched based on the related REST Message records.  
• REST Variable Substitutions → Records are fetched based on the related REST Message records.  

Connection & Credential Alias → Records are fetched using the configured filter.  

• Connection Attributes → Records are fetched based on the related Connection & Credential Alias records.  
• Connections → Records are fetched based on the related Connection & Credential Alias records. 

4. Generate Workbook 

Once the Config is set, close the workbook and go back to workspace and click on the Hamburger Menu and select Generate Workbook. 
In the pop-up window: 

• Enter your ServiceNow instance password 
• Add any execution notes 
• Select the checkbox for Select All 

Then click Confirm and Start to prepare sheet.

5. Review Results 

Once the status shows Complete, 

open the generated workbook, and navigate to each sheet to see the data is backfilled successfully from the instance 

Now for Compare two workbooks to see the difference across multiple instance  

6. Compare Workbook 

Back to workspace and click on the hamburger menu icon of the iteration that you want to compare and click on Request Reprocess. 

Again click on the hamburger menu icon and this time select Compare Iteration

In the pop-up window: 

• Select the iteration that you want to compare your current iteration against 
• Write any execution notes 
• Click Confirm and Start button 

Once the status shows complete, open the workbook and navigate to each sheet to see the changes

You can notice highlights across multiple tabs: 

• Red Highlights → Indicate differences between the two iterations. 
• Green Highlights → Indicate matching values across both workbooks. 

These color-coded results allow you to instantly identify what has changed or remained consistent between the two ServiceNow instances. 

Navigate to the “Compare Summary” Sheet

This screen provides a quick and reliable way to validate data consistency between environments. Instead of manually inspecting records, you can visualize differences and matches in a structured tabular form. 

Thanks for using ConfigBot!

Updated on: 08/25/2026