Step by Step Guide for Project Configuration Deployment
The operation of project configuration deployment consists of two consecutive steps:
1. Exporting the project and its dependencies for the deployment from the source Codebeamer instance.
2. Applying the deployment on the target Codebeamer instance.
Exporting Projects from the Source Instance
1. As a project administrator, open the project that you want to export, click Admin and then click the Export for Deployment link.
◦ A background job starts to discover the dependencies of the project. WebSocket and email notifications inform the user about the statuses of the background job:
2. After the job is completed, click the Deployment Export page link to open the Exporting Project and its dependencies window:
◦ The dependent projects are listed in an accordion choice list. To expand the list of trackers, click the name of the project.
◦ Some items are selected by default: such items are the ones that had been exported in the preceding project deployment. You can also select other items of any trackers for the deployment.
◦ Include items are selected by default for the following tracker types:
▪ Configuration Item
▪ Release
▪ Component
▪ Platform
▪ Contact
▪ Testset
▪ Testconf
▪ Team
▪ Area
◦ The export of most tracker items is not supported. Such items are marked with an info icon that shows a tooltip message.
◦ Selecting the INCLUDE ALL CONFIGURATION ITEMS checkbox selects the INCLUDE ALL PROJECTS checkboxes of all projects. Clearing the INCLUDE ALL CONFIGURATION ITEMS checkbox clears the INCLUDE ALL PROJECTS checkboxes of all projects.
◦ The Number of items column displays the tracker items included in the export.
3. After selecting the relevant options, click Export.
4. Click the project name with ZIP extension to download the project export file:
Applying Deployment on a Target Instance
1. On the Projects tab, click > :
2. Upload the deployment archive downloaded from the source environment. For encrypted archives, provide the password.
 | Archives created by features other than the Export for Deployment are not compatible with the Apply Project Deployment function. |
3. The lower menu displays the Additional settings:
◦ The Skip refresh computed fields on tracker items option configures the deployment to skip the execution of the computed field formulas, preventing delays in the deployment import of complex configurations.
◦ The Import tracker inheritance option appears only if trackerHierarchyDeploymentEnabled is set to true in Application Configuration. See "deployment" section for detailed information.
4. Click Apply.
◦ The deployment starts in the background. A message is displayed when the deployment finishes:
| | • The Work/Config items type field behaves in a way similar to any other field in the tracker configuration. You cannot delete it if the field has a value in an item in the history. • The project deployment is terminated in the following scenarios: ◦ A field in the target tracker is deleted or modified in a way that creates a conflict. ◦ A choice value created in the target tracker is deleted. ◦ The deployment process detects configuration changes in the target tracker. When the project deployment is terminated, an error message lists the items where changes were detected. You can use this information to clean the data and retry the project deployment. |