Add-on Configuration Packages
The Add-on Configuration Packages sub-node is available for the users who have "enable" permission for the Configuration Package Management module. This sub-node lists all of the added configuration packages existing in the development environment and has the following toolbar options:
Notes:
- The Add-on Component Lists and the Add-on Configuration Packages follow the same naming convention as regular Component Lists and Configuration Packages, for package names.
- The file names for Add-on and Component Lists cannot contain these characters: forward slash (/), backslash (\), colon (:), asterisk (*), angle brackets (< >), and vertical bar, or the pipe (|), quotation marks (“ ”), and question marks (?). You can use close bracket ([ ]), open and close braces, or curly brackets ({ }), apostrophe or single quote ('), and semicolon (;).
- The file names for Add-on and Configuration Packages (Package Name in Create and Import) cannot contain these characters: forward slash (/), backslash (\), colon (:), asterisk (*), angle brackets (< >), and vertical bar, or the pipe (|), quotation marks (“ ”), and question marks (?). You can use close bracket ([ ]), open and close braces, or curly brackets ({ }), apostrophe or single quote ('), and semicolon (;).
Create:
To open the New Add-on Configuration Package window and create new add-on configuration packages. The process has the following steps (wizard interface):
- Add-on Package Details
- Add-on Package Components - Error/Warnings
- Create
When you are done with each step, click Next to go to the next step.
Use the Save as Draft option to save your work and change it at a later time.
Add-on Package Details
This step allows you to enter or select the following for the add-on configuration package :
- Add-on Package Name (required field)
- File Name (required field)
- Description
- Select an add-on component list (required field): A list of added add-on component lists is displayed under this field which enables you to select an item in order to include it in the add-on configuration package. You cannot select more than one item (add-on component list) for the add-on configuration package. The component list must have at least one component selected. The Shell Type field is read-only and the value is populated based the component list that you have selected from the list. The possible values for the Shell Type field are: CBS Cost Codes and Generic Cost Codes.
Once you select the required fields in the Add-on Package Details step and click Next, the configuration package components are shown from the components selected during the first step. This is a read-only view of all of the components from the selected component lists. For Example, if you select "Add-on Component List1" (including the Designs, Configurations, and Setups from Shell Template1), then packaged components will show the components from the selected list as follows:
- Designs
- Configurations
- Setups (grouped by Shell Templates node)
- User Defined Reports
The left-hand section of the window displays the grouping node of the packaged components. This is similar to the regular configuration package component view. The right-hand side of the window shows all of the packaged components, for each grouping node.
In the right-hand side of the window, the toolbar options are context sensitive and you can expand, collapse, search for the items on the page. You can also filter the components seen on the right-hand side.
Add-on Package Components - Error/Warnings
During this step, first the error check will be performed to determine if the package has errors or not. If the package has no errors, then you can see the Create step. You will see errors when the packaged components have dependency to the shell attribute design. You can resolve the shell design dependency errors by removing the elements from the tagged components which are dependent on the shell attribute design. In the case of seeing errors, you must use Save as Draft, fix the errors at the application level, and then proceed to push the package to the Create step.
Create
When all of the errors are resolved, or there are no errors in the add-on configuration package, you can access the Create step and create the add-on configuration package, with the selected set of components. You can download the package after the creation.
Import:
To import the new add-on configuration package in the destination development environment. The process has the following steps (wizard interface):
- Select File
- Add-on Package Details
- User Mapping
- Import
When you are done with each step, click Next to go to the next step.
Select File
The fields seen in the Select File step are as follows:
- File Name: The exported zip file can be added in this field.
Note: If you select the add-on package in the regular configuration package, then the following message will be displayed: "The Configuration Package zip file is an add-on package, not a valid regular package."
- Add-on Package Name: You can specify the package name that can be used for import in this field.
- Description: You can provide additional description for the add-on package details in this field.
- Source Shell Type: This field shows the selected package to import along with the shell type components. Unifier will populate the shell type value of the selected package. The shell type value is read-only field and can have one of the following values, after you select the file: CBS Cost Codes and Generic Cost Codes.
- Select a destination shell template: This option enables you to select the destination shell template, where the components from source template can be added. By default, it will not show any shell templates. In this shell template log the Shell Number, Shell Name, and Status columns will be available. The Shell Number and Shell Name columns will display the number and name of the shell template. The Status column will show the status of the shell template. All of the shell templates seen are grouped by Shell Type. The list of shell templates will be displayed once you select the package file name. The shell templates list displayed will be based on the source shell type. For example, if the add-on configuration package that you have created has source shell template components which are based on CBS Cost Codes (shell), then the destination shell templates will show only the shell templates which are of CBS Cost Codes type. The same process applies to the Generic Cost Codes. Based on the source shell type the list of destination shell templates will be displayed in the Import step of the add-on package window. All active, inactive, and on-hold shell templates will be displayed based on the source shell type. The Find on Page option will be available to search for the shell template based on the name or number. By default, this option will not show any shell templates until you select the file name.
- Destination Shell Template: This field gets populated with the selected shell template, from the right-hand side. It displays the "Shell Template Name:Shell Template Number." This is a read-only field and shows the selected shell template. By default, this field does not show any value. If you do not select the destination shell template and click Next, then the following alert message is displayed: "Select a destination shell template before proceeding to next step." You must select all of the required fields before proceeding to next step, in the import add-on package wizard.
Add-on Package Details
When you select the destination shell template in first step and click Next, you can view the selected package details. This is similar to the Add-on Package Components while creating the add-on configuration package. The package components from the selected zip file will be displayed. The options seen in the left-hand navigation list will be the following, based on what is coming from the selected add-on component lists:
- Designs (except shell manager)
- Data Structure Setup
- Data Views
- Configuration
- Company Workspace > Setup
- Source Shell Template Components
The Designs node will show all of the designs that are a part of the add-on configuration package. The Data Structure Setup will show the data elements, or the data definitions, that are in the add-on configuration package. Similarly, the other grouping nodes will be shown based on the add-on configuration package contents. The Shell Template will show all of the components such as setups, access control, and so forth that are a part of the selected add-on configuration package.
User Mapping
After you click Next at the Add-on Package Details step, you will see the User Mapping step. In this step, the BP Auto creator, in BP Setup component, will be extracted for user mapping. For the other component where users or groups are assigned (Example: WF setup or Access Control etc.):
- If all of the assignees are groups, then the groups will be extracted.
- If all of the assignees are a mix of users and groups, then only the groups will be extracted.
- If there are no users to map to, then Unifier displays the message: "There are no users to perform user mapping. Proceed to next step."
All other validations will be same as currently seen in User Mapping window while importing configuration packages.
Import
After you click Next at the User Mapping step, you will see the Import step, and the following message will be displayed: "When imported, the designs and setup components in the add-on configuration package overwrite the corresponding designs and setup components residing in destination server. Components from source template will be added to the destination shell template." You have the option to download the impact analysis report. The impact analysis report will be available for you to view after the import has been performed whether the import has been successful or not. Even if you deselect the option, you can still download the impact analysis report (from the gear menu) which will be available for packages in the import-related statuses in the configuration package log page.
Find on Page: To filter the rows displayed in the log.
The Add-on Configuration Packages log has the following columns:
- Package Name
- File Name
- Shell Type
- Description
- Status
- Last Modified By
- Creation Date
The gear menu for each item in the Add-on Configuration Packages log has the following options:
Open | To open the item. |
|---|---|
Download | Applicable to the items with status: Created or Import Success, only. |
Download impact analysis report | Applicable to items with status: Import Success, Import Failed, or Import Error, only. |
Delete | To delete the item. |
Download error/warning report | Applicable to items with status: Import Success, Import Failed, or Import Error, only. |
The Add-on Configuration Packages log items are sorted according to the value of the Creation Date column, by default. The configuration package name must be unique and duplicated names are not accepted. If a configuration package exists in draft form, the system will not allow you to create a new (add-on) configuration package.
The following restrictions will be applied for the Add-on Configuration Packages:
- Additional Add-on Component Lists and Add-on Configuration Packages will be available only on the development server.
- The option "Publish to Production" (in the gear menu) will not be available for the Add-on Configuration Packages.
- The add-on configuration packages can be imported only within the development servers, from the Add-on Configuration Packages node.
Last Published Monday, August 28, 2023