目次

概要

• アイテムとは、取得するデータのパターンを指します。
• データソースの配下に紐付く要素です。
• BIツールから見た場合、「テーブル」要素とほぼ一致する粒度です。
• アイテム登録数の上限はライセンスキーによって管理されています。

前提

• Cadre サーバー管理者権限を持つユーザー、または DATASOURCE 編集権限をもつユーザーのみアイテムの編集が可能になります。

機能

アイテムを登録する

1. 上部ナビゲーションバーからITEMを選択します。
2. サイドバーからアイテムを追加したいデータソースを選択します。
3. ADD ボタンを押下します。
   
   
   

4. アイテム設定を行います。
   
   

   項目	必須	説明	備考
   DATASOURCE NAME		データソース名称を表示します。	※読取専用
   SERVICE NAME	●	データ取得元のサービスを選択します。	サービス設定 で事前に登録したもののいずれかを選択します。
   ITEM NAME	●	取得するデータ種類を選択します。	アプリケーション種類により選択可能な項目が異なります。 アイテム種類は今後の開発により順次拡大します。
   QUERY STRING		データを収集する条件となるクエリ文字列を指定します。	サービスとクエリ文字列の仕様の対応関係は以下の通りです。 サービス クエリ仕様 Jira JQL Confluence CQL クエリ文字列を指定しない場合はサービス全体を対象としてデータを取得します。 サービス登録時に指定したユーザーの権限範囲でデータを収集します。
   SUMMARY	●	本アプリ内でアイテムを特定するための任意の文字列を指定します。
   SCHEDULE PATTERN	●		管理メニュー/SCHEDULE(スケジュールパターンマスタ) で事前に登録したもののいずれかを選択します。
   OUTPUT FORMAT	●	収集データの出力フォーマットを選択します。	選択可能なフォーマットは以下の通りです。 Tableau(WDC): Tableau Web Data Connector(WDC) で参照可能な形式で出力します。 External Storage: 外部ストレージに parquet 形式で出力します。 DB (READ ONLY): RDB(PostgreSQL) テーブルへ参照専用データとして出力します。
   TRANSFER TO EXTERNAL STORAGE		OUTPUT FORMAT で EXTERNAL STORAGE を選択した場合、出力先の外部ストレージを選択します。	管理メニュー/EXTERNAL STORAGE(外部ストレージ設定) で事前に登録したもののいずれかを選択します。 選択できるのは、自身で作成した外部ストレージ情報か、参照許可の権限が付与されているものだけです。
   DETAIL CONFIG		アイテムによっては追加の詳細設定が表示されます。入力項目に従い必要事項を設定します。

   
   
   

5. SAVE ボタンを押下して、設定を保存します。

   • 新規登録後、設定マスタに基づいたデータ取得が即座に開始されます。
   • アイテム毎にフィールド設定のデフォルトパターンがあり、新規登録時に自動的に展開されます。
     　但し、一部アイテムにおいては詳細設定の内容に基づきフィールドパターンが変化する場合があります。

アイテムを編集する

1. 登録済アイテムの明細行右端にあるサブメニュー(･･･アイコン)を開き、EDIT を選択します。
   
   

2. 必要な修正を行い、SAVE ボタンを押下します。

   この場合、データ取得は即座に行われません。

   編集によってクエリ文字列を変更した場合、一部アイテムについては変更前のクエリデータが残る場合があります。

   順次改修を進め問題を解消する予定ですが、対応が完了するまでの間でクエリ文字列の変更が必要な場合は、アイテムを削除し再登録してください。

アイテムを削除する

1. 登録済アイテムの明細行右端にあるサブメニュー(･･･アイコン)を開き、DELETE を選択します。
   
   
2. 確認ダイアログが表示されますので、削除対象に間違いがないことを確認し、問題なければ OK ボタンを押下します。

データを取得する(全件)

1. 登録済アイテムの明細行右端にあるサブメニュー(･･･アイコン)を開き、GET DATA(ALL) を選択します。
   
   
2. ブラウザのリロード(F5) を実行すると、NEXT SCHEDULE 欄が IMMEDIATE(即時実行) に変わります。 
   1. 取得待ちのデータがない場合は即座にデータ取得が始まり、STATUS 欄にプログレスバーが表示されます。
   2. 取得待ちのデータが残っている場合は即座に実行されません。実行順序は ORDER 列の順に従い順次処理されますので実行までしばらくお待ちください。
       ORDER は値が小さいほど実行順序が早いことを指します。

