Documentation for JIRA 4.1. Documentation for other versions of JIRA is available too.

JIRA's Project Import tool allows you to restore a single project from a backup file into your JIRA instance. This feature is particularly useful if you do not wish to overwrite the existing projects or configuration of your JIRA instance by importing the entire backup. Your backup file must have been created using JIRA's backup tool. You cannot import a project from a backup using your native database tools.

Please note, if you wish to restore a project from a backup file into a new empty JIRA instance, we highly recommend that you do not use the Project Import tool. Restoring the entire backup file into the new instance and then deleting unwanted projects is much simpler in this scenario, as you will retain the configuration settings from your backup. Instructions on moving a project to a new instance are available on the splitting a JIRA instance page. Projects can be deleted via the 'Projects' page in JIRA, which is accessed from the '*Administration' menu.

On this page:

はじめる前に

バックアップからのプロジェクトの復元は簡単な作業ではありません。プロジェクトのインポートに対応するために、ターゲット JIRAインスタンスの構成を変更する必要があります。さらに、大規模なプロジェクトをインポートする場合、プロジェクトのインポートデータのマッピングは、ハードウェア上のリソースを大量に消費する可能性があり、完了するまでに長時間かかる場合があります。注:プロジェクト インポート ツールは実データのインポートの間、JIRA インスタンスを閉塞させるため、ご利用のインスタンスがその間アクセスされる必要がないことを確認してください。

We strongly recommend that you perform a full backup of your target JIRA instance before attempting to restore a project into it.

Project Import Restrictions

プロジェクト インポート ツールは同じ JIRA インスタンスの間でのみ、プロジェクトをインポートします。これは、

  • The version of JIRA in which your backup was created must be identical to the version of your target JIRA instance, e.g. if your backup file was created in JIRA 4.0, then your target instance of JIRA must be version 4.0.
  • If your instance of JIRA had a custom fields plugin (e.g. JIRA Toolkit) installed when the backup file was created and the custom field was used in your project, then your target instance of JIRA must have the same version of the plugin installed for the Project Import tool to automatically work.

この制限のどれかに当てはまっていてもバックアップからプロジェクトを復元したい場合、以下の適切な手順に従ってプロジェクトをインポートする前に、互換性のあるバックアップ ファイルを作成する必要があります。

JIRA のバージョンが一致しない

  • ターゲット JIRA インスタンスよりも前のバージョンの JIRA でバックアップファイルが作成された場合
    1. ターゲット JIRA インスタンスと同じバージョンのテスト JIRA インスタンスをセットアップします。テスト JIRA インスタンスはターゲット JIRA インスタンスから分離したデータベースとインデックスを使用していることを確認します。
    2. Import the backup file into a test JIRA instance.
    3. Create a new backup file from your test JIRA instance.
  • ターゲット JIRA インスタンスよりも後のバージョンの JIRA でバックアップファイルが作成された場合
    1. Upgrade the version of your target instance of JIRA to match the version of JIRA in which the backup was created.

カスタム フィールド プラグインのバージョンが一致しない

  • バックアップのカスタム フィールド プラグインがターゲット JIRA インスタンスのカスタム フィールド プラグインよりも前のバージョンである場合
    1. Import the backup file into a test JIRA instance. Make sure that the test JIRA instance uses a separate database and index from your target JIRA instance, as the import will overwrite all data in the database.
    2. ターゲット JIRA インスタンスのプラグインのバージョンと一致するように、テスト JIRA インスタンスでカスタム フィールド プラグインのバージョンをアップグレードします。
    3. Create a new backup file from your test JIRA instance.
  • バックアップのカスタム フィールド プラグインがターゲット JIRA インスタンスのカスタム フィールド プラグインよりも後のバージョンである場合
    1. バックアップを作成した JIRA のバージョンと一致するようにターゲット JIRA インスタンスのカスタム フィールド プラグインのバージョンを アップグレード します。

