用語の設定
アジャイルのベスト プラクティスに従えるように、Jira Data Center バージョン 8.17 以降には Flexible Terminology (柔軟な用語) 機能が用意されています。この機能によって管理者は一般的な Jira Data Center 用語 (sprint と epic) を変更できるため、Jira と SAFe (Scaled Agile Framework) や LeSS (Large-Scale Scrum Framework) などの大規模アジャイル フレームワークの間で、スプリントとエピックの一貫した命名を維持できます。
用語の変更は英語でのみ行えます。従うフレームワークや選択する用語にかかわらず、変更をインスタンス全体で簡単に実装できます。
新しい用語は、元の用語を出力で置き換えます。
- 課題タイプ名
- 課題画面
- レポート
- エピック関連のフィールド名 (エピック名、エピックの色、エピック ステータス、エピック リンク)
- 基本と詳細の各検索結果
- API 出力
Jira では、可能な限り元の用語の先頭の大文字が保持されます。
「sprint」や「epic」をカスタム用語に置き換える場合は、リストされる出力で元の用語の代わりに使用する必要がある新しいラベルを Jira で設定します。カスタム用語の大文字と小文字は、出力によって異なる場合があります。たとえば、「sprint」を「Team Sprint」に変更し、両方の単語の最初の文字を大文字にする場合は、次のようになります。
課題ビューの [Sprint] フィールドが [Team sprint] (「Team」という単語のみ大文字) に変更されます。
スプリントの作成または編集フォームの [Sprint Name] フィールドが [Team Sprint Name] (3 つの単語すべて大文字) に変更されます。
大文字使用の動作を示すその他の例については、「Jira Data Center での用語の大文字使用の仕組み」を参照してください。
新しい用語は、以下の入力には適用されません。
- 詳細検索の結果 (JQL クエリ)。元の用語である「sprint」と「epic」、加えてエピック関連フィールドの元の名前を使用する必要があります。
- API クエリ (JQL)。
新しい用語をアプリに適用する際の制限に関する詳細については、次のセクションをご参照ください。
用語の定義
はじめる前に
用語の変更はインスタンスに広範な影響を及ぼすため、開始する前に次を実行することをお勧めします。
- 用語の変更を送信する前に、データベースと重要なディレクトリをバックアップする
- ユーザーが新しい名前に混乱しないように、これらの変更は計画的なダウンタイム中またはユーザーが少ない時間帯に行う
用語を表示して管理するには、次を実行します。
- In the upper-right corner of the screen, select Administration
, then System.
- [ユーザー インターフェイス] (左側のパネル) で [用語] を選択します。
- [用語を変更] を選択します。
- 新しい用語の単数/複数形を定義します。
- [名前を変更] を選択します。
- 新しい用語をご確認のうえ、[変更] を選択して確定します。
次のルールに従って、新しい用語の単数/複数形を定義できます。
エピックとスプリントの名前は入れ替えられません。
新しい用語は 40 文字以下で、英数字とスペースのみを含められます。
- 用語は一意である必要があります。たとえば、エピックとスプリントの両方を「Potatoes」にできません。
すべてのフィールドに 1 文字以上の値が必要です。
名前を変更すると、英語 (UK) と英語 (US) で翻訳された用語が上書きされる場合があります。
アトラシアン製品全体で用語を調整する
管理者は Jira の用語を制御できて、サードパーティ製アプリなしでグローバルに定義できます。ただし、その他の製品のためにいくつか考慮が必要なことがあります。
Advanced Roadmaps
用語「sprint」を Jira で変更すると、Advanced Roadmaps でも変更されます。ただし、用語「epic」は自動更新されません。レベル名は個別に更新する必要があります。これを行うには、[プラン] > [管理] > [階層レベル] の順に移動します。
Jira Align
Jira コネクターではプラットフォームの用語が同期されないため、Jira Align で用語を個別に更新する必要があります。Jira Align で新しい用語を用語「sprint」と「epic」に設定するには、[管理者] > [プラットフォーム] > [テクノロジー] の順に移動します。
制限事項
言語
用語の変更は、英語の変化形にのみ適用されます。それ以外の言語の場合、Jira には元の名前が表示されます。
エピック課題タイプとエピック関連フィールドの翻訳
Flexible Terminology (柔軟な用語) は、エピック課題タイプとエピック関連フィールドの翻訳を使用して名前をローカライズします。その結果、すべての API は、API をクエリまたは課題 (新しい用語など) を保存する際に、ローカライズされた名前を返します。しかし、クエリを構築するには、ローカライズされた用語ではなく元の用語を使用する必要があります。
新しい変更項目は翻訳されたフィールドの名前で保持されるため、フィールドの履歴に関するクエリではそのフィールドの現在と過去のすべての名前が考慮されます。
アプリまたはスクリプトには、課題タイプ「epic」または次の名前を持つエピック関連フィールドに対するハードコードされた参照がある場合があります。
エピック名
エピックの色
エピック ステータス
Epic Link (エピック リンク)
- Sprint
このような場合、これらのフィールドは ID (推奨) または新しい名前を使用するように適合させる必要があります。
そのためには、「sprint」または「epic」を、rest/api/2/terminology/entries で返された新しい用語に置き換えます。
アプリまたはスクリプトがすでにエピック課題タイプまたはエピック関連のフィールドにカスタム翻訳を使用している場合は、変更を加えないでください。
詳細検索では、元の名前の「sprint」、「epic」、エピック関連フィールドを使用する
用語集機能によって、用語「sprint」と課題タイプ名の用語「epic」を変更できます。また、「epic」の新しい用語はエピック関連フィールド (エピック名、エピックの色、エピック ステータス、エピック リンク) の名前に適用されます。
その結果、ボード、課題画面、レポート、基本検索フィルターなど、出力のいたるところに新しい用語が表示されます。
ただし、API クエリまたは詳細検索の入力には、元の用語である「sprint」、「epic」、エピック関連フィールドが必要です。
詳細検索クエリの例を次に示します: 解決状況 = 未解決、課題タイプ = エピック。
詳細検索で元の用語が必要となる別の例を次に示します。説明のために、ここでは用語「epic」を「feature」に変更します。
基本検索は「feature」で機能する | 詳細検索は「epic」が必要する |
|---|---|
|
|
この結果、フィールド Epic Link は Feature Link という名前になりました。ただし、このフィールドを詳細検索で使用する場合は、フィールドの元の名前を使用する必要があります。
以下のスクリーンショットでは、検索におけるエピック課題タイプと関連フィールドの元の名前を列のカスタム名と比べて、その違いに注目してください。
この検索では、Epic と Epic Link を使用しています。これが入力画面です。
しかし、ボード上の列 (出力内) には、Feature Link と Feature Name があります。これらはエピック関連のフィールドで、この例では「epic」という名前が「feature」に変わっています。
データベース内では元の用語が保持される
「sprint」と「epic」に新しい用語を設定しても、データベースには記録されません。データベースには、元の用語「sprint」、「epic」、加えてエピック関連フィールドの元の名前が引き続き含まれます。
例 1
データベースがエピック関連フィールドの元の名前を保持して、用語「epic」が「feature」に変更されていることを示すクエリの例を次に示します (カスタム フィールド名は、これらのフィールドの名前を意味する Jira の内部用語です)。
例 2
次は、データベースがスプリント、エピック、エピック関連フィールドの元とカスタマイズされた両用語を保持する場合があることを示す別のクエリの例です。これは、元の条件が変更された直後に問題が更新された際に発生する可能性があります。
スクリーンショットでは、課題 TERM-9 に最初に [エピック リンク] フィールドがあったことがわかります。しかし、用語「エピック」は「フィーチャー」に変更されました。そのため、課題が同日に更新された際に、[エピック リンク] フィールドの名前が [フィーチャー リンク] に変更されました。その結果、データベースにはフィールドの元の名前とカスタマイズされた名前の両方が保持されます。
