Magic xpi からCData ODBC Driver を使ってHubDB につないでみた

こんにちは！テクニカルディレクターの桑島です。

ノーコードでデータを連携・同期・統合するデータ連携（EAI）ツール「Magic xpi」には、ODBC でデータベースへ接続する機能が備わっているので、これを使ってHubDB データ連携を行うことが可能です。 通常、HubDB などのSaaS として提供されるアプリケーションにはWeb API でアクセスしますが、CData HubDB ODBC Driver によって、RDB にアクセスするのと同感覚で、HubDB のデータを扱うことができます。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. HubDB をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにHubDB データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてHubDB の接続を設定、2.Magic xpi 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとHubDB への接続設定

まずは、本記事右側のサイドバーからHubDB ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

Magic xpi スタジオにてプロジェクトを作成して、ODBC接続設定を行います。

1. Magic xpi スタジオを起動してメニューバーからファイル > 新規 を選択します。新規プロジェクトウィンドウが起動したらプロジェクト名を指定して新規プロジェクトを作成します。
   
2. メニューバーからプロジェクト > リソース を選択します。リソース設定ウィンドウが起動したら左下の「新規」ボタンをクリックします。
   
3. 新規リソースウィンドウにて、リソースタイプを「Database」を選択、リソース名にCDataHubDBを指定して「OK」ボタンをクリックします。
   

4. リソース設定ウィンドウにて、DBMSには「ODBC」、データソース名には、Microsoft ODBC データソースアドミニストレーターのシステムDSNで定義されたデータソース名（DSN）、例えば「CData HubDB Source」などを設定します。
   Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、CData HubDBのヘルプドキュメントの「はじめに」をご参照ください。

   Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

   HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

   カスタムOAuthアプリを使用する

   すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

   アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

   1. HubSpotアプリ開発者アカウントにログインします。
      • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
   2. 開発者アカウントのホームページで、アプリタブをクリックします。
   3. アプリを作成をクリックします。
   4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
   5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
      • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
      • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
   6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
   7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

   8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

      テーブルにアクセスするには、最低限以下のスコープが必要です：

      • hubdb
      • oauth
      • crm.objects.owners.read
   9. 変更を保存をクリックします。
   10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
       • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
       • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
       • アプリを接続をクリックします。結果のタブは閉じて構いません。

   プライベートアプリを使用する

   HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

   以下の手順に従ってプライベートアプリケーショントークンを生成できます：

   1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
   2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
   3. プライベートアプリを作成をクリックします。
   4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
   5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
   6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
   7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
   8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
   9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

   接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

   「検証」ボタンをクリックしてデータベースとの接続が成功することを確認して、リソース設定ウィンドウを「OK」ボタンをクリックして終了します。

HubDB データをCSV ファイルへ出力するフローの作成

Magic xpi スタジオにて、データマッパーコンポーネントを使用してHubDB データをCSV ファイルへ出力するフローを作成します。

1. プロジェクト内に作成されたフローを右クリックして、特性を選択します。フロー特性ウィンドウが起動したら自動起動をYesに変更して「OK」ボタンをクリックします。
   
2. トリガコンポーネントが「自動起動」に設定されたことを確認します。コンポーネント内のデータマッパーを右側のペインにドラッグ＆ドロップします。
   
3. データマッパーウィンドウが起動するので「構成」ボタンをクリックします。
   
4. 送り元/送り先管理ウィンドウが開くので、送り元のタイプをDatabase、送り先のタイプをフラットファイルに設定します。
   
5. 送り元の「特性」ボタンをクリックして、データベーススキーマ特性ウィンドウにてDB オペレーションで「Select」を選択、データベース定義で「CDataHubDB」を選択して「ウィザード」ボタンをクリックします。
   
6. 使用可能テーブルからテーブルを選択して「追加」ボタンをクリックして選択済テーブルに追加されたことを確認して「次へ」ボタンをクリックします。
   
7. データベースウィザードにて出力したいカラムを使用可能カラムから「追加」ボタンをクリックして選択済カラムに追加されたことを確認して「次へ」ボタンをクリックします。 Where 句とOrder By 句の定義ウィンドウが表示されるので必要であれば設定して「次へ」ボタンをクリックします。
   
8. ウィザードの結果にてSQL が表示されます。誤りがなければ「終了」ボタンをクリックします。
   
9. 次に、送り先の「特性」ボタンをクリックして、フラットファイルウィンドウにてデータの送り先で「ファイル」を選択、右横のウィンドウにパス付の出力ファイル名を入力します。 下段の「新規」ボタンを、出力するカラム数分クリックして出力項目を定義します。出力項目に併せて必要に応じて型や桁数を定義してください。
   
10. 送り元/送り先管理ウィンドウに戻り「マップ」ボタンをクリックします。
11. 「マップ」ウィンドウが起動するので、送り元から送り先の項目へのドラッグ＆ドロップ操作で線でつなぎます。「OK」ボタンをクリックします。 送り元/送り先管理ウィンドウに戻り「OK」ボタンをクリックします。
    

Magic xpi スタジオからのテスト実行

Magic xpi スタジオから作成したフローを実行します。

1. メニューバーからデバッガ > 開く を選択します。チェック処理が実行され正常に終了すると、メニューバーからデバッガ > 実行 が活性化されるので選択します。
   
2. フローが実行されて正常に終了すると送り先のフラットファイルウィンドウで指定したファイルが作成されてHubDB 内の指定したカラムのデータが出力されていることを確認できます。
   

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。