ApprovalMax のデータをBoard に連携してビジュアライズを作成
CData ODBC Driver for API は、ODBC 標準に準拠しており、BI ツールからIDE まで幅広いアプリケーションでApprovalMax への接続を提供します。 この記事では、CPM/BIツールのBoardからApprovalMax に接続、レポートを作成する方法を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持った製品です。
- ApprovalMax をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- 多様なアプリケーション、ツールにApprovalMax のデータを連携
- ノーコードでの手軽な接続設定
- 標準SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてApprovalMax の接続を設定、2.board 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとApprovalMax への接続設定
まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
- インストール後、ODBCデータソースアドミニストレーターにて[システムDSN]タブをクリックし、CData ApprovalMax Source Sys(64bit or 32bit)の接続情報を構成します。(※BoardはシステムDSNのみに対応しています。ユーザーDSNの場合接続できませんので、ご注意ください。)
-
まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します(例:C:\profiles\ApprovalMax.apip)。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します(以下を参照)。
ApprovalMax API プロファイル設定
ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。
まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal(https://developer.approvalmax.com/applications)にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI(Callback URL)を少なくとも1つ登録しておく必要があります。
Public API を利用するには、ApprovalMax の Premium サブスクリプション(または有効なトライアル)が必要です。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
- OAuthClientSecret:ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
- CallbackURL:アプリケーション設定で登録した Redirect URI に設定します。
- Scope:(オプション)デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。
OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。
Board DB の作成
最初にBoardの接続情報やキューブ等を格納するDBを作成します。
- Boardを立ち上げて、任意の接続先へ接続します。
- [Database]タブから[New DB]をクリックします。
- 開いたDB作成用ウィンドウにて、任意の[Database name][Language][From Year][To Year]を入力し[OK]をクリックします。
SQL FastTrackを用いたODBCデータソースからのデータロード
次にSQL FastTrackの機能を用いてODBCデータソースから ApprovalMax のデータをBoard上にロードします。
- [Database]タブの[SQL FastTrack]をクリックし、Data souceの[New]ボタンをクリックします。
- 接続先を設定するためのウィンドウが表示されますので、[OLE-DB Wizard]をクリックします。
- 開いたデータリンクプロパティの[プロバイダー]タブから[Microsoft OLE DB Provider for ODBC Drivers]を選択し、[次へ]をクリックします。
- [接続タブ]の[1.データソースを指定します]から事前に設定したODBC DSNを選択し、[3.使用する初期カタログを入力します]に[CData]を入力の上、[OK]をクリックします。
- 任意の[Name]を入力し[Save & Connect]をクリックします。
- SQL FastTrackの画面に戻った後、[Connect]をクリックします。
- Connectをクリック後、Data souce画面左側に ApprovalMax のテーブル一覧が表示されます。分析対象とするテーブルをダブルクリックすると、自動的にSQL クエリが記述されます。記述内容を確認の上、[Execute Query]をクリックします。
- Execute Queryをクリックすると、テーブルに格納された項目一覧が以下の図のように表示されます。分析で使用したい任意の項目を[Code][Desc][Cube]のいずれかにチェックを入れ、Cube/Entityを入力し、Track実行ボタンをクリックします。
- 確認ダイアログが表示されますので、[Yes]をクリックします。
- SQL FastTrackの機能により、ODBC データソースからデータがロードされ、自動的にEntityとCubeが生成されます。
- 以下のダイアログが表示されれば、Boardへのデータロードは完了です。
グラフの作成
ロードしたデータを元に簡単なグラフの作成方法を紹介します。
- 最初に各種Screenを格納するためのCapsuleを作成します。[Home]タブを選択し[Capsule]から[New Capsule]をクリックします。
- 任意の[Capsule Name]を入力し[OK]をクリックします。
- 続いてScreenを作成するための画面が表示されるため任意の[Screen Name]を入力し[OK]をクリックします。
- Screenが作成されると、ChartやDataViewを配置することが可能になります。[Charts]から[Chart]を選択し、Screenにドラッグ・アンド・ドロップでChartを配置します。
- 以下のようにChartを配置後、右クリックメニューで[Layout]をクリックします。
- LayoutでChart上のValueとして扱う値を指定します。[Data]タブから[Double-click here to create a block]の箇所をダブルクリックします。
- [Data Selection]から先程のSQL FastTrackにてCubeの指定をした任意の値を選択し[OK]をクリックします。
- 続いて[Axes]タブをクリックし、先程指定した値の分析軸とするBy Rowに任意の項目を選択し[OK]をクリックします。
- 設定完了後、以下のようにグラフが表示されます。
このようにAPI 内のデータをAPI を書くことなくBoard上で利用することができるようになります。