To replicate reported problems, Atlassian support staff may ask you for a copy of your JIRA data. A backup can be generated as follows:
- Login as a user with global administrator access.
- Bring up the administration page by clicking either on the "Administration" link on the top bar or the title of the Administration box on the dashboard:
- On the panel on the left, under the title "Import & Export", click "Backup Data to XML". This will bring up the "Backup JIRA data" page.
- In the form, fill in the File path data entry box with a full path, including filename, that JIRA can write to.
- Select the "Backup as Zip" checkbox if you don't want to anonymize the data (see below).
- Click the Backup button, and be patient.
- JIRA will return, confirming that it has written out the content to the file specified above.
- Attach the generated file on disk to a support request. As the support site runs over SSL this is more secure than email, and you can remove attachments if you like.
Support requests are resolved much faster if people attach their data export, however with some companies this is not an option, because the data contains sensitive commercial information.
In JIRA 3.7+, JIRA automatically anonymises data sent to Atlassian from the Administration -> Support Request page. For earlier versions, or people who want to anonymise JIRA data from the command-line, we've created a data 'anonymiser', which replaces most text in JIRA XML backups with x's.
The anonymiser can be downloaded from here.
Unzip the package, then open a console and in the
jira_anon directory run:
java -jar joost.jar <name of your backup file.xml>
anon.stx > <name of the anonymised backup file to be generated.xml>
java -jar joost.jar backup.xml anon.stx > anon-backup.xml
Then zip the generated backup XML file, and attach it to a support case on https://support.atlassian.com
The anonymiser currently replaces the following text with x's:
- Issue summary, environment, and description
- Comments, work logs, change logs
- Project descriptions
- Descriptions for most elements (notification schemes, permission schemes, resolutions)
- Attachment file names.
- "Unlimited text" custom fields
Check anon-backup.xml to ensure it's clean enough for your needs before you send to us.
Invalid XML Characters
If, when you run the anonymiser, you get an error indicating that there are invalid XML characters in the XML backup of your database, run our utility to remove invalid XML characters first before anonymising.
You will need Java 1.4 or above to run this. You can check your Java version by running
java -version, eg:
If you find yourself using JDK 1.3 or earlier, check your path (
echo %PATH% on Windows,
echo $PATH on Unix) and ensure that the right version of Java is at the beginning. See the docs for more info on setting up Java.
The screenshot below is a simple example of how it is run in the command prompt of Windows XP: