HubDB データ をHeroku Postgres にレプリケーションして、Salesforce Connect から利用する方法

こんにちは！プロダクトスペシャリストの宮本です。

CData Sync は、いろいろなシナリオのデータレプリケーション（同期）を行うことができるスタンドアロンのアプリケーションです。例えば、sandbox および本番インスタンスのデータをデータベースに同期することができます。HubDB データ をHeroku 上のPostgreSQL に同期することで、Salesforce の通常オブジェクトに加えて、Salesforce 外部オブジェクト（Salesforce Connect）としてHubDB データへのアクセスが可能になります。

要件

本レプリケーション例では、次が必要です:

1. CData Sync (試用版もしくは商用版)、およびHubDB のレプリケーションに必要なライセンス。
2. Heroku Postgress を含むHeroku app および、Heroku Connect アドオン許可。
3. Salesforce アカウント。

レプリケーション同期先の設定

CData Sync を使って、HubDB データ をHeroku 上のPostgreSQL データベースにレプリケーションできます。本記事では、Heroku 上の既存のPostgreSQL を使用します。PostgreSQL データベースをレプリケーション先に指定するには、［接続］タブから進みます。

1. ［同期先］タブをクリックします。
2. PostgreSQL を同期先として選択します。

   PostgreSQL への接続には、Port（デフォルトでは5432）、およびデータベース接続プロパティを設定し、サーバーに認証するuser およびpassword を設定します。データベースプロパティが指定されていない場合には、ユーザーのデフォルトデータベースに接続します。

3. 接続のテスト］をクリックして、正しく接続できているかをテストします。
4. ［変更を保存］をクリックします。

HubDB 接続の設定

データソース側にHubDB を設定します。［接続］タブをクリックします。

1. ［接続の追加］セクションで［データソース］タブを選択します。
2. HubDB アイコンをデータソースとして選択します。プリインストールされたソースにHubDB がない場合には、追加データソースとしてダウンロードします。
3. 接続プロパティに入力をします。
   
   

   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を取得したプライベートアプリケーショントークンに設定します。

4. ［接続のテスト］をクリックして、正しく接続できているかをテストします。
5. ［変更を保存］をクリックします。

HubDB インスタンス毎のクエリの設定

Data Sync はレプリケーションをコントロールするSQL クエリを簡単なGUI 操作で設定できます。 レプリケーションジョブ設定には、［ジョブ］タブに進み、［ジョブを追加］ボタンをクリックします。 次にデータソースおよび同期先をそれぞれドロップダウンから選択します。

テーブル全体をレプリケーションする

テーブル全体をレプリケーションするには、［テーブル］セクションで［テーブルを追加］をクリックします。表示されたテーブルリストからレプリケーションするテーブルをチェックします。

テーブルをカスタマイズしてレプリケーションする

レプリケーションはテーブル全体ではなく、カスタマイズが可能です。［変更］機能を使えば、レプリケーションするカラムの指定、同期先でのカラム名を変更しての保存、ソースデータの各種加工が可能です。レプリケーションのカスタマイズには、ジョブの［変更］ボタンをクリックしてカスタマイズウィンドウを開いて操作を行います:

• チェックボックスでフィールドを追加もしくは削除
• カラムリストの下に新しく計算されたフィールドを追加する
• フィルタセクションを利用してフィルタを追加する

インターフェースを使って変更を行うと、レプリケーションのSQL クエリは以下のようなシンプルなものから：

REPLICATE [NorthwindProducts]

次のような複雑なものになります:

REPLICATE [NorthwindProducts] SELECT [PartitionKey], [Name] FROM [NorthwindProducts] WHERE [Id] = 1

レプリケーションのスケジュール起動設定

［スケジュール］セクションでは、レプリケーションジョブの自動起動スケジュール設定が可能です。反復同期間隔は、15分おきから毎月1回までの間で設定が可能です。

レプリケーションジョブを設定したら、［変更を保存］ボタンを押して保存します。複数のHubDB データ のジョブを作成して、Salesforce の外部オブジェクトとして利用可能です。

外部オブジェクトとしてHubDB データ レプリケーションにアクセス

HubDB データ がHeroku 上のPostgreSQL データベースとしてレプリケーションされたので、Heroku のOData インターフェースを設定し、Salesforce Connect から外部オブジェクトとしてデータ連携できるようにします。

Heroku のOData Service を設定します

まずは、Heroku 上のPostgreSQL データベースに複製されたHubDB データ への接続のために、データベースに対しHeroku External Object を設定します。

1. Heroku ダッシュボードで、［Connect Add-on］ をクリックします。
2. ［External Objects］を指定します。はじめてHeroku External Object を使用する場合には、OData Server のログインクレデンシャルを作成するようにナビゲートされます。
3. OData service URL およびクレデンシャルを確認します。このクレデンシャルをSalesforce Connect 接続時に利用します。
4. ［Data Sources］において、前のプロセスで作成したレプリケーション済みデータベースを設定します。

詳しくは、こちらのHeroku documentation を参照してください。

Salesforce の外部データソースの設定

Heroku のOData サービスの設定が終わったら、Salesforce Connect を使って、複製されたHubDB データ のデータに外部データソースとして連携します。

1. Salesforce で設定をクリックします。
2. Administration (管理)セクションで、［データ］→［外部データソース］をクリック。
3. データソースパラメータプロパティを設定します:
   • External Data Source: Salesforce UI に表示される名前
   • Name: API の一位の識別子
   • Type: Salesforce Connect: OData 4.0
   • URL: Heroku Connect のOData エンドポイント
   • Format: JSON
4. 認証の設定:
   • Identity Type: Named Principal
   • Authentication Protocol: Password Authentication
   • Username: Heroku Connect username
   • Password: Heroku Connect password
5. ［保存］をクリック。

HubDB オブジェクトの同期

Salesforce の外部データソース登録が終わったら、次の方法でHubDB 外部データソースに変更を反映させます。HubDB テーブルの定義とHubDB 外部オブジェクトの定義を同期します。

1. 作成した外部データソースのリンクをクリック。
2. ［Validate and Sync］をクリック
3. HubDB テーブルを選択して、［同期］をクリックします。

Salesforce オブジェクトとしてHubDB データ にアクセス

これで、レプリケーションされたHubDB エンティティに対して、Salesforce の通常オブジェクトと同じように外部オブジェクトとしてアクセスが可能になりました。

是非、CData Sync の30日の無償評価版 をダウンロードして、Salesforce との連携をお試しください！