プロジェクトを復元する

プロジェクト インポート ツールは、バックアップ ファイルのデータをターゲット JIRA インスタンスにマッピングしようとします。復元中のプロジェクトがターゲット JIRA インスタンスに存在しない場合、このツールはバックアップのデータを使用して、プロジェクトを作成し、データを追加します。プロジェクトが既に存在しているが、空の場合、このツールはバックアップのデータをプロジェクトに追加しようとします。

ターゲット JIRA インスタンスに空のプロジェクトを作成しなければならない理由

プロジェクト インポート ツールの主要なタスクが、バックアップ プロジェクトからデータをターゲット JIRA インスタンスに復元することであることに注意が必要です。ターゲット JIRA インスタンスにプロジェクトが 1 つも存在しない場合、プロジェクト インポート ツールはプロジェクトを作成できますが、データに影響を与える構成設定(たとえば、画面スキーム)を再現することはしません。元のプロジェクトの任意の構成設定を保持したい場合、バックアップ プロジェクトからデータをインポートする前に、必要な構成設定を行ったターゲット インスタンスに空のプロジェクトを作成することをお勧めします。

以下のセットアップ タスクを実行すれば、ターゲット JIRA インスタンスがプロジェクトのインポートを受信する用意ができていることを事前に確認できます。これによって、ターゲット JIRA インスタンスへのデータ マッピングを検証するのに要する時間を短縮できます。

If you are confident that your JIRA instance is set up appropriately, you can skip straight to the Project Import tool instructions. If there are any problems mapping the data from your backup file to your target JIRA instance, the Project Import tool will present validation errors for you to address.

ターゲット JIRA インスタンスの準備

プロジェクト インポート ツールは欠落したプロジェクト エンティティ(たとえば、ユーザー グループや課題の優先度、カスタム フィールド タイプなど)を自動的に追加したり、不正確な関連付け(たとえば、ワークフロー スキームの課題タイプなど)を修正したりしないため、ターゲット JIRA インスタンスを設定して、プロジェクトを復元するには、手作業がいくらか必要になります。プロジェクト インポート ウィザードが、バックアップ プロジェクト データのターゲットとなる有効な場所を見つけられない場合、プロジェクトの復元はできません。以下の手順は、バックアップからプロジェクトを復元する際に発生する、最も一般的なデータ マッピングの問題に対処するセットアップ アクティビティについて説明しています。

We recommend that you perform as much of the configuration of your target JIRA instance as possible, prior to starting the project import. However, if you do not have the information available to complete these setup activities beforehand, the Project Import wizard will inform you of any problems that need your attention. Alternatively, you can import the backup file into a test JIRA instance to check the configuration.

1. プロジェクトをセットアップする

データの復元先となるプロジェクトがターゲット JIRA インスタンスにある場合、そのプロジェクトが空であることを確認する必要があります。すなわち、次の項目を確認します。

2. ユーザとグループをセットアップする

プロジェクトをインポートするためには次のユーザの種類が必須だと考えられます。

  • 報告者、担当者、コンポーネント リーダー、プロジェクト リーダー

プロジェクトのインポートでは次のユーザは任意だと考えられます。

  • コメント作成者/編集者、作業ログ作成者/編集者、カスタムフィールド(ユーザー ピッカー)のユーザー、投票者、監視者、グループ変更者(即ち、課題を変更した人)、添付ファイル作成者、プロジェクトロールのユーザー

The Project Import will attempt to create missing users if they are associated with the project. However, if the Project Import tool cannot create missing mandatory users in your target JIRA instance, then you will not be permitted to import the project. This may occur in the following situations:

  • you have External User Management enabled in your target JIRA instance — you will need to disable External User Management or create the missing users manually in your external user repository before commencing the import.
  • Atlassian's Crowd was connected to your JIRA instance when the backup was made (hence, the backup file will only contain minimal reference data for each user which is insufficient to create users in JIRA) — you will need to create any missing mandatory users manually. Alternatively, you may wish to connect the current JIRA to the same external user management system as the original, if that is possible. This check does not apply if you connected an LDAP (not using Crowd) to your JIRA instance when the backup was made, as connecting an LDAP to JIRA requires the creation of the users in JIRA (hence, full user data will be in the backup file).

