Escribir una acción de envío personalizada para formularios adaptables writing-custom-submit-action-for-adaptive-forms

Los formularios adaptables requieren enviar acciones para procesar los datos especificados por el usuario. Una acción de envío determina la tarea realizada en los datos enviados mediante un formulario adaptable. Adobe Experience Manager (AEM) incluye Acciones de envío de OOTB que muestran tareas personalizadas que puede realizar mediante los datos enviados por el usuario. Por ejemplo, puede realizar tareas como enviar correos electrónicos o almacenar los datos.

Flujo de trabajo para una acción de envío workflow-for-a-submit-action

El diagrama de flujo muestra el flujo de trabajo de una acción de envío que se activa al hacer clic en el botón Enviar de un formulario adaptable. Los archivos del componente Archivo adjunto se cargan en el servidor y los datos del formulario se actualizan con las direcciones URL de los archivos cargados. Dentro del cliente, los datos se almacenan en formato JSON. El cliente envía una solicitud Ajax a un servlet interno que analiza los datos especificados y los devuelve en formato XML. El cliente recopila estos datos con campos de acción. Envía los datos al servlet final (servlet de envío de guía) mediante la acción de envío formulario. A continuación, el servlet reenvía el control a la acción de envío. La acción de envío puede reenviar la solicitud a otro recurso de sling o redirigir el explorador a otra dirección URL.

Formato de datos XML xml-data-format

Los datos XML se envían al servlet utilizando el parámetro de solicitud jcr:data. Las acciones Enviar pueden acceder al parámetro para procesar los datos. El siguiente código describe el formato de los datos XML. Los campos vinculados al modelo de formulario aparecen en la sección afBoundData. Los campos no vinculados aparecen en la sección afUnoundData. Para obtener más información sobre el formato del archivo data.xml, consulte Introducción al rellenado previo de campos de formularios adaptables.

<?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>

Campos de acción action-fields

Una acción de envío puede agregar campos de entrada ocultos (mediante la etiqueta de entrada HTML) al HTML de formulario procesado. Estos campos ocultos pueden contener los valores que necesita al procesar el envío del formulario. Al enviar el formulario, estos valores de campo se vuelven a registrar como parámetros de solicitud que la acción de envío puede utilizar durante el envío. Los campos de entrada se denominan campos de acción.

Por ejemplo, una acción de envío que también capture el tiempo necesario para rellenar un formulario, puede agregar los campos de entrada ocultos startTime y endTime.

Un script puede aportar los valores de los campos startTime y endTime cuando el formulario se procesa y antes de enviarlo, respectivamente. El script de acción de envío post.jsp puede acceder a estos campos mediante parámetros de solicitud y calcular el tiempo total necesario para rellenar el formulario.

Archivos adjuntos file-attachments

Las acciones de envío también pueden utilizar los archivos adjuntos que se cargan mediante el componente Archivo adjunto. Los scripts de acción de envío pueden acceder a estos archivos mediante la API RequestParameter de Sling. El método isFormField de la API ayuda a identificar si el parámetro de solicitud es un archivo o un campo de formulario. Puede iterar los parámetros de solicitud en una acción de envío para identificar los parámetros del archivo adjunto.

El siguiente código de ejemplo identifica los archivos adjuntos en la solicitud. A continuación, lee los datos en el archivo utilizando Obtener API. Finalmente, crea un objeto Documento utilizando los datos y lo anexa a una lista.

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()));
    }
}

Ruta de reenvío y URL de redireccionamiento forward-path-and-redirect-url

Después de realizar la acción necesaria, el servlet de envío reenvía la solicitud a la ruta de reenvío. Una acción utiliza la API setForwardPath para establecer la ruta de reenvío en el servlet de envío de la guía.

Si la acción no ofrece una ruta de reenvío, el servlet de envío redirecciona el explorador mediante la URL de redireccionamiento. El autor configura la URL de redireccionamiento utilizando la configuración de la página de agradecimiento del cuadro de diálogo Editar formulario adaptable. También puede configurar la URL de redireccionamiento mediante la acción de envío o la API setRedirectUrl en el servlet de envío de la guía. También puede configurar los parámetros de solicitud enviados a la URL de redireccionamiento utilizando la API setRedirectParameters en el servlet de envío de la guía.

Acción de envío submit-action

Una acción de envío es un sling:Folder, que incluye lo siguiente:

Crear una acción de envío personalizada creating-a-custom-submit-action

Realice los siguientes pasos para crear una acción de envío personalizada que guarde los datos en el repositorio CRX y luego le envíe un correo electrónico. El formulario adaptable contiene el contenido del repositorio de acciones de envío OOTB (obsoleto) que guarda los datos en el repositorio CRX. Además, CQ facilitará una API de Correo electrónico que se puede utilizar para enviar correos electrónicos. Antes de usar la API de correo, [configure](https://docs.adobe.com/docs/en/cq/current/administering/notification.html?#Configuring el servicio de correo) el servicio Day CQ Mail a través de la consola del sistema. Puede reutilizar la acción Almacenar contenido (obsoleta) para almacenar los datos en el repositorio. La acción Almacenar contenido (obsoleta) está disponible en la ubicación /libs/fd/af/components/guidesubmittype/store en el repositorio CRX.