アダプティブフォームからフォームデータモデルサービスを呼び出すための API

概要

AEM Forms を使用すると、アダプティブフォームフィールド内からフォームデータモデルで構成されたサービスを呼び出すことで、フォーム作成者はフォームへの記入作業を簡略化および強化することができます。データモデルサービスを呼び出すには、ビジュアルエディターでルールを作成するか、ルールエディターのコードエディターの guidelib.dataIntegrationUtils.executeOperation API を使用して JavaScript を指定します。

このドキュメントでは、guidelib.dataIntegrationUtils.executeOperation API を使用して JavaScript を記述してサービスを呼び出す方法に焦点を当てています。

API の使用

guidelib.dataIntegrationUtils.executeOperation API は、アダプティブフォームのフィールド内から サービスを呼び出します。API 構文は以下のとおりです。

guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs)

guidelib.dataIntegrationUtils.executeOperation API の構造は、サービス操作の詳細を指定します。この構造の構文は以下のとおりです。

var operationInfo = {
formDataModelId,
operationTitle,
operationName
};
var inputs = {
inputField1,
inputFieldN
};
var outputs = {
outputField1,
outputFieldN
}

API 構造は、サービス操作の以下の詳細を指定します。

パラメーター 説明
operationInfo フォームデータモデルの識別子、操作タイトル、操作名を指定する構造
formDataModelId 名前を含むフォームデータモデルへのリポジトリパスを指定します
operationName 実行するサービス操作の名前を指定します
inputs 1 つ以上のフォームオブジェクトをサービス操作の入力引数にマップします
Outputs 1 つ以上のフォームオブジェクトをサービス操作からの出力値にマップしてフォームフィールドを埋め込みます
success サービス操作の入力引数に基づいて値を返します。コールバック関数として使用されるオプションのパラメーターです。
failure success コールバック関数が入力引数に基づいて出力値を表示できない場合に、エラーメッセージを表示します。コールバック関数として使用されるオプションのパラメーターです。

サービスを呼び出すスクリプトのサンプル

以下のサンプルスクリプトでは、guidelib.dataIntegrationUtils.executeOperation API を使用して、employeeAccount フォームデータモデルで構成された getAccountById サービス操作を呼び出しています。

getAccountById 操作は、empId 引数の入力値として employeeID フォームフィールドにある値を使用し、該当する従業員の名前、口座番号、口座残高を戻します。この出力値は指定されたフォームフィールドに入力されます。例えば、name 引数の値は fullName フォーム要素に入力され、accountNumber 引数の値は account フォーム要素に入力されます。

var operationInfo = {
"formDataModelId": "/content/dam/formsanddocuments-fdm/employeeAccount",
"operationName": "getAccountDetails"
};
var inputs = {
"empid" : employeeID
};
var outputs = {
"name" : fullName,
"accountNumber" : account,
"balance" : balance
};
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);

コールバック関数での API の使用

また、コールバック関数でguidelib.dataIntegrationUtils.executeOperation APIを使用してフォームデータモデルサービスを呼び出すこともできます。 API 構文は以下のとおりです。

guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, callbackFunction)

コールバック関数は、success および failure コールバック関数を持つことができます。

success コールバック関数と failure コールバック関数を持つサンプルスクリプト

以下のサンプルスクリプトでは、guidelib.dataIntegrationUtils.executeOperation API を使用して、employeeOrder フォームデータモデルで構成された GETOrder サービス操作を呼び出しています。

GETOrder 操作は、Order ID フォームフィールドの値を orderId 引数の入力として受け取り、success コールバック関数に注文数量の値を返します。success コールバック関数が注文数を返さない場合、failure コールバック関数は Error occured メッセージを表示します。

メモ

success コールバック関数を使用する場合、指定したフォームフィールドに出力値が入力されません。

var operationInfo = {
    "formDataModelId": "/content/dam/formsanddocuments-fdm/employeeOrder",
    "operationTitle": "GETOrder",
    "operationName": "GETOrder"
};
var inputs = {
    "orderId" : Order ID
};
var outputs = {};
var success = function (wsdlOutput, textStatus, jqXHR) {
order_quantity.value = JSON.parse(wsdlOutput).quantity;
 };
var failure = function(){
alert('Error occured');
};
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, success, failure);

このページ