バックアップ ファイルのユーザーについて十分な情報を持ってない場合、プロジェクト インポート ウィザードは(新しいページで)いないユーザーを含む XML ファイルへのリンクだけでなく、いないユーザーの表へのリンクを提供することに注意してください。ユーザーの表は最大100ユーザーを表示しますが、XML ファイルは常に利用可能です。

3. カスタム フィールドをセットアップする

前述したように、プロジェクトのインポートでは、カスタム フィールド プラグインのバージョンはバックアップとターゲット JIRA インスタンスの間で一致している必要があります。ターゲット JIRA インスタンスでカスタム フィールドが次のように正しくセットアップされていることを確認する必要があります。

  • Custom Field Type — If you do not have a particular custom field type (e.g. cascading select) installed on your target JIRA, then all custom field data in your backup project that uses that custom field type will not be restored. However, your project can still be restored.
    For example, say you have a custom field, 'Title', which is a 'Cascading Select' field type and was used in your backup project (i.e. there is saved data for this field). If you do not have the 'Cascading Select' custom field type installed on your target JIRA, then all data for custom field 'Title' (and all other cascading select custom fields) will not be restored.
  • Custom Field Configuration — If you do have a particular custom field type (e.g. multi select) installed on your target JIRA, then you must configure all of the custom fields (of that custom type) in your target JIRA to match the equivalent custom fields in your backup project. Additionally, if your custom field has selectable options, then any options used (i.e. there is saved data for these options) in your backup project must exist as options for the custom field in your target JIRA.
    For example, say you have a custom multi select field named, 'Preferred Contact Method', in your backup project with options, 'Phone', 'Email', 'Fax'. Only the 'Phone' and 'Email' were actually used in your backup project. In this scenario, you need to set up your target JIRA instance as follows:
    • ターゲット JIRA インスタンスに「優先連絡方法」という名前のフィールドがある必要があります。
    • 「優先連絡方法」は複数選択カスタム フィールド タイプである必要があります。
    • 'Preferred Contact Method' must have the options, 'Phone' and 'Email' at a minimum, since they were used in your backup project. Please note, 'Preferred Contact Method' in your target JIRA could also have additional options like 'Fax', 'Post', 'Mobile', etc, if you choose.
      If you have not configured your existing custom field correctly, you will not be permitted to import your backup project until you correct the configuration errors in your target JIRA.
      You may wish to refer to the custom fields documentation for more information on the custom field types and custom field configuration.
  • Compatibility with the Project Import tool — Custom fields also need to be compatible with the Project Import tool for the custom field data to be imported. Custom fields created prior to JIRA v4.0 cannot be imported by the Project Import tool. The custom field developer will need to make additional code changes to allow the Project Import tool to restore the custom field data. If any of the custom fields used in your backup file are not compatible with the Project Import tool, the Project Import wizard will warn you and the related custom field data will not be imported. All the target JIRA system custom fields and the custom fields included in JIRA plugins supported by Atlassian (e.g. JIRA Toolkit, Charting Plugin, Labels Plugin, Perforce Plugin) are compatible with the Project Import tool.

4. ワークフロー、システムフィールド、グループ、ロールをセットアップする

カスタム フィールドに加えて、正常にプロジェクトを復元するために、ターゲット JIRA インスタンスにプロジェクトのワークフロー、課題の属性(例、課題 タイプ)、グループ/ロールが正しく構成する必要があります。次の各制約を確認してください。

