Advanced Options
- Rosen Marinkov
- Stanley Neychev
On this page:
Configure Advanced Options
Configuration Manager for Jira (CMJ) provides a set of advanced options for managing the deployment of some specific configuration objects.
By default, the 'Merge everything' option is selected. However, if you want to exclude some optional elements from your deployment, you'll need to select the 'Choose what to merge' option and then uncheck the boxes of those elements you wish to skip.
The options for a System snapshot in 'Restore Configuration' mode are 'Restore everything' and 'Choose what to restore'. Also, the descriptions for the checkboxes read, "Uncheck this box to skip restoring …"
For example, the following screenshot contains all the options currently available for a System snapshot in 'Merge Configuration' mode:
Advanced Options
Here, you can find more information about all the different skip options you can encounter during all the different deployment types.
Advanced Option | Snapshot Deployment Type | Description |
|---|---|---|
Avatars |
| Uncheck this box to skip merging the avatars included in the snapshot. Avatars of new objects will still be imported. |
Custom Field Default Values |
| Uncheck this box to skip merging the default values of custom fields included in the snapshot. The default values of new custom fields will still be imported. Find out more in Detailed outcomes below. |
Custom Field Options |
| Uncheck this box to stop CMJ from disabling any custom field options that are present in the custom fields on the target instance but not in the custom fields on the snapshot. Find out more in Detailed outcomes below. |
Historical Issue Keys |
| Uncheck this box to skip merging historical issue keys conflicting with current and historical project keys on target. Otherwise, the historical issue keys would be merged as usual. Find out more in Detailed outcomes below. |
Issue Types in Contexts |
| Uncheck this box to combine the issue type context set for custom fields. Find out more in Detailed outcomes below. |
Global Permissions |
| Uncheck this box to skip merging the global permissions included in the snapshot. |
Object Descriptions |
| Uncheck this box to skip merging the descriptions of objects (projects, issue types, request types, etc.) included in the snapshot. Descriptions of new objects will still be merged. |
Object Translations |
| Uncheck this box to skip merging the translations of objects (projects, issue types, resolutions, etc.) included in the snapshot. |
Priority Colors |
| Uncheck this box to skip merging the priority colors included in the snapshot. |
Project Components |
| Uncheck this box to skip merging the components included in the snapshot. |
Project Roles |
| Uncheck this box to skip merging the project roles included in the snapshot. This is particularly useful when there is a different set of users with already set permissions on the target Jira system. |
Project Shortcuts |
| Uncheck this box to skip merging the project shortcuts included in the snapshot. |
Project Versions |
| Uncheck this box to skip merging the project versions included in the snapshot. |
Status Categories |
| Uncheck this box to skip merging the status categories included in the snapshot. |
Do not perform re-indexing during the deployment |
| Check this box to skip the re-indexing process after the issue data is imported. The deployment time will be considerably reduced but re-indexing will need to be manually triggered afterwards. |
Do not import issue attachments |
| Check this box to skip importing the issue attachments included in the snapshot. |
Attachments |
| Provide the path where the attachment files reside. This option is available if the files were not included in the snapshot during its creation. |
Detailed outcomes
Some of the options are more complex than others, so this section describes their detailed outcomes and corner cases.
Custom Field Default Values
If you uncheck this option, CMJ will not merge the default values of the custom fields in your snapshot. The default values of new custom fields are still imported.
For example …
You have a custom field called Priority with options High, Medium, and Low. In the snapshot, the Medium option is set as a default value. You’ve unchecked the Custom Field Default Values box.
Scenario 1: No matching custom field on the target instance
If the target instance does not have a Priority custom field, then it is imported along with all of its options - High, Medium, and Low.
The Medium option is set as the default value on the target instance.
Scenario 2: Available matching custom field on the target instance
If the target instance already has a Priority custom field, then it’s compared to the snapshot version of the custom field.
Any missing options (e.g., if the target instance version only has High and Low) are imported to match the source instance.
The Medium option will not be set as the default value. Instead, the Priority custom field on the target instance will retain its original default value (i.e., if it was empty before, it will remain empty).
This way CMJ ensures the options are retained while allowing flexibility with your default value settings.
Custom Field Options
If you uncheck this option, CMJ will not disable custom field options that are disabled in the snapshot but enabled on the target instance.
For example …
You have a custom field called Holiday both in your snapshot and on your target instance.
The snapshot version has two options - OoO and Returned - where the second option is disabled.
The target instance’s version has three options - OoO, Returned, and Pending - and they are not disabled.
Scenario 1: The Custom Field Options checkbox is checked
The Pending option is disabled because it is present on the target instance but not on the snapshot.
The Returned option is disabled because it was disabled in the snapshot to begin with.
Scenario 2: The Custom Field Options checkbox is unchecked
There are no modifications to be made, so this custom field will be skipped.
If you uncheck the Custom Field Default Values option but leave the Custom Field Options checked, CMJ will not disable options that are set as default values because default values cannot be disabled.
Historical Issue Keys
CMJ’s usual behavior for historical issue keys is checking if there is any matching historical data between the two instances. If there is an identical historical issue key entry, then CMJ will not override that information since it will break any existing links.
Issue Types in Contexts
Let’s cover some examples of expected outcomes after deployment.
If this option is unchecked:
The snapshot has its custom field context set only for the Bug issue type, while the target custom field has its context set for the Task and Story issue types. After the deployment, the context of the custom field will be set for the Bug, Task, and Story issue types.
The snapshot has its custom field context set to All Issue Types, while the target custom field has its context set for the Bug and Improvement issue types. After deployment, the context of the custom field will be set to All Issue Types.
The snapshot has its custom field context set only for the Task issue type, while the target custom field has its context set to All Issue Types. After deployment, the context of the custom field will still be set to All Issue Types, or in other words, no changes will occur on the target instance.
If this option is checked:
The snapshot has its custom field context set only for the Bug issue type, while the target custom field has its context set for the Task and Story issue types. After the deployment, the context of the custom field will be set only for the Bug issue type.
The snapshot has its custom field context set to All Issue Types, while the target custom field has its context set for the Bug and Improvement issue types. After deployment, the context of the custom field will be set to All Issue Types.
The snapshot has its custom field context set only for the Task issue type, while the target custom field has its context set to All Issue Types. After deployment, the context of the custom field will still be set only for the Task issue type.