Salesforce Connect で CouchDB 外部オブジェクトを編集・検索（API Server）

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
API Server を使用して、スマートデバイスやクラウドベースのアプリケーションにCouchDB のデータのセキュアな OData フィードを提供します。API Server と Salesforce Connect を使用して、アプリやダッシュボードからアクセスできる CouchDB オブジェクトを作成します。

CData API Server を使用すると、Salesforce コンソールや Salesforce1 モバイルアプリなどのクラウドベースのアプリケーションからCouchDB のデータにアクセスできます。この記事では、API Server と Salesforce Connect を使用して、標準の Salesforce オブジェクトと一緒に CouchDB 外部オブジェクトにアクセスする方法を説明します。

API Server のセットアップ

まだインストールしていない場合は、CData API Server をダウンロードしてください。API Server をインストールしたら、以下の手順に従ってセキュアな CouchDB OData サービスの作成を開始します。

CouchDB への接続

Salesforce Connect からCouchDB のデータを操作するには、まず CouchDB への接続を作成・設定します。以下の手順で API Server を設定してCouchDB のデータに接続します。

  1. まず、Connections ページに移動します。
  2. Add Connection をクリックし、CouchDB 接続を検索して選択します。
  3. CouchDB に接続するために必要な認証プロパティを入力します。

    Apache CouchDB 接続プロパティの取得・設定方法

    それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

    ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

    Apache CouchDB への認証

    続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

    • Basic：基本的なユーザー名 / パスワード認証
    • JWT：JWT 認証
    • None：パブリックなデータベースへの匿名アクセス

    Basic 認証

    データに接続するには、以下のプロパティを設定してください。

    • AuthScheme：Basic
    • User：認証に使用されるApache CouchDB ユーザーアカウント
    • Password：認証するユーザーに関連付けられたApache CouchDB パスワード

    その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

  4. 接続を設定したら、 Save & Test をクリックして接続が成功したことを確認します。

API Server のユーザー設定

次に、API Server を通じてCouchDB のデータにアクセスするユーザーを作成します。Users ページでユーザーを追加・設定できます。以下の手順でユーザーを設定・作成します。

  1. Users ページで、 Add User をクリックして Add User ダイアログを開きます。
  2. 次に、Role、Username、Privileges プロパティを設定し、Add User をクリックします。
  3. その後、ユーザーの Authtoken が生成されます。各ユーザーの Authtoken やその他の情報は Users ページで確認できます。

CouchDB 用の API エンドポイントの作成

ユーザーを作成したら、CouchDB テーブル用の API エンドポイントを作成します。

  1. まず、API ページに移動し、 Add Table をクリックします。
  2. アクセスしたい接続を選択し、Next をクリックします。
  3. 接続を選択した状態で、各テーブルを選択し、Confirm をクリックしてエンドポイントを作成します。

OData URL の取得

CouchDB のデータへの接続を設定し、ユーザーを作成し、API Server にリソースを追加したので、これらのリソース用の OData プロトコルに基づいた簡単にアクセスできる REST API が利用可能になりました。API Server の API ページから、API の API エンドポイントを表示およびコピーできます。

CouchDB のデータ を外部データソースとして接続

以下の手順に従って、API Server が生成するフィードに接続します。

  1. Salesforce にログインし、設定 -> 開発 -> 外部データソース をクリックします。
  2. 「新規外部データソース」をクリックします。
  3. 以下のプロパティの値を入力します：
    • 外部データソース：リストビューやレポートで使用するラベルを入力します。
    • 名前：一意の識別子を入力します。
    • 種類：「Salesforce Connect: OData 4.0」オプションを選択します。

    • URL：API Server の OData エンドポイントへの URL を入力します。URL の形式は https://your-server:your-port/api.rsc です。

      注意：プレーンテキストはテスト専用です。本番環境では TLS を使用してください。

  4. 「書き込み可能外部オブジェクト」オプションを選択します。

  5. 「形式」メニューで JSON を選択します。

  6. 「認証」セクションで、以下のプロパティを設定します：
    • ID 種類：組織のすべてのメンバーが同じ資格情報を使用して API Server にアクセスする場合は、「指定プリンシパル」を選択します。組織のメンバーが独自の資格情報で接続する場合は、「ユーザーごと」を選択します。
    • 認証プロトコル：Basic 認証を使用する場合は「パスワード認証」を選択します。
    • 証明書：Salesforce からサーバーへの通信を暗号化・認証するために使用する証明書を入力または参照します。
    • ユーザー名：API Server のユーザー名を入力します。
    • パスワード：ユーザーの Authtoken を入力します。

CouchDB オブジェクトの同期

外部データソースを作成したら、以下の手順に従って、データソースの変更を反映する CouchDB 外部オブジェクトを作成します。CouchDB 外部オブジェクトの定義を CouchDB テーブルの定義と同期します。

  1. 作成した外部データソースのリンクをクリックします。
  2. 「検証して同期」をクリックします。
  3. 外部オブジェクトとして操作する CouchDB テーブルを選択します。

CouchDB のデータ を Salesforce オブジェクトとしてアクセス

CouchDB のデータ を外部データソースとして追加し、CouchDB テーブルを CouchDB 外部オブジェクトと同期したら、標準の Salesforce オブジェクトと同様に外部オブジェクトを使用できます。

  • フィルターリストビューを持つ新しいタブを作成：

  • 標準 Salesforce オブジェクトと一緒に CouchDB 外部オブジェクトの関連リストを表示：

  • Salesforce ダッシュボードのタブから CouchDB オブジェクトの作成、読み取り、更新、削除：

トラブルシューティング

一般的な接続の問題を避けるために、以下のチェックリストを使用できます：

  • サーバーにパブリックアクセス可能な IP アドレスがあることを確認してください。これに関連して、OS レイヤーで、ファイアウォールが API Server が実行されているポートを開いていることを確認する必要があります。アプリケーションレイヤーでは、管理コンソールの Settings -> Security タブで信頼できる IP アドレスを追加していることを確認してください。
  • 商用の信頼できる CA からの SSL 証明書で保護された接続を使用していることを確認してください。Salesforce は現在、自己署名証明書や内部 CA を受け入れていません。

  • API Server をホストしているサーバーが TLS 1.1 以上を使用していることを確認してください。.NET API Server を使用している場合は、.NET API Server の組み込みサーバーを使用することで実現できます。

    IIS を使用している場合、TLS 1.1 および 1.2 はサポートされていますが、デフォルトでは有効になっていません。これらのプロトコルを有効にするには、MSDN のハウツーと Microsoft 技術リファレンスを参照してください。

    Java エディションを使用している場合、TLS 1.2 は Java 8 ではデフォルトで有効ですが、Java 6 または 7 では有効ではありません。これらの以前のバージョンを使用している場合は、この Oracle ハウツーを参照してください。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事