プロジェクトキーの編集

プロジェクトの定義

このページの内容

このセクションの項目

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

プロジェクトキーの編集は簡単なタスクです。プロジェクトを作成する際は、プロジェクトの作成後にプロジェクトキーを編集するのではなく、長期的なニーズに合うキーを選択してください。多足、次のような状況では既存のプロジェクトのキーを変更する必要があります。例: 製品名の変更。

このページの説明は、プロジェクトキーの変更と、このような変更に関する情報を示しています。

はじめる前に

  • 希望するプロジェクトキーは、JIRA アプリケーションで指定したプロジェクトキーのフォーマットの制約に準拠する必要があります。既定では、プロジェクトキーは 2 文字以上で、1 つの大文字を含む必要があります。別の制約を実施するよう、プロジェクトキーのフォーマットを変更することもできます。方法については、「プロジェクトキーのフォーマットの変更」を参照してください。

  • この変更は、使用率が低い時間に実行してください — JIRA アプリケーションは更新したプロジェクトキーを保存すると background re-index を開始します。これにより、インスタンスのパフォーマンスに影響を与える可能性があります。「JIRA をロックしてインデックスを再構築する」を選択することはできません。バックグラウンドインデックスはプロジェクトの課題のみに限定されているため、短時間で実行されます。
  • 変更をユーザーに伝える — プロジェクトキーの変更の結果を認識しており、変更に対し、ユーザーの準備を適切に行っていることを確認してください。詳細は、以下の「変更」を参照してください。

プロジェクトキーの編集

  1. > [プロジェクト] を選択し、関連するプロジェクトを選択します
  2. 変更するプロジェクトを見つけます。
  3. 変更するプロジェクトのアクション列で編集を選択します。
  4. プロジェクトキーを編集し、詳細を保存をクリックします。インストール済みのアプリケーションのプロジェクトタイプのみを使用できます。

これにより、プロジェクトのインデックス再作成が開始されます。完了時に確認が必要です。

注意:

  • その他のプロジェクトの詳細フィールドを更新した場合、ただちに変更を確認できます。インデックス再作成が完了するまで待つ必要はありません。
  • バックグラウンドの再インデックスをキャンセルした場合、プロジェクトに関する課題の検索で問題が生じます。キャンセルしたい場合は、後でもう一度実行してこれらの問題を修正してください。

更新後のタスク

  • プロジェクトエンティティリンクを修正する — JIRA を別のアトラシアン製品に接続している場合、JIRA プロジェクトと他のアプリケーションの関連「プロジェクト」間でエンティティリンクが自動的に作成されます (例: Confluence spaces)。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 の下に保存されます。
  • 名前が変更されたプロジェクトをエクスポートしてからインポートすると、プロジェクトキーが更新されます。たとえば、元のプロジェクトキーは保持されません。実際、そのプロジェクトのすべての履歴キーは削除されます。これにより、データベース内のデータが直接変更されるのを防ぐ回避策があります。この回答の投稿を参照してください。

関連トピック

プロジェクトキーの最大の長さを変更する — プロジェクトキーで使用可能な最大文字数を変更できます。「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
最終更新日 2018 年 5 月 8 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する

このセクションの項目

Powered by Confluence and Scroll Viewport.