アダプティブフォーム向けのカスタム送信アクションの作成 writing-custom-submit-action-for-adaptive-forms

適用先 applies-to

このドキュメントは、AEM 6.5 LTS Forms​に適用されます。

AEM as a Cloud Serviceのドキュメントについては、Cloud Service上のAEM Formsを参照してください。

アダプティブフォームでは、ユーザー指定のデータを処理するために、送信アクションが必要となります。 送信アクションとは、アダプティブフォームを使って送信されるデータに対して実行されるタスクを決定するものです。 Adobe Experience Manager（AEM）には、ユーザーから送信されたデータを使用して実行できるカスタムタスクを示す標準の送信アクションが含まれています。 例えば、メール送信やデータの格納などのタスクを実行することができます。

送信アクションのワークフロー workflow-for-a-submit-action

このフローチャートは、アダプティブフォームで「送信」ボタンをクリックしたときにトリガーされる送信アクションのワークフローを表しています。 添付ファイルコンポーネント内のファイルがサーバーにアップロードされ、フォームデータはアップロードされたファイルの URL を使用して更新されます。 クライアント内では、データは JSON 形式で保存されます。 クライアントは内部サーブレットに Ajax リクエストを送信し、サーブレットは指定したデータを処理して XML 形式で返します。 クライアントは、このデータをアクションフィールドと照合します。 そして、Form Submit アクションを通して、データを最終サーブレット（Guide Submit サーブレット）に送信します。 次に、サーブレットが送信アクションにコントロールを転送します。 送信アクションは、異なるスリングリソースにリクエストを転送するか、ブラウザーを別の URL にリダイレクトさせることができます。

XML データ形式 xml-data-format

XML データは、jcr:data リクエストパラメーターを使ってサーブレットへと送信されます。 送信アクションは、パラメーターにアクセスしてデータを処理できます。 次のコードは、XML データの形式を説明しています。 フォームモデルにバインドされているフィールドは、afBoundData セクションに表示されます。 バインドされていないフィールドは、afUnoundData セクションに表示されます。 data.xml ファイルの形式について詳しくは、アダプティブフォームフィールドの自動埋め込みの概要を参照してください。

<?xml ?>
<afData>
<afUnboundData>
<data>
<field1>value</field2>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
</data>
</afUnboundData>
<afBoundData>
<!-- xml corresponding to the Form Model /XML Schema -->
</afBoundData>
</afData>

アクションフィールド action-fields

送信アクションは、HTML の input タグを使って、レンダリングされたフォームの HTML に非表示の入力フィールドを追加することができます。 これらの非表示のフィールドには、フォーム送信の処理中に必要な値を含めることができます。 フォーム送信時に、これらのフィールド値は、送信アクションが送信処理中に使用することのできるリクエストパラメーターとしてポストバックされます。 この入力フィールドは、アクションフィールドと呼ばれます。

例えば、フォームの記入にかかった時間も取得する送信アクションであれば、startTime および endTime のフィールドを非表示で追加することができます。

スクリプトを使って、フォームがレンダリングされた時間ならびにフォーム送信前の時間を、それぞれ startTime および endTime フィールドの値として指定することができます。 その後、送信 ActionScript post.jsp が、リクエストパラメーターを使用してこれらのフィールドにアクセスし、フォームの記入にかかった合計時間を計算することができます。

添付ファイル file-attachments

送信アクションは、ファイル添付コンポーネントを使ってアップロードされた添付ファイルを使用することもできます。 送信アクションスクリプトは、スリング RequestParameter API を使ってこれらのファイルにアクセスすることができます。 API の isFormField メソッドは、リクエストパラメーターがファイルであるかフォームフィールドであるかを特定するのに役立ちます。 送信アクション内のリクエストパラメーターを反復することで、File Attachment パラメーターを特定することができます。

次のサンプルコードは、まず、リクエスト内の添付ファイルを特定します。 続いて、このコードは、Get API を使ってファイルにデータを読み込みます。 最後に、データを使用してドキュメントオブジェクトを作成し、それをリストに追加します。

RequestParameterMap requestParameterMap = slingRequest.getRequestParameterMap();
for (Map.Entry<String, RequestParameter[]> param : requestParameterMap.entrySet()) {
    RequestParameter rpm = param.getValue()[0];
    if(!rpm.isFormField()) {
        fileAttachments.add(new Document(rpm.get()));
    }
}

転送パスおよびリダイレクト URL forward-path-and-redirect-url

要求されたアクションを実行した後、送信サーブレットは、リクエストを転送パスに転送します。 アクションが、setForwardPath API を使って Guide Submit サーブレットに転送パスを作成します。

アクションによって転送パスが指定されない場合、送信サーブレットは、リダイレクト URL を使ってブラウザーをリダイレクトします。 作成者は、アダプティブフォーム編集ダイアログの「ありがとうございます」ページ設定を使って、リダイレクト URL を設定します。 リダイレクト URL は、送信アクションまたは Guide Submit 内の setRedirectUrl API を通して設定することもできます。 また、Guide Submit サーブレット内の setRedirectParameters API を使って、リダイレクト URL に送られるリクエストパラメーターを設定することもできます。

送信アクション submit-action

送信アクションは、次を含むsling:Folderです。

カスタム送信アクションの作成 creating-a-custom-submit-action

次の手順を実行し、CRX リポジトリにデータを保存した後、メール送信をおこなうカスタム送信アクションを作成します。 アダプティブフォームには、データを CRX リポジトリに保存する標準の送信アクション Store Content（廃止）が含まれています。 さらに、CQ には、メール送信に使用される Mail API が含まれています。 Mail API を使用する前に、システムコンソールを通して Day CQ Mail サービスを設定します。 リポジトリーにデータを保存するには、コンテンツを格納アクション（非推奨）を再利用できます。 コンテンツを格納アクション（非推奨）は、CRX リポジトリーの /libs/fd/af/components/guidesubmittype/store にあります。