データソースの設定 configure-data-sources

バージョン
記事リンク
AEM 6.5
ここをクリックしてください
AEM as a Cloud Service
この記事

データ統合

Experience Manager Forms のデータ統合機能により、複数の異なるデータソースを設定して接続することができます。以下のタイプがサポートされています。これらのタイプは、すぐに使用することができます。

  • リレーショナルデータベース - MySQL、Microsoft® SQL Server、IBM® DB2®、postgreSQL および Oracle RDBMS
  • RESTful Web サービス
  • SOAP ベースの web サービス
  • OData サービス(バージョン 4.0)
  • Microsoft® Dynamics
  • Salesforce
  • Microsoft® Azure Blob Storage

データ統合では、すぐに使用できる認証タイプとして、OAuth2.0(認証コードクライアント資格情報)、基本認証、API キー認証がサポートされています。また、web サービスにアクセスするためのカスタムの認証タイプを実装することもできます。RESTful サービス、SOAP ベースサービス、OData サービスは Experience Manager as a Cloud Service で設定し、リレーショナルデータベース用の JDBC と Experience Manager ユーザープロファイル用のコネクタは、Experience Manager web コンソールで設定します。

リレーショナルデータベースの設定 configure-relational-database

前提条件

Experience Manager web コンソール設定を使用してリレーショナルデータベースを設定する前に、次の操作が必須です。

リレーショナルデータベースを設定する手順

Experience Manager web コンソールの設定を使用して、リレーショナルデータベースを設定することができます。次の手順を実行します。

  1. https://server:host/system/console/configMgr で Experience Manager web コンソールに移動します。

  2. 「Day Commons JDBC 接続プール」 ​設定を見つけます。その設定を選択して編集モードで開きます。

    JDBC コネクタープール

  3. 設定ダイアログで、設定するデータベースの詳細を指定します。例えば、以下のような詳細を指定します。

    • JDBC ドライバーの Java™ のクラス名

    • JDBC 接続 URI

    • JDBC ドライバーとの接続を確立するためのユーザー名とパスワード

    • 検証クエリ」フィールドの SQL SELECT クエリを指定して、プールからの接続を検証します。クエリは、少なくとも 1 つのレコードを返す必要があります。データベースに応じて、次のいずれかを指定します。

      • SELECT 1(MySQL または MS SQL の場合)
      • SELECT 1 from dual(Oracle の場合)
    • データソースの名前

    リレーショナルデータベースを構成するための文字列の例:

    code language-text
       "datasource.name": "sqldatasourcename-mysql",
       "jdbc.driver.class": "com.mysql.jdbc.Driver",
       "jdbc.connection.uri": "jdbc:mysql://$[env:AEM_PROXY_HOST;default=proxy.tunnel]:30001/sqldatasourcename"
    
    note note
    NOTE
    詳しくは、JDBC DataSourcePool を使用した SQL 接続を参照してください。
  4. 保存」をクリックして、設定を保存します。

これで、設定済みのリレーショナルデータベースをフォームデータモデルと共に使用できます。

クラウドサービス設定用フォルダーの構成 cloud-folder

RESTful サービス、SOAP サービス、OData サービスのクラウドサービスを設定するには、クラウドサービス用のフォルダーを設定する必要があります。

Experience Manager のすべてのクラウドサービス設定は、Experience Manager リポジトリーの /conf フォルダー内に保存されます。デフォルトの場合、conf フォルダーには global フォルダーが含まれています。このフォルダーで、クラウドサービスの設定を作成することができます。ただし、このフォルダーを手動でクラウド設定用に有効にする必要があります。追加のフォルダーを conf フォルダー内に作成して、クラウドサービスの作成と編集を行うこともできます。

