こんにちは!リードエンジニアの杉本です。
UiPath は高機能なRPA(Robotic Process Automation)製品です。UiPath Studio を使うことで、RPA プログラムをノーコードで開発できます。CData ODBC Driver を使えば、コーディングなしでUiPath からHubDB への接続を作成し、連携フローに組み込めます。CData ODBC Driver は、UiPath からODBC Driver に対して発行されたSQL をHubDB へのリアルタイムリクエストに変換し、レスポンスをテーブルデータとして取得します。
この記事では、UiPath Studio を使ってHubDB に連携するRPA プログラムを作成します。
今回作成するUiPath RPA プロジェクト
データベース接続用アクティビティを利用してCData ODBC Driver for HubDB に接続し、HubDB のNorthwindProducts データを取得するSQL を実行。取得したデータをCSV 書き込みアクティビティを利用して、CSV 出力するRPA プロジェクトを作成します(以下は完成したフローチャート)。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- HubDB をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにHubDB データを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてHubDB の接続を設定、2.UiPath 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとHubDB への接続設定
まずは、本記事右側のサイドバーからHubDB ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
インストール後、ODBC DSN HubDB で接続プロパティを設定します。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および設定できます。
HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。
カスタムOAuthアプリを使用する
すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ(デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン)に必要な接続プロパティについては、ヘルプドキュメントを確認してください。
アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。
- HubSpotアプリ開発者アカウントにログインします。
- アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
- 開発者アカウントのホームページで、アプリタブをクリックします。
- アプリを作成をクリックします。
- アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
- 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
- デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
- Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
- アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
- 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。
スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。
テーブルにアクセスするには、最低限以下のスコープが必要です:
- hubdb
- oauth
- crm.objects.owners.read
- 変更を保存をクリックします。
- 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
- 「インストールURL(OAuth)」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
- コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
- アプリを接続をクリックします。結果のタブは閉じて構いません。
プライベートアプリを使用する
HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。
以下の手順に従ってプライベートアプリケーショントークンを生成できます:
- HubDBアカウントで、メインナビゲーションバーの設定アイコン(歯車)をクリックします。
- 左サイドバーメニューで、統合 > プライベートアプリに移動します。
- プライベートアプリを作成をクリックします。
- 基本情報タブで、アプリケーションの詳細(名前、ロゴ、説明)を設定します。
- スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
- テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
- アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
- アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
- コピーをクリックして、プライベートアプリケーショントークンをコピーします。
接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。
これで、UiPath Studio にHubDB データを接続する準備は完了です。では、実際にプロジェクトを作成していきましょう。
- スタートページから「プロセス」をクリックして、新しいプロジェクトを作成します。
- プロジェクトを作成したら、「新規」アイコンから「フローチャート」を選択して、新しいフローチャートを作成します。
- HubDB への接続を行うには、データベース接続用のアクティビティが必要になります。リボンの「パッケージを管理」をクリックし、「UiPath.Database.Activities」を検索してインストールしてください。
データ取得用アクティビティの作成
データベース関連のアクティビティが追加できたので、次にHubDB への接続を設定してデータを取り出すための、「クエリを実行」アクティビティを追加します。
- アクティビティナビゲーションから「クエリを実行」を選択し、フローチャートに配置します。
- アクティビティをダブルクリックすると設定用画面に移動するので、「接続を構成」をクリックします。
- 「接続ウィザード」をクリックして、「Data Source」に「Microsoft ODBC Data Source」を選択します。
- 「Use user or system data source」のドロップダウンから、先ほど作成した「CData HubDB Source」を選択します。
- 「Test connection」をクリックして接続テストが成功したら、OK をクリックします。これで、UiPath からHubDB への接続設定は完了です。
- 次に、データ取得用のクエリを入力します。以下はサンプルのSQL です。
"SELECT * FROM NorthwindProducts;"
- 最後に、「クエリを実行」アクティビティのプロパティにある「出力」以下の、データテーブルの「+」ボタンから、出力格納用の変数を作成します。
CSV 書き込み用のアクティビティを作成
最後に、出力したデータをCSV に書き込むためのアクティビティを作成します。アクティビティの設定画面から以下の項目を指定してください。
- 書き込み元:先ほど作成した出力用変数を指定します。
- 書き込み先ファイル:任意のファイルパスを指定します。右側のフォルダアイコンからGUI ベースで指定できます。
各アクティビティの紐づけと実行
あとは各アクティビティを紐付ければ、HubDB データを出力するRPA プロジェクトの作成は完了です。
リボンから「実行」を選択してクリックすると、フローが実行されます。無事、HubDB データを持ったCSV ファイルが作成されていました!もちろん取得したデータは、CSV 作成以外にもさまざまなフローに組み込んで使用できます。
おわりに
このようにCData ODBC ドライバを利用して、簡単にUiPath Studio でHubDB に連携するフローを作成することができました。CData ではHubDB 以外にも270種類以上のデータソース向けのドライバーを提供しています。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData ODBC ドライバは、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。