Generar varias comunicaciones interactivas mediante la API por lotes use-batch-api-to-generate-multiple-ic

Cree una Carpeta inspeccionada y configúrela para utilizar la API por lotes:

1. Inicie sesión en la instancia de autor de AEM Forms.
2. Vaya a Herramientas > Forms > Configurar carpeta inspeccionada. Seleccione Nuevo.
3. Especifique el Nombre y la Ruta física de la carpeta. Por ejemplo, c:\batchprocessing.
4. Seleccione la opción Servicio en el campo Procesar archivo usando.
5. Seleccione el servicio com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl en el campo Nombre de servicio.
6. Especifique un Patrón de archivo de salida. Por ejemplo, el %F/ patrón especifica que la carpeta inspeccionada puede encontrar archivos de entrada en una subcarpeta de la carpeta Watched Folder\input.

Configure los parámetros avanzados:

1. Abra la pestaña Avanzadas y agregue las siguientes propiedades personalizadas:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Propiedad	Tipo	Descripción
   templatePath	Cadena	Especifique la ruta de la plantilla de comunicación interactiva que desea utilizar. Por ejemplo, /content/dam/formsanddocuments/testsample/mediumic. Es una propiedad obligatoria.
   recordPath	Cadena	El valor del campo recordPath permite establecer el nombre de una comunicación interactiva. Puede establecer la ruta del campo de un registro como el valor del campo recordPath. Por ejemplo, si especifica /employee/Id, el valor del campo ID se convierte en el nombre de la comunicación interactiva correspondiente. El valor predeterminado es un UUID aleatorio.
   usePrefillService	Booleano	Establezca el valor en False. Puede utilizar el parámetro usePrefillService para rellenar previamente la comunicación interactiva con los datos recuperados del servicio de relleno previo configurado para la comunicación interactiva correspondiente. Cuando usePrefillService se establece en True, los datos JSON de entrada (de cada registro) se tratan como argumentos FDM. El valor predeterminado es False.
   batchType	Cadena	Establezca el valor en PRINT, WEB o WEB_AND_PRINT. El valor predeterminado es WEB_AND_PRINT.
   locale	Cadena	Especifique la configuración regional de la comunicación interactiva de salida. El servicio predeterminado no utiliza la opción Configuración regional, pero puede crear un servicio personalizado para generar comunicaciones interactivas localizadas. El valor predeterminado es en_US.

2. Seleccione Crear.

Utilice la carpeta vigilada creada para generar una comunicación interactiva:

1. Abra la carpeta inspeccionada. Vaya a la carpeta de entrada.

2. Cree una carpeta en la carpeta de entrada y coloque el archivo JSON en la carpeta recién creada.

3. Espere a que la carpeta inspeccionada procese el archivo. Cuando se inicia el procesamiento, el archivo de entrada y la subcarpeta que contiene el archivo se mueven a la carpeta provisional.

4. Abra la carpeta de salida para poder ver el resultado:

   • Cuando especifica la opción PRINT en la configuración de la carpeta inspeccionada, se genera la salida PDF de la comunicación interactiva.
   • Cuando especifica la opción WEB en la configuración de la carpeta inspeccionada, se genera un archivo JSON por cada registro. Puede utilizar el archivo JSON para rellenar previamente una plantilla web.
   • Al especificar las opciones PRINT y WEB, se generan los dos documentos PDF y un archivo JSON por registro.

Configure el modelo de datos de formulario de la plantilla:

1. Abra el modelo de datos de formulario asociado a la plantilla de comunicación interactiva.

2. Seleccione el OBJETO DEL MODELO DE NIVEL SUPERIOR y seleccione Editar propiedades.

3. Seleccione el servicio de recuperación o Get-service en el campo Servicio de lectura del panel Editar propiedades.

4. Seleccione el icono de lápiz del argumento del servicio de lectura para enlazar el argumento a un atributo de solicitud y especificar el valor del enlace. Vincula el argumento del servicio al atributo del enlace o el valor literal especificado, el cual se pasa al servicio como argumento para recuperar datos asociados con el valor especificado de la fuente de datos.

   En este ejemplo, el argumento id toma el valor del atributo id del perfil de usuario y lo pasa como argumento al servicio de lectura. Lee y devuelve valores de propiedades asociadas del objeto del modelo de datos de empleado para el ID especificado. Por lo tanto, si especifica 00250 en el campo ID del formulario, el servicio de lectura lee los detalles del empleado con 00250 ID de empleado.

   

5. Guarde las propiedades y el modelo de datos de formulario.

Configure el valor del atributo de solicitud:

1. Cree un archivo .json en el sistema de archivos y ábralo para editarlo.

2. Cree una matriz JSON y especifique el atributo principal para poder recuperar datos del modelo de datos de formulario. Por ejemplo, el siguiente JSON solicita al FDM que envíe los datos de registros en los que el ID es 27126 o 27127:

   code language-json
   [ { "id": 27126 }, { "id": 27127 } ]

3. Guarde y cierre el archivo.

Cree una carpeta inspeccionada y configúrela para utilizar el servicio de la API por lotes:

