Crear una acción de envío personalizada para un formulario adaptable writing-custom-submit-action-for-adaptive-forms

Un formulario adaptable ofrece varias acciones de envío de forma predeterminada (OOTB). Una acción de envío especifica los detalles de las acciones que se realizarán en los datos recopilados mediante el formulario adaptable. Por ejemplo, el envío de datos en un correo electrónico.

Puede crear una acción de envío personalizada para agregar una funcionalidad que no esté incluida en las acciones de envío de forma predeterminada o no que no son compatibles con una única acción de envío OOTB. Por ejemplo, enviar datos a un flujo de trabajo, guardar los datos en un almacén de datos, enviar una notificación por correo electrónico a la persona que envía el formulario y enviar un correo electrónico a la persona responsable de procesar el formulario enviado para aprobarlo o rechazarlo mediante una única acción de envío.

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 de envío puede 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.

<?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 utilizando el API RequestParameter de Sling. El método isFormField del 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()));
    }
}

Cuando adjunta archivos al formulario adaptable, el servidor valida los archivos adjuntos después del envío del formulario adaptable y muestra un mensaje de error si ocurre lo siguiente:

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 el 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 el 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 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 almacén de acciones de envío OOTB (obsoleto) que guarda los datos en el repositorio CRX. Además, AEM facilitará un API de Correo electrónico que se puede utilizar para enviar correos electrónicos. Antes de usar el API de correo electrónico, configure el servicio Day CQ Mail mediante 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.

Utilizar la propiedad submitService para las acciones de envío personalizadas submitservice-property

Al establecer la acción de envío personalizada, que incluye la propiedad submitService, el formulario activa FormSubmitActionService en el momento del envío. FormSubmitActionService utiliza el método getServiceName para recuperar el valor de la propiedad submitService. En función del valor de la propiedad submitService, el servicio invoca el método de envío adecuado. Incluya FormSubmitActionService al paquete personalizado que carga en el servidor de AEM Forms.

Añada la propiedad submitService de tipo cadena a sling:Folder de su acción de envío personalizada para habilitar Adobe Sign para el formulario adaptable. Puede seleccionar la opción Habilitar Adobe Sign en la sección Firma electrónica de las propiedades del contenedor del formulario adaptable solo después de establecer el valor de la propiedad submitService de su acción de envío personalizada.