プロジェクト キーの編集
はじめる前に
希望するプロジェクトキーが、Jira アプリケーションで指定されるプロジェクト キーのフォーマットの制約に準拠する必要があります。既定では、プロジェクト キーは 2 文字以上で、大文字のみを含む必要があります。別の制約を適用するようにプロジェクト キーのフォーマットを変更することもできます。方法については、「プロジェクト キーのフォーマットの変更」を参照してください。
- この変更は、使用率が低い時間に実行してください。更新したプロジェクト キーを保存すると、Jira アプリケーションはバックグラウンドで再インデックスを開始します。これはインスタンスのパフォーマンスに影響を与える可能性があります。"Jira をロックしてインデックスを再構築する" 方法を選択することはできませんが、バックグラウンドでのインデックスはプロジェクトの課題のみに限定されるため、短時間で実行されます。
- 変更をユーザーに伝える — プロジェクト キーの変更の結果を認識し、ユーザーが変更に十分に備えていることを確認します。詳細は、以下の「変更」セクションを参照してください。
プロジェクト キーの編集
- 画面右上で [管理
] > [プロジェクト] の順に選択します。 - 変更するプロジェクトを選択します。
- 変更するプロジェクトの [アクション] 列で [編集] を選択します。
- プロジェクト キーを編集し、[詳細を保存] をクリックします。インストール済みのアプリケーションのプロジェクト タイプのみを使用できます。
これにより、プロジェクトのインデックス再作成が開始されます。完了時に確認が必要です。
注意:
- プロジェクトの他の詳細フィールドを更新した場合、変更はすぐに反映されます。インデックスの再作成が完了するまで待つ必要はありません。
- バックグラウンドの再インデックスをキャンセルした場合、プロジェクトに関する課題の検索で問題が生じます。キャンセルする必要がある場合、後でもう一度実行してこれらの問題を修正してください。
更新後のタスク
- プロジェクトのエンティティ リンクの修正 — Jira を別のアトラシアン製品に接続している場合、Jira プロジェクトと他のアプリケーションの関連 "プロジェクト" (例: Confluence スペース) 間でエンティティ リンクが自動的に作成されます。Jira プロジェクトのキーを変更した場合、「プロジェクト間でリンクを作成する」の説明に従って、プロジェクトのエンティティ リンクを修正する必要があります。
- Jira Software のアジャイル ボードのフィルターの更新 - Jira Software のアジャイル ボードが古いプロジェクト キーを使用している場合、ボードのフィルターを更新し、新しいプロジェクト キーを反映させる必要がある場合があります。これを行わないと、名前が変更されたプロジェクトの課題をボードで表示できなくなる場合があります。
変更管理の注意事項
プロジェクト キーの編集は大規模な変更ですが、ほとんどの場合、Jira プロジェクトは新しいキーで期待どおり動作します。注意すべきいくつかの事例について以降で説明します。これらを確認し、必要に応じてユーザーに共有することをおすすめします。
- 古いプロジェクト キーは JQL クエリで使用可能 — ユーザーは、古いプロジェクト キーを参照する課題フィルターを更新する必要はありません。
- Confluence と Jira を使用している場合、Confluence の Jira 課題マクロは引き続き動作します。変更をすぐに確認できない場合は、キャッシュが更新されるまでしばらくお待ちください。
- 古いプロジェクト キーを使用して新しいプロジェクトを作成することはできません。ただし、名前を変更したプロジェクトを古いプロジェクト キーに戻すように変更することはできます。プロジェクトを削除すると、関連付られたすべてのキーが解放され、再使用できるようになります。
- リンクは、Jira 内部のものか外部ソースからのものかを問わず、動作します。しかしながら、リンク エイリアスは更新されません。たとえば、ある課題の説明に課題 "EXAMPLE-1" へのリンクがあり、プロジェクト キー "EXAMPLE" を "DEMO" に変更したとします。この場合、エイリアス "EXAMPLE-1" のエイリアスは "DEMO-1" には更新されません。ただし、リンクにアクセスすると、引き続き DEMO-1 にリダイレクトされます。
- ガジェットをグローバル フィルターとともに使用している場合、プロジェクトの名前を変更した後にフィルターを更新する必要があります。
- すべての添付ファイルはプロジェクト キーを変更した後でもアクセス可能です。ただし、それらが保存されているディレクトリ (
<Jira Home>\data\attachmentsディレクトリ配下) は古いプロジェクト キーを保持します。たとえば、プロジェクト キーを TEST から DEMO に変更した場合、添付ファイルは<Jira Home>\data\attachments\TESTの下に保存されます。 名前が変更されたプロジェクトをエクスポートしてからインポートすると、プロジェクト キーが更新されます。元のプロジェクトキーは保持されません。そのプロジェクトのすべての履歴キーが削除されます。これによってデータベース内のデータが直接変更されるのを防ぐ回避策があります。この Answers の投稿を参照してください。
関連トピック
プロジェクト キーの最大の長さを変更する — プロジェクト キーで使用可能な最大文字数を変更できます。「Jira アプリケーションのオプションの構成」の説明に従って Jira 管理コンソールの [一般設定] ページに移動し、[プロジェクト キーの最大サイズ] フィールドを変更します。プロジェクト キーのフォーマットを変更する — プロジェクト キーのフォーマットを変更できます。これによって上述のとおり、作成または編集時にプロジェクト キーのフォーマットを制限します。詳細については、「プロジェクト キーのフォーマットの変更」を参照してください。
開発者向けの注意事項
- REST API 呼び出しは古いプロジェクト キーでも動作します。課題キーを指定する REST 呼び出しは、プロジェクト キーの変更後でも古い課題キーで動作します。たとえば、プロジェクト キーを
EXAMPLEからDEMOに変更した後でも、/rest/api/issue/EXAMPLE-100は機能します。 - 新しいイベント、ProjectUpdatedEvent を作成しました。このイベントはプロジェクトの詳細が変更されるたび (プロジェクト キーの変更を含む) にトリガーされます。
- すべての課題キーおよびプロジェクト キー (過去および現在) を取得する必要がある場合は、次の方法で実行できます。
- REST:
- プロジェクトのすべてのプロジェクト キーを取得:
/rest/api/2/project/<project key>?expand=projectKeys
- プロジェクトのすべてのプロジェクト キーを取得:
- Java API:
- すべてのプロジェクト キーを取得:
com.atlassian.jira.project.ProjectManager#getAllProjectKeys - 課題のすべての課題キーを取得:
com.atlassian.jira.issue.IssueManager#getAllIssueKeys
- すべてのプロジェクト キーを取得:
- REST: