How to use it (version 1.0.5 and earlier)



IMPORTANT: Before loading a configuration into JIRA, read these Safety measures when loading configurations !



IMPORTANT TOO: After loading a configuration into JIRA, it is highly recommended to reindex your database !



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 "Project Config Export".


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 "Export failed!"
  • A message that describes the error
  • A set of objects enclosed within square brackets, that point to the object that was being exported when the error happened. In the example, the error happened when trying to translate a custom field identified by the string "customfield_10000", referenced in workflow "Un super-completo". This workflow was used in workflow scheme "Super completo", used by project with key "PC"
  • Finally, the stack trace of the error.

This description applies to versions 1.0.5. Error reporting for exports was more limited in previous versions. For more details, see issues PCP-19, PCP-35, PCP-41 and PCP-46.

Import a project configuration from an XML file

Go to "Administration" and in the "Plugins" menu, select "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.

If the "Apply changes?" tick is not selected, the load process will be simulated. This means that no changes will be actually made in JIRA, but you will be able to see in the result page a simulation of all the changes that the plugin will make in JIRA when loading that configuration file. Note that this tick is not selected initially, as a safety measure.

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 open and validate the XML file against the schema. If there is any error, it will be shown in red text under the button.

if the file can be opened and it is valid, the load process will be started.

IMPORTANT: The load process may take a few seconds, in that case you will perceive that the browser takes longer than usual to display the results page.

When it finishes, the results page will be shown. This page has an area that contains the trace of the process, including a stack trace if any error was detected during the load.

In the upper right corner 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 trace of a simulated load. You can read a message at the beginning, that states this load process will not apply changes to the database (in red). Another message at the end (in green) shows that the process has finished without errors.

Next you can see the trace of a real load. Another message indicates the end of the process (in green).

Errors when loading

If an error is found during the load process (either simulated or real), it will be shown inside the same area, including the stack trace produced by the error.

The first line beginning with "ERROR" shows the message "Load failed for reason: " followed by a message describing the error. The next line shows in which context the error happened, in this example while trying to aply changes to tab "Field Tab" included in screen "Editar Screen". Next two lines warn that any changes already applied to the database are being rolled back, and finally the error stack trace is included.