クラウドサービス設定用のフォルダーを構成するには、以下の手順を実行します。

  1. ツール/一般/設定ブラウザー ​に移動します。

  2. 以下の手順を実行して、global フォルダーをクラウド設定用に有効にします。クラウドサービス設定用に別のフォルダーを作成する場合は、この手順をスキップしてください。

    1. 設定ブラウザー ​で、global フォルダーを選択し、「プロパティ」をクリックします。

    2. 設定プロパティ ​ダイアログで、「クラウド設定」を有効にします。

    3. 保存して閉じる」を選択して設定内容を保存し、ダイアログを閉じます。

  3. 設定ブラウザー ​で「作成」を選択します。

  4. 設定を作成」ダイアログでフォルダーのタイトルを指定し、「クラウド設定」を有効にします。

  5. 作成」を選択して、クラウドサービス設定が有効になったフォルダーを作成します。

RESTful Web サービスの設定 configure-restful-web-services

RESTful Web サービスは、Swagger の仕様に従い、JSON 形式または YAML 形式で in JSON or YAML forSwagger 定義ファイル in JSON or YAML format in a 内に記述できます。Experience Manager as a Cloud Service で RESTful web サービスを設定するには、ファイルシステムまたはファイルがホストされている URL に Swagger ファイル(Swagger Version 2.0)Swagger ファイル(Swagger Version 3.0)が存在しているか、Swagger ファイルがホストされる URL を指定する必要があります。

Open API 仕様バージョン 2.0 用の RESTful サービスの設定 configure-restful-services-open-api-2.0

  1. ツール/Cloud Services/データソース ​に移動します。クラウド設定の作成対象となるフォルダーを選択します。

    クラウドサービス設定用フォルダーの作成方法と構成方法については、「クラウドサービス設定用フォルダーの構成」を参照してください。

  2. 作成」を選択して、データソース設定を作成 ​ウィザードを開きます。設定の名前と、必要に応じて設定のタイトルを指定し、サービスタイプ ​ドロップダウンで「RESTful サービス」を選択します。必要な場合は、設定のサムネール画像を選択して「次へ」をクリックします。

  3. RESTful サービスの次の詳細を指定します。

    • 「Swagger ソース」ドロップダウンで「URL」または「ファイル」を選択します。「URL」を選択した場合は、 Swagger 定義ファイルに対する Swagger URL を指定し、「ファイル」を選択した場合は、ローカルのファイルシステムから Swagger ファイルをアップロードします。

    • Swagger ソース入力に基づいて、次のフィールドに値が事前入力されます。

      • スキーム:REST API で使用される転送プロトコル。ドロップダウンリストに表示されるスキームの種類の数は、Swagger ソースで定義されているスキームによって異なります。
      • ホスト:REST API を提供するホストのドメイン名または IP アドレス。このフィールドは必須です。
      • 基本パス:すべての API パスの URL プリフィックス。これはオプションのフィールドです。
        必要に応じて、これらのフィールドの事前入力された値を編集します。
    • RESTful サービスにアクセスするための認証タイプ(なし、「OAuth2.0(認証コードクライアント資格情報)、基本認証、API キー認証、カスタム認証)を選択し、その選択内容に応じて認証の詳細を指定します。

    認証タイプとして API キー ​を選択した場合は、API キーの値を指定します。API キーは、リクエストヘッダーまたはクエリパラメーターとして送信できます。「場所」ドロップダウンリストから次のオプションの 1 つを選択し、それに応じて「パラメーター名」フィールドにヘッダーまたはクエリパラメーターの名前を指定します。

  4. 作成」を選択して、RESTful サービス用のクラウド設定を作成します。

Open API 仕様バージョン 3.0 用の RESTful サービスの設定 configure-restful-services-open-api-3.0

  1. ツール/Cloud Services/データソース ​に移動します。クラウド設定の作成対象となるフォルダーを選択します。

    クラウドサービス設定用フォルダーの作成方法と構成方法については、「クラウドサービス設定用フォルダーの構成」を参照してください。

  2. 作成」を選択して、データソース設定を作成 ​ウィザードを開きます。設定の名前と、必要に応じて設定のタイトルを指定し、サービスタイプ ​ドロップダウンで「RESTful サービス」を選択します。必要な場合は、設定のサムネール画像を選択して「次へ」をクリックします。

  3. RESTful サービスの次の詳細を指定します。

    • 「Swagger ソース」ドロップダウンで「URL」または「ファイル」を選択します。「URL」を選択した場合は、 Swagger 定義ファイルに対する Swagger 3.0 URL を指定し、「ファイル」を選択した場合は、ローカルのファイルシステムから Swagger ファイルをアップロードします。
    • Swagger ソース入力に基づいて、ターゲットサーバとの接続情報が表示されます。
    • RESTful サービスにアクセスするための認証タイプ(なし、OAuth2.0(認証コードクライアント資格情報)、基本認証、API キー認証、カスタム認証)を選択し、その選択内容に応じて認証の詳細を指定します。

    認証タイプとして API キー ​を選択した場合は、API キーの値を指定します。API キーは、リクエストヘッダーまたはクエリパラメーターとして送信できます。「場所」ドロップダウンリストから次のオプションの 1 つを選択し、それに応じて「パラメーター名」フィールドにヘッダーまたはクエリパラメーターの名前を指定します。

  4. 作成」を選択して、RESTful サービス用のクラウド設定を作成します。

