Gmailアダプターについてご紹介させていただきます。
このアダプターで使えるコンポーネントは次の通りです。
 |
GmailへSELECT文を発行して結果セットをストリームとして出力します。 |
 |
Gmailのテーブルに対して更新を行います。 |
 |
Gmailへ任意のSQLの実行を行います。 |
また、Gmailアダプターでは下記２つのデータモデルを提供しています。
- RESTスキーマ
- IMAPスキーマ
データモデルによって認証方法や処理可能な機能に差があります。
| データモデル | 認証方法 | 機能 |
| RESTスキーマ | OAuth認証 | メール送受信、添付ファイル送受信 |
| IMAPスキーマ | ログイン認証 OAuth認証 |
メール送受信、添付ファイル送受信、メールボックス(ラベル)管理、 メールステータス管理、MIMEデータ取得 |
ここでは、両方のデータモデルで利用できるOAuth認証を使って、アダプターを使うための事前準備とコネクション作成方法についてご紹介いたします。
■事前準備
【Google API Console】
下記の手順でOAuth認証情報を取得します。
- Google API コンソールにログインします。
- ［新しいプロジェクト］をクリック、または既存のプロジェクトを選択します。
- API Manager で、［認証情報］->［認証情報を作成］->［OAuth クライアントID］をクリックします。
- アプリケーションの種類は、［デスクトップアプリ］を選択します。
- ［作成］をクリックします。クライアントIDとクライアントシークレットが表示されます。
- ［ライブラリ］→［Gmail API］→［有効にする］をクリックします。
【ASTERIA Warpサーバー】
Gmailアダプターを利用するためには、事前にアダプターをインストールしておく必要があります。
アダプターは［FSMC］→［システム］→［アップデート］画面にてダウンロードするか、ユーザーサイトからダウンロードしてサーバーにアップロードすることで適用できます。
アダプターのインストールについて詳しくは下記弊社のオンラインヘルプをご参考ください。
［FSMC > システム > アップデート］のオンラインヘルプ
※アダプターのインストール後設定を有効にするためにはフローサービス全体の再起動が必要となります。
【フローデザイナー】
ASTERIA Warpサーバー側でアダプターが正常にインストールされたら、フローデザイナー側でコンポーネントを取得する必要があります。
手順は下記になります。
- フローデザイナーからフローサービスへ接続
- メニューの「ツール > コンポーネント／マッパー関数の取得」でjarファイルを取得
- フローデザイナーを再起動
※今回ダウンロードするファイルはfccdatagmail-2012.0950.jarとなります。
■コネクションの作成
事前準備が終わりましたら、コネクションを作成します。
FSMCでコネクションを作成する手順は下記になります。
FSMC画面の［設定］→［コネクション］→［Gmail］メニューから「新規」ボタンをクリックします。
コネクション作成画面が表示されますので、下記の通り項目を設定します。
- 接続名：コネクション名を設定します。
- 認証スキーマ：OAuthを選択します。
- イニシエートOAuth：GETANDREFRESHを選択します。
現在トークンが存在しない場合にはブラウザを通じてユーザーをプロンプトすることで取得されます。
トークンが存在する場合には必要に応じてリフレッシュされます。 - OAuthクライアントID：Google API Consoleの事前準備で作成したクライアントIDを設定します。
- OAuthクライアントシークレット：Google API Consoleの事前準備で作成したクライアントシークレットを設定します。
- スキーマ：利用するデータモデルを選択します。
※フローデザイナーからもコネクションの設定が可能です。
■コネクションの接続テスト
作成したコネクションが正常に動作するか確認するためにコネクションの接続テストを実行してみます。
今回はOAuthトークン情報を自動で取得更新するために、「イニシエートOAuth」に「GETANDREFRESH」を設定しました。この時、最初にOAuthトークンを取得するにはWARPサーバー側でブラウザが起動され、ログイン画面が表示されます。
ログインに成功するとアプリで必要なアクセス許可をリクエストする画面が表示されますので、許可をクリックします。
【スキーマプロパティにRESTを設定した場合】
【スキーマプロパティにIMAPを設定した場合】
許可をクリックすると認証に成功し、OAuthトークンが取得されます。
また、以下のようにコネクション接続テスト成功画面が確認できます。
※場合によってはGmailで「安全性の低いアプリの許可」をオンにする必要があります。
■最後に
Gmailアダプターの利用するために必要な事前準備、およびコネクションの作成方法についてご紹介いたしました。コネクションの作成後接続テストが正常に行われるとGmailGetコンポーネント、GmailPutコンポーネント、GmailSQLCallコンポーネントが使えます。
各コンポーネントの使い方については既存のRDB系のコンポーネントと同様です。つまり、RDBGetコンポーネントの付属ツールである「SQLビルダー」、RDBPutコンポーネントの付属ツールである「テーブルの選択」ツールについても同様に使えます。また、GmailSQLCallコンポーネントを利用してストアドプロシージャを実行することができます。
- GmailコンポーネントのSQLビルダー
【RESTスキーマ】
【IMAPスキーマ】
- Gmailコンポーネントのテーブル選択
【RESTスキーマ】
【IMAPスキーマ】