Exporting hierarchy process via JSON
Summarize
Summary of Exporting hierarchy process via JSON
This process enables ServiceNow customers to migrate models and templates between instances by exporting them along with all dependent data as a single JSON file. The export preserves system ID continuity, ensuring the records maintain their relationships and references when imported on the target instance. This method is recommended for reliable cross-instance migration of inventory models and templates.
Show less
Key Features
- Complete Hierarchy Export: The Export Hierarchy action generates a JSON file containing the selected record and its entire hierarchy, including all dependent reference data required for full functionality.
- Included Dependencies: The JSON export packages the selected model or template, dependent reference data such as manufacturer details, product information, classifications, and pricing data, as well as models referenced by inventory templates.
- System ID Preservation: System IDs are preserved between source and target instances, maintaining data integrity and relationships.
- Role-Based Access: Export permissions vary by role:
- Inventory Admin: Can export both models and inventory templates with their hierarchies.
- Catalog Manager: Can export models and their hierarchies.
- Template Manager: Can export inventory templates and their referenced models.
- Export Process: Initiated from a model or template record, the system collects all related and referenced records, packages them into a single JSON file attached to the export request record, which can then be downloaded once the export completes.
- Import Capability: The JSON file can be imported into a target instance via the Network Inventory Workspace, recreating the model or template hierarchy with all dependencies intact.
Practical Benefits for ServiceNow Customers
- Ensures seamless migration of complex inventory data across instances without losing relationships or references.
- Simplifies the export-import process by packaging all necessary records and dependencies into one JSON file.
- Maintains consistency and integrity of data by preserving system IDs during transfers.
- Enables role-based control over who can perform exports, aligning with organizational governance.
Learn how to migrate models and templates between ServiceNow instances by exporting them with all their dependencies as a single JSON file. The export preserve system ID continuity between source and target.
Exporting hierarchy via JSON overview
The Export Hierarchy action produces a JSON file containing the selected record and its complete hierarchy. This includes the dependent reference data the records require. You can import the JSON file on a target ServiceNow instance to recreate the hierarchy. System ID continuity is preserved between source and target.
Components in JSON file
A JSON export packages the selected model or template along with everything it depends on:
- Dependent reference data: Any records the model or template references, such as manufacturer details, product information, model classifications, and currency or pricing data.
- Inventory templates and their referenced models: When you export a template, the models the template depends on are included automatically
The dependent reference data is included because the models and templates can't function on the target instance without their references intact. For example, an exported equipment model for a Cisco router includes the Cisco manufacturer record. This ensures the imported model on the target instance keeps its manufacturer link.
Roles required for Export Hierarchy
The role required for JSON export depends on what's being exported:
| Action | Roles permitted | Result |
|---|---|---|
| Export a model and its hierarchy | sn_ni_core.inventory_admin or sn_ni_core.telco_inventory_catalog_manage | The exported JSON contains models, child records, referenced records and related records |
| Export an inventory template and its hierarchy (including its referenced models) | sn_ni_core.inventory_admin or sn_ni_core.inventory_template_manager | The exported JSON contains the templates, the model it references and the related recorde of both. |
Inventory admin can perform either action. Catalog Manager can export models. Template Manager can export templates and the models those templates reference.
How Export Hierarchy via JSON works
The JSON export process operates as a single-stage interaction. When you initiate the Export Hierarchy function from a model or template record, the system identifies the selected record together with all its related and referenced records. The system packages them into a single JSON file. The JSON file is generated as an attachment on the Export request record. After the export status shows Completed, you can download the JSON file from the right sidebar.
You can transfer the downloaded JSON file to the target instance. Load it using the JSON import feature in the Network Inventory Workspace. Importing the JSON on the target instance recreates the model or template along with its complete hierarchy. System ID continuity is preserved between the source and target.
This is why JSON export is the recommended path for cross-instance migration. The file contains everything needed for the records to function on the target instance, not just the records themselves.
To learn the step-by-step procedure for exporting a model or template hierarchy as JSON, see Import models and templates in JSON format.