Creating a Configuration Package for Import
In the Configuration Packages log, when you click the Import toolbar option, the Import Configuration Package window opens.
The Import Configuration Package window has the following steps that you can complete through corresponding wizards:
Select File | This step has the following fields:
You must select a valid zip file from the local system for the File Name. |
|---|---|
Package Details | This is a view-only step enabling you to view the configuration package components. This step displays the configuration package components, from the selected zip file. It also shows only those categories, and components, that are in the selected configuration package. If available, the "Data Structure Setup" category (on the left-hand navigator) shows the additional user attributes data definitions and dependent user data picker definitions that are a part of the configuration package. |
User Mapping | Unifier extracts the user's information for user mapping:
Only the groups will be extracted from other components. |
Import | See below. |
Import
In this step you can elect Download the Impact Analysis Report option and click Import.
In the Import User Attributes window, you will see whether the selected configuration package has custom user attributes that are not existing in the user attribute design in destination environment, or not. If the custom user attributes already exists in the destination, then the Import User Attributes window will not be displayed.
In the Import User Attributes window, you will be provided with the list of data elements (from the configuration package) that do not exist in the destination user attribute design. The Import User Attributes window allows you to choose one of the following actions, if in the destination user attribute design does not exist:
- Add the data elements to the <destination user attribute form> user attribute design. (selected by default)
Select this option and proceed with the import of package by clicking Continue. The import process might result in an error if, for example, the status of the user attribute design is Draft, or if there is a mismatch between the "design" and the "deployed" versions of the "design."
This option enables the import process to continue. If there are no other errors, then the custom user attributes will be added to the destination user attribute design if the "design" and the "deployed" versions are the same and the "design" is in a complete status.
- Add the data elements to the Data Structure Setup but not to the user attribute design
Select this option and proceed with the import of package by clicking Continue. The import process results in an error because the user attributes are not added to the user attribute design. Add the data elements to the user attribute design and try to import again.
This option enables the import process to continue. The data elements will get added into the destination server even if the import fails because of referenced user attributes in the configuration package.
During import, the additional custom user attributes that do not exist in the destination will be added to the user attribute design, based on the following conditions:
- User attribute design in the destination should be in Complete status.
- In the destination server, the user attributes design and the deployed version should match.
If the above two conditions are met, then the additional custom user attributes will be added to the destination user attribute design, after the import.
Note: In the above case, the destination server user attribute design is allowed to have a higher version than the source.
If any one of the above conditions are not met, then the import fails.
You have the option to download the impact analysis report and view the import errors and warnings, by using the gear menu which will be available for the configuration packages that you had selected for import (in the configuration package log page). In addition, if the custom user attributes that are coming as part of the configuration package already exists in the destination, then:
- If the data element name and data type (or data definition) match (and are not currently a part of the user attribute design), then the data elements will be added, if the above conditions are met.
- If the data element name and data type (or data definition) match (and are currently a part of the destination user attribute design), then no changes are needed.
- If the data element name and data type (or data definition) do not match, then import fails. In the case of adding new data elements (custom user attributes) into the destination, and the data definition exists with same name but with different definition, then the following error message is displayed in the errors and warnings report: "The data element {0} from the Configuration Package cannot be added to the destination environment due to conflict in data definition {1}." The "Component" for this message is the "User Attributes," and the "Location" will be "Designs."
If you click Cancel, or close the Import User Attributes window, the following confirmation message is displayed: "The import process will be canceled. Do you want to continue?" If you click "Yes," then the Import User Attributes window closes, and the import process stops.
The data elements that do not exist in the destination server are displayed in the grid and will have the following columns:
- Data Element: Displays the name of the data element.
- Data Definition: Display the data definition of the data element.
- Data Type: Displays the data type of the data definition.
- Input Type: Displays the Input Method of the data definition.
When the destination server does not have user attribute form defined, if in the destination server there is no user attribute design, and the configuration package has custom user attributes, then the following message appears in the errors and warnings report, after you click Import: "Import has failed. The destination server does not have the user attribute design that can add the custom user attributes included in your package."
Data Structure Setup Component in Impact Analysis Report
The impact analysis report is created whether the configuration package import succeeds or fails. When a configuration package has custom user attributes, and you have selected to add the custom user attributes (data elements and dependent data definitions) in the Import User Attributes window (Add the data elements to the Data Structure Setup but not to the user attribute design), then the impact analysis report lists all of the data elements that are added into the destination server. That is to state that the Data Structure Setup window lists components affected in data structure setup by providing the following information in column format:
- Component
- Status
- Name
- Description
The Data Structure Setup module shows the additional data elements that were included in the destination server because of importing the configuration package. In the report:
- Name column will show data element name that was added
- Description column will show as "Included but have not been added to user attribute design."
- Status column shows "Added." The Status column also shows the data elements that are not added because of the data definition conflicts as "Not Added" and the corresponding Description column cell provides the reason for not adding the data elements to the destination server data structure setup. The data elements that are not added, or basically not changed, in the destination server will be captured because the elements already exists in the destination server. In this case, importing of the configuration package will result in error even if the data elements are added to the Data Structure Setup.
If you select the Add the data elements to the <destination user attribute form> user attribute design option in the Import User Attributes window, then the impact analysis report displays the user attribute design (in the destination server) as updated. In this case:
- An additional section for the Data Structure Setup components will be displayed in the impact analysis report. The impact analysis report will be the same as seen when the data elements are added as a part of the design import.
- The Description for the data elements added will be displayed as: "Included and have been added to user attribute design."
Similarly, if the import results in error because of the data definition mismatch, then it will be captured as a part of the regular error/warnings report.
In the case when you select the Add the data elements to the Data Structure Setup but not to the user attribute design option, but the import fails because of the user attribute design (in the destination server) is not in complete status, if the custom user attributes exist in destination server, then the user data elements will be added. In this case, the impact analysis report displays the list of the data elements that are added, and the data elements that are not changed. This is the case where custom user data elements are added successfully in the destination server.
The descriptions for the data elements that are added to the destination server but not to the user attribute design will show: "Included and added to the data structure setup."
The descriptions for the data elements that are added to the destination server but not to user attribute design will show: "Ignored because the data element exists in destination server."
Importing the User Data Pickers
The data elements and data definitions of the user data picker will be imported into the destination server if the user data picker definition is not defined.
The display element will be added into the user attribute design if you select the option to add the display element into the user attribute form of the destination server.
Unifier ignores the user data picker in the configuration package ("There is a mismatch between the package and this server for the display element of <user data picker> data definition. No changes will be done to the existing definition upon import.").
The errors and warnings report displays the detail of the user data pickers that are ignored during the configuration package import, if they already exists in the destination server.
See Also
Creating Configuration Packages
Creating a Configuration Package for Export
Last Published Saturday, July 13, 2024