FAQ and Troubleshooting
Version Information
- Application Version: 2.0.0
- ServiceNow Compatibility: Certified for Yokohama and Zurich versions.
Table of Contents
- Installation Issues
- Guided Setup Issues
- I'm getting a blank page when attempting to run the Guided Setup
- I'm missing some plugins and don't have a license for them
- What's the purpose of the HTTP(s) connection record?
- Both our NetBox and ServiceNow instances are in the cloud but we have a MID server on-premises, when should I configure it in Guided Setup?
- The connection test keeps failing, how do I troubleshoot connections?
- Application Parameters
- What are the important Application parameters to know about initially?
- How can I tell the application to increase the logging level?
- How do I configure how NetBox Tenants are imported?
- What are the NetBox Tenant Group ID parameters used for?
- How do I add custom CI classes to the NetBox integration?
- What's the difference between Sites, Regions, and Locations in NetBox?
- What is the nbk parameter for?
- Data Synchronization
- Data is not getting synchronized from ServiceNow to NetBox (export)
- Data is not getting synchronized from NetBox to ServiceNow
- I have objects in NetBox that are tagged with both ServiceNowSyncTo and ServiceNowSyncFrom, why is that?
- How do I pause synchronization between systems, one way or another?
- How do I cancel synchronization between systems, one way or another, for example if it's overly long?
- I'm getting duplicate records in ServiceNow or NetBox
- Can I backup and restore NetBox configuration and data included in ServiceNow?
- Why is my data restore failing or skipping most records?
Installation Issues
Are there any known issues with the current version?
Each release may have known issues that are documented along with workarounds and resolution plans.
Where to Find Known Issues:
- Known Issues Document: Check the dedicated Known Issues document for detailed information about current issues, their impact, and workarounds
- Release Notes: Review the Release Notes for version-specific known issues listed under each release
- Version-Specific Information: Issues are organized by version number, so check the section corresponding to your installed version
When to Check:
- Before installing or upgrading the application
- When encountering unexpected behavior during installation
- When troubleshooting integration issues
- After reviewing this FAQ if your issue isn't covered
Important: Some known issues may have specific workarounds that differ from general troubleshooting steps. Always check the known issues documentation before attempting other solutions.
What can I check to see that installation went well?
Verification Checklist:
- Application Menu: Verify "NetBox" application appears in the application navigator
- Tables Created: Check that new tables are present, for example:
x_nbl_cmdb_netbox_attributesx_nbl_cmdb_device_types_import_setx_nbl_cmdb_devices_import_setx_nbl_cmdb_netbox_locations_import
- No Extended Fields on Base Tables: Verify the integration does not add custom NetBox fields to base tables like
cmdb_ciorcmn_location. NetBox metadata is stored inx_nbl_cmdb_netbox_attributes(1:1 byrecord_sys_id). - Guided Setup: Access All > NetBox > Configuration > Guided Setup successfully
- No Critical Errors: Check system logs for any critical errors during installation
What new tables are included with the application?
Import Set Tables:
x_nbl_cmdb_devices_import_set- NetBox devices stagingx_nbl_cmdb_device_types_import_set- NetBox device types stagingx_nbl_cmdb_netbox_sites_import- NetBox sites stagingx_nbl_cmdb_netbox_regions_import- NetBox regions stagingx_nbl_cmdb_netbox_locations_import- NetBox locations stagingx_nbl_cmdb_netbox_clients_import- NetBox tenants/clients stagingx_nbl_cmdb_netbox_departments_imports- NetBox departments stagingx_nbl_cmdb_netbox_manufacturers_import- NetBox manufacturers staging
Configuration and Queuing:
- Parameters: Stored as scoped entries in the native ServiceNow
sys_propertiestable (managed via All > NetBox > Application parameters - menu categories Export, Import, Synchronization Defaults, System) - Webhook queue: Stored as native ServiceNow events in the
syseventtable (event namex_nbl_cmdb.webhook_received) and processed by a script action
Under which license should I subscribe the new tables?
Licensing Guidance:
- Import Set Tables: These are typically covered under the base ServiceNow platform license as they are temporary staging tables
- NetBox Attributes Table: This table would usually be licensed under the ITSM allotment, but can be included wherever some allotments remain
Recommendation: Consult with your ServiceNow account manager for specific licensing questions, as requirements may vary based on your ServiceNow contract and usage.
Guided Setup Issues
I'm getting a blank page when attempting to run the Guided Setup
Quick Resolution: This is a known issue. See the Known Issues document for the detailed workaround procedure.
General Troubleshooting (if the documented workaround doesn't apply):
- In most cases, if the Guided Setup doesn't start, the Workflow Studio and/or the Playbook Experience plugins are at an older version
- Make sure you update the plugins to the versions stated in the installation guide (see Installation and Setup)
- If you updated your plugins after initially starting the Guided Setup, you will need to perform these steps to reinitialize it:
- With Admin privileges, navigate to All > Adoption Services > Guided Setup
- Depending on your ServiceNow and Guided Setup versions, select either Build your guided setups or Go to Guided Setup Builder
- Open the NetBox Labs CMDB Integration Setup for edition
- Without doing any changes, finalize the Guided Setup and finish the procedure. This should reset the NetBox Guided Setup to a working state
I'm missing some plugins and don't have a license for them
Required Plugins:
- Essential Plugins (Required):
- IntegrationHub Starter Pack
Resolution Options:
- Contact ServiceNow: Request licensing for required plugins through your ServiceNow account manager
- PDI Users: Activate plugins through the PDI configuration screen
What's the purpose of the HTTP(s) connection record?
Purpose and Importance:
- Application Package: The NetBox API HTTP(s) connection is delivered with the NetBox Labs CMDB Integration application. Guided Setup updates it with your NetBox URL (and you add MID settings if needed); you do not create it from scratch unless you are recovering manually.
- API Communication: Establishes the connection between ServiceNow and your NetBox instance
- Authentication: Stores connection parameters and credential references
- MID Server Support: Configures routing through MID servers if required
- Standardization: Uses ServiceNow's standard HTTP connection framework for reliability
Key Requirements:
- Name: Must be exactly "NetBox API" (serves as a key for the application)
- Connection Alias: Must be
x_nbl_cmdb.NetBox_API - URL Format: Must not include trailing slash
Both our NetBox and ServiceNow instances are in the cloud but we have a MID server on-premises, when should I configure it in Guided Setup?
Recommendation:
- If both instances are in the cloud, direct communication is typically possible and no MID server is necessary
- MID server configuration should only be used if network policies require it
- Configure Use MID on the NetBox API HTTP(s) connection when you need it, before Test Connections and Credentials (see Installation and Setup - Step 6 and Step 15), not as a separate numbered "optional phase" after setup
Decision Factors:
- Network Policies: Check if your organization requires all API traffic to route through the MID server
- Security Requirements: Some organizations mandate MID server usage for all external connections
- Performance: Direct cloud-to-cloud communication is typically faster
Testing Approach: Try without the MID server first, then enable MID on the NetBox API connection and re-run Test Connections and Credentials if tests fail.
The connection test keeps failing, how do I troubleshoot connections?
- Credential Records Not Properly Associated with the API Key
- In Guided Setup, credential association to the HTTP(s) connection is normally automated after you create the ServiceNow-to-NetBox API token (see Installation - Steps 7-9). If your instance skipped that or tests fail, navigate to All > NetBox > Configuration > Connection and Credentials and open the NetBox API HTTP(s) connection record from the related list. Confirm the Credential field references NetBox API Token, then save
- Re-run Test Connections and Credentials after fixing the association
- Note: Every time you restart a Setup Credentials for... step, passwords and keys are reset to random new values. Make sure you take note of them again before saving
-
Verify Basic Connectivity
- Check for firewall restrictions between instances
- Verify DNS resolution of NetBox hostname
-
Check API Token Format
- Ensure API token is exactly 32 hexadecimal characters
- Verify token is active in NetBox
- Verify that the token in NetBox is associated with a user with sufficient privileges
- Test token manually using curl or Postman with a simple API call, for example:
curl -X 'GET' 'https://YOUR-NETBOX-INSTANCE/api/dcim/sites/' \
-H 'accept: application/json' \
-H 'Authorization: Token YOUR-NETBOX-API-TOKEN'
-
Validate Connection Record
- Confirm connection name is exactly "NetBox API"
- Verify URL has no trailing slash
- Check credential association is correct
-
Review Network Configuration
- Check MID server configuration if applicable
- Verify proxy settings if required
- Test from ServiceNow's network diagnostic tools
-
Check Logs
- Review ServiceNow system logs for detailed error messages
- Check NetBox logs for incoming connection attempts
- Look for authentication or authorization errors
-
Restart Guided Setup
- Try running the Guided Setup again, making sure you note all usernames, passwords and API tokens as you go
Application Parameters
What are the important Application parameters to know about initially?
Critical Parameters for Initial Setup:
| Parameter | Purpose | Default Value |
|---|---|---|
| NetBox Log Level | Controls application logging verbosity | Medium |
| API user in NetBox | Username for ServiceNow → NetBox API calls | servicenow_integration |
| API user in ServiceNow | Username for NetBox → ServiceNow API calls | netbox_integration |
| Import [ObjectType] | Enable/disable synchronization from NetBox to ServiceNow (import direction) for specific objects | false |
| Export [ObjectType] | Enable/disable synchronization from ServiceNow to NetBox (export direction) for specific objects | false |
Navigation: Parameters that appear on the Application parameters menu are reached via All > NetBox > Application parameters > Export, All > NetBox > Application parameters > Import, All > NetBox > Application parameters > Synchronization Defaults, or All > NetBox > Application parameters > System (see User Guide, Application parameters). API user settings and other scoped properties not on those screens are documented under Additional Parameters and are edited from System Definition > System Properties with the Application filter set to this integration.
How can I tell the application to increase the logging level?
Steps to Increase Logging:
-
Go to All > NetBox > Application parameters > System
- Find the NetBox Log Level parameter
-
Available Log Levels (case insensitive):
- Low: Basic operational messages
- Medium: Moderate detail including warnings (default)
- High: Detailed debug information
-
Change Log Level
- Edit the "NetBox Log Level" parameter
- Set value to "High" for maximum detail
- Save the parameter
-
View Logs
- Check All > NetBox > Maintenance > NetBox Logs for NetBox-related entries (see Technical Information, Logging)
How do I configure how NetBox Tenants are imported?
Quick Configuration:
- Navigate to All > NetBox > Configuration > Setup Tenant Usage
- Select one of the following options:
- Both: Import and export tenants as both Customers and Departments. REQUIRES Tenant Group IDs to distinguish between them.
- Customers only: Synchronize tenants only as Companies (customers). Tenant Group ID ignored.
- Departments only: Synchronize tenants only as Departments. Tenant Group ID ignored.
- None: Disable tenant synchronization entirely.
Important:
- When selecting "Both", you MUST configure Tenant Group IDs in Application Parameters. This is how the application distinguishes which NetBox tenants should become Customers vs Departments in ServiceNow.
- When selecting "Customers only" or "Departments only", Tenant Group IDs are ignored.
Navigation: All > NetBox > Configuration > Setup Tenant Usage
What are the NetBox Tenant Group ID parameters used for?
Purpose: These parameters control how NetBox tenants are mapped to ServiceNow organizational structures.
Key Parameters:
- NetBox Tenant Group ID for Customers: Specifies which NetBox tenant group contains tenants that should map to ServiceNow customer companies when "Both" is selected in Setup Tenant Usage
- NetBox Tenant Group ID for Departments: Specifies which NetBox tenant group contains tenants that should map to ServiceNow departments when "Both" is selected in Setup Tenant Usage
Usage Requirements:
- MANDATORY when "Both" is selected in Setup Tenant Usage: Required to distinguish which tenants become Customers vs Departments
- IGNORED when "Customers only" or "Departments only" is selected
- NOT USED when "None" is selected
Behavior:
- Import: Tenants will be imported into ServiceNow as Customers or Departments according to their tenant group
- Export: ServiceNow records are assigned to these tenant groups in NetBox
- Format: Integer value representing the NetBox tenant group ID
Configuration: Set these parameters manually in the Parameters table or use All > NetBox > Configuration > Setup Tenant Usage for guided configuration.
How do I add custom CI classes to the NetBox integration?
Steps to Add CI Classes:
-
Navigate to Class Management
- Go to All > NetBox > Configuration > Class Management
-
Select CI Classes to Register
- Browse available CMDB CI classes from the ServiceNow database
- Select one or more classes you want to integrate with NetBox
- Recommendation: Register up to 6 classes at a time for optimal performance
-
Register the Classes
- Click the register/add button
- The application will automatically:
- Add the classes to the NetBox custom field choice list
- Configure the necessary synchronization rules
- Make the classes available for device mapping
-
Configure in NetBox
- In NetBox, edit or create devices
- Set the "ServiceNow CI Class" custom field to one of the registered classes
- Tagged devices will now be imported to the corresponding CI class in ServiceNow
Important Notes:
- Classes must be descendants of
cmdb_ciin the ServiceNow class hierarchy - Registration process may take a few moments for multiple classes
- Registered classes appear in the NetBox device custom field choices immediately
- You can register both standard ServiceNow CI classes and custom classes from your implementation
What's the difference between Sites, Regions, and Locations in NetBox?
Object Types:
Regions (NetBox and ServiceNow):
- Geographic or organizational groupings
- Hierarchical structure (regions can contain sub-regions)
- In ServiceNow: A
cmn_locationrecord is classified as a Region if:- Its NetBox Attributes record exists and has
nb_class = "region", OR - ServiceNow Location Type has a sequence number lower than the Site default, OR
- The location is positioned above a Site in the location hierarchy
- Its NetBox Attributes record exists and has
- Typically parents of Sites
Sites (NetBox and ServiceNow):
- Physical locations where equipment is installed
- Usually assigned to a Region
- In ServiceNow: A
cmn_locationrecord is classified as a Site if:- Its NetBox Attributes record exists and has
nb_class = "site", OR - ServiceNow Location Type matches or has the same sequence as the Site default location type
- Its NetBox Attributes record exists and has
- Contain devices and can contain Locations
Locations (NetBox concept):
- Sub-site physical locations (buildings, floors, rooms, racks)
- Hierarchical structure within a Site
- In ServiceNow: A
cmn_locationrecord is classified as a Location if:- Its NetBox Attributes record exists and has
nb_class = "location", OR - ServiceNow Location Type has a sequence number higher than the Site default, OR
- The location is positioned below a Site in the location hierarchy
- Its NetBox Attributes record exists and has
- More granular than Sites, used for detailed asset placement
Synchronization:
- All three types synchronize to ServiceNow's
cmn_locationtable - The
nb_classvalue inx_nbl_cmdb_netbox_attributesdistinguishes between them - Proper hierarchical relationships are maintained (Regions → Sites → Locations)
- Each has separate import/export parameters for control
Navigation in ServiceNow:
- All > NetBox > Synchronized Data > NetBox Regions: View regions
- All > NetBox > Synchronized Data > NetBox Sites: View sites
- All > NetBox > Synchronized Data > NetBox Locations: View locations
Configuration: Navigate to All > NetBox > Configuration > Setup Location Types for guided configuration
What is the nbk parameter for?
Purpose: The nbk parameter is a temporary administrative credential used during the Guided Setup process.
Details:
- Temporary Nature: Created during Guided Setup and automatically deleted afterward
- Elevated Privileges: Provides admin-level access to NetBox for configuration
- Security: Ensures only low-privilege accounts remain after setup completion
- Usage: Enables ServiceNow to configure NetBox settings during initial setup
Important: This parameter should not exist after Guided Setup completion. If it persists, it may indicate an incomplete setup process. If you think the setup has concluded normally, you can and should delete the parameter from the table.
Data Synchronization
Data is not getting synchronized from ServiceNow to NetBox (export)
-
Check NetBox Ready for Export and NetBox Ready Message fields
- On records that are not synchronizing, use the NetBox view to check the field values
- NetBox Ready for Export should be set to
true - If it is not, check the NetBox Ready Message for clues on why the field is not exporting
- If the record is not ready for export, an explanation outlining the cause will be provided
-
Check Synchronization Parameters
- Verify "Export [ObjectType]" parameters are set to
true - In ServiceNow, check that specific records have "NetBox Synchronize" field set to
true
- Verify "Export [ObjectType]" parameters are set to
-
Verify Connection Health
- Test API connectivity in both directions by navigating to All > NetBox > Maintenance > Test Connections
- Check credential validity and expiration
- Review HTTP connection record configuration
-
Review Flow Execution
- Check All > Process Automation > Flow Designer > Executions
- Look for flows in the NetBox Labs CMDB Integration application labeled as Create/Update NetBox [ObjectType]
- Look for failed or stuck flow executions
- Review error messages in execution logs
- Increase NetBox Log Level parameter if logs are not verbose enough
Data is not getting synchronized from NetBox to ServiceNow
-
Check Event Queue and Clear Cache
- If some objects were recently synchronized and you are trying again to import them, they may be stored in the Import Cache
- Navigate to All > NetBox > Maintenance > Event Queue and try finding the object in the list by filtering on Remote Object Type and Remote ID
- If the object figures in the cache, use the Clear Import Cache function in the same menu
- Note: Clearing the cache will not affect the import process but may impact performance if you are currently importing objects from NetBox in large quantities
-
Check tags in NetBox object
- On NetBox, verify that objects not being synchronized are tagged with ServiceNowSyncTo
-
Check NetBox logs
- Set the "NetBox Log Level" parameter to High
- Trigger the data synchronization again on the object by making a minor change to it
- Navigate to All > NetBox > Maintenance > NetBox Logs
- Filter logs on:
- [NetBox Notification API]: check that a log record was created for the modified object and that the record was processed (Notification received) and not ignored (Ignoring notification)
- [NetBox Notification Queue Processing]: check that the received event payload has values in all the expected fields
- [NetBoxSetup.rest]: check that a GET statement was issued for the object in question and that the response code is 200
- [Validate Remote Object]: check that the object validation was successful. Check the messages for clues about why it wasn't
-
Check Synchronization Parameters
- Verify "Import NetBox [ObjectType]" parameters are set to
true
- Verify "Import NetBox [ObjectType]" parameters are set to
-
Check the Buffer Data Sources
- Navigate to All > NetBox > Configuration > Data Sources
- Open the NetBox Buffer data source and check if it contains attachments. Refresh the record several times to see if the number of attachments starts decreasing after a while
-
Check the other Data Sources
- Navigate to All > NetBox > Configuration > Data Sources
- Open data sources other than Buffer
- Verify that data sources don't contain more than one attachment
- Delete all attachments if so and submit an incident report to NetBox Labs
-
Verify Connection Health
- Test API connectivity in both directions by navigating to All > NetBox > Maintenance > Test Connections
- Check credential validity and expiration
- Review HTTP connection record configuration
-
Webhook Configuration
- Verify NetBox webhooks are properly configured
- Check webhook URL points to correct ServiceNow instance
- Confirm webhook authentication credentials
-
NetBox Event Rules
- Ensure event rules are active in NetBox
- Verify event rules trigger on appropriate object changes
- Check event rule conditions and actions
I have objects in NetBox that are tagged with both ServiceNowSyncTo and ServiceNowSyncFrom, why is that?
The ServiceNowSyncTo Tag is a synchronization control tag that tells ServiceNow to proceed with importing the objects when a webhook is received to its API. It is basically a granular, record-level way of telling the application which records should be synchronized in the NetBox to ServiceNow direction, and which shouldn't (see User Guide, Synchronization Control).
On the other hand, the ServiceNowSyncFrom Tag is only an indicator that data for this record was sent by ServiceNow. It is not meant to act as a control and will have no effect if removed. In fact, it will come back as soon as a new export on that record is triggered in ServiceNow.
It is therefore possible for a record to have both tags if data flows in both directions.
How do I pause synchronization between systems, one way or another?
Temporary Pause Options:
Option 1: Disable Synchronization Parameters
- Navigate to All > NetBox > Application parameters > Export, All > NetBox > Application parameters > Import, All > NetBox > Application parameters > Synchronization Defaults, or All > NetBox > Application parameters > System
- Set "Import NetBox [ObjectType]" and "Export NetBox [ObjectType]" parameters to
falsefor affected object types - This stops all synchronization for those objects
Option 2: Record-Level Control
- Set "NetBox Synchronize" field to
falseon specific records - This provides granular control over individual items
Option 3: Connection Disruption (Emergency only)
- Modify HTTP connection record to invalid URL
- Remove or invalidate API credentials
- Warning: This may cause errors in logs
Resuming Synchronization:
- Reverse the changes made during pause
- Verify connection tests pass
- Monitor initial synchronization for any issues
Best Practice: Use Option 1 (parameter-based) for planned maintenance, as it's the cleanest approach and doesn't generate error messages.
How do I cancel synchronization between systems, one way or another, for example if it's overly long?
In the ServiceNow to NetBox direction:
- Navigate to Flow Designer
- Open all flows labeled "Create/update NetBox [ObjectType]"
- For each flow, go to Executions and cancel the ones that are pending
In the NetBox to ServiceNow direction:
- Navigate to All > NetBox > Maintenance > Event Queue
- Delete all records in the table
I'm getting duplicate records in ServiceNow or NetBox
Duplicate records can occur during synchronization due to various factors such as data inconsistencies or identification rule challenges.
Mitigation Steps:
-
Install and Configure the ServiceNow "Normalization Data Services" Plugin
- The plugin helps keep the Company (core_company) table free of duplicates by setting up aliases for company names (ex. Cisco Systems, Inc.) and normalize them all to the same value (Cisco)
-
Review ServiceNow Class Identification Rules
- In ServiceNow's CI Class Manager, ensure that the identification rules are aligned with your organization's data strategy (see Technical Information, CI Classification)
- By default, the NetBox Correlation ID sits at an order of 250, after serial number but before name identifiers
-
Review Correlation IDs
- Check that NetBox Correlation ID fields are properly populated
- Verify correlation IDs are unique and consistent between systems
-
Manual Cleanup
- Identify duplicate records
- Manually merge or delete duplicates as appropriate
- Document patterns for NetBox Labs support
Future Improvements: NetBox Labs is developing enhanced IRE rules and automated deduplication capabilities that will be included in future releases to minimize this issue.
Can I backup and restore NetBox configuration and data included in ServiceNow?
Yes, the NetBox Labs CMDB Integration application includes comprehensive backup and restore capabilities through the NetBoxDataUtils script include.
What Can Be Backed Up:
- Application Parameters: All NetBox configuration settings including log levels, import/export parameters, and tenant configurations
- Version 1.x Data: NetBox fields from base tables (devices, locations, companies, departments, product models)
- Version 2.x+ Data: All entries from the NetBox Attributes table
- Metadata: Backup date, version information, data model type, and record counts
Backup File Format:
- Unified JSON format compatible across NetBox Labs CMDB Integration versions
- Files are saved as timestamped JSON attachments on the record
NetBoxDataUtilsuses for storage (v1.x: NetBox Log Level; v2.x+: netbox_data_files / Manage NetBox Data), namednetbox_backup_<app_version>_<date_time>.json - Backups can be restored after application upgrades (same-instance operation)
Valid Use Cases:
- Configuration Backup: Regular backups of NetBox application parameters
- Instance Refresh Recovery: Restore configuration after ServiceNow instance refreshes
- Upgrade Support: Preserve data when upgrading application version
- Disaster Recovery: Maintain backup files as part of recovery procedures
- Same-Instance Operations: Any backup/restore within the same ServiceNow instance
How to Use:
- Backup: Call
NetBoxDataUtils.exportNetBoxData()via script or create a scheduled job - Restore: Call
NetBoxDataUtils.importNetBoxData(attachmentSysId)with the sys_id of the backup file attachment - Both functions return detailed result objects with success status, counts, and error messages
Important: See the detailed User Guide section on Backup and Restore for complete documentation, including critical limitations regarding cross-instance restores.
Why is my data restore failing or skipping most records?
If your restore shows "Parameters: 15, Records: 0, Attributes: 0" with many "Record not found for update" messages, you are likely attempting a cross-instance restore, which is not supported by design.
Understanding the Issue:
The NetBox Labs CMDB Integration backup/restore functionality is designed for use within the same ServiceNow instance only. It will fail when restoring data from one ServiceNow instance to a different instance.
Why Cross-Instance Restores Fail:
ServiceNow records are uniquely identified by their sys_id field (a 32-character hexadecimal string). These sys_ids are:
- Unique per instance: Each ServiceNow instance generates different sys_ids for the same logical record
- Non-transferable: A device with sys_id
abc123...in Instance A will have a completely different sys_id in Instance B - Required for restores: The restore function looks for records by sys_id to update them
What Gets Restored (Cross-Instance):
- Parameters: Successfully restored (matched by name, not sys_id)
- Table Data: Fails - records not found by sys_id
- Attributes: Fails - cannot associate with non-existent record sys_ids
Common Scenarios:
Works:
- Same instance after refresh (sys_ids remain identical)
- Immediately after instance cloning (before data divergence)
- Application upgrades within the same instance
Fails:
- Development → Production instance
- Test → Production instance
- Any transfer between independent ServiceNow environments
- Customer A → Customer B instance migration
Solutions for Cross-Instance Data Transfer:
If you need to move configuration or data between different ServiceNow instances, use these alternative approaches:
-
Manual Configuration Replication
- Document parameter settings and manually configure each instance
- Use Guided Setup for consistent baseline configurations
-
NetBox as Data Bridge
- Export data from Instance A to NetBox
- Import data from NetBox to Instance B using standard synchronization
- NetBox creates new records with appropriate sys_ids for each instance
-
Transform Maps with Business Keys
- Export data to CSV or XML format
- Use ServiceNow Import Sets with transform maps
- Match records by business identifiers (name, asset tag, correlation ID) instead of sys_ids
-
Custom API-Based Integration
- Develop integration between instances using ServiceNow REST APIs
- Match records using business identifiers
- Create or update records as appropriate for target instance
Error Messages:
"Record not found for update: [table_name] / [sys_id]"- Record exists in source but not in target"Skipped Records: [count]"- Number of records that couldn't be imported"Import completed. Parameters: X, Records: 0"- Only parameters imported
Best Practice: Always verify you're importing to the same instance that created the export. For cross-instance needs, use one of the alternative approaches listed above.
See Also: User Guide - Backup and Restore for complete documentation and detailed examples.