ODBC 経由で R から ApprovalMax のデータ を分析
純粋な R スクリプトと標準 SQL で ApprovalMax のデータ にアクセスできます。CData ODBC ドライバ for ApprovalMax と RODBC パッケージを使用すると、R からリモート ApprovalMax のデータ を操作できます。CData ドライバを使用することで、業界で実績のある標準に準拠したドライバを活用し、人気のオープンソース言語 R でデータにアクセスできます。この記事では、ドライバを使用して ApprovalMax のデータ に SQL クエリを実行し、R で ApprovalMax のデータ を可視化する方法を説明します。
R をインストール
マルチスレッドや管理コードによるドライバのパフォーマンス向上は、マルチスレッド対応の Microsoft R Open や、BLAS/LAPACK ライブラリにリンクした R を実行することで補完できます。この記事では Microsoft R Open(MRO)を使用します。
ApprovalMax にODBC データソースとして接続
ApprovalMax への接続情報と、Windows および Linux 環境での 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 の両方に対応しています。
DSN を設定する際に、Max Rows 接続プロパティも設定することをお勧めします。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。
Windows
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最後のステップです。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成・設定できます。
Linux
Linux 環境で CData ODBC Driver for ApprovalMax をインストールする場合、ドライバーのインストール時にシステム DSN が事前定義されます。システムデータソースファイル(/etc/odbc.ini)を編集して、必要な接続プロパティを定義することで DSN を変更できます。
/etc/odbc.ini
[CData API Source]
Driver = CData ODBC Driver for ApprovalMax
Description = My Description
Profile = C:\profiles\ApprovalMax.apip
AuthScheme = OAuth
InitiateOAuth = GETANDREFRESH
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackURL = your_callback_url
これらの設定ファイルの使用方法の詳細については、ヘルプドキュメント(インストール済みまたはオンライン)を参照してください。
RODBC パッケージを読み込む
ドライバを使用するには、RODBC パッケージをダウンロードします。RStudio で、[ツール] -> [パッケージのインストール]をクリックし、[パッケージ]ボックスに RODBC と入力します。
RODBC パッケージをインストールした後、以下の行でパッケージを読み込みます。
library(RODBC)
注意:この記事では RODBC バージョン 1.3-12 を使用しています。Microsoft R Open を使用すると、Microsoft の MRAN リポジトリのチェックポイント機能を使用して同じバージョンでテストできます。 checkpoint コマンドを使用すると、MRAN リポジトリでホストされている CRAN リポジトリのスナップショットからパッケージをインストールできます。2016年1月1日のスナップショットにはバージョン 1.3-12 が含まれています。
library(checkpoint)
checkpoint("2016-01-01")
ApprovalMax のデータ にODBC データソースとして接続
以下の行で R から DSN に接続できます。
conn <- odbcConnect("CData API Source")
スキーマの検出
ドライバは ApprovalMax API をリレーショナルテーブル、ビュー、ストアドプロシージャとしてモデル化します。以下の行でテーブルの一覧を取得できます。
sqlTables(conn)
SQL クエリを実行
sqlQuery 関数を使用して、ApprovalMax API でサポートされている任意の SQL クエリを実行できます。
userprofiles <- sqlQuery(conn, "SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'", believeNRows=FALSE, rows_at_time=1)
以下のコマンドでデータビューアウィンドウに結果を表示できます。
View(userprofiles)
ApprovalMax のデータ をプロット
これで、CRAN リポジトリで利用可能なデータビジュアライゼーションパッケージを使用して ApprovalMax のデータ を分析できます。組み込みのバープロット関数を使用して、シンプルな棒グラフを作成できます。
par(las=2,ps=10,mar=c(5,15,4,2))
barplot(userprofiles$Email, main="ApprovalMax UserProfiles", names.arg = userprofiles$UserId, horiz=TRUE)