アダプティブフォーム向けのカスタム送信アクションの作成

Adaptive forms では、ユーザー指定のデータを処理するために、送信アクションが必要となります。送信アクションは、アダプティブフォームを使用して送信するデータに対して実行されるタスクを決定します。 Adobe Experience Manager(AEM)には、ユーザーが送信したデータを使用して実行できるカスタムタスクを示すOOTB送信アクションが含まれています。 例えば、電子メールの送信やデータの保存などのタスクを実行できます。

送信アクションのワークフロー

このフローチャートは、アダプティブフォームで「送信」ボタンをクリックしたときにトリガーされる送信アクションのワークフローを示しています。 File Attachment コンポーネントのファイルはサーバーにアップロードされ、フォームデータはアップロードされたファイルの URL で更新されます。クライアント内で、データは JSON 形式で格納されます。クライアントは、指定したデータをメッセージして XML 形式で返信する内部サーブレットに Ajax リクエストを送信します。クライアントは、このデータをアクションフィールドと照合します。フォーム送信アクションを通じて、データを最終サーブレット（Guide Submitサーブレット）に送信します。 次に、サーブレットが送信アクションにコントロールを転送します。送信アクションは、別のSlingリソースに要求を転送したり、ブラウザーを別のURLにリダイレクトしたりできます。

XML データ形式

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>

アクションフィールド

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

例えば、フォームの記入にかかる時間も取得する送信アクションでは、非表示の入力フィールドstartTimeとendTimeを追加できます。

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

添付ファイル

送信アクションでは、添付ファイルコンポーネントを使用してアップロードした添付ファイルを使用することもできます。 送信アクションスクリプトは、スリング 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

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

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

送信アクション

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

• addfields.jsp：このスクリプトは、レンダリング中に HTML ファイルに追加されるアクションフィールドを指定します。post.POST.jsp スクリプトでの送信中に必要な非表示の入力パラメーターの追加には、このスクリプトを使用します。

• dialog.xml：このスクリプトは、CQ Component ダイアログに似ています。作成者がカスタマイズする設定情報を提供します。これらのフィールドは、送信アクションを選択すると、アダプティブフォーム編集ダイアログの送信アクションタブに表示されます。

• post.POST.jsp：送信サーブレットは、送信されたデータおよび前のセクションからの追加データで、このスクリプトを呼び出します。このページで言及されるアクションの実行は、post.POST.jsp スクリプトの実行を意味します。送信アクションをアダプティブフォームに登録して、アダプティブフォームの編集ダイアログに表示するには、次のプロパティをsling:Folderに追加します。

  • 文字列型の guideComponentType および値 fd/af/components/guidesubmittype
  • 送信アクションを適用できるアダプティブフォームのタイプを指定する文字列型(String)の guideDataModelを指定します。​ xfaはXFAベースのアダプティブフォームでサポートされ、xsdはXSDベースの ​​アダプティブフォームでサポートされます。XDPまたはXSDを使用しないアダプティブフォームでは、 を基本としてサポートされています。複数のタイプのアダプティブフォームでのアクションを表示するには、対応する文字列を追加します。各文字列はカンマで区切ります。例えば、XFAベースのアダプティブフォームとXSDベースのアダプティブフォームでアクションを表示するには、それぞれ​xfa​と​xsd​の値を指定します。
  • 文字列型の jcr:description。このプロパティの値は、アダプティブフォーム編集ダイアログの「送信アクション」タブにある送信アクションリストに表示されます。 OOTB アクションは、/libs/fd/af/components/guidesubmittype の場所にある CRX リポジトリに存在します。

カスタム送信アクションの作成