データを取得する(差分)

1. 登録済アイテムの明細行右端にあるサブメニュー(･･･アイコン)を開き、GET DATA(DIFF) を選択します。
   
   
2. ブラウザのリロード(F5) を実行すると、NEXT SCHEDULE 欄が IMMEDIATE(即時実行) に変わります。 
   1. 取得待ちのデータがない場合は即座にデータ取得が始まり、STATUS 欄にプログレスバーが表示されます。
   2. 取得待ちのデータが残っている場合は即座に実行されません。実行順序は ORDER 列の順に従い順次処理されますので実行までしばらくお待ちください。
       ORDER は値が小さいほど実行順序が早いことを指します。

データ取得を一括実行する(全件/差分)

1. データ取得を行う対象が複数存在する場合は、対象となる明細行左端のチェックボックスを ON にします。

   1. 明細行のヘッダ部にあるチェックボックスを選択すると、全明細を一括選択します。

      一覧表のフッタ部に、1ページ内に表示する明細行の設定があります。 1ページに収まらない場合にヘッダ部の全選択を行った場合は当ページ内のみ全選択を行います。
      複数ページに跨がり一括実行する場合は、1ページあたりの表示件数を増やし、対象がすべて表示された状態で全選択を行ってください。

      

2. 明細行の上部に ACTION プルダウンが表示されますので、差分取得(GET DATA(DIFF))、または全件取得(GET DATA(ALL)) のいずれかを実行します。

データの取得結果を確認する

件数を確認する

• アイテム一覧画面の RECORD COUNT を確認します。

直近のデータ取得日時を確認する

• アイテム一覧画面の LAST LOAD DATE を確認します。

  • 該当アイテムのデータ取得を開始した日時が記録されます。データ取得完了日時ではありません。
  • データ取得開始日時 = 該当時刻時点のサービスのデータを取得したことを表します。

実行結果を確認する

• アイテム一覧画面の STATUS を確認します。

  状態	説明	備考
  	成功	データ取得、及び参照データ生成処理が正常終了しました。
  	失敗	データ取得を手動で再実行しても復旧しない場合は個別に原因調査が必要です。 ログファイルの出力を実行いただき、弊社 ヘルプデスク にサポートをリクエストしてください。
  	データ取得中にシャットダウンしました	データ取得処理中にコンテナが停止され、取得に失敗しました。 再度データ取得を実行し(手動/スケジュール起動どちらでも問題ありません)、正常にデータ取得が完了するかご確認ください。 繰り返し同一エラーが発生する場合、データ肥大化の影響でハードウェアリソース不足に陥っている可能性があります。 リソース使用状況をご確認頂き、取得データ量を減らすか、またはハードウェアリソース増強をご検討ください。
  	データ取得には成功しましたが、参照データ生成に失敗しました	主にフィールド設定の不整合が原因です。 対象アイテムのフィールド設定をご確認ください。
  	同一 ITEM NAME のデータ取得完了を待っています	同一データソース内に同一アイテムを複数定義した場合は、名寄せされ単一データセットとして出力されます。 自身以外の同一アイテムのデータ取得が完了するまでお待ちください。
  	データ取得は未実施です	過去に一度もデータ取得が実施されていない場合に本記号が表示されます。 一度でもデータ取得が実施されている場合は、成功/失敗/警告のいずれかのマークが表示された状態となります。

次回データ取得日時を確認する

• アイテム一覧画面の NEXT SCHEDULE を確認します。

  スケジュールパターンマスタに基づき、次回実行時刻が決定されます。
  他のアイテム取得処理の兼ね合いで、次回実行時刻を超えても処理が開始できない状態の場合は IMMEDIATE と表示されます。

アイテム一覧とアプリケーション別使用可能アイテム

Jira 関連

アイテム	Jira	JiraSoftware	JiraServiceManagement
issue
issue_permission
comment
completecycle
earned_schedule
epiclink
label
issue_history
issuechanelog
issuelink
remotelink
multi_select_list
project_status
sprint
sprint_issue
component
component_issue
subtasklink
version
version_issue
worklog
git_commit_issue
git_pullrequest_issue
jira_user
jira_group_member

Confluence 関連

アイテム	Confluence
page
page_property
page_table
conflunece_user
confluence_label
confluence_attachment

DVCS 関連

アイテム	Bitbucket (DataCenter)	GitLab (Self-Managed)
git_diff
pullrequest
pullrequest_comment
pullrequest_reviewer
review_history