Project Configurator for Jira Server and DC

Import Options

When importing projects, default options are displayed according to the import project file type selected in the Import Projects screen. You can adjust these to suit your needs. We recommend that you always run a simulated import before applying an import to your target instance. To select import options, first choose the import project file type as described in Selecting Project File Types. The Import Project Configuration screen for a configuration-only XML project file and the Import Complete Project screen for complete project ZIP file are shown below.

xml-import-example

complete-project-options

The table below outlines the options available for each import project file type, followed by additional notes on the use of specific options.

Option Detail Configuration Only Complete Projects

First Run a Simulated Configuration Import

This option is highly recommended to allow you to visualise all the changes that will be applied to your target instance before running an actual import. See Import Simulation to learn more.

check
check

Create Other Projects

Automatically create projects in the target instance when required by custom field configuration contexts. Projects are created with the specified key, a default name and description and they are associated to default schemes. If a project is created because it is required by a custom field configuration context, a corresponding message is displayed in the load trace.

check
check

Smart Custom Field Contexts

Limits changes to custom field configuration contexts to only those projects being imported.

check
check

Try to Publish Drafts

Automatically publishes workflow and workflow scheme drafts that are created during the import. More details about this option can be found in Specific Information for Some Object Types.

check
error

Allow Data Input From Different Jira Versions

Enables the import of data from different versions of Jira. Use with caution: the greater the difference in Jira version numbers between your source and target instances, the greater the likelihood of import inconsistencies and unexpected results. Always check that everything has been imported as expected when using this option.

error
check

Skip

This multi-select option allows you to list objects you wish to skip from the import. See Skip Loading of Some Object Types below for details of which object types can be skipped.

check
check

Create Other Projects

Custom field configuration schemes in Jira have an associated context. This is a set of projects that the configuration applies to, or it can be a global context, where a configuration applies to any project not specified in another context. For more information, see Workflow and Workflow Schemes. If you are trying to import a custom field with a context that refers to another project(s), those projects must exist before the app can build the configuration as it is described in the XML file.

Smart Custom Field Contexts

Using the Smart Custom Field Contexts option, the imported configuration for custom fields will only affect the imported projects, and not other projects that may exist in the target instance.

This ensures that, for each custom field defined in the imported configuration:

  • The configuration of the custom field for other projects whose configuration is not defined in the imported file ("not imported projects") will not change

  • The configuration of the custom field for the projects whose configuration is defined in the imported file ("imported projects") will be as described in the XML file

  • All this will be achieved in accordance with Jira rules: no project will be in the context for more than one custom field configuration scheme (CFCS)

  • No two CFCS within the same field will have the same name

To achieve this, the import may:

  • Restrict some of the imported CFCS to apply only to the imported projects

  • Rename some of the existing CFCS to prevent them from being impacted by changes in the imported configuration

  • Restrict the context to some of the existing CFCS to apply only to projects not imported (as the configuration for imported projects will be defined by the imported file)

If you are importing a configuration using the Smart Custom Field Contexts option, it is best to use an XML configuration file that was created using the Filter Custom Fields option. Otherwise, you risk having some custom fields configured especially for the projects in the XML file, even if they are not associated with those projects. See Export Options for more information.

Skip Import of Some Object Types

The multi-select list Skip option allows you to select the object types that you want to be ignored during import. For example, if you select Groups, Project Configurator does not create or modify any group in the target instance, leaving them as they were before the import.

Projects (changes) refers to the project lead (only in versions for Jira 7), category, and schemes associated to imported projects. When using this option, the import of object types which are part of projects, such as versions, components, and project role members, are also ignored. Creation of new projects cannot be skipped. Projects included in the XML configuration file are always created with a default configuration, including default schemes. To remove a selected object type from the list, click the corresponding X.

Skipping objects can lead to import errors if the creation of an object that is required for another object’s configuration is skipped. For example, the configuration file contains Screen A which does not exist in the target instance, and it also contains Workflow B which uses Screen A. If screens are skipped from the import, when the app tries to load Workflow B it will fail because Screen A does not exist.

Object types that can be skipped:

  • Projects (changes)

Project Scope Objects:

  • Versions

  • Components

  • Role members

  • Service Desks

Global Objects:

Users

Groups

Project roles

Priorities

Resolutions

Statuses

Event types

Categories

Issue types

Issue type schemes

Custom fields

Field configurations

Field configuration schemes

Screens

Screen schemes

Issue type screen schemes

Workflows

Workflow layouts

Workflow schemes

Permission schemes

Notification schemes

Issue security schemes

Filters

System dashboard

Maintain Settings Between Loads

The import screens are designed to keep your selections from one retry to the next, so you do not have to reselect your options every time you run the configuration import. The only exception is the name of the configuration file to load because, as a security measure, most browsers will not permit code in a web page to select a local file. The following settings are maintained between successive loads:

  • Real or simulated load

  • Automatic creation of extra projects

  • Smart custom field contexts

  • Try to publish drafts

  • Continue on errors found in dashboards and filters

  • Object types to be ignored during the load

For import settings to be maintained between load attempts, you must have a Javascript-enabled browser and remain in the same Jira session.