1. Inicie sesión en la instancia de autor de AEM Forms.
2. Vaya a Herramientas > Forms > Configurar carpeta inspeccionada. Seleccione Nuevo.
3. Especifique el Nombre y la Ruta física de la carpeta. Por ejemplo, c:\batchprocessing.
4. Seleccione la opción Servicio en el campo Procesar archivo usando.
5. Seleccione el servicio com.adobe.fd.ccm.multichannel.batch.impl.service.InteractiveCommunicationBatchServiceImpl en el campo Nombre de servicio.
6. Especifique un Patrón de archivo de salida. Por ejemplo, el %F/ patrón especifica que la carpeta inspeccionada puede encontrar archivos de entrada en una subcarpeta de la carpeta Watched Folder\input.

Configure los parámetros avanzados:

1. Abra la pestaña Avanzadas y agregue las siguientes propiedades personalizadas:

   table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3
   Propiedad	Tipo	Descripción
   templatePath	Cadena	Especifique la ruta de la plantilla de comunicación interactiva que desea utilizar. Por ejemplo, /content/dam/formsanddocuments/testsample/mediumic. Es una propiedad obligatoria.
   recordPath	Cadena	El valor del campo recordPath permite establecer el nombre de una comunicación interactiva. Puede establecer la ruta del campo de un registro como el valor del campo recordPath. Por ejemplo, si especifica /employee/Id, el valor del campo ID se convierte en el nombre de la comunicación interactiva correspondiente. El valor predeterminado es un UUID aleatorio.
   usePrefillService	Booleano	Establezca el valor en True. El valor predeterminado es false. Cuando el valor se establece en true, la API por lotes lee los datos del modelo de datos de formulario configurado y los cumplimenta en la comunicación interactiva. Cuando usePrefillService se establece en True, los datos JSON de entrada (de cada registro) se tratan como argumentos FDM.
   batchType	Cadena	Establezca el valor en PRINT, WEB o WEB_AND_PRINT. El valor predeterminado es WEB_AND_PRINT.
   locale	Cadena	Especifique la configuración regional de la comunicación interactiva de salida. El servicio predeterminado no utiliza la opción Configuración regional, pero puede crear un servicio personalizado para generar comunicaciones interactivas localizadas. El valor predeterminado es en_US.

2. Seleccione Crear.

Utilice la carpeta vigilada creada para generar una comunicación interactiva:

1. Abra la carpeta inspeccionada. Vaya a la carpeta de entrada.

2. Cree una carpeta en la carpeta de entrada. Coloque el archivo JSON creado en el paso 2 en la carpeta recién creada.

3. Espere a que la carpeta inspeccionada procese el archivo. Cuando se inicia el procesamiento, el archivo de entrada y la subcarpeta que contiene el archivo se mueven a la carpeta provisional.

4. Abra la carpeta de salida para poder ver el resultado:

   • Cuando especifica la opción PRINT en la configuración de la carpeta inspeccionada, se genera la salida PDF de la comunicación interactiva.
   • Cuando especifica la opción WEB en la configuración de la carpeta inspeccionada, se genera un archivo JSON por cada registro. Puede utilizar el archivo JSON para rellenar previamente una plantilla web.
   • Al especificar las opciones PRINT y WEB, se generan los dos documentos PDF y un archivo JSON por registro.

Inicie sesión en la instancia de AEM y cree una comunicación interactiva. Para utilizar la comunicación interactiva mencionada en el código de ejemplo que aparece a continuación, haga clic aquí.

Creación e implementación de un proyecto AEM mediante Apache Maven en la instancia de AEM.

Agregue AEM Forms AEM Client SDK versión 6.0.12 o posterior en la lista de dependencias del archivo POM de su proyecto de la. Por ejemplo,

    <dependency>
        <groupId>com.adobe.aemfd</groupId>
        <artifactId>aemfd-client-sdk</artifactId>
        <version>6.0.122</version>
    </dependency>

