データソースの設定

データ統合

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

  • 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 で設定されますが、Experience Manager ユーザープロファイル用のコネクタは Experience Manager web コンソールで設定されます。

メモ

Experience Manager Forms はリレーショナルデータベースをサポートしていません。

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

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

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

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

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

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

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

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

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

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

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

  5. 作成」をタップします。これで、クラウドサービス設定が有効になったフォルダーが作成されました。

RESTful Web サービスの設定

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

RESTful サービスを設定するには、以下の手順を実行します。

  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 サービス用のクラウド設定を作成します。

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

データソースとして 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"
}

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

フォームデータモデルの HTTP クライアントを設定するには、以下の手順を実行します。

  1. Experience Manager Forms オーサーインスタンスに管理者としてログインし、Experience Manager web コンソールバンドルに移動します。デフォルトの URL は https://localhost:4502/system/console/configMgr です。

  2. REST データソース用フォームデータモデル HTTP クライアント設定」をタップします。

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

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

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

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

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

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

SOAP Web サービスの設定

SOAP ベースの web サービスは、Web Services Description Language(WSDL)の仕様に従って記述します。Experience Manager Forms は RPC スタイルの 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 でのインポート文の使用を有効にする

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

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

{
  "importAllowlistPattern": ".*"
}

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

OData サービスの設定

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

メモ

フォームデータモデルは 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 つを選択し、それに応じて「パラメーター名」フィールドにヘッダーまたはクエリパラメーターの名前を指定します。

    メモ

    OData エンドポイントをサービスルートとして使用して Microsoft Dynamics サービスに接続する場合は、OAuth 2.0 認証を選択する必要があります。

  4. 作成」をタップして、OData サービス用のクラウド設定を作成します。

次の手順

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

このページ