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

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

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

要件

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

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

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

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

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

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

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

Bitbucket 接続の設定

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

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

   ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。

   Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。

   • Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
   • Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。

   Bitbucketでの認証

   BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。

   特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。

   カスタムOAuthアプリケーションの作成

   Bitbucketアカウントから、以下のステップを実行します。

   1. 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
   2. アプリと機能セクションで、OAuthコンシューマーを選択します。
   3. コンシューマーを追加をクリックします。
   4. カスタムアプリケーションの名前と説明を入力します。
   5. コールバックURLを設定します。
      • デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
      • Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
   6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
   7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
   8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
   9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
4. ［接続のテスト］をクリックして、正しく接続できているかをテストします。
5. ［変更を保存］をクリックします。

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

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

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

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

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

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

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

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

REPLICATE [Issues]

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

REPLICATE [Issues] SELECT [Title], [ContentRaw] FROM [Issues] WHERE [Id] = 1

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

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

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

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

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

Heroku のOData Service を設定します

まずは、Heroku 上のPostgreSQL データベースに複製されたBitbucket データ への接続のために、データベースに対し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 を使って、複製されたBitbucket データ のデータに外部データソースとして連携します。

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. ［保存］をクリック。

Bitbucket オブジェクトの同期

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

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

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

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

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