Workflows and Workflow Schemes:

  • The project import process does not import workflows or workflow schemes. If you wish to retain a customised workflow from your backup, you will need to create a new workflow in your target JIRA instance and manually edit the new workflow (e.g. create steps and transitions) to reflect your old workflow (note, the default JIRA workflow is not editable). You will then have to add this workflow to a workflow scheme to activate it.
    Read more about creating and editing workflows in the JIRA Workflow and Activating Workflows documents. Please note that you may be required to create and edit a new workflow and workflow scheme to satisfy constraints on workflow entities from your backup, as described in the sections below, even if you do not wish to recreate the exact same workflow.

Do not use the JIRA functionality for exporting and importing workflow XML definitions, to copy your backup workflow to your target JIRA instance. The workflow import/export tools do not include workflow screens in the process. Hence, you will be required to manually edit the workflow definitions post-import to match up new screens to the workflow, which is more work that it is worth.

課題タイプ:

  • If an issue type has been used in your backup project (i.e. there are issues of this issue type), you must set up the same issue type in your target JIRA project. You may want to consider setting up Issue Types for the project instead of globally.
  • Workflow schemes — If you have associated an issue type with a particular workflow scheme in your backup project, you must ensure that the same association exists in your target JIRA. See the above section on 'Workflow and Workflow Schemes' for further information on how to set up a workflow in your target JIRA instance.
  • Custom field configuration schemes — custom field configuration schemes can be used to apply a custom field configuration to specific issue types. If you have configured a custom field differently for different issue types in your backup project, you may wish to set up a custom field configuration scheme to apply the same custom field configuration to the same issue types in your target JIRA instance. This will help ensure that you do not have a custom field for an issue type that is configured incorrectly (e.g. missing an option, if it has multiple selectable options), as described in the 'Setting up custom fields' section above.

ステータス:

  • If an issue status has been used in your backup project (i.e. there are issues with the status), you must set up the same status in your target JIRA project.
  • Workflow schemes — If you have linked a status into a particular workflow scheme in your backup project, you must ensure that the same association exists in your target JIRA. See the above section on 'Workflow and Workflow Schemes' for further information on how to set up a workflow in your target JIRA instance.

セキュリティ レベル:

  • If an issue security level has been used in your backup project (i.e. there are issues with this security level), it must be set up in your target instance of JIRA. If you did not create an existing empty project, we recommend that you do so and set up the appropriate security levels for the project (via an issue security scheme).
  • Issue Security schemes — Not applicable. It does not matter which users, groups or project roles are assigned to which security levels, as long as the appropriate security levels exist (please see the constraints on security levels in the 'Setting up entities and types' section).

優先度:

  • If an issue priority has been used in your backup project (i.e. there are issues with this priority), it must be set up in your target instance of JIRA.

解決状況:

  • If an issue resolution has been used in your backup project (i.e. there are issues with this resolution), it must be set up in your target instance of JIRA.

課題リンク タイプ

  • If an issue link type has been used in your backup project (i.e. there are issues associated by this link type), it must be set up in your target instance of JIRA.

プロジェクト ロール

  • If a project role has been used in your backup project (i.e. there are users/groups assigned to this project role), it must be set up in your target instance of JIRA.
    (Note: The Project Import tool will copy across the project role membership from your backup project to your target JIRA instance, if you choose. See the Project Import section for further details).

グループ:

  • If a user group has been used in your backup project (i.e. there are users in this group), it must be set up in your target instance of JIRA.

スキームに関するメモ
プロジェクト インポート プロセスはスキームに直接影響しませんが、スキームに関連付けられているエンティとタイプは上記のように影響を受ける可能性があります。以下のスキームはプロジェクト インポートによる影響をまったく受けないことに注意してください。

  • Permission schemes — Not applicable. Permissions schemes do not need to match between the backup and target instance of JIRA.
  • Notification schemes — Not applicable. Notification schemes do not need to match between the backup and target instance of JIRA.
  • Screen schemes — Not applicable. Screen schemes do not need to match between the backup and target instance of JIRA.
  • Issue type screen schemes — Not applicable. Issue type screen schemes do not need to match between the backup and target instance of JIRA.
  • Field Configuration schemes — Not applicable. Please note that if a field was configured as optional in your backup project and is configured as a required field in your target JIRA instance, then the project will still be imported even if the field is empty. However, this field will be enforced as mandatory the next time a user edits an issue containing the field.

