Project Configuration Deployment - Technical Details
This topic provides a detailed overview of the technical aspects involved in project configuration deployment, including the definition and handling of various entities.
Entities
The term entity is used for Codebeamer artifacts such as:
User groups
Project roles
Project categories
Global fields
Projects
Trackers
Wiki pages and Dashboards
Documents
Comments / Attachments
cbQL queries
Configuration type tracker items
Exceptions
The following types are not part of the configuration deployment, and are not considered as entities in the scope of this documentation:
Associations
Baselines
Branches
Escalation rules
User accounts
Review Hub reviews
Notification settings
Tracker template inheritance references
Work item type tracker items
Calendars
Tags
Level of Support for References
Reference
Support Level
Projects
Supported
Trackers
Supported
Work items
Supported
Roles
Supported
User groups
Supported
Global types (only in cbQL queries and tracker field settings)
Supported
Repositories
Not supported
Users
Not supported
Branches
Not supported
Work item versions
Not supported
Detailed Entity Descriptions
Global Type
All Global types are moved from the source system to the target systems. Renaming the Global types is supported.
Link Type
UUID
Limitations
A Global Type with an existing name on the target system cannot be created.
Deletion
Not supported
Role
This section refers to the template roles used by the project roles.
All roles are moved from the source system to the target systems.
New roles with the new names are created.
Renaming is not supported. Existing roles are found by name and then reused.
Link Type
Name
Limitations
Not known
Deletion
The roles cannot be deleted from the Codebeamer user interface.
Roles are not deleted on the target system.
User Group
All user groups are moved from the source system to the target systems.
New user groups are created.
Existing user groups are found by name.
Renaming is not supported.
Link Type
Name
Limitations
Not known
Deletion
Not supported
Report
All public reports are moved from the source system to the target systems.
Link Type
UUID
Limitations
The name of an entity can be used in cbQL as reference. These names are not resolved during the import. Entities with numeric names (for example, 123 as a project name) are either resolved incorrectly or they break the import.
Deletion
Not supported
Project
All exported projects are moved from the source system to the target systems.
Link Type
UUID
Limitations
Projects with existing names on the target system cannot be created. Project images are not moved from the source to the target systems.
Deletion
Not supported
Project Role
All project roles are moved from the source system to the target systems.
New roles are created.
Existing roles are updated.
Updates to the Project Admin role are not supported from the Codebeamer user interface or in the configuration deployment.
Link Type
UUID
Limitations
You cannot move a project role if a role with the same name already exists on the target system.
Deletion
Not supported
Project Category
All project categories are moved from the source system to the target systems.
Renaming project categories is not supported.
New categories are created on the target system.
Link Type
Name
Limitations
Not known
Deletion
Not supported
Project Category Hierarchy
All project categories are moved from the source system to the target systems.
Link Type
Name
Limitations
Project category hierarchies are not applied to the target system. All categories are merged to the root level.
Deletion
Not supported
Project Tracker Tree
Tracker tree is moved from the source system to the target systems.
Source tracker tree overrides the target tracker tree.
Link Type
-
Limitations
-
Deletion
Supported
Tracker
All trackers are moved from the source system to the target systems.
All tracker attributes are moved from the source system to the target systems.
Link Type
UUID
Limitations
* 
Deleting work item fields with values from the target system causes unrecoverable errors. PTC recommends setting these fields to Read-only and Hidden instead of deleting them.
Trackers with existing names within a project on the target system cannot be created.
References in the configuration use the HEAD version of selected entities, for example, a work item, project, or tracker.
Settings are overwritten. If possible, the deleted fields on the source system are also deleted on the target system.
Email inbox settings are not supported.
Deletion
Not supported
Tracker Configuration Update
The project configuration update is a complex process: Codebeamer creates and updates several entities and their attributes.
The existing entities are overwritten and the non-existing ones are created.
Customizations are deleted on the target server. Customizations may cause errors, therefore, configuration deployment to the target servers with the modified tracker configurations are not supported.
Tracker Entities
For tracker entities, the following settings are updated:
General attributes
Permissions
Workflows (Transitions and Actions)
Fields
Service desk attributes
* 
Escalations and notifications are not updated. These can be customized on the target server.
Tracker Reference Update
Codebeamer updates reference settings and values in the tracker configuration.
The following references are replaced in the configuration:
Tracker fields
Default value
Allowed value
Reference filters
Combination values (depends on)
Calculated fields and conditions
View type configurations, such as guards and conditions
Shared tracker view configurations
Workflows
Transitions
Guard
Actions
Condition
Foreign item filter
Fields updates
Parameters
Tracker View
All tracker views are moved from the source system to the target systems.
Link Type
UUID
Limitations
If the target tracker contains a tracker view with a specific name, that view is overwritten by the deployed tracker view with the same name.
Deletion
Not supported
Configuration/Work Item
* 
Configuration deployment supports only configuration items. Work items cannot be included in the deployment file.
All exported configuration items are moved from the source system to the target systems.
New configuration items are created.
Existing configuration items are updated.
Link Type
UUID
Limitations
Configuration/work item references in the tracker configurations use the HEAD version of items.
Configuration/work item versions are not imported.
Deletion
Not supported
Configuration/Work Item Reference Update
The following reference values are replaced in configuration/work items:
Project fields
Tracker fields
Configuration/work item fields
Member fields. Only the user groups and roles only are supported, while the accounts are removed.
When the project configurations are updated, the references in the tracker items can be replaced.
Was this helpful?