Advanced Options
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. |
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 we’ll be describing their detailed outcomes and corner cases in this section.
Custom Field Options
If you uncheck this option, you’ll stop CMJ from disabling custom field options that are disabled in the snapshot but enabled on the target instance.
If you uncheck the Custom Field Default Values option but leave the Custom Field Options checked, CMJ will not be able to disable options that are set as default values. A custom field default value cannot be disabled, so CMJ will skip over that change but will act as intended for other custom field options.
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.
For example …
You have a target Jira instance with a project called A0. You later change its project key to B0. The issues that were created when the project was still A0 keep that data in their historical issue references.
You also have a source Jira instance with a project called A0. You change that one to C0. The issues will again keep data for A0 in their historical issue references.
You now run a deployment from your source Jira instance to your target Jira instance. When CMJ checks the target instance, it finds this match between the historical project keys for A0. CMJ aims to protect your existing links on target, so it doesn’t override the historical data.
This will happen regardless of whether the Historical Issue Keys option was selected during deployment.
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 for issue type A only, while the target custom field has its context set for issue types B and C. After the deployment, the context of the custom field will be set for issue types A, B, and C.
The snapshot has its custom field context set to All Issue Types, while the target custom field has its context set for issue types A and D. After deployment, the context of the custom field will be set to All Issue Types.
The snapshot has its custom field context set for issue type B only, 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 for issue type A only, while the target custom field has its context set for issue types B and C. After the deployment, the context of the custom field will be set for issue type A only.
The snapshot has its custom field context set to All Issue Types, while the target custom field has its context set for issue types A and D. After deployment, the context of the custom field will be set to All Issue Types.
The snapshot has its custom field context set for issue type B only, 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 for issue type B only.