Jira 課題マクロ
Confluence サイトが JIRA アプリケーションに接続されている場合、Confluence ページ上のグラフとして JIRA 課題を表示できます。Confluence を、JIRA Software や JIRA Service Desk などの JIRA アプリケーションへ接続できます。
JIRA 課題マクロでできること
JIRA の課題マクロでできること :
- JIRA クエリ言語 (JQL) 検索、フィルター、または URL に基づいてページ上に課題のリストを表示します。
- 1 つの課題を表示します。
- 課題数を表示します。
- Confluence を終了せずにページ上で新しい課題を作成し、課題を表示します。
JIRA 課題マクロの追加と更新 - 概要
Confluence ページ上のマクロを使用するためのクイックガイド:
- Confluence のエディタで、
> [その他のマクロ] を選択します。 - 対象のマクロを見つけて、選択します。
オートコンプリートでマクロを素早く入力する方法
- 新しいエディタ - 「/」と要素 (ツールや挿入メニューのアイテム) の先頭の文字を入力すると、提案の一覧が表示されます。
- 従来のエディタ - 「{」とマクロ名の先頭を入力すると、マクロ候補の一覧が表示されます。
詳細については、「キーボード ショートカット、マークダウン、およびオートコンプリート」をご参照ください。
既存のマクロを編集する方法
マクロ プレースホルダーをクリックして、編集を選択します 。 マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。
スクリーンショット: Confluence ページでの JIRA 課題マクロの例
JIRA クエリ言語 (JQL) 検索経由で課題を表示する
また、マクロを使用し、JIRA Query Language (JQL) を使用した検索結果に基づいて、ページ上で課題の表を表示することもできます。
JQL は、SQL に似たシンプルなクエリ言語です。基本的な JQL のクエリは、フィールド、演算子 (= や > など)、1 つ以上の 値 または関数 で構成されています。
例:
次のクエリは、 プロジェクト内のすべての課題を検索します。
project = "TEST"次のクエリは、'CONF' プロジェクトの 'documentation' コンポーネント内のすべての課題を検索します。
project = CONF and component = documentation
JQL 構文の詳細については、JIRA Software ドキュメントの「詳細検索」を参照してください。
JQL 検索に基づいて課題のテーブルを表示するには:
- 上記のように、Confluence ページに JIRA 課題マクロを挿入します。
- 検索ボタンの横にある JIRA サーバーを選択します。
- プロンプトが表示されたら、JIRA サーバーにログインします。
- JQL クエリを検索ボックスに入力します。
- 検索を選択します。
- ディスプレイをカスタマイズする場合は、表示オプションを選択し、課題の表に表示される列と課題数を調節します。
- [挿入] を選択します。
スクリーンショット JIRA 課題マクロ ブラウザーの表示オプション。
JIRA URL 経由で課題を表示する
次の JIRA アプリケーション URL を JIRA 課題マクロに貼り付けることができます。Confluence は URL を直ちに JQL 検索へと変換します。
- 課題検索またはフィルターの URL。
- 1 つの課題の URL。
- 検索の XML ビューの URL。
自動変換: URL を直接 Confluence エディターに貼り付けることができます (マクロ ブラウザーを呼び出さずに)。Confluence は URL を JIRA 課題マクロに自動変換します。
1 つの課題、または選択した課題を表示する
1 つの JIRA 課題を表示するには、次の方法からいずれかを選択します。
- Confluence ページに直接課題の URL を貼り付けます。(マクロ ブラウザーを使用する必要はありません。)Confluence は JIRA 課題マクロへのリンクを自動変換します。
- または: 上記のように JIRA 課題マクロをページに追加し、最近の表示履歴 を選択して最近訪問した課題を表示します。課題を選択し、 挿入を選択します。
- または: 上記のように JIRA 課題マクロをページに追加し、マクロ ブラウザーの検索ボックスに課題 URL を貼り付けます。
- または: JIRA 課題をページﾞに追加、上記のように JQL 経由でマクロ ブラウザで検索条件を定義、またはマクロ ブラウザ内の検索結果で、課題の横にあるチェックボックスを選択します。
課題キーのみや、課題キーとサマリーを表示するよう選択できます。マクロ プレースホルダーをクリックして、「概要を表示」または「概要を非表示」を選択します。
検索結果から JIRA 課題のサブセットを表示します。
- ページ JIRA 課題マクロを追加します。
- JQL 経由でマクロ ブラウザーの検索条件を定義します (上記のとおり)。
- マクロ ブラウザーで、検索結果の必要な課題の隣にあるチェックボックスを選択します。
スクリーンショット: 表示する課題のサブセットを選択する
課題数を表示する
課題の表ではなく、検索で返される課題の数を表示するよう選択できます。JIRA 課題マクロは、JIRA アプリケーションの検索にリンク付けされた課題の数を表示します。
スクリーンショット: Confluence ページで課題数を表示する JIRA 課題マクロ
課題カウントを表示するには:
- JIRA 課題マクロをページに追加します。
- JQL 経由でマクロ ブラウザーの検索条件を定義します (上記のとおり)。
- 表示オプション を選択し、マクロブラウザで [表示オプション] の横にある 合計発行数 を選択します。
- [挿入] を選択します。
新しい課題を作成する
Confluence ページで編集を行いながら、Confluence エディターを開いたまま JIRA で課題を作成し、Confluence ページにその課題を表示させることができます。
課題を作成してページに追加するには:
- 上記のように、ページに JIRA 課題マクロを挿入します。
- 新しい課題作成 を選択します。
- 要求されたら JIRA サーバー、プロジェクト、課題に関する情報を提供します。
- [挿入] を選択します。
Confluence は課題を作成するよう JIRA アプリケーションにリクエストを送信した後、ページで新しく作成した課題を表示します。
制限事項
JIRA 課題マクロは選択されたプロジェクトで課題を作成できない場合、通知します。これは、プロジェクトに JIRA 課題マクロでサポートされていないフィールド、フィールド設定およびその他のカスタマイズがあることが原因の可能性があります。この状況では、JIRA アプリケーションで直接課題を作成する必要があります。
JIRA アプリケーションからの HTML レンダリング
Conflucnce から JIRA へのアプリケーション リンクを設定すると、JIRA の書式付きフィールドを Confluence に表示することができます。この操作を行わない場合、JIRA 課題マクロの出力内で、これらの書式付きフィールドはエスケープされます。これにより、信頼されない JIRA サーバーによる不正な HTML の可能性を防ぐことができます。これに気付く可能性が最も高いフィールドは、説明フィールドです。
この例では、JIRA での説明列の表示方法を示します。
説明
これは
- 課題の
- 説明です
JIRA と Confluence の間のアプリケーション リンクがない場合、JIRA 課題マクロには次のように説明が表示されます。
説明
<p>これは課題の<ul><li>説明</li><li>です</li></ul></p>
JIRA 課題マクロの無効化
"Jira Macros" と呼ばれるアドオン (プラグイン) により提供される機能です。ご使用のサイトでマクロを使用できないようにするために、アドオンを無効にすることもできます。「アプリの無効化と有効化」を参照してください。
Wiki マークアップの例
Wiki マークアップは従来のエディタでのみサポートされます。
Wiki マークアップはエディタ外部でマクロを追加する必要がある場合 (スペースのサイドバー、ヘッダー、またはフッターのカスタム コンテンツなど) に便利です。
マクロ名: jiraissues
マクロ本文: なし。
{jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}注: マクロ ブラウザー経由で使用できない多数の付加パラメーターは、ストレージ形式や Wiki マークアップで利用可能です。
パラメーター名 | 必須 | 既定 | パラメーターの説明と指定可能な値 |
|---|---|---|---|
| いいえ |
| このパラメーターが 'true' に設定されている場合、JIRA アプリケーションは閲覧制限のない課題のみを返します。つまり、匿名の閲覧者が表示可能な課題です。このパラメーターが省略または 'false' に設定されている場合、結果は管理者が JIRA アプリケーションと Confluence の間の通信をどのように設定したかによって異なります。デフォルトでは、Confluenceは、ユーザーが表示する権限を持つ問題のみを表示します。 注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |
| いいえ | 'url' パラメーターの値 | 'baseurl'、ヘッダー内のリスクを指定し、JIRA アプリケーションを示すとパラメーターの値ではなくこのベース URL が使用されます。これは、他のユーザーが使用している URL とは異なる URL で Confluence が JIRA に接続している場合に便利です。 |
| いいえ | 既定では、次の列が表示されます。
| セミコロン (;) で区切られた JIRA 列のリスト。カスタム列を含め、JIRA アプリケーションで認識できる多くの列を含めることができます。 'work ratio' や 'time to resolution' など、JIRA による計算が必要な一部の列は、Confluence で表示することはできません。 |
| いいえ |
| このパラメーターが 'true' に設定されている場合、課題リストには JIRA 課題の数が表示されます。カウントは JIRA サイトにリンクされます。 |
| いいえ |
| マクロは、JIRA クエリの結果の課題のキャッシュを保持します。'cache' パラメーターが 'off' に設定されている場合、キャッシュの関連部分は、マクロが再度ロードされるたびにクリアされます。(値 'false' も使用でき、 と同じ効果があります。) 注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |
| いいえ |
| 課題を表示するテーブルの高さ (ピクセル単位)。
注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |
| いいえ |
| 値を「dynamic (動的)」にすると、JIRA 課題マクロは、ユーザーが次のように操作できるインタラクティブ ディスプレイを提供します。
'static' の値は、ダイナミック表示機能を無効化します。 注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |
| いいえ | JIRA 課題 | このパラメーターを使用して、課題テーブルの一番上にあるタイトル テキストをカスタマイズできます。例えば、タイトルを「Bugs-to-fix (修正するバグ)」に設定すると、既定の「JIRA Issues (JIRA 課題)」テキストが置き換えられます。表示されている課題リストにより多くの内容を提供する場合に便利です。 注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |
| はい | なし | 選択した課題の XML ビューの URL。 注: "url" パラメーターの URL に |
| いいえ | 100% | 課題を表示するテーブルの幅。パーセント (％) またはピクセル (px) で入力できます。 注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。 |