次の手順を実行し、CRX リポジトリにデータを保存した後、メール送信を行うカスタム送信アクションを作成します。アダプティブフォームには、CRXリポジトリにデータを保存するOOTB送信アクションStore Content（非推奨）が含まれています。 さらに、CQ には、メール送信に使用される Mail API が含まれています。Mail APIを使用する前に、システムコンソールを通じて[] (https://docs.adobe.com/docs/en/cq/current/administering/notification.html?#Configuring the Mail Service) Day CQ Mailサービスを設定します。 リポジトリにデータを保存するには、コンテンツを格納アクション（非推奨）を再利用できます。コンテンツを格納アクション（非推奨）は、CRX リポジトリの /libs/fd/af/components/guidesubmittype/store にあります。

1. URL https://<server>:<port>/crx/de/index.jspから、CRXDE Lite にログインします。/apps/custom_submit_action フォルダー内に sling:Folder プロパティを持つノードを作成し、名前を store_and_mail に設定します。custom_submit_action フォルダーが存在しない場合は作成します。

   

2. 必須の設定フィールドを指定します。

   格納アクションに必要な設定を追加します。/libs/fd/af/components/guidesubmittype/store から、格納アクションの cq:dialog ノードを、/apps/custom_submit_action/store_and_email のアクションフォルダーにコピーします。

   

3. 作成者に電子メール設定を促す設定フィールドを指定します。

   アダプティブフォームには、ユーザーに電子メールを送信する Email アクションもあります。要件に応じて、このアクションをカスタマイズします。/libs/fd/af/components/guidesubmittype/email/dialog に移動します。cq:dialogノード内のノードを、送信アクションのcq:dialogノード(/apps/custom_submit_action/store_and_email/dialog?lang=ja)にコピーします。

   

4. アクションをアダプティブフォーム編集ダイアログで使用できるようにします。

   次のプロパティを store_and_email ノードに追加します。

   • 文字列​型の guideComponentType および値 fd/af/components/guidesubmittype
   • ​​型がStringで値が ​​xfa、 xsd、basicのguideDataModel
   • 文字列​型の jcr:description​および値 Store and Email Action

5. 任意のアダプティブフォームを開きます​Start の隣にある「Edit」ボタンをクリックし、アダプティブフォームコンテナの Edit ダイアログを開きます。新しいアクションが、「送信アクション」タブに表示されます。格納およびメール送信アクション​を選択すると、ダイアログノードに追加された設定が表示されます。

   

6. アクションを使用してタスクを完了します。

   post.POST.jsp スクリプトをアクションに追加します。(/apps/custom_submit_action/store_and_mail/?lang=ja)。

   OOTB の格納アクション（post.POST.jsp スクリプト）を実行します。CQの[FormsHelper.runAction] (https://docs.adobe.com/docs/en/cq/current/javadoc/com/day/cq/wcm/foundation/forms/FormsHelper.html#runAction(java.lang.String,%20java.lang.String,%20org.apache.sling.api.resource.Resource,%20org.apache.sling.api.SlingHttpServletRequest,%20org.apache.sling.api.SlingHttpServletResponse?lang=ja) API) APIを使用します。は、ストアアクションを実行するためのコードにを提供します。 次のコードを JSP ファイルに追加します。

   FormsHelper.runAction("/libs/fd/af/components/guidesubmittype/store", "post", resource, slingRequest, slingResponse);

   メールを送信するために、コードが受信者の電子メールアドレスを設定から読み取ります。アクションのスクリプトに設定値を取り込むには、次のコードを使って現在のリソースのプロパティを読み込みます。同じく、その他の設定ファイルを読み込むこともできます。

   ValueMap properties = ResourceUtil.getValueMap(resource);

   String mailTo = properties.get("mailTo");

   最後に、CQ Mail API を使用してメールを送信します。SimpleEmail クラスを使って、次に示すとおりに Email Object を作成します。

   メモ

   JSP ファイルの名前が post.POST.jsp になっていることを確認してください。

   <%@include file="/libs/fd/af/components/guidesglobal.jsp" %>
   <%@page import="com.day.cq.wcm.foundation.forms.FormsHelper,
          org.apache.sling.api.resource.ResourceUtil,
          org.apache.sling.api.resource.ValueMap,
                   com.day.cq.mailer.MessageGatewayService,
     com.day.cq.mailer.MessageGateway,
     org.apache.commons.mail.Email,
                   org.apache.commons.mail.SimpleEmail" %>
   <%@taglib prefix="sling" 
                   uri="https://sling.apache.org/taglibs/sling/1.0" %>
   <%@taglib prefix="cq" 
                   uri="https://www.day.com/taglibs/cq/1.0" 
   %>
   <cq:defineObjects/>
   <sling:defineObjects/>
   <%
           String storeContent = 
                       "/libs/fd/af/components/guidesubmittype/store";
           FormsHelper.runAction(storeContent, "post", resource, 
                                   slingRequest, slingResponse);
    ValueMap props = ResourceUtil.getValueMap(resource);
    Email email = new SimpleEmail();
    String[] mailTo = props.get("mailto", new String[0]);
    email.setFrom((String)props.get("from"));
           for (String toAddr : mailTo) {
               email.addTo(toAddr);
      }
    email.setMsg((String)props.get("template"));
    email.setSubject((String)props.get("subject"));
    MessageGatewayService messageGatewayService = 
                       sling.getService(MessageGatewayService.class);
    MessageGateway messageGateway = 
                   messageGatewayService.getGateway(SimpleEmail.class);
    messageGateway.send(email);
   %>
   

   アダプティブフォームでアクションを選択します。アクションによりメールが送信され、データが保存されます。