RESTful サービス Open API 仕様バージョン 3.0 でサポートされていない操作の一部は次のとおりです。

  • コールバック
  • oneof/anyof
  • リモート参照
  • リンク
  • 1 回の操作に対する異なる MIME タイプの異なるリクエスト本文

詳しくは、OpenAPI 3.0 仕様を参照してください。

パフォーマンスを最適化するためのフォームデータモデル HTTP クライアント設定 fdm-http-client-configuration

データソースとして RESTful web サービスと統合する場合の Experience Manager Forms フォームデータモデルには、パフォーマンス最適化のための HTTP クライアント設定が含まれています。

REST データソース設定のフォームデータモデル HTTP クライアント設定 ​の次のプロパティを設定し、正規表現を指定します。

  • http.connection.max.per.route プロパティを使用して、フォームデータモデルと RESTful web サービス間で許可される最大接続数を設定します。デフォルト値は 20 接続です。

  • http.connection.max プロパティを使用して、各ルートに許可される最大接続数を指定します。デフォルト値は 40 接続です。

  • http.connection.keep.alive.duration プロパティを使用して、永続的な HTTP 接続が有効に保たれる期間を指定します。デフォルト値は 15 秒です。

  • http.connection.timeout プロパティを使用して、Experience Manager Forms 接続が確立するまでのサーバーの待機時間を指定します。デフォルト値は 10 秒です。

  • http.socket.timeout プロパティを使用して、2 つのデータパケット間の無操作状態の最大期間を指定します。デフォルト値は 30 秒です。

以下の JSON ファイルにサンプルが表示されています。

{
   "http.connection.keep.alive.duration":"15",
   "http.connection.max.per.route":"20",
   "http.connection.timeout":"10",
   "http.socket.timeout":"30",
   "http.connection.idle.connection.timeout":"15",
   "http.connection.max":"40"
}
  1. REST データソース用フォームデータモデル HTTP クライアント設定」を選択します。

  2. REST データソース用フォームデータモデル HTTP クライアント設定ダイアログで、

    • 接続制限(合計) ​フィールドに、フォームデータモデルと RESTful web サービス間の接続許可数の上限を指定します。デフォルト値は 20 接続です。

    • ルートごとの接続制限 ​フィールドで、各ルートに許可される最大接続数を指定します。デフォルト値は 2 つの接続です。

    • Keep Alive フィールドで、持続的な HTTP 接続を維持する期間を指定します。デフォルト値は 15 秒です。

    • 接続タイムアウト ​フィールドで、Experience Manager Forms サーバーが接続を確立するまでの待ち時間を指定します。デフォルト値は 10 秒です。

    • ソケットタイムアウト ​フィールドに、2 つのデータパケット間の非アクティブの最大時間を指定します。デフォルト値は 30 秒です。

SOAP Web サービスの設定 configure-soap-web-services

SOAP ベースの web サービスは、Web Services Description Language(WSDL)の仕様に従って記述します。Experience Manager Forms RPC-style WSDL モデルをサポートしていません。