Abra el proyecto Java™ y cree un archivo .java como, por ejemplo, CCMBatchServlet.java. Añada el siguiente código al archivo:

        package com.adobe.fd.ccm.multichannel.batch.integration;

        import java.io.File;
        import java.io.FileInputStream;
        import java.io.FileOutputStream;
        import java.io.IOException;
        import java.io.InputStream;
        import java.io.PrintWriter;
        import java.util.List;
        import javax.servlet.Servlet;
        import org.apache.commons.io.IOUtils;
        import org.apache.sling.api.SlingHttpServletRequest;
        import org.apache.sling.api.SlingHttpServletResponse;
        import org.apache.sling.api.servlets.SlingAllMethodsServlet;
        import org.json.JSONArray;
        import org.json.JSONObject;
        import org.osgi.service.component.annotations.Component;
        import org.osgi.service.component.annotations.Reference;

        import com.adobe.fd.ccm.multichannel.batch.api.builder.BatchConfigBuilder;
        import com.adobe.fd.ccm.multichannel.batch.api.factory.BatchComponentBuilderFactory;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchConfig;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchInput;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchResult;
        import com.adobe.fd.ccm.multichannel.batch.api.model.BatchType;
        import com.adobe.fd.ccm.multichannel.batch.api.model.RecordResult;
        import com.adobe.fd.ccm.multichannel.batch.api.model.RenditionResult;
        import com.adobe.fd.ccm.multichannel.batch.api.service.BatchGeneratorService;
        import com.adobe.fd.ccm.multichannel.batch.util.BatchConstants;
        import java.util.Date;


        @Component(service=Servlet.class,
        property={
                "sling.servlet.methods=GET",
                "sling.servlet.paths="+ "/bin/batchServlet"
        })
        public class CCMBatchServlet extends SlingAllMethodsServlet {

            @Reference
            private BatchGeneratorService batchGeneratorService;
            @Reference
            private BatchComponentBuilderFactory batchBuilderFactory;
            public void doGet(SlingHttpServletRequest req, SlingHttpServletResponse resp) {
                try {
                    executeBatch(req,resp);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
            private void executeBatch(SlingHttpServletRequest req, SlingHttpServletResponse resp) throws Exception {
                int count = 0;
                JSONArray inputJSONArray = new JSONArray();
                String filePath = req.getParameter("filePath");
                InputStream is = new FileInputStream(filePath);
                String data = IOUtils.toString(is);
                try {
                    // If input file is json object, then create json object and add in json array, if not then try for json array
                    JSONObject inputJSON = new JSONObject(data);
                    inputJSONArray.put(inputJSON);
                } catch (Exception e) {
                    try {
                        // If input file is json array, then iterate and add all objects into inputJsonArray otherwise throw exception
                        JSONArray inputArray = new JSONArray(data);
                        for(int i=0;i<inputArray.length();i++) {
                            inputJSONArray.put(inputArray.getJSONObject(i));
                        }
                    } catch (Exception ex) {
                        throw new Exception("Invalid JSON Data. File name : " + filePath, ex);
                    }
                }
                BatchInput batchInput = batchBuilderFactory.getBatchInputBuilder().setData(inputJSONArray).setTemplatePath("/content/dam/formsanddocuments/[path of the interactive communcation]").build();
                BatchConfig batchConfig = batchBuilderFactory.getBatchConfigBuilder().setBatchType(BatchType.WEB_AND_PRINT).build();
                BatchResult batchResult = batchGeneratorService.generateBatch(batchInput, batchConfig);
                List<RecordResult> recordList = batchResult.getRecordResults();
                JSONObject result = new JSONObject();
                for (RecordResult recordResult : recordList) {
                    String recordId = recordResult.getRecordID();
                    for (RenditionResult renditionResult : recordResult.getRenditionResults()) {
                        if (renditionResult.isRecordPassed()) {
                            InputStream output = renditionResult.getDocumentStream().getInputStream();
                            result.put(recordId +"_"+renditionResult.getContentType(), output);

                            Date date= new Date();
                            long time = date.getTime();

                            // Print output
                            if(getFileExtension(renditionResult.getContentType()).equalsIgnoreCase(".json")) {
                                File file = new File(time + getFileExtension(renditionResult.getContentType()));
                                copyInputStreamToFile(output, file);
                            } else
                            {
                                File file = new File(time + getFileExtension(renditionResult.getContentType()));
                                copyInputStreamToFile(output, file);
                            }
                        }
                    }
                }
                PrintWriter writer = resp.getWriter();
                JSONObject resultObj = new JSONObject();
                resultObj.put("result", result);
                writer.write(resultObj.toString());
            }


            private static void copyInputStreamToFile(InputStream inputStream, File file)
                    throws IOException {

                    try (FileOutputStream outputStream = new FileOutputStream(file)) {

                        int read;
                        byte[] bytes = new byte[1024];

                        while ((read = inputStream.read(bytes)) != -1) {
                            outputStream.write(bytes, 0, read);
                        }

                    }

                }


            private String getFileExtension(String contentType) {
                if (contentType.endsWith(BatchConstants.JSON)) {
                    return ".json";
                } else return ".pdf";
            }


        }

En el código anterior, reemplace la ruta de la plantilla (setTemplatePath) con la ruta de su plantilla y establezca el valor de la API setBatchType:

• Cuando se especifica el PDF de la opción PRINT, se genera la salida de la comunicación interactiva.
• Cuando especifica la opción WEB, se genera un archivo JSON por cada registro. Puede utilizar el archivo JSON para rellenar previamente una plantilla web.
• Al especificar las opciones PRINT y WEB, se generan los dos documentos PDF y un archivo JSON por registro.

Utilice maven para implementar el código actualizado en la instancia de AEM.

Para generar la comunicación interactiva, invoque la API por lotes. La opción PRINT de la API por lotes devuelve un flujo de archivos PDF y .json en función del número de registros. Puede utilizar el archivo JSON para rellenar previamente una plantilla web. Si utiliza el código anterior, la API se implementa en http://localhost:4502/bin/batchServlet. El código imprime y devuelve un flujo de archivos PDF y archivos JSON.