Garoonのスケジュール情報をGaroon REST APIとCDataDriversを使用してBIツールでビジュアライズ


はじめに

本記事は、サイボウズ社のグループウェア製品であるサイボウズ ガルーンのスケジュールを、2018/5/13にリリースされたばかりのGaroon REST APIを使い、CData REST ODBC Driver経由で各BIツールでビジュアライズする手順についてご紹介します。

前提条件

本記事では以下のサービスや製品を使用しています。

手順

Garoon REST APIで利用するユーザー認証情報の準備

Garoon REST APIの仕様はこちらからご覧いただけます。ユーザー認証には、パスワード認証を用います。下記のAPI仕様書の通り、「ログイン名:パスワード」をBASE64エンコードした文字列を準備します。準備した文字列は後の手順で利用するので手元に控えておきます。

リクエストヘッダに「X-Cybozu-Authorization」を追加し、「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。

// ログイン名が「Administrator」、パスワードが「cybozu」の場合
X-Cybozu-Authorization:QWRtaW5pc3RyYXRvcjpjeWJvenU=

なお、BASE64のデコードはWindowsマシンにて下記コマンドでエンコード済みの文字列を作成することができます。

certutil -f -encode "入力ファイル" "出力ファイル"

Garoonのスキーマ定義ファイルの準備

続いて、Garoon REST APIをCData ODBC Drivers for RESTがSQLとして解釈できるように設定ファイルを作成します。

GaroonのスケジュールのAPIエンドポイントのデータを取得するための設定ファイルを作成していますので、以下のGitHubから保存して、利用してみてください。

WebAPIエンドポイント名 ファイル名 備考
予定の取得(GET) ScheduleEvents.rsd

保存先フォルダは後ほど使用するので「C:\CData_REST\garoon」といった読み取り可能な任意のフォルダに配置してください。

CData 製品のインストール、および、初期設定

CData ODBC Drivers for REST のビルドをダウンロードします。ダウンロードすると、インストールファイル(.exe)がダウンロードされます。インストーラーを起動してソフトウェア使用許諾契約書を確認してデフォルトのままインストールします。

(注意) オンラインアクティベーションのためインターネットへの接続が必要となります

インストールが完了すると、ODBCのDSN設定のウィンドウが立ち上がりますので以下の項目をセットします。

項目 備考
Custom Headers X-Cybozu-Authorization:***** *****部分は「ログイン名:パスワード」をBASE64エンコードしたもの
Location C:\CData_REST\garoon RSDファイル群のパス
Other subdomain=**** *****部分はサブドメインを指定

ODBCのDSN構成画面の「OK」ボタンをクリックして設定内容を保存して閉じます。

Tableauからの接続確認

Tableau Desktopを起動して、データ接続より「サーバーへ」>「詳細」>「その他データベース(ODBC)」を選択します。

「その他のデータベース(ODBC)」設定ウィンドウが開いたら、接続手段内のDSNから「CData REST Source」を選択して「サインイン」します。

「データソース」画面が開くので、左側のペインで、表「ScheduleEvents(REST.ScheduleEvents)」を選択して、右上のエリアにドラッグ&ドロップします。抽出を行い、右下のデータプレビューにGaroonの自身のスケジュール一覧が表示されることを確認します。

以下の各スケジュールの時間を取得する計算項目(hours)を追加します。

DATEDIFF('hour',[start_dateTime],[end_dateTime])

接続をライブから抽出に変更して抽出を作成してください。抽出結果の作成した計算項目(hours)にスケジュールの時間が計算されていることを確認します。

「シート」ページに移動して、グラフや表を追加します。

今回は、以下3つのシートを作成してダッシュボードとして並べて表示してみました。

  • 円グラフ : 色:eventMenu、ラベル:eventMenu、メジャー:合計(hours)
  • 水平棒グラフ: 色:eventMenu、列:合計(hours)、行:subject
  • 積み上げ棒グラフ : 色:eventMenu、列:日(start_datetime)、行:合計(hours)

QlikSenceからの接続確認

QlikSence Desktopを起動して、「アプリの新規作成」をクリックします。

「データの追加」をクリックします。

「ODBC」を選択します。

「CData REST Sources」を選択します。

テーブル「ScheduleEvents」を選択してデータプレビューにGaroonの自身のスケジュール一覧が表示されることを確認します。

「シート」を追加して、チャートを追加します。

今回は、以下のオブジェクトを作成して表示してみました。

  • 円グラフ : 軸:eventMenu、メジャー:数式(Sum(end_dateTime - start_dateTime))
  • 水平棒グラフ: 軸:subject、メジャー:合計(Sum(end_dateTime - start_dateTime))、ラベル色:eventMenu、
  • 積み上げ棒グラフ : 軸:start_datetime、eventMenu、メジャー:合計(Sum(end_dateTime - start_dateTime))、ラベル色:eventMenu

※数式の設定例

PowerBIからの接続確認

PowerBI Desktopを起動して、「Get Data」から「Other」>「ODBC」を選択します。

「Data source name(DSN)」で「CData REST Source」を選択します。

「Navigator」にてテーブル「ScheduleEvents」を選択してデータプレビューにGaroonの自身のスケジュール一覧が表示されることを確認します。

「Page」を追加して、クエリの編集ボタンをクリックします。

以下のカスタム列を追加して適用してクエリ編集を閉じます。

hours = [end_dateTime]-[start_dateTime]

チャートを追加します。今回は、以下3つのオブジェクトを作成してダッシュボードとして並べて表示してみました。

  • 円グラフ : 凡例:eventMenu、値:hours
  • 水平棒グラフ: 軸:subject、凡例:eventMenu、値:hours
  • 積み上げ棒グラフ : 軸:start_datetime(日までドリルダウン)、凡例:eventMenu、値:hours

まとめ

Garoon内の自身の案件状況の一覧をREST API経由でCData REST ODBC Driverを使用して各BIツールからビジュアライズする手順について説明しました。本記事で必要な各サービスおよび製品は無償版や評価版が用意されているので是非お試しください。