Package Details

A package represents a bundle of configuration items that should be logically migrated together. Creating a package in an environment then means the configuration in that package can be migrated to other environments.

This page is used for multiple purposes:

1. To create a new package in the current environment.

2. To refresh a package in the current environment if the configuration has changed since the package was created.

3. To view the contents of a package in this or another environment.

4. To copy the contents of a package in another environment. Copying a package from another environment is useful in the scenario when an environment migrates configuration from a source and then itself acts as a source for another target. For example in a Development/Test/Production scenario, the package is first defined in Development and the contents are migrated to Test. The package in Development is then copied to Test so that the configuration can be migrated to Production.

• This page can be accessed from the Configuration workbench. From the menu, select Configuration under the Administration section.

• From the configuration workbench, select Packages from the Migrations section.

• Click on Select Environment and select the environment to see the list of packages in an environment. Select the one marked 'Local' to view packages in the current environment.

• Identify the package to be viewed and click on the drill-down arrow to the right of the record to open this page.

• If this page has been reached when opting to create a package from the Packages Dashboard the Package Title attribute will be blank and the content categories (Report Definitions, Validations , Datasources, Content Area Definitions, Groups, Process Templates, Email Templates, Menus, Accolades) will all have '0' against them.

• Provide a value for the Package Title. This value will be displayed when other environments request a list of packages in this environment.

• Add contents by clicking on the '+' icon against the relevant category and then selecting item(s) from the list.

• Dependent items are automatically added so there is no requirement to try and separately add dependent items.

• Click on Save when all items have been added.

• Directly referenced dependencies are added automatically.

• In some cases there can be indirect reference to dependencies. An common example is one where the SQL in a datasource or validation refers to another validation in the query. In this instance the referenced validation will not be added automatically and must be added manually.

• Only packages that are in the local (current) environment can be edited. Packages in other environments can be viewed but not edited.

• The package title can be edited at any time.

• Contents can be added by clicking on the '+' icon to the right of the configuration category. Dependent items will be added automatically.

• Contents can be removed by clicking on the 'X' icon to the right of them. The editor does not prevent the removal of dependent items. If unsure whether all the dependent items are present, click on 'Add New Dependencies' to the left of the contents to ensure they are present.

• Click on Save when changes are complete.

• Configuration items in a package are the version that is current when the configuration item was added to the package, or when the package was last refreshed with the latest versions. Packages are not automatically updated with the latest versions of a configuration item if changes are made to the configuration item after it has been added to the package.

• To ensure the package has the latest versions, click on Latest Versions to refresh all the contents with the latest versions. 

• If a configuration item that is defined in the package contents changes and there are new dependencies included in those changes the package can be refreshed with the new dependencies by clicking on Add New Dependencies

• This option can be used simply to make sure that the package has all dependent items in case some of the dependent items might have been removed.