Table of Contents |
---|
Highlight |
---|
IMPORTANT: Before loading a configuration into JIRA, read these Safety measures when loading configurations ! |
Highlight |
---|
IMPORTANT TOO: After loading a configuration into JIRA, it is highly recommended to reindex your database ! |
Permissions
The use of this plugin is restricted to system administrators in JIRA.
Export a project configuration to XML
Go to "Administration" and to the chosen project summary page, and click on the tab called "Export configuration" or "Filter unused CF".
There are three options for exporting configurations (new feature since version 1.1.0):
- "Export configuration": exports all objects that are referenced directly or indirectly from the project configuration. As any field configuration in JIRA contains all fields defined in the instance, in practical terms this means all custom fields will be included in the exported file.
- "Filter unused CF": in this case the plugin will not include in the export file custom fields that are not used by this project. See the details at Filtering unused custom fields.
- "Advanced export" to set additional options for the exporting process. You can find the details at Advanced export options.
Your browser will inmediately download the XML file with the project configuration. It will usually show a message asking if you want to save or open the created XML file.
Errors when exporting
If the plugin finds any error trying to export the configuration, instead of downloading the XML file, your browser will go to an error page like the one shown below.
The information shown in this page is:
- The message "An error occurred:", followed by a message that describes the error, and a link to a wiki page with helpful information on export errors.
- Another message detailing the object that caused the error (location). This message is formed by a set of objects enclosed within square brackets, that point to the objects that were being exported when the error happened. In the example, the error happened when trying to export a group called "Group-B", used in workflow "Workflow-B". This workflow was used in workflow scheme "Workflow Scheme-B", used by project with key "PB"
- Finally, the stack trace of the error.
In Most frequent errors found in export you can find information about the most frequent causes of export errors.
Import a project configuration from an XML file
Go to "Administration" and in the "Plugins" menu, select "Load Project Configuration".
Info |
---|
Find the import link in JIRA 6Take into account that the "Plugins" menu has changed quite a lot in JIRA 6. To start with, they are not called "Plugins" any longer, but "Add-ons"! If you want to find the link to the import page in JIRA 6, follow these steps:
|
After clicking on the link named "Load project configuration" the following page will appear:
Clicking on the button to the right of the text field, allows you to select the XML file you want to load with the project configuration.
...
Once you have selected the file and chosen whether the load will be simulated or real, click on the "Project Configuration File Upload" button to launch the load. The plugin will verify the license, the logged-in user, it will open the XML file and validate it against the schema. If there is any error, it will be shown in a message close to the top of the page.
if the file can be opened and it is valid, the load process will be started.
...
When it finishes, the results page will be shown. Just under the header you will see a message with the result of the load. Below, there is an area that contains the trace of the process. The next image shows the result page after a real load:
Under the title of this page there is a button to go back to the previous page, in case you want to launch another load. This will happen typically after a successful simulated load, in order to execute the actual configuration changes.
Remember that loading a configuration may alter custom field configurations, resolutions, statuses or priorities. You should reindex the database after the load.
The next image shows the result of a simulated load. The result message says this load is simulated. Additionally, in the process trace, you can read a warning at the beginning, that this load process will not apply changes to the database.
Option to create projects needed for custom field configuration contexts
Custom field configuration schemes in JIRA have an associated context. This is a set of projects that configuration applies to, or it can be a global context, meaning a configuration that applies to any project not specified in other context. You can find more information here.
If you are trying to load a custom field with a context that refers to another project(s), those projects must exist before the plugin can build the configuration as it is described in the XML file.
If the option "Create extra projects" is ticked, during the real load if a project used in a custom field context does not exist, Project Configurator will create it automatically. The project will be created with the specified key, and a default name and description and it will be associated to default schemes.
If that option is ticked, and a project is created because it is needed in a custom field configuration context, a message like this will appear in the load trace:
Option to skip loading of some object types
The multiselect list labelled "Do not load:" lets you select object types that will be ignored during the load. This means that, for example if you select "Groups", the plugin will not create or modify any group, leaving them as they were before the load.
You can select more than one object type to ignore, clicking on any of them while the keys "Ctrl" or "Shift" are pressed. To deselect an already selected object type, click on it while pressing the "Ctrl" key.
The list of object types that can be skipped is:
Project scope objects:
- Versions
- Components
- Role members
Global objects:
- Users
- Groups
- Project roles
- Priorities
- Resolutions
- Statuses
- Event types
- Category
- Issue types
- Issue type scheme
- Custom fields
- Field configurations
- Field configuration scheme
- Screens
- Screen schemes
- Issue type screen scheme
- Workflows
- Workflow scheme
- Permission scheme
- Notification scheme
- Issue security scheme
Note | ||
---|---|---|
| ||
This option can lead to load errors, if creation of an object that is necessary for another object's configuration is skipped. For example, suppose the configuration file contains screen "A" which does not exist in the target, and it also contains workflow "B" which uses screen "A". If load of screens is skipped, when the plugin tries to load workflow "B" it will fail as screen "A" does not exist. So, use this option with care! |
When object types are selected to be ignored during the load, the load trace shows warning messages like these:
Keeping settings between loads
This web page is designed to keep your selections from one retry to the next, so you do not have to select everything every time you run the configuration load. The only exception is the name of the configuration file to load because, as a security measure, most browsers will not let code in a web page select a local file. So these settings will persist between successive loads:
- Real or simulated load
- Automatic creation of extra projects
- Object types to be ignored during the load
The only requirement for this persistence of settings is a browser that accepts cookies and has Javascript enabled.
Errors when loading
If an error is found during the load process (either simulated or real), it will be shown within a message just under the page header. This message explains the likely cause of the error. Below, another message states the location, or object that was being loaded when the error happened.
The trace of the load process is shown up to the error. In this case, the trace also includes two important pieces of information:
- Information about the rollback of the changes made so far to this JIRA instance (only in a real load).
- The stack trace produced by the error.
Child pages (Children Display) |
---|