Project Snapshot

On this page:

Overview

A project configuration snapshot represents the configuration of a number of projects (either a single project or multiple) in Jira - their schemes (workflow, permission, etc.), roles, and all other configuration objects that are related to these projects. A project snapshot can be used to transfer the configuration of projects to another Jira instance or can be used as a template when creating new projects.

Video Guide

Create Project Configuration Snapshots

To create a new project configuration snapshot:

1. Log in as a user with the Jira System Administrators global permission.

2. Choose the cog icon at the top right of the screen, then choose Configuration Manager:

3. Select Snapshots to open the Configuration Snapshots page and click on the Create Snapshot button. The following screen will appear:

   Open

   

4. Select the Project Configuration button and enter a name for the snapshot. Here you can select as many projects as you need to include in the snapshot. Optionally enter a description.

5. Adding projects to the snapshot:
   To add all projects from a Jira instance to a snapshot, you can use the Select all projects button.
   To select projects by listing them by their keys, first type the keys like KEY1, KEY2, KEY3. etc. in the Project(s) field, and then use the Bulk select by key button.
   To clear the current selection of projects, use the Clear selected projects button.
    If a snapshot with that name already exists, a warning will be shown.

6. Click Next to add filters in the snapshot (since CMJ 3.0):
   Select the filters that you'd like to be included in the snapshot.

   Open

   

7. Click Next to add Agile boards in the snapshot (since CMJ 4.0) Select the boards that you'd like to include in the snapshot.

8. Click Next to add dashboards in the snapshot (since CMJ 4.1): Select the dashboards you'd like to include in the snapshot.

9. If you want to see a preview of the snapshot details click Next (since CMJ 3.0).

10. Click the Create button and wait while Configuration Manager creates a snapshot of your Jira instance.
     A message will be displayed, confirming the successful snapshot creation. If there are any warnings Configuration Manager will inform you and offer you to review their details in the Audit log.

Snapshot Options

Include custom fields with value in at least one issue

When you create project snapshots, Configuration Manager will include only the configuration objects referenced by the project. For a custom field to be included in the snapshot, it needs to fulfill the following conditions:

• A custom field must be referenced by at least one other object different from the field configuration. 

• If the "Include custom fields with value in at least one issue" option is set, and the custom field has no references to it, it will be checked if there are any issues in the project for which the custom field has a non-empty value and if any it will be included.

This is particularly useful when migrating projects from one Jira instance to another.

Include selected filters

When you create project snapshots, on the second page of the snapshot wizard, you can select Jira filters to be included in the snapshot to be deployed along with the rest of the configuration. See step 4. in the snapshot creation process.

Include selected Agile boards

When you create project snapshots, on the "Boards" page of the snapshot wizard, you can select Jira Agile (Jira Software) boards to be included in the snapshot so they can be deployed along with the rest of the configuration. See step 5. in the snapshot creation process.

Include selected dashboards

When you create project snapshots, on the "Dashboards" page of the snapshot wizard, you can select Jira dashboards to be included in the snapshot so they can be deployed along with the rest of the configuration. See step 6. in the snapshot creation process.