Project Configuration Deployment
The Project Configuration Deployment feature in Codebeamer streamlines the process of transferring and updating complex project hierarchies and configurations between different instances. This functionality ensures consistency by reducing manual steps and replicating project structures, settings, and entities across environments.
With this feature, you can set up a dedicated configuration server where the tracker configurations are initially developed. When the first version is ready, it can be deployed to a test system. You can make any subsequent configuration changes on the configuration server, and then deploy to the test or the production environment. This approach simplifies the deployment process and enhances reliability and efficiency.
Project Configuration Deployment is also referred to as horizontal deployment, as it is executed between different Codebeamer instances.
In the following diagram, there are two different contexts: a configuration server and a production server. In each context, there is a Codebeamer instance of same version. Deployment is the process of deploying all project configurations, a project structure, and selected entities from one instance to another.
 | In the future, this functionality is intended to replace the Export and Import features of the preceding Codebeamer versions. PTC recommends switching to Project Configuration Deployment. |
The page Project Configuration Deployment - Technical Details lists the entities that the Project Configuration Deployment feature supports.
Prerequisites
• The Project Configuration Deployment feature requires additional licensing. For more information, contact your PTC sales representative.
• To enable the Export for Deployment option in the Admin > Settings tab of a project, add the following configuration at System Admin > Application Configuration:
"deployment": {
"enabled": true
}
"enabled": true
}
◦ For detailed information about the Application Configuration options, see the "deployment" section.
• Importing a project configuration deployment archive requires the following:
◦ User group level permissions:
▪ Group - Admin
▪ Administration permission for shared fields
▪ Document - Add Global
| | The user performing project deployment does not require permissions for other projects that have field references in the project being deployed. This means that if the deployed project includes a field reference to another project that the user does not have permission for, project deployment can still be performed. After deployment, the deployed project includes the references to the other projects, even if the user does not have permission for those projects. For example, if the user is part of a group with Group - Admin permission for only Project A, and Project A includes a reference to a tracker in Project B, the user can deploy Project A. After deployment, Project A includes the reference to the tracker in Project B. |
◦ Project role level permission:
▪ Project - Admin
| | The System Admin role is not required for initiating the deployment process. |
Project Deployment Methods
In Codebeamer, you can perform various types of project deployment depending on your needs:
• For the basic instructions, see Step by Step Guide for Project Configuration Deployment.
• For advanced methods, refer to the following table:
Method | Purpose | Description |
|---|---|---|
The most comprehensive method; targeting projects, configurations and dependencies. | Imports and exports the selected project and its tracker configurations, together with all dependencies from other projects. | |
Selective method; with focus on incremental updates or specific configurations. | Allows users to choose specific projects or configurations for deployment rather than deploying the project with all its dependencies. | |
Programmatic method; deployment of configurations and templates. | Exports and imports projects using the Swagger API capabilities. |