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

Puede utilizar la API por lotes para generar varias comunicaciones interactivas a partir de una plantilla. La plantilla es una comunicación interactiva sin ningún tipo de datos. La API por lotes combina datos con una plantilla para generar una comunicación interactiva. La API resulta muy útil a la hora de producir comunicaciones interactivas de forma masiva, como facturas telefónicas y extractos de tarjetas de crédito para varios clientes.

La API por lotes acepta registros (datos) en formato JSON y desde un modelo de datos de formulario. El número de comunicaciones interactivas producidas es igual a los registros especificados en el archivo JSON de entrada del modelo de datos de formulario configurado. Puede utilizar la API para generar la salida impresa y la salida web. La opción IMPRIMIR produce un documento PDF y la opción WEB produce datos en formato JSON para cada registro individual.

Uso de la API por lotes using-the-batch-api

Puede utilizar la API por lotes con carpetas inspeccionadas o como una API de REST independiente. Puede configurar una plantilla, un tipo de salida (HTML, PRINT o Ambos), una configuración regional, un servicio de relleno previo y un nombre para que las comunicaciones interactivas generadas utilicen la API por lotes.

Los registros se combinan con una plantilla de comunicación interactiva para generar una comunicación interactiva. Las API por lotes pueden leer registros (datos para plantillas de comunicación interactivas) directamente desde un archivo JSON o desde una fuente de datos externa a la que se accede a través del modelo de datos de formulario. Puede mantener cada registro en un archivo JSON independiente o crear una matriz JSON para guardar todos los registros en un solo archivo.

Un registro único en un archivo JSON

{
   "employee": {
       "name": "Sara",
       "id": 3,
       "mobileNo": 9871996463,
       "age": 37
   }
}

Varios registros en un archivo JSON

[{
   "employee": {
       "name": "John",
       "id": 1,
       "mobileNo": 9871996461,
       "age": 39
   }
},{
   "employee": {
       "name": "Jacob",
       "id": 2,
       "mobileNo": 9871996462,
       "age": 38
   }
},{
   "employee": {
       "name": "Sara",
       "id": 3,
       "mobileNo": 9871996463,
       "age": 37
   }
}]

Uso de la API por lotes con carpetas inspeccionadas using-the-batch-api-watched-folders

Para facilitar la experiencia de la API, AEM Forms proporciona un servicio de carpetas inspeccionadas configurado para utilizar la API por lotes de forma predeterminada. Puede acceder al servicio a través de la interfaz de usuario de AEM Forms para generar varias comunicaciones interactivas. También puede crear servicios personalizados según sus necesidades. Puede utilizar los métodos que se indican a continuación para utilizar la API por lotes con una carpeta inspeccionada:

  • Especifique los datos de entrada (registros) en el formato de archivo JSON para que pueda generar una comunicación interactiva.
  • Utilice los datos de entrada (registros) guardados en una fuente de datos externa y a los que se accede a través de un modelo de datos de formulario para generar una comunicación interactiva.

Especifique registros de datos de entrada en formato de archivo JSON para poder generar una comunicación interactiva specify-input-data-in-JSON-file-format

Los registros se combinan con una plantilla de comunicación interactiva para generar una comunicación interactiva. Puede crear un archivo JSON independiente para cada registro o crear una matriz JSON para guardar todos los registros en un solo archivo:

Para crear una comunicación interactiva a partir de los registros guardados en un archivo JSON:

  1. 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. Seleccionar 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/ pattern especifica que la carpeta inspeccionada puede encontrar archivos de entrada en una subcarpeta de la carpeta Watched Folder\input.
  2. 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 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.

  3. 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.

Utilice los datos de entrada guardados en una fuente de datos externa y a los que se accede a través del modelo de datos de formulario para generar una comunicación interactiva use-fdm-as-data-source

