Salesforce Connect で Elasticsearch 外部オブジェクトを編集・検索(API Server)
CData API Server を使用すると、Salesforce コンソールや Salesforce1 モバイルアプリなどのクラウドベースのアプリケーションからElasticsearch のデータにアクセスできます。この記事では、API Server と Salesforce Connect を使用して、標準の Salesforce オブジェクトと一緒に Elasticsearch 外部オブジェクトにアクセスする方法を説明します。
Elasticsearch データ連携について
CData を使用すれば、Elasticsearch のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています:
- SQL エンドポイントと REST エンドポイントの両方にアクセスでき、接続を最適化し、Elasticsearch データの読み書きに関してより多くのオプションを提供します。
- v2.2 以降およびオープンソース Elasticsearch サブスクリプションを含む、ほぼすべての Elasticsearch インスタンスに接続できます。
- SCORE() 関数を明示的に要求することなく、常にクエリ結果の関連性スコアを受け取ることができます。これにより、サードパーティツールからのアクセスが簡素化され、クエリ結果のテキスト関連性のランキングを簡単に確認できます。
- 複数のインデックスを検索でき、クライアントマシンではなく Elasticsearch がクエリと結果の管理・処理を担当します。
ユーザーは、Crystal Reports、Power BI、Excel などの分析ツールと Elasticsearch データを統合し、当社のツールを活用して、Elasticsearch を含むすべてのデータソースへの単一のフェデレートアクセスレイヤーを実現しています。
CData の Elasticsearch ソリューションの詳細については、ナレッジベース記事をご覧ください:CData Elasticsearch Driver Features & Differentiators
はじめに
API Server のセットアップ
まだインストールしていない場合は、CData API Server をダウンロードしてください。API Server をインストールしたら、以下の手順に従ってセキュアな Elasticsearch OData サービスの作成を開始します。
Elasticsearch への接続
Salesforce Connect からElasticsearch のデータを操作するには、まず Elasticsearch への接続を作成・設定します。以下の手順で API Server を設定してElasticsearch のデータに接続します。
- まず、Connections ページに移動します。
-
Add Connection をクリックし、Elasticsearch 接続を検索して選択します。
-
Elasticsearch に接続するために必要な認証プロパティを入力します。
Elasticsearch 接続プロパティの取得・設定方法
接続するには、Server およびPort 接続プロパティを設定します。 認証には、User とPassword プロパティ、PKI (public key infrastructure)、またはその両方を設定します。 PKI を使用するには、SSLClientCert、SSLClientCertType、SSLClientCertSubject、およびSSLClientCertPassword プロパティを設定します。
CData 製品は、認証とTLS/SSL 暗号化にX-Pack Security を使用しています。TLS/SSL で接続するには、Server 値に'https://' を接頭します。Note: PKI を 使用するためには、TLS/SSL およびクライアント認証はX-Pack 上で有効化されていなければなりません。
接続されると、X-Pack では、設定したリルムをベースにユーザー認証およびロールの許可が実施されます。
- 接続を設定したら、 Save & Test をクリックして接続が成功したことを確認します。
API Server のユーザー設定
次に、API Server を通じてElasticsearch のデータにアクセスするユーザーを作成します。Users ページでユーザーを追加・設定できます。以下の手順でユーザーを設定・作成します。
- Users ページで、 Add User をクリックして Add User ダイアログを開きます。
-
次に、Role、Username、Privileges プロパティを設定し、Add User をクリックします。
-
その後、ユーザーの Authtoken が生成されます。各ユーザーの Authtoken やその他の情報は Users ページで確認できます。
Elasticsearch 用の API エンドポイントの作成
ユーザーを作成したら、Elasticsearch テーブル用の API エンドポイントを作成します。
-
まず、API ページに移動し、 Add Table をクリックします。
-
アクセスしたい接続を選択し、Next をクリックします。
-
接続を選択した状態で、各テーブルを選択し、Confirm をクリックしてエンドポイントを作成します。
OData URL の取得
Elasticsearch のデータへの接続を設定し、ユーザーを作成し、API Server にリソースを追加したので、これらのリソース用の OData プロトコルに基づいた簡単にアクセスできる REST API が利用可能になりました。API Server の API ページから、API の API エンドポイントを表示およびコピーできます。
Elasticsearch のデータ を外部データソースとして接続
以下の手順に従って、API Server が生成するフィードに接続します。
- Salesforce にログインし、設定 -> 開発 -> 外部データソース をクリックします。
- 「新規外部データソース」をクリックします。
- 以下のプロパティの値を入力します:
- 外部データソース:リストビューやレポートで使用するラベルを入力します。
- 名前:一意の識別子を入力します。
- 種類:「Salesforce Connect: OData 4.0」オプションを選択します。
URL:API Server の OData エンドポイントへの URL を入力します。URL の形式は https://your-server:your-port/api.rsc です。
注意:プレーンテキストはテスト専用です。本番環境では TLS を使用してください。
- 「書き込み可能外部オブジェクト」オプションを選択します。
「形式」メニューで JSON を選択します。
- 「認証」セクションで、以下のプロパティを設定します:
- ID 種類:組織のすべてのメンバーが同じ資格情報を使用して API Server にアクセスする場合は、「指定プリンシパル」を選択します。組織のメンバーが独自の資格情報で接続する場合は、「ユーザーごと」を選択します。
- 認証プロトコル:Basic 認証を使用する場合は「パスワード認証」を選択します。
- 証明書:Salesforce からサーバーへの通信を暗号化・認証するために使用する証明書を入力または参照します。
- ユーザー名:API Server のユーザー名を入力します。
- パスワード:ユーザーの Authtoken を入力します。
Elasticsearch オブジェクトの同期
外部データソースを作成したら、以下の手順に従って、データソースの変更を反映する Elasticsearch 外部オブジェクトを作成します。Elasticsearch 外部オブジェクトの定義を Elasticsearch テーブルの定義と同期します。
- 作成した外部データソースのリンクをクリックします。
- 「検証して同期」をクリックします。
- 外部オブジェクトとして操作する Elasticsearch テーブルを選択します。
Elasticsearch のデータ を Salesforce オブジェクトとしてアクセス
Elasticsearch のデータ を外部データソースとして追加し、Elasticsearch テーブルを Elasticsearch 外部オブジェクトと同期したら、標準の Salesforce オブジェクトと同様に外部オブジェクトを使用できます。
-
フィルターリストビューを持つ新しいタブを作成:
-
標準 Salesforce オブジェクトと一緒に Elasticsearch 外部オブジェクトの関連リストを表示:
-
Salesforce ダッシュボードのタブから Elasticsearch オブジェクトの作成、読み取り、更新、削除:
トラブルシューティング
一般的な接続の問題を避けるために、以下のチェックリストを使用できます:
- サーバーにパブリックアクセス可能な 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 ハウツーを参照してください。