Experience Manager as a Cloud Service で SOAP ベースの web サービスを設定するには、その web サービスの WSDL URL を確認して、以下の手順を実行します。

  1. ツール/Cloud Services/データソース ​に移動します。クラウド設定の作成対象となるフォルダーを選択します。

    クラウドサービス設定用フォルダーの作成方法と構成方法については、「クラウドサービス設定用フォルダーの構成」を参照してください。

  2. 作成」を選択して、データソース設定を作成ウィザード ​を開きます。設定の名前と、必要に応じて設定のタイトルを指定し、サービスタイプ ​ドロップダウンで「SOAP web サービス」を選択します。必要な場合は、設定のサムネール画像を選択して「次へ」を選択します。

  3. SOAP web サービスに対して次の情報を指定します。

    • Web サービスの WSDL URL。

    • サービスエンドポイント。WSDL で指定されているサービスエンドポイントを上書きするには、このフィールドの値を指定します。

    • SOAP サービスにアクセスするための認証タイプ(なし、OAuth2.0(認証コードクライアント資格情報)、基本認証、カスタム認証)を選択し、その選択内容に応じて認証の詳細を指定します。

  4. 作成」を選択して、SOAP web サービス用のクラウド設定を作成します。

SOAP Web サービス WSDL でのインポート文の使用を有効にする enable-import-statements

SOAP Web サービス WSDL のインポート文として許可される絶対 URL のフィルターとして機能する正規表現を指定できます。デフォルトでは、このフィールドに値はありません。その結果、Experience Manager は WSDL で使用可能なすべてのインポート文をブロックします。このフィールドの値として .* を指定すると、Experience Manager はすべてのインポート文を許可します。

フォームデータモデル SOAP Web サービスインポート許可リスト ​の設定の importAllowlistPattern プロパティを設定して、正規表現を指定します。以下の JSON ファイルにサンプルが表示されています。

{
  "importAllowlistPattern": ".*"
}

設定の値をセットするには、AEM SDK を使用して OSGi 設定を生成し、Cloud Service インスタンスに設定をデプロイします。

OData サービスの設定 config-odata

OData サービスは、そのサービスのルート URL によって識別されます。Experience Manager as a Cloud Service で OData サービスを設定するには、そのサービスのルート URL を確認して、以下の手順を実行します。

NOTE
フォームデータモデルは OData バージョン 4 をサポートします。
オンライン環境またはオンプレミス環境で Microsoft®® Dynamics 365 を設定する詳しい手順については、Microsoft® Dynamics OData 設定を参照してください。
  1. ツール/Cloud Services/データソース ​に移動します。クラウド設定の作成対象となるフォルダーを選択します。

    クラウドサービス設定用フォルダーの作成方法と構成方法については、「クラウドサービス設定用フォルダーの構成」を参照してください。

  2. 作成」を選択して、データソース設定を作成ウィザード ​を開きます。設定の名前と、必要に応じて設定のタイトルを指定し、サービスタイプ ​ドロップダウンで「OData サービス」を選択します。必要な場合は、設定のサムネール画像を参照および選択して「次へ」をクリックします。

  3. OData サービスの次の詳細を指定します。

    • 設定する OData サービスのサービスルート URL。
    • OData サービスにアクセスするための認証タイプ(なし、OAuth2.0(認証コードクライアント資格情報)、基本認証、API キー認証、カスタム認証)を選択し、その選択内容に応じて認証の詳細を指定します。

    認証タイプとして API キー ​を選択した場合は、API キーの値を指定します。API キーは、リクエストヘッダーまたはクエリパラメーターとして送信できます。「場所」ドロップダウンリストから次のオプションの 1 つを選択し、それに応じて「パラメーター名」フィールドにヘッダーまたはクエリパラメーターの名前を指定します。

    note note
    NOTE
    OData エンドポイントをサービスルートとして使用して Microsoft®® Dynamics サービスに接続する場合は、OAuth 2.0 認証タイプを選択します。
  4. 作成」を選択して、OData サービス用のクラウド設定を作成します。

次の手順 next-steps

上記の手順により、データソースが設定されました。次に、フォームデータモデルを作成できます。データソースのないフォームデータモデルが既に作成されている場合は、設定したデータソースにそのフォームデータモデルを関連付けることができます。詳しくは、フォームデータモデルの作成を参照してください。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab