Jira ダッシュボードからインポート
Exportelier は Jira のダッシュボードを読み取り、そこからレポートを 構築できます。ダッシュボードを選ぶと、Exportelier がガジェットごとに何を理解したかを 示します。Jira が渡さなかった部分をあなたが補うと、ごく普通の編集可能なレポートが できあがります。
始める前に知っておくべきことが 2 つあります。このページの内容はすべてこの 2 点から 導かれます。
Exportelier がインポートするのはダッシュボードの構成です。どのフィルター、どの フィールド、どのチャート種別かを読み取り、自前のコンポーネントで組み直します。結果は スクリーンショットでも、ピクセル単位の複製でも、埋め込まれた Jira ページでもありません。 列幅、ガジェットの枠、正確な余白は再現されません。Jira の公開 API がそれらを提供しない ためです。
Atlassian は、組み込みガジェットの設定が公開 API から読み取れることを保証していません。 設定が読み取れない場合、Exportelier はあなたに選択を求めます。どのフィルターや どのフィールドを意図したのかを推測することは決してありません。
インポートできるもの
| Jira ガジェット | 変換先 | 備考 |
|---|---|---|
| Filter Results | 課題テーブル | 選択された列とその順序を保持します |
| Pie Chart | カテゴリーチャート（円） | ガジェットの統計タイプを使用します |
| Work Item Statistics | カテゴリーチャート（棒） | ガジェットの統計タイプを使用します |
| Two Dimensional Filter Statistics | マトリクス | 両軸のフィールドを使用します |
| Created vs. Resolved Chart | 時系列チャート | ガジェットの集計期間と遡及日数を引き継ぎます — 下記の制限を参照 |
| Sprint Burndown | — | スプリントの履歴データが必要ですが、Exportelier はまだ提供していません |
| その他すべて | — | 名前を挙げて除外します。黙って捨てることはありません |
ダッシュボード上の各ガジェットには、必ず 1 つのステータスが付きます。
- 準備完了 — 認識でき、必要なものはすべて読み取れました。
- 要補完 — 認識できましたが、不足している設定をあなたが指定する必要があります。
- 今後利用可能 — 認識できましたが、対応する Exportelier コンポーネントが まだありません。Sprint Burndown がここに入ります。
- 未対応 — サードパーティまたは未知のガジェットです。隠さず、名前を挙げます。
- エラー — Jira が読み取りを許可しなかったか、読み取った内容が矛盾していました。 これは Jira 側で解決するまでインポートをブロックします。
認識はガジェットの技術的な識別子で行い、タイトルでは行いません。Jira でガジェットの 名前を変えても、Jira を別の言語で使っていても、Exportelier の判断は変わりません。 独自ガジェットを「Pie Chart」と名付けても、Pie Chart にはなりません。
作成 vs 解決チャートが示すもの
インポートされた作成 vs 解決チャートは、保存済みフィルターが現在返す課題の作成日と 解決日を数えます。過去にそのフィルターがどの課題を返していたかは再現しません。
これはフィルターの対象が変わっている場合に重要です。フィルターが対象とする プロジェクトから課題が移動された場合、その課題は移動前の期間も含めてチャートの すべてのバケットから消えます。Jira 自身のガジェットも同じ理由で同じ挙動をしますが、 数か月離れた 2 つのエクスポートを比較する前に知っておく価値があります。
さらに 3 つの違いが生じる可能性があり、該当する場合はレポートの完全性に関する 注記にそれぞれ明記されます。
- 集計期間。 日次・週次・月次はそのまま再現されます。時間単位は日次に、 四半期と年次は月次になります。合計値は変 わらず、各バケットの幅だけが変わります。
- 未解決のトレンド線。 Jira は未解決課題の推移を示す 3 本目の線を重ねて 描画できます。Exportelier のチャートは作成と解決の系列のみを表示します。
- 遡及期間。 366 日を超える期間は 366 日に短縮されます。
それ以外 — フィルター、累積表示、数値そのもの — はそのまま引き継がれ、これらの 設定はあとからデザイナーで自由に編集できます。
インポートの手順
- レポートを開き、Jira ダッシュボードからインポートを選びます。
- ダッシュボードを選びます。ここに表示されるのは Jira がすでにあなたに見せている ダッシュボードだけです。Exportelier のサイト管理者であっても、この一覧は 広がりません。
- 解析結果を確認します。各ガジェットがステータス付きで一覧されます。
- 補完が必要なものを補完します。保存フィルターとフィールドは通常のピッカーから 選びます。生の JQL を入力する欄は、意図的にありません。
- 完全性を確認します。除外されるものはすべて名前付きで列挙され、レポートを作成する 前に除外を明示的に確認する必要があります。
- レポートを作成します。通常のデザイナーで開き、完全に編集できます。
要補完またはエラー のまま残っているものがあると、作成はブロックされます。 Exportelier は、ダッシュボードの半分を黙って落としたレポートを作るくらいなら、拒否する ことを選びます。
完全性の注記
インポートされたレポートは必ず完全性の注記で始まります。これは UI 上のヒントでは なく、ドキュメント内の実在するコンポーネントです。元のダッシュボード名、インポート 日時、ダッシュボードのガジェットのうち何件が含まれているか、そして含まれていない ものすべてをタイトルで示します。
すべてインポートできた場合は情報の注記、何かが除外された場合は警告になります。PDF、 Word、Markdown のいずれにも同じように現れます。
レポートがインポートと結び付いている間、この注記は Exportelier が管理します。ほかの レイアウトは自由に組み替えられますが、注記だけは削除も書き換えもできません。それでも 削除・改変された場合、レポートはエクスポートできません。ダッシュボードを表している と称しながら一部を黙って欠落させたドキュメントは、ドキュメントが無いことより有害です。
注記のないレポートが欲しい場合は、複製してください。複製は背後にインポートを持たない 通常のレポートで、管理された注記もありません。
ダッシュボードの変化に追随する
インポートはダッシュボードの構成のスナップショットです。データはライブのまま です。レポートはエクスポート時に保存フィルターを読み直すため、インポートから数か月 経っていても数値は最新です。
自動で更新されないのはレイアウトと構成です。誰かが Jira でガジェットを追加したり、 別のフィルターに向けたりしても、あなたが指示するまでレポートはそれまでどおり動きます。
レポートを開き、変更を確認を使います。Exportelier がダッシュボードを読み直し、 各ガジェットを追加・削除・移動・構成変更・変更なしのいずれかに分類します。 再インポートがそれを適用します。
- 変更なしと移動のガジェットは現状を維持します。
- あなたが手で追加したものはそのまま残ります。
- 変更されたガジェットと追加されたガジェットには新しい内容が入ります。
- 新しい構成を自動的に解決できないガジェットがあると、再インポートは中断して補完へ 回ります。推測であなたの作業を上書きすることはありません。
- 「今後利用可能」として除外されていたガジェットを新しい Exportelier でインポートできるようになった場合は変更ありとして表示され、再インポートで レポートの末尾に追加されます。リリースが出ただけで既存のレポートに コンポーネントが増えることはありません。あな たが指示したときにだけ追加されます。
再インポートの前にはテンプレートのバージョンが自動保存されるため、 バージョンを復元で元に戻せます。
スケジューラーもバックグラウンド同期もありません。再インポートはあなたが指示したときに だけ行われます。
権限
インポート、再インポート、インポートの削除はサイト管理者の操作です。
インポート中のダッシュボード・ガジェット・フィルターの読み取りはすべて、実行している 本人として行われます。サイト管理者であっても、Jira が見せないダッシュボードは インポートできません。その後のエクスポートでは、レポートのフィルターをエクスポート する本人として読み直すため、インポートによって誰かの Jira データへのアクセスが広がる ことはありません。権限とロールを参照してください。
制限
| 制限 | 値 |
|---|---|
| 1 回のインポートで解析するガジェット数 | 12 |
| 上限を超えた場合に選択肢として提示するガジェット数 | 60 |
ガジェットが 12 個を超えるダッシュボードは切り捨てられません。どのガジェットを取り込む かを尋ねられ、外したものはほかの除外と同じように完全性の注記に名前が残ります。
インポートされたレポートは通常のレポートであり、データソース、コンポーネント、 ソースあたりの課題数など、すべてのレポート制限を引き継ぎます。 制限リファレンスを参照してください。
使用している Jira API について
Exportelier がダッシュボードを読むのは、Atlassian が文書化した Jira Cloud ダッシュボード REST API のみを通じてです。Jira の Web ページを解析することも、ガジェットの iframe を読むことも、 スクリーンショットを撮ることも、未文書のエンドポイントを使うこともありません。
そのうちの 1 つ、ダッシュボードのガジェットを列挙する Get gadgets は、Atlassian に よって Experimental と位置付けられています。つまり API のほかの部分に適用される 安定性の保証なしに変更されうるということです。Exportelier が認識できない形に変わった 場合、ダッシュボードインポートは自ら停止してその旨を伝えます。誤読したものを インポートすることはありません。既存のレポート・テンプレート・エクスポートには影響 しません。