プロジェクト インポート ツールはバックアップしたプロジェクト内の全ての課題間の課題リンクを自動的に作成します。該当する課題キーでターゲット JIRA インスタンスに他のプロジェクトが既に存在するように、バックアップ プロジェクトと他のプロジェクトの間にリンクを作成しようとします。リンク元/対象が見つからない(プロジェクト全体または特定の課題が見つからない場合)場合、リンクは作成されませんが、プロジェクトはインポートされます。

プロジェクト インポート ツールがプロジェクト間の双方向(元から対象へ、対象から元へ)の課題リンクを作成することに注意してください。これは、2つのプロジェクトを同じバックアップファイルからインポートする場合、2つ目のプロジェクトのインポートが1つ目のプロジェクトのインポートからなくなった2つのプロジェクト間の全てのリンクを作成するということです。

Once you have completed as many of the setup tasks as you are able to, run the Project Import tool.

プロジェクトをインポートする

4つの手順でプロジェクトを復元します。

  1. バックアップ ファイルを指定する
  2. プロジェクトを選択する
  3. データ マッピングの検証を確認する
  4. 復元したプロジェクトを確認する

プロジェクト インポート ツールを起動する場合、JIRA の他のアクティビティを実施する前に、ウィザードの全ての手順を完了することをお勧めします。データ マッピングの検証とその後のプロジェクトのインポートに少し時間がかかるため注意してください。

ウィザードの検証エラーが出た際は、JIRA の構成を修正するためにプロジェクト インポート ウィザードから移動する必要があります。JIRA の構成の修正や他のアクティビティのため、JIRA の他のページに移動する必要がある場合、以下のいずれかを実施します。

  • (推奨)ブラウザの新しいウィンドウ/タブで JIRA の別のセッションを開きます。ブラウザの元のウィンドウ/タブでプロジェクト インポート ツールに戻る場合は、検証画面の「検証の更新」ボタンを使用し、データマッピングを再検証します。
  • JIRA の他のページに移動する前に、現在の手順のプログレス バーが完了するまで待ちます。JIRA からログアウトする、ユーザ セッションが期限切れになる、または別のプロジェクトのインポートを開始するまで、プロジェクト インポート ウィザードの状態は保存されます。プロジェクト インポート ページに(メインの管理メニューを経由して)戻り、ウィザードの最初のページで「再開」リンクを選択すると、プロジェクトのインポートを再開できます。

1. バックアップファイルを指定する

To start the Project Import tool,

  1. Log in as a user with the 'JIRA System Administrators' global permission.
  2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard.
  3. Click the 'Project Import' link in the left hand menu. The first step of the Project Import wizard will display, ' Project Import: Select Backup File'.
  4. 「ファイル名」フィールドにバックアップ ファイルのパスと名前を指定します。バックアップファイルは(JIRA でエクスポートした) XML または ZIP ファイルである必要があります。
  5. Specify the path where you have backed up the attachments (add anchor to backup attachments section) for your project in the 'Backup Attachment Path' field. Do not specify the attachment path for your target instance of JIRA as the backup attachment path, as the Project Import tool will overwrite attachments in that directory. Please also ensure that you have enabled file attachments in your target JIRA instance. You will not be allowed to proceed with the import if you have specified a backup attachment path and do not enable file attachments in your target JIRA instance.
    Note: You can choose to not specify a backup attachment path. If so, you will be able to restore your project from backup, however it will have no attachments associated with it. Please note, you cannot restore your attachments separately if you do not restore them as part of the project import, as the database entries for the attachments will be missing.

