In this topic, you will find information regarding configuration management in Instrument and how an Instrument UI configuration from a source system can be imported into an Instrument UI configuration on a target system. For information related to readying your Instrument UI configuration for import, review the Configuration Management - Export topic, also found in the Administration documentation.
Importing an Instrument UI configuration is accomplished via the Import Manager.
The standard use case for an import of an Instrument UI configuration is importing an Instrument UI configuration on a pre-production system into an Instrument UI configuration on a production system. This ability to import also supports importing pre-configured data management solutions like Accelerator for Retail and Sustainability from pre-production systems into production systems.
-
Bringing in a pre-configured Accelerator for Retail Data Management solution configuration from a pre-production system to a production system.
-
Bringing in a pre-configured Sustainability Data Management solution configuration from a pre-production system to a production system.
-
Merging two STEP instances into one, including UIs.
When importing an Instrument UI configuration from a source system to a target system, there are a few additional things to keep in mind:
-
All work areas in the target Instrument UI configuration source system are retained upon import. Because the import process does not allow for admin users to select which work areas to import in the import configuration, all work areas will be imported and will display in the target Instrument UI, (subject to the users granted the appropriate privileges required to view those work areas).
-
If there are mismatches between the source and target systems' configurations in which user groups are present in the source system's Instrument UI configuration that are not present in the target system's Instrument UI configuration (or vice versa), the import will fail and an error will be listed in the execution report.
-
If there are mismatches between the source and target systems' configurations in which mandatory attributes are present in the source system's Instrument UI configuration that are not present in the target system's Instrument UI configuration (or vice versa), the import will fail and an error will be listed in the execution report.
-
If there are mismatches between the source and target systems' configurations in which non-mandatory attributes are present in the source system's Instrument UI configuration that are not present in the target system's Instrument UI configuration (or vice versa), the import will progress and a warning will be listed in the execution report.
-
Admin users are not able to delete centralized configurations for Instrument.
Additional Considerations for Administrators
For admins importing an Instrument UI from a source system into a target system, there are aspects of the import that are important to be aware of:
-
Because work areas on a target Instrument UI are not overwritten by those on the source system's Instrument UI during import, all work areas deemed unnecessary must be deleted manually by the admin. Deletion of work areas must be done using the configuration tool in Instrument. For more information on managing work areas, refer to the Maintaining work areas topic.
-
Work areas, perspectives, and tabs configured on the target UI that have the same ID as those found on the source UI will be overwritten upon import.
-
If a specific view has been configured for an object type on the target Instrument UI, and a specific view has been configured for the same object type on the source Instrument UI (or vice versa), the two views will be in conflict upon import and will display as an error in the import execution report. Both views will be present in the post-import UI; the admin user will be responsible for reviewing the two views and deleting the unnecessary view.