"deployment" section
Configures the Project Configuration Deployment feature.
A typical example
"deployment": {
"enabled": true,
"waitBeforeJobExecutionInSeconds": 5,
"enableAutomaticTrackerLocking": false
}
"enabled": true,
"waitBeforeJobExecutionInSeconds": 5,
"enableAutomaticTrackerLocking": false
}
Deployment Configuration Options
|
Property
|
Default Value
|
Description
|
||
|---|---|---|---|---|
|
enabled
|
false
|
When set to true, the Project Configuration Deployment feature is enabled.
|
||
|
trackerHierarchyDeploymentEnabled
|
false
|
When set to true, the Import tracker inheritance checkbox appears on the Apply Project Deployment import window, as shown in the following image:  Selecting the Import tracker inheritance checkbox enables the import of the tracker hierarchies and configurations. |
||
|
enableSelectiveDeployment
|
false
|
When set to true, the selective deployment is enabled, allowing users to choose specific projects and trackers for deployment.
|
||
|
waitBeforeJobExecutionInSeconds
|
5
|
Sets a delay in seconds before starting the deployment job. This value is useful to ensure that all necessary dependencies are ready before the deployment process starts.
|
||
|
enableDocumentTrackers
|
false
|
When set to true, enables the deployment of the configurations from a document type tracker.
|
||
|
enableFieldIdOffset
|
false
|
When set to true, a new field created on the target system will get its ID from a shifted upper-half of the full ID range. This helps to avoid ID collisions when importing from the source system.
|
||
|
enableLogLastBlacklistCheck
|
true
|
When set to true, the import process tracks the validations against the invalid references list. In case of error, the server logs additional information about the last check. This helps to debug deployment import errors.
|
||
|
maxReferencePathCount
|
100
|
Sets the maximum number of paths for entity references between two projects that the dependency finder can calculate.
If the dependency finder causes Codebeamer performance issues during the calculation phase, you can set this property to a smaller value.
You can use the GET /v3/job/{jobId} Swagger API endpoint to query the background job generated by the export for deployment. This endpoint generates a JSON response with a list of all the dependencies that the dependency finder calculates, such as:
• Outgoing dependencies—The cross-project reference models
• Incoming dependencies—The referring reference filters
|
||
|
maxWarningsOnUi
|
25
|
Sets the maximum number of warning messages that the user interface can show during the deployment export process.
|
||
|
enableAutomaticTrackerLocking
|
true
|
When set to true, the deployed trackers on the target system are locked and the project members cannot modify any configuration affected by the deployment process. This option does not affect the trackers that inherit from the deployed trackers but are not directly deployed.
|