Los datos (registros) guardados en una fuente de datos externa se combinan con una plantilla de comunicación interactiva para generar una comunicación interactiva. Cuando se crea una comunicación interactiva, se conecta a una fuente de datos externa a través de un modelo de datos de formulario (FDM) para acceder a los datos. Puede configurar el servicio de procesamiento por lotes de las carpetas inspeccionadas para que recupere los datos utilizando el mismo modelo de datos de formulario de una fuente de datos externa. Para crear una comunicación interactiva a partir de los registros guardados en una fuente de datos externa:

  1. 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.

      Configurar el atributo de solicitud

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

  2. 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.

  3. 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. Seleccionar 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/ pattern especifica que la carpeta inspeccionada puede encontrar archivos de entrada en una subcarpeta de la carpeta Watched Folder\input.
  4. 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 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.

  5. 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.

Invocar la API por lotes utilizando solicitudes REST

Puede invocar la API por lotes mediante solicitudes de transferencia de estado representacional (REST). Permite proporcionar un extremo REST a otros usuarios para que accedan a la API y configurar sus propios métodos para procesar, almacenar y personalizar la comunicación interactiva. AEM Puede desarrollar su propio servlet Java™ personalizado para implementar la API en la instancia de la.

Antes de implementar el servlet Java™, asegúrese de que tiene una comunicación interactiva y de que los archivos de datos correspondientes están listos. Siga estos pasos para poder crear e implementar el servlet Java™:

  1. 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í.

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

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

    code language-xml
        <dependency>
            <groupId>com.adobe.aemfd</groupId>
            <artifactId>aemfd-client-sdk</artifactId>
            <version>6.0.122</version>
        </dependency>
    
  4. Abra el proyecto Java™ y cree un archivo .java como, por ejemplo, CCMBatchServlet.java. Añada el siguiente código al archivo:

    code language-java
            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";
                }
    
    
            }
    
  5. 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.
  6. Utilice maven para implementar el código actualizado en la instancia de AEM.

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

Rellenar previamente una plantilla web web-template

Cuando establece batchType para procesar el canal web, la API genera un archivo JSON para cada registro de datos. Puede utilizar la siguiente sintaxis para combinar el archivo JSON con el canal web correspondiente para generar una comunicación interactiva:

Sintaxis
http://host:port/<template-path>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=<guide-merged-json-path>

Ejemplo
Si el archivo JSON se encuentra en C:\batch\mergedJsonPath.json y utiliza la siguiente plantilla de comunicación interactiva: http://host:port/content/dam/formsanddocuments/testsample/mediumic/jcr:content?channel=web.

Después, la siguiente URL del nodo de publicación muestra el canal web de la comunicación interactiva:
http://host:port/<path-to-ic>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=file:///C:/batch/mergedJsonData.json

Además de guardar los datos en el sistema de archivos, los archivos JSON se almacenan en el repositorio CRX, el sistema de archivos o el servidor web. También es posible acceder a los datos mediante el servicio de relleno previo OSGI. La sintaxis para combinar datos mediante varios protocolos es:

  • Protocolo CRX
    http://host:port/<path-to-ic>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=crx:///tmp/fd/af/mergedJsonData.json

  • Protocolo de archivo
    http://host:port/<path-to-ic>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=file:///C:/Users/af/mergedJsonData.json

  • Protocolo del servicio de relleno previo
    http://host:port/<path-to-ic>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=service://[SERVICE_NAME]/[IDENTIFIER]

    SERVICE_NAME hace referencia al nombre del servicio de relleno previo de OSGI. Consulte Crear y ejecutar un servicio de relleno previo.

    IDENTIFIER se refiere a cualquier metadato que requiera el servicio de relleno previo OSGI para recuperar los datos. Un identificador para el usuario que ha iniciado sesión es un ejemplo de metadatos que se pueden utilizar.

  • Protocolo HTTP
    http://host:port/<path-to-ic>/jcr:content?channel=web&mode=preview&guideMergedJsonPath=http://localhost:8000/somesamplexmlfile.xml

NOTE
Únicamente el protocolo CRX está habilitado de forma predeterminada. Para habilitar el resto de protocolos admitidos, consulte Configuración del servicio de relleno previo mediante el Administrador de configuración.
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2