Support requests are often resolved significantly faster if a data export is provided as it will allow our legendary supporters direct access to a copy of your instance. We understand that sometimes this may be a difficult option due to the sensitivity of your data and have written an anonymising tool to handle this particular scenario.
Anonymising JIRA Data
The JIRA inbuilt backup functionality will produce a ZIP file containing either 1 or 2 XML files, depending on the version that is being used. These files are a copy of the entire contents of JIRA's database, encoded in XML, that can be used to restore an instance - we have further detail on this in our Automating JIRA Backups documentation.
As of JIRA 4.4, the backup functionality will produce a ZIP file that contains 2 XML files. These files will be
entities.xml will need to be anonymised - please do not attempt to anonymise the
activeobjects.xml. For versions prior to 4.4, only one XML file will be produced with the same naming convention as the ZIP it is compressed as (for example
1970-Jan-01–0001.zip will expand to
- Ensure that the
JAVA_HOMEvariable has been configured, as in our Setting JAVA_HOME documentation.
- Download the JIRA Anonymiser.
- Create a temporary directory.
- Unzip the anonymizer in the temporary directory.
- Unzip the JIRA backup ZIP file (for example
1970-Jan-01--0001.zip) in the temporary directory.
Anonymise the backup file with the below commands:
For example, this would be anonymising a JIRA backup with the naming convention from JIRA 4.4+:
Depending on the size of the backup, additional memory may need to be allocated to the JVM. In order to do this, increase the value of the
Xmxin increments of
- Compress the generated anonymised XML backup file (e.g:
anon-entities.xml) and the
activeobjects.xml(JIRA 4.4.x + only) into a ZIP or tarball.
- Attach that ZIP or tarball onto the support issues as raised on support.atlassian.com.
- The temporary directory can now be removed.
Information about the Anonymiser
The anonymiser currently replaces the following text with
- 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.
Please check the anonymised backup,
anon-backup.xml, to ensure it's clean enough for the needs of your organisation before sending it to Atlassian.
Invalid XML Characters
If, when the anonymiser runs, an error indicates that there are invalid XML characters in the XML backup of the database, run our utility to remove invalid XML characters first before anonymising.