Jira 課題マクロ

マクロ

このページの内容

お困りですか?

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

コミュニティに質問

Confluence サイトが JIRA アプリケーションに接続されている場合、Confluence ページ上のグラフとして JIRA 課題を表示できます。Confluence を、JIRA Software や JIRA Service Desk などの JIRA アプリケーションへ接続できます。 

このマクロを使用するには、Confluence と Jira アプリケーションがアプリケーション リンクを介して接続されている必要があります。ページを表示しているユーザーは、公開されている課題のグラフを見ることができます。Jira アプリケーションに表示制限が設定されている場合 (ユーザーに課題の表示権限が必要な場合)、グラフを表示する前に認証が必要です。Jira での課題の制限については以降をご参照ください。

JIRA 課題マクロでできること

JIRA の課題マクロでできること :

  • JIRA クエリ言語 (JQL) 検索、フィルター、または URL に基づいてページ上に課題のリストを表示します。
  • 1 つの課題を表示します。
  • 課題数を表示します。
  • Confluence を終了せずにページ上で新しい課題を作成し、課題を表示します。

JIRA 課題マクロの追加と更新 - 概要

Confluence ページ上のマクロを使用するためのクイックガイド:

  1. エディタのツールバーで、[挿入] > [その他のマクロ] を選択します。
  2. 対象のマクロを見つけて、選択します。

