プロジェクトをバックアップから復元する
At this moment, Project Import functionality does not include Active Objects data and so it is not possible to move JIRA Agile and JIRA Service Desk project data between instances.
This page describes how to restore a single project from a backup file into your JIRA instance. This also includes instructions on how to migrate a project from JIRA Cloud to JIRA Server (see the Restoring a project from JIRA Cloud to JIRA Server section below).
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.
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.
はじめる前に
バックアップからのプロジェクトの復元は簡単な作業ではありません。プロジェクトのインポートに対応するために、ターゲット JIRAインスタンスの構成を変更する必要があります。さらに、大規模なプロジェクトをインポートする場合、プロジェクトのインポートデータのマッピングは、ハードウェア上のリソースを大量に消費する可能性があり、完了するまでに長時間かかる場合があります。注:プロジェクト インポート ツールは実データのインポートの間、JIRA インスタンスを閉塞させるため、ご利用のインスタンスがその間アクセスされる必要がないことを確認してください。
プロジェクトをリストアする前に、適用するJIRAのインスタンスのフルバックアップを取得することを強くお奨めします。
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 any custom field plugins (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 plugins installed for the Project Import tool to automatically work.
- Project Import functionality does not currently include Active Objects data. This means data such as JIRA Agile sprints and Service Desk customer portals will not be included.
この制限のどれかに当てはまっていてもバックアップからプロジェクトを復元したい場合、以下の適切な手順に従ってプロジェクトをインポートする前に、互換性のあるバックアップ ファイルを作成する必要があります。
JIRA のバージョンが一致しない
- ターゲット JIRA インスタンスよりも前のバージョンの JIRA でバックアップファイルが作成された場合
- ターゲット JIRA インスタンスと同じバージョンのテスト JIRA インスタンスをセットアップします。テスト JIRA インスタンスはターゲット JIRA インスタンスから分離したデータベースとインデックスを使用していることを確認します。
- バックアップ ファイルをテスト JIRA インスタンスにインポートします。(テスト インスタンスに完全に上書きします。)
- Create a new backup file from your test JIRA instance. You can now use this backup to import a specific project into your target production instance.
- ターゲット JIRA インスタンスよりも後のバージョンの JIRA でバックアップファイルが作成された場合
- バックアップを作成した JIRA のバージョンと一致するようにターゲット JIRA のバージョンをアップグレードします。
カスタム フィールド プラグインのバージョンが一致しない
- バックアップのカスタム フィールド プラグインがターゲット JIRA インスタンスのカスタム フィールド プラグインよりも前のバージョンである場合
- 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.
- ターゲット JIRA インスタンスのプラグインのバージョンと一致するように、テスト JIRA インスタンスでカスタム フィールド プラグインのバージョンをアップグレードします。
- Create a new backup file from your test JIRA instance.
- バックアップのカスタム フィールド プラグインがターゲット JIRA インスタンスのカスタム フィールド プラグインよりも後のバージョンである場合
- バックアップを作成した JIRA のバージョンと一致するようにターゲット JIRA インスタンスのカスタム フィールド プラグインのバージョンを アップグレード します。
JIRA Cloud から JIRA サーバーにプロジェクトを復元する
You cannot import a project directly from JIRA Cloud to JIRA Server — the importer will display errors about version mismatches. If you want to restore a project from JIRA Cloud to JIRA Server, follow the steps below:
- Install a new JIRA Server instance (in addition to the one that you want to import your project into). This will be a temporary instance that is used to store a full JIRA import from JIRA Cloud. Ensure that the version of this temporary instance matches the version of the JIRA instance that you want to import your project into, e.g. JIRA 6.2.
- Do a full JIRA migration from JIRA Cloud to the temporary JIRA Server instance. See Migrating from JIRA Cloud to JIRA Server.
- Export the entire JIRA Server instance.
- Import the project into your desired JIRA Server instance, by following the instructions in the Restoring your project section below.
- (optional) Delete the temporary JIRA Server instance, once the project has completed
プロジェクトを復元する
The Project Import tool will attempt to map the data in your backup file into your target JIRA Server instance. If the project you are restoring does not exist in your target JIRA Server instance, it will create and populate the project with data from your backup. If the project already exists and is empty, it will attempt to populate the data from your backup into the project.
ターゲット JIRA インスタンスに空のプロジェクトを作成しなければならない理由
It is important to note that the primary task of the Project Import tool is to restore the data from your backup project into your target JIRA Server instance. While the Project Import tool can create a project if one does not exist in your target JIRA Server instance, it does not recreate any configuration settings that affect the data (e.g. screen schemes). If you wish to retain any configuration settings from your original project, we recommend that you create an empty project in your target instance with the necessary configuration settings before importing the data from your backup project.
You may wish to carry out the following setup tasks to ensure that your target JIRA Server instance is prepared to receive a project import beforehand. This can improve the time taken to validate the data mappings to your target JIRA Server instance.
If you are confident that your JIRA Server 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 Server instance, the Project Import tool will present validation errors for you to address.
Preparing your target JIRA Server instance
The Project Import tool does not automatically add missing project entities (e.g. user groups, issue priorities, custom field types) or fix incorrect associations (e.g. issue types in workflow schemes), so some manual work is required to set up your target JIRA Server instance so that your project can be restored. If the Project Import wizard cannot find a valid target location for any of the backup project data, it will not be able to restore the project. The instructions below describe the setup activities that address the most common data mapping problems that occur when restoring a project from a backup.
We recommend that you perform as much of the configuration of your target JIRA Server 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 Server instance to check the configuration.
1. プロジェクトをセットアップする
If you have a project in your target JIRA Server instance that you wish to restore data into, you will need to ensure that the project is empty, i.e.
- no issues — read the Quick Search page to find out how to find all issues in a project
- no components — read the Component Management page to find out how to view a summary of a project's components
- no versions — read the Version Management page to find out how to view a summary of a project's versions
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 Server instance, then you will not be permitted to import the project. This may occur if you have External User Management enabled in your target JIRA Server instance — you will need to disable External User Management or create the missing users manually in your external user repository before commencing the import.
バックアップ ファイルのユーザーについて十分な情報を持ってない場合、プロジェクト インポート ウィザードは(新しいページで)いないユーザーを含む XML ファイルへのリンクだけでなく、いないユーザーの表へのリンクを提供することに注意してください。ユーザーの表は最大100ユーザーを表示しますが、XML ファイルは常に利用可能です。
3. カスタム フィールドをセットアップする
前述したように、プロジェクトのインポートでは、カスタム フィールド プラグインのバージョンはバックアップとターゲット JIRA インスタンスの間で一致している必要があります。ターゲット JIRA インスタンスでカスタム フィールドが次のように正しくセットアップされていることを確認する必要があります。
- カスタム フィールド タイプ — ご利用の JIRA に特定のカスタム フィールド タイプ(例、カスケード選択)がインストールされていない場合、そのカスタム フィールド タイプを使用しているバックアップ プロジェクトの全てのカスタム フィールド データが復元されません。ただし、プロジェクトはまだ復元できます。
例えば、「カスケード選択」フィールド タイプのカスタム フィールド「タイトル」があり、それをバックアッププロジェクトで使っている(即ち、このフィールドでデータを保存している)とします。「カスケード選択」カスタム フィールド タイプが対象の JIRA にインストールされていない場合、カスタム フィールド「タイトル」(および他のカスケード選択カスタム フィールド)の全てのデータは復元されません。 - 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:
- プロジェクト インポート プロセスはワークフローとワークフロー スキームをインポートしません。バックアップからカスタマイズされたワークフローを残したい場合、ターゲット JIRA インスタンスに新しいワークフローを作成し、新しいワークフロー(例:ステップとトランジションの作成)を手動で編集して古いワークフローを反映させる必要があります(注:デフォルトの JIRA ワークフローは編集できません)。次にこのワークフローをワークフロー スキームに追加してアクティブ化する必要があります。
- プロジェクトをインポートする場合、課題作成トランジションと課題作成イベントが全ての対応する後処理とともに各課題にトリガーされます。インポートした後課題作成トランジションを変更する(例えば、課題作成フィールドの値を1つ設定する)場合、元のものと違う値が得られる場合があります。回避策として、手動でインポート中の後処理を無効にすることができます。
- 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.
バックアップのワークフローをターゲット JIRA インスタンスにコピーするためにワークフローの XML 定義をエクスポートおよびインポートする JIRA の機能を使用しないでください。ワークフローのインポート/エクスポート ツールは途中でワークフロー画面を含みません。そのため、ワークフローに新しい画面を組み合わせるためにインポート後に手動でワークフロー定義を編集する必要があります。
課題タイプ:
- 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.
- ワークフロー スキーム - バックアップ プロジェクトの特定のワークフロー スキームを課題タイプと関連付けている場合は、同じ関連付けがターゲット JIRA に存在するか確認する必要があります。ターゲット JIRA インスタンスでワークフローを設定する方法の詳細は、上記のセクションの「ワークフローとワークフロー スキーム」を参照してください。
- カスタム フィールド構成スキーム — カスタム フィールド構成スキームはカスタム フィールド構成を特定の課題タイプに適用するのに使うことができます。カスタムフィールドをバックアップ プロジェクトの他の課題タイプと異なる構成にした場合、カスタム フィールド構成スキームにターゲット JIRA インスタンスの同じ課題タイプを適用することができます。上記の「カスタム フィールドをセットアップする」セクションで説明されているように、誤って構成された課題タイプ(例、オプションがない、複数の選択可能オプションがある場合)のカスタム フィールドが無いことを確認するのに役立ちます。
ステータス:
- ある課題ステータスがバックアップ プロジェクトで使用されている(すなわち、その課題ステータスの課題がある)場合、ターゲット JIRA プロジェクト内に同じ課題ステータスを設定する必要があります。
- 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.
ワークフローを検索する時、ステップ名ではなく、リンク済みステータス名が一致していることを確認します。
セキュリティ レベル:
- 課題セキュリティ レベルがバックアッププロジェクトで使用されている(このセキュリティレベルが設定されている課題がある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。既存の空プロジェクトを作成していない場合、空プロジェクトを作成し、プロジェクトに(課題セキュリティ スキーム経由で)適切なセキュリティ レベルを設定することをお勧めします。
- 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).
優先度:
- 課題優先度がバックアッププロジェクトで使用されている(この優先度が設定されている課題がある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。
解決状況:
- 課題解決状況がバックアッププロジェクトで使用されている(この解決状況が設定されている課題がある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。
課題リンク タイプ
- 課題リンク タイプがバックアッププロジェクトで使用されている(このリンク タイプが設定されている課題がある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。
プロジェクト ロール
- プロジェクト ロールがバックアップ プロジェクトで使用されている(例、このロールが関連付けられているユーザ/グループがある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。
(注: プロジェクト インポート ツールは選択に応じて、バックアッププロジェクトからターゲット JIRA インスタンスに全プロジェクト ロールのメンバーシップをコピーします。詳細はプロジェクト インポート セクションを参照してください。
グループ:
- ユーザ グループがバックアッププロジェクトで使用されている(このユーザ グループが設定されている課題がある)場合、それをターゲット JIRA インスタンスにセットアップする必要があります。
スキームに関するメモ
プロジェクト インポート プロセスはスキームに直接影響しませんが、スキームに関連付けられているエンティとタイプは上記のように影響を受ける可能性があります。以下のスキームはプロジェクト インポートによる影響をまったく受けないことに注意してください。
- 権限スキーム — 提供できません。権限スキームはバックアップとターゲット JIRA インスタンスの間で一致している必要はありません。
- 通知スキーム — 適用できません。通知スキームはバックアップとターゲット JIRA インスタンスの間で一致している必要はありません。
- 画面スキーム — 適用できません。画面スキームはバックアップとターゲット JIRA インスタンスの間で一致している必要はありません。
- 課題タイプ画面スキーム — 適用できません。課題タイプ画面スキームはバックアップとターゲット 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.
5. リンクをセットアップする
プロジェクト インポート ツールはバックアップしたプロジェクト内の全ての課題間の課題リンクを自動的に作成します。該当する課題キーでターゲット JIRA インスタンスに他のプロジェクトが既に存在するように、バックアップ プロジェクトと他のプロジェクトの間にリンクを作成しようとします。リンク元/対象が見つからない(プロジェクト全体または特定の課題が見つからない場合)場合、リンクは作成されませんが、プロジェクトはインポートされます。
プロジェクト インポート ツールがプロジェクト間の双方向(元から対象へ、対象から元へ)の課題リンクを作成することに注意してください。これは、2つのプロジェクトを同じバックアップファイルからインポートする場合、2つ目のプロジェクトのインポートが1つ目のプロジェクトのインポートからなくなった2つのプロジェクト間の全てのリンクを作成するということです。
可能な限り多くのセットアップタスクを完了させたら、プロジェクト インポート ツールを起動します。
プロジェクトをインポートする
4つの手順でプロジェクトを復元します。
プロジェクト インポート ツールを起動する場合、JIRA の他のアクティビティを実施する前に、ウィザードの全ての手順を完了することをお勧めします。データ マッピングの検証とその後のプロジェクトのインポートに少し時間がかかるため注意してください。
ウィザードの検証エラーが出た際は、JIRA の構成を修正するためにプロジェクト インポート ウィザードから移動する必要があります。JIRA の構成の修正や他のアクティビティのため、JIRA の他のページに移動する必要がある場合、以下のいずれかを実施します。
- (推奨)ブラウザの新しいウィンドウ/タブで JIRA の別のセッションを開きます。ブラウザの元のウィンドウ/タブでプロジェクト インポート ツールに戻る場合は、検証画面の「検証の更新」ボタンを使用し、データマッピングを再検証します。
- JIRA の他のページに移動する前に、現在の手順のプログレス バーが完了するまで待ちます。JIRA からログアウトする、ユーザ セッションが期限切れになる、または別のプロジェクトのインポートを開始するまで、プロジェクト インポート ウィザードの状態は保存されます。プロジェクト インポート ページに(メインの管理メニューを経由して)戻り、ウィザードの最初のページで「再開」リンクを選択すると、プロジェクトのインポートを再開できます。
1. バックアップファイルを指定する
To start the Project Import tool,
- Log in as a user with the 'JIRA System Administrators' global permission.
- Choose > System. Select Import & Export > Project Import to open the Project Import wizard page.
- 「ファイル名」フィールドにバックアップ ファイルのパスと名前を指定します。バックアップファイルは(JIRA でエクスポートした) XML または ZIP ファイルである必要があります。
- Copy the attachments from the path where you have backed up the attachments to the 'Backup Attachment Path' shown in the import window. This path is under the JIRA Home Directory of the instance. Please note that if file attachments are not enabled in your target JIRA instance you will not see the path to which you need to copy the attachments from the backup.
Note: You can choose to not copy the attachments to the '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. 復元するプロジェクトを選択する
- Select a project to restore from the 'Projects from Backup' dropdown. This dropdown will list all of the projects contained in your backup file.
- バックアップから復元するための有効なプロジェクトがあり、対象の JIRA インスタンスに既存の空プロジェクトがある場合、「プロジェクトの詳細を上書きする」オプションが表示されます。既存の空プロジェクトの詳細をバックアップのプロジェクトの詳細で上書きしたい場合、「プロジェクトの詳細を上書きする」オプションを選択します。プロジェクトの詳細とは、名前、URL、プロジェクト リーダー、デフォルトの担当者、プロジェクトの説明、プロジェクト ロール メンバーのことを指します。対象 JIRA インスタンスに空プロジェクトが存在しない場合、プロジェクト インポートがバックアップ ファイルからプロジェクト詳細とともにプロジェクトを作成するとき、このオプションはチェック済みかつ無効となります。
3. データ マッピングの検証を確認する
- プロジェクト インポート ウィザードがバックアップからプロジェクトをインポートするのに必要なデータマッピングの検証を試みます。ウィザードのこの手順では検証を確認することができ、必要に応じて対象 JIRA インスタンスを修正することができます。
- チェック マーク ( ) は、エンティティのマッピングに問題がないことを示しています。
- エクスクラメーション マーク ( ) は、プロジェクトをインポートする前にデータ マッピングで確認すべき問題がありますが、プロジェクトはインポートできることを示します。これには、見つからないユーザーがいて、それをプロジェクト インポート ツールで自動的に作成できない場合などがあります。
- 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.
- このページの「対象 JIRA インスタンスを準備する」セクションでデータ マッピング エラーを一覧にしています。
- 必要に応じてデータ検証エラーを解決したら、「インポート」をクリックし、バックアップ ファイルからデータのインポートを開始します。
プロジェクト インポート ツールは実データのインポートの間、JIRA インスタンスを閉塞させるため、ご利用のインスタンスがその間アクセスされる必要がないことを確認してください。
4. 復元したプロジェクトを確認する
- プロジェクト ツールの実行が終了したら、「OK」をクリックし、復元したプロジェクトに移動します。課題、コンポーネント、バージョンが正しく復元されていることを確認する必要があります。すべてのカスタム フィールド データとリンクが正しく復元されていることも確認してください。
- 添付ファイルのバックアップディレクトリから添付ファイルが正しく復元されていることを確認します。
プロジェクト インポート ツールがインポートした全ての課題の変更履歴にプロジェクトがインポートされた時を示すエントリを追加します。インポート前からある変更履歴の古いエントリは履歴保持の目的のためだけに残されます。古い 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 インスタンスの以下の情報
- ログ ファイル
- 対象 JIRA インスタンスのXML バックアップ
- ご利用の JIRA の構成の詳細を知るため、システム情報ページ(管理タブからアクセス)の全コンテンツをコピー ペーストしたもの
You can anonymise the XML backups, if your data contains sensitive information.