Anonymising JIRA Data
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 activeobjects.xml and entities.xml. Only 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 1970-Jan-01--0001.xml).
- Ensure that the
JAVA_HOMEvariable has been configured, as in our Setting JAVA_HOME documentation. - Download the JIRA Anonymiser.
- 一時ディレクトリを作成します。
- 一時ディレクトリにアノニマイザーを解凍します。
- 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:
$ java -DentityExpansionLimit=2147480000 -DtotalEntitySizeLimit=2147480000 -Djdk.xml.totalEntitySizeLimit=2147480000 -Xmx2g -jar joost.jar <JIRA BACKUP>.xml anon.stx > <NAME OF ANONYMISED BACKUP>.xmlFor example, this would be anonymising a JIRA backup with the naming convention from JIRA 4.4+:
$ java -DentityExpansionLimit=2147480000 -DtotalEntitySizeLimit=2147480000 -Djdk.xml.totalEntitySizeLimit=2147480000 -Xmx2g -jar joost.jar entities.xml anon.stx > anon-entities.xml
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 of128m.- Compress the generated anonymised XML backup file (e.g:
anon-entities.xml) and theactiveobjects.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.
- これで一時ディレクトリを削除できます。
Information about the Anonymiser
The anonymiser currently replaces the following text with x's:
- 課題のまとめ、環境および説明。
- コメント、作業ログ、変更ログ。
- プロジェクトの説明。
- ほとんどの要素の説明 (通知スキーム、権限スキーム、解決策)。
- 添付ファイル名。
- 「無制限テキスト」カスタムフィールド
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.