オートコンプリートを活用して素早く入力: {」とマクロ名の先頭を入力すると、マクロ候補の一覧が表示されます。この例では、cheese マクロを挿入します。

既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。これによりマクロの詳細を開き、マクロのパラメーターを編集できます。


スクリーンショット: 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 検索に基づいて課題のテーブルを表示するには:

  1. 上記のように、Confluence ページに JIRA 課題マクロを挿入します。
  2. 検索ボタンの横にある JIRA サーバーを選択します。
  3. プロンプトが表示されたら、JIRA サーバーにログインします。
  4. JQL クエリを検索ボックスに入力します。
  5. 検索を選択します。
  6. ディスプレイをカスタマイズする場合は、表示オプションを選択し、課題の表に表示される列と課題数を調節します。
  7. 挿入を選択します。

スクリーンショット 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 課題のサブセットを表示します。

  1. ページ JIRA 課題マクロを追加します。
  2. JQL 経由でマクロ ブラウザーの検索条件を定義します (上記のとおり)。
  3. マクロ ブラウザーで、検索結果の必要な課題の隣にあるチェックボックスを選択します。

スクリーンショット: 表示する課題のサブセットを選択する

課題数を表示する

課題の表ではなく、検索で返される課題の数を表示するよう選択できます。JIRA 課題マクロは、JIRA アプリケーションの検索にリンク付けされた課題の数を表示します。

スクリーンショット: Confluence ページで課題数を表示する JIRA 課題マクロ

課題カウントを表示するには:

  1. JIRA 課題マクロをページに追加します。
  2. JQL 経由でマクロ ブラウザーの検索条件を定義します (上記のとおり)。
  3. 表示オプション を選択し、マクロブラウザで [表示オプション] の横にある 合計発行数 を選択します。
  4. 挿入を選択します。

新しい課題を作成する 

Confluence ページで編集を行いながら、Confluence エディターを開いたまま JIRA で課題を作成し、Confluence ページにその課題を表示させることができます。

課題を作成してページに追加するには:

  1. 上記のように、ページに JIRA 課題マクロを挿入します。
  2. 新しい課題作成 を選択します。
  3. 要求されたら JIRA サーバー、プロジェクト、課題に関する情報を提供します。
  4. 挿入を選択します。

Confluence は課題を作成するよう JIRA アプリケーションにリクエストを送信した後、ページで新しく作成した課題を表示します。

制限事項

JIRA 課題マクロは選択されたプロジェクトで課題を作成できない場合、通知します。これは、プロジェクトに JIRA 課題マクロでサポートされていないフィールド、フィールド設定およびその他のカスタマイズがあることが原因の可能性があります。この状況では、JIRA アプリケーションで直接課題を作成する必要があります。

制限付き課題を表示するアプリケーションリンクの設定

このマクロを使用するには、Confluence と Jira のサイトがアプリケーション リンクを介して接続されている必要があります。

Jira が匿名ユーザーに対して課題の閲覧を許可している場合、アプリケーション リンクを設定する必要がありますが、Jira アプリケーションと Confluence の間で外向きおよび内向きの認証を設定する必要はありません。Confluence ページを表示しているユーザーは、公開されている課題を見ることができます。

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" と呼ばれるアドオン (プラグイン) により提供される機能です。ご使用のサイトでマクロを使用できないようにするために、アドオンを無効にすることもできます。「アプリの無効化と有効化」を参照してください。

注意

HTTPS: Confluence サーバーが Jira SSL 証明書を受け入れるように設定されている場合、Jira 課題マクロは SSL で実行中の Jira アプリケーションにアクセスできます。「SSL 経由で LDAP、 Jira アプリケーション、または他のサービスに接続する」を参照してください。

Custom fields can be added as columns to the table simply by using the name of the field with no quotes. Earlier versions of the macro required you to use the custom field id, e.g. customfield_10100.

Wiki マークアップの例

以下の例は、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。

マクロ名: jiraissues

マクロ本文: なし。

この例では、Jira フィルターを使用します。 

{jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}

マクロ ブラウザー経由で使用できない多数の付加パラメーターは、ストレージ形式や Wiki マークアップで利用可能です。

付加パラメータを参照する...

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

anonymous

いいえ

false

このパラメーターが 'true' に設定されている場合、JIRA アプリケーションは閲覧制限のない課題のみを返します。つまり、匿名の閲覧者が表示可能な課題です。このパラメーターが省略または 'false' に設定されている場合、結果は管理者が JIRA アプリケーションと Confluence の間の通信をどのように設定したかによって異なります。デフォルトでは、Confluenceは、ユーザーが表示する権限を持つ問題のみを表示します。

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

baseurl

いいえ

'url' パラメーターの値

'baseurl'、ヘッダー内のリスクを指定し、JIRA アプリケーションを示すとパラメーターの値ではなくこのベース URL が使用されます。これは、他のユーザーが使用している URL とは異なる URL で Confluence が JIRA に接続している場合に便利です。

columns

いいえ

既定では、次の列が表示されます。

  • type
  • 鍵 (キー)
  • summary
  • assignee
  • reporter
  • priority
  • status
  • resolution
  • created
  • updated
  • due

セミコロン (;) で区切られた JIRA 列のリスト。カスタム列を含め、JIRA アプリケーションで認識できる多くの列を含めることができます。

'work ratio' や 'time to resolution' など、JIRA による計算が必要な一部の列は、Confluence で表示することはできません。

count

いいえ

false

このパラメーターが 'true' に設定されている場合、課題リストには JIRA 課題の数が表示されます。カウントは JIRA サイトにリンクされます。

cache

いいえ

on

マクロは、JIRA クエリの結果の課題のキャッシュを保持します。'cache' パラメーターが 'off' に設定されている場合、キャッシュの関連部分は、マクロが再度ロードされるたびにクリアされます。(値 'false' も使用でき、 と同じ効果があります。)

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

height

いいえ

480 (レンダリング モードが dynamic の場合)

課題を表示するテーブルの高さ (ピクセル単位)。
課題を表示するテーブルの高さこの高さの仕様は、次の状況では無視されます。

  • 'renderMode' パラメーター (以下を参照) が 'static' に設定されている場合。
  • 課題が PDF / Word ドキュメント、メール メッセージ、または RSS フィードで表示されている場合。

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

renderMode

いいえ

static

値を「dynamic (動的)」にすると、JIRA 課題マクロは、ユーザーが次のように操作できるインタラクティブ ディスプレイを提供します。

  • 列ヘッダーをクリックして出力を並べ替えます。
  • 列をドラッグし、別の順序にドロップします。
  • ディスプレイから列を一時的に削除します。
  • 応答時間を短縮するため、一度に課題のページを表示します。

'static' の値は、ダイナミック表示機能を無効化します。

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

title

いいえ

JIRA 課題

このパラメーターを使用して、課題テーブルの一番上にあるタイトル テキストをカスタマイズできます。例えば、タイトルを「Bugs-to-fix (修正するバグ)」に設定すると、既定の「JIRA Issues (JIRA 課題)」テキストが置き換えられます。表示されている課題リストにより多くの内容を提供する場合に便利です。

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

url

はい

なし

選択した課題の XML ビューの URL。

注: "url" パラメーターの URL に tempMax 引数が含まれていない場合、tempMax の既定値は 500 となります。このため、お使いの Jira がバージョン 3.12 以前の場合、Jira 課題マクロは最大 500 件の課題を返します。Jira Server のバージョンが 3.13 以降の場合、500 の値は、Jira 課題マクロはページあたり最大 500 件の課題を返すことを意味します。

width

いいえ

100 %

課題を表示するテーブルの幅。パーセント (%) またはピクセル (px) で入力できます。

注: このパラメーターはページのストレージ形式を編集することで、Wiki マークアップ経由でマクロを挿入した場合にのみ使用できます。マクロ ブラウザはこのパラメーターを提供しません。

最終更新日 2018 年 3 月 20 日

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

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.