Migrating Designer Configuration

To occasionally migrate data from one instance to another, you can export the XML data from one instance and import it to another.

To occasionally migrate data from one instance to another, you can export the XML data from one instance and import it to another.

This method ensures that all fields and values are transferred exactly. Exporting and importing data in XML files is commonly used for records created in a development instance that must be migrated with the update sets as part of a migration procedure.

Here is the list of typical files required:

Tables to be captured as XML for migration
Class Definitions <x_inpgh_des_class_definitions>
Class Fields <x_inpgh_des_class_fields>
Diagrams <x_inpgh_des_diagrams>
Filters <x_inpgh_des_filters>
Indicators <x_inpgh_des_indicators>
Indicator Breakdown <x_inpgh_des_indicator_breakdown>
Relationship Definitions <x_inpgh_des_relationship_definitions>
Relationship Fields <x_inpgh_des_relationship_fields>
Shapes <x_inpgh_des_shapes>
Shape Libraries <x_inpgh_des_shape_libraries>
Templates <x_inpgh_des_templates>
Cross scope privileges <sys_scope_privilege>
Global Settings <x_inpgh_des_global_settings>

Designer is fully dependent on the following tables which needs to be migrated, too if configuration changes have been made:

Additional tables to be considered for migration
Images <db_image>
Relationship Types <cmdb_rel_type>
Suggested Relationships <cmdb_rel_type_suggest>

Additional configurations done on or in relation to Designer needs to be migrated, too. Those changes should be captured and migrated by UpdatedSets:

  • Field extensions (captured via UpdateSet)
  • Dashboards
  • Reports
  • Workflows

Migrating Diagrams between environments

There are two ways to migrate Designer Diagrams between ServiceNow environments:

  • Migrating data from the diagrams table, this is recommended for migrating multiple or all diagrams and includes the diagram metadata
  • Migrating the diagram content as XML data, this is recommended to move individual diagrams between systems fast. Does not include diagram metadata. 

Migrating multiple or all diagrams of an instance

This approach is suited to migrate multiple diagrams or the entire diagram table content of an environment. Diagram metadata is included with the diagrams.

bde6de0-Designer_V5.1_export_diagram_table_XML

A – Type ‘x_inpgh_des_diagrams.list’ in the app navigator on the source environment to open the diagrams table (Hint: typing 'LIST' in capitals will open the table in a new browser tab)

B – Apply any desired filters or selections

C – Right-click on a column heading and select ‘Export > XML’

D – Download the file from the pop-up window when the export is ready

E –  Type ‘x_inpgh_des_diagrams.list’ in the app navigator on the target environment to open the diagrams table

F – Right-click on a column heading and select ‘Import XML’

G – Select the previously exported and downloaded XML file from your filesystem and confirm with ‘Upload’

Migrating the diagram content XML

This approach is suited to migrate individual diagrams and transfers only the diagram content to the target environment.

No Metadata is transferred along with the diagram using this approach

This approach is a very fast way to transfer diagrams between environments that does not require admin privileges.
However the diagram metadata, i.e. information about the diagram, e.g. its' description, who created/updated it, the contributors and consumers and so on, are not exported along with the diagram.

112fa4f-Designer_V5.1_export_diagram_XML

A – Select ‘Export’ then ’XML’ on the DIAGRAM pane

B – Uncheck the ‘Compressed’ option, if you want to export it uncompressed, i.e. in human readable XML format

C – Click EXPORT

D – The XML file will download automatically once ready. Drag and drop it (compressed or uncompressed) on the canvas on the target environment (option 1)

OR

E – Navigate to ‘Edit Diagram’ on the DIAGRAM pane

F – Select ‘Add to Existing Diagram’ in the drop-down menu

G – Delete the content here and paste the clean (uncompressed) XML here and click OK (option 2)