2. 復元するプロジェクトを選択する

  1. Select a project to restore from the 'Projects from Backup' dropdown. This dropdown will list all of the projects contained in your backup file.
  2. If you have a valid project to restore from your backup, and your target JIRA instance has an existing empty project, then the 'Overwrite Project Details' option will display. Select the 'Overwrite Project Details' option if you want to overwrite the project details of the existing empty project with the project details from your backup. The project details are the Name, URL, Project Lead, Default Assignee and Description of the project, as well as any project role members set up on your project. If there is no existing empty project in your target instance of JIRA, this option will be checked and disabled as the Project Import will create the project with project details from your backup file.

3. データ マッピングの検証を確認する

  1. プロジェクト インポート ウィザードがバックアップからプロジェクトをインポートするのに必要なデータマッピングの検証を試みます。ウィザードのこの手順では検証を確認することができ、必要に応じて対象 JIRA インスタンスを修正することができます。
    • A tick symbol ( ) means that there are no problems with mapping these entities.
    • An exclamation mark symbol ( ) means that there are problems with the data mapping that you should review before importing the project, but the project can still be imported. For example, a missing optional user that cannot be created automatically by the Project Import tool.
    • A cross symbol ( ) means that there are problems with the data mapping that must be fixed before you can import the project. For example, an Issue Type that is used in the backed up project is missing in your target JIRA instance.
  2. The 'Preparing your target JIRA instance' section on this page lists the common data mapping errors.
  3. 必要に応じてデータ検証エラーを解決したら、「インポート」をクリックし、バックアップ ファイルからデータのインポートを開始します。

プロジェクト インポート ツールは実データのインポートの間、JIRA インスタンスを閉塞させるため、ご利用のインスタンスがその間アクセスされる必要がないことを確認してください。

4. 復元したプロジェクトを確認する

  1. プロジェクト ツールの実行が終了したら、「OK」をクリックし、復元したプロジェクトに移動します。課題、コンポーネント、バージョンが正しく復元されていることを確認する必要があります。すべてのカスタム フィールド データとリンクが正しく復元されていることも確認してください。
  2. 添付ファイルのバックアップディレクトリから添付ファイルが正しく復元されていることを確認します。

プロジェクト インポート ツールがインポートした全ての課題の変更履歴にプロジェクトがインポートされた時を示すエントリを追加します。インポート前からある変更履歴の古いエントリは履歴保持の目的のためだけに残されます。古い JIRA システムと 新しい JIRA システムの構成が異なる場合があるため、古いエントリは一貫性のないデータを含んでいる可能性があります。

不具合が起きた場合

  • If your project import did not complete, you can refer to the JIRA log file. The Project Import tool will log details of the operation to this file, including any unexpected errors and exceptions. e.g. database locked out, disk full... etc.
  • プロジェクトのインポートが完了したが期待通りにプロジェクトが復元されなかった場合、ターゲット JIRA インスタンスで手動で問題を修正します。ターゲット JIRA インスタンスでプロジェクトの削除を実行し、あらゆる警告の検証(例:自動的に追加されないユーザ)に特に注意し、バックアップから再インポートします。

問題を解決できない場合、サポートまでお問い合わせください。詳細については「お困りですか?」セクションを参照してください。

お困りですか?

Need further help? You can raise a support request in the JIRA project at https://support.atlassian.com/ja for assistance from our support team. Please attach to the support case:

  • プロジェクトをインポートしようとしているバックアップ ファイル
  • ターゲット JIRA インスタンスの以下の情報
    • ログ ファイル
    • an XML backup of your target JIRA instance
    • ご利用の JIRA の構成の詳細を知るため、システム情報ページ(管理タブからアクセス)の全コンテンツをコピー ペーストしたもの

You can anonymise the XML backups, if your data contains sensitive information.