Usar procesamiento por lotes

Las comunicaciones le permiten crear, ensamblar y entregar comunicaciones personalizadas y orientadas a la marca, como correspondencia comercial, documentos, declaraciones, cartas de procesamiento de reclamaciones, avisos de beneficios, cartas de procesamiento de reclamaciones, facturas mensuales y kits de bienvenida. Puede utilizar las API de comunicaciones para combinar una plantilla (XFA o PDF) con datos de clientes para generar documentos en los formatos PDF, PS, PCL, DPL, IPL y ZPL.

Las comunicaciones proporcionan API para la generación de documentos bajo demanda y programados. Puede utilizar API sincrónicas para API bajo demanda y por lotes (API asincrónicas) para la generación programada de documentos:

  • Las API sincrónicas son adecuadas para casos de uso de generación de documentos bajo demanda, baja latencia y de registro único. Estas API son más adecuadas para casos de uso basados en acciones del usuario. Por ejemplo, la generación de un documento después de que un usuario rellene un formulario.

  • Las API por lotes (API asíncronas) son adecuadas para casos de uso programados de alto rendimiento y de generación de documentos. Estas API generan documentos por lotes. Por ejemplo, facturas telefónicas, extractos de tarjetas de crédito y extractos de beneficios generados cada mes.

Operaciones por lotes

Una operación por lotes es un proceso de generación de varios documentos de tipo similar para un conjunto de registros a intervalos programados. Una operación por lotes consta de dos partes: Configuración (definición) y ejecución.

  • Configuración (definición): Una configuración por lotes almacena información sobre varios recursos y propiedades que se deben establecer para documentos generados. Por ejemplo, proporciona detalles sobre la plantilla XDP o PDF y la ubicación de los datos de cliente que se van a utilizar, además de especificar diversas propiedades para los documentos de salida.

  • Ejecución: Para iniciar una operación por lotes, pase el nombre de configuración por lotes a la API de ejecución por lotes.

Componentes de una operación por lotes

Configuración de nube: La configuración de Experience Manager Cloud le ayuda a conectar una instancia de Experience Manager al almacenamiento de Microsoft Azure de propiedad del cliente. Permite especificar las credenciales de la cuenta de Microsoft Azure propiedad del cliente para conectarse a ella.

Configuración del almacén de datos por lotes (USC): La configuración de datos por lotes ayuda a configurar una instancia específica del almacenamiento de blob para las API por lotes. Permite especificar las ubicaciones de entrada y salida en el almacenamiento del blob de Microsoft Azure, propiedad del cliente.

API por lotes: Permite crear configuraciones por lotes y ejecutar las ejecuciones por lotes en función de estas configuraciones para fusionar una plantilla PDF o XDP con datos y generar resultados en los formatos PDF, PS, PCL, DPL, IPL y ZPL. Las comunicaciones proporcionan API por lotes para la administración de la configuración y la ejecución por lotes.

data-merge-table

Almacenamiento: Las API de comunicación utilizan el almacenamiento de Microsoft Azure Cloud propiedad del cliente para recuperar registros del cliente y almacenar documentos generados. Puede configurar el almacenamiento de Microsoft Azure en la configuración del Experience Manager Cloud Service.

Aplicación: La aplicación personalizada para utilizar las API por lotes para generar y consumir documentos.

Generación de varios documentos mediante operaciones por lotes

Puede utilizar operaciones por lotes para generar varios documentos a intervalos programados.

Puede ver el vídeo o realizar las instrucciones siguientes para aprender a generar documentos mediante operaciones por lotes. La documentación de referencia de la API utilizada en vídeo está disponible en formato .yaml . Puede descargar el API por lotes y cárguelo en Postman para comprobar la funcionalidad de las API y seguir el vídeo.

Requisitos previos

Para utilizar la API por lotes, se requiere lo siguiente:

Configuración del entorno

Antes de utilizar una operación por lotes:

  • Cargar datos de clientes (archivos XML) al almacenamiento de blob de Microsoft Azure
  • Crear una configuración de Cloud
  • Crear configuración del almacén de datos por lotes
  • Cargar plantillas y otros recursos a la instancia de Cloud Service de Experience Manager Forms

Cargar datos de clientes (archivos XML) al almacenamiento de Azure

En el almacenamiento de Microsoft Azure, cree contenedores y cargar datos de clientes (XML) a carpetas dentro de los contenedores.

NOTA

Puede configurar el almacenamiento de Microsoft Azure para que limpie automáticamente la carpeta de entrada o mueva el contenido de la carpeta de salida a una ubicación diferente a intervalos programados. Sin embargo, asegúrese de que las carpetas no se limpien cuando se siga ejecutando una operación por lotes que haga referencia a las carpetas.

Crear una configuración de Cloud

La configuración de Cloud conecta la instancia de Experience Manager con el almacenamiento de Microsoft Azure. Para crear una configuración de Cloud:

  1. Vaya a Herramientas > Cloud Services > Almacenamiento de Azure
  2. Abra una carpeta para alojar la configuración y haga clic en Crear. Utilice la carpeta Global o cree una carpeta.
  3. Especifique el nombre de la configuración y las credenciales para conectarse al servicio. Puede recupere estas credenciales de su portal de almacenamiento de Microsoft Azure.
  4. Haga clic en Crear.

La instancia de Experience Manager ya está lista para conectarse al almacenamiento de Microsoft Azure y utilizarla para almacenar y leer contenido, cuando sea necesario.

Crear configuración del almacén de datos por lotes

La configuración de datos por lotes ayuda a configurar contenedores y carpetas para la entrada y salida. Los registros de cliente se mantienen en la carpeta de origen y los documentos generados se colocan en la carpeta de destino.

Para crear la configuración:

  1. Vaya a Herramientas > Forms > Conector de almacenamiento unificado.
  2. Abra una carpeta para alojar la configuración y haga clic en Crear. Utilice la carpeta Global o cree una carpeta.
  3. Especifique el Título y el Nombre de la configuración. En Almacenamiento, seleccione Almacenamiento de Microsoft Azure.
  4. En Ruta de configuración de almacenamiento, busque y seleccione la configuración de nube que contiene las credenciales de la cuenta de almacenamiento de Azure propiedad del cliente.
  5. En la carpeta de origen, especifique el nombre del contenedor de almacenamiento de Azure y la carpeta que contiene los registros.
  6. En la carpeta de destino, especifique la ruta del contenedor y la carpeta de almacenamiento de Azure para almacenar los documentos generados.
  7. Haga clic en Crear.

La instancia de Experience Manager ahora está conectada al almacenamiento de Microsoft Azure y configurada para recuperar y enviar datos a ubicaciones específicas del almacenamiento de Microsoft Azure.

Cargar plantillas y otros recursos a la instancia de Experience Manager

Una organización suele tener varias plantillas. Por ejemplo, una plantilla para los extractos de tarjetas de crédito, los estados de beneficios y las solicitudes de reivindicación. Cargue todas estas plantillas XDP y PDF en la instancia de Experience Manager. Para cargar una plantilla:

  1. Abra la instancia de Experience Manager.
  2. Vaya a Forms > Forms y documentos
  3. Haga clic en Crear > Carpeta y cree una carpeta. Abra la carpeta.
  4. Haga clic en Crear > Cargar archivo y cargue las plantillas.

Usar la API por lotes para generar documentos

Para utilizar una API por lotes, cree una configuración por lotes y ejecute una ejecución basada en esa configuración. La documentación de la API proporciona información sobre las API para crear y ejecutar un lote, los parámetros correspondientes y los posibles errores. Puede descargar el Archivo de definición de API y cárguelo en Postman o software similar para probar las API para crear y ejecutar una operación por lotes.

Crear un lote

Para crear un lote, utilice la variable POST /config API. Incluya las siguientes propiedades obligatorias en el cuerpo de la solicitud HTTP:

  • configName: Especifique un nombre único del lote. Por ejemplo, wknd-job

  • dataSourceConfigUri: Especifique la ubicación de la configuración del almacén de datos por lotes. Puede ser una ruta relativa o absoluta de la configuración. Por ejemplo: /conf/global/settings/forms/usc/batch/wknd-batch

  • outputTypes: Especifique los formatos de salida: PDF e IMPRIMIR. Si utiliza el tipo de salida PRINT, en printedOutputOptionsList , especifique al menos una opción de impresión. Las opciones de impresión se identifican por su tipo de renderizado, por lo que actualmente no se permiten varias opciones de impresión con el mismo tipo de renderizado. Los formatos admitidos son PS, PCL, DPL, IPL y ZPL.

  • plantilla: Especifique la ruta absoluta o relativa de la plantilla. Por ejemplo, crx:///content/dam/formsanddocuments/wknd/statements.xdp

Si especifica una ruta relativa, proporcione también una raíz de contenido. Consulte la documentación de API para obtener más información sobre la raíz del contenido.

Puede usar GET /config /[configName] para ver los detalles de la configuración del lote.

Ejecutar un lote

Para ejecutar (ejecutar) un lote, utilice el POST /config /[configName]/execution. Por ejemplo, para ejecutar un lote denominado wknd-demo, utilice /config/wknd-demo/execution. El servidor devuelve el código de respuesta HTTP 202 al aceptar la solicitud. La API no devuelve ninguna carga útil excepto un código único (identificador de ejecución) en el encabezado de la respuesta HTTP para el trabajo por lotes que se ejecuta en el servidor. Puede utilizar el identificador de ejecución para recuperar el estado del lote.

NOTA

Mientras se ejecuta el lote, no realice ningún cambio en las carpetas de origen y destino correspondientes, en la configuración de la fuente de datos y en la configuración de Microsoft Azure Cloud.

Comprobar el estado de un lote

Para recuperar el estado de un lote, utilice la variable GET /config /[configName]/execution/[execution-identifier]. El identificador de ejecución se incluye en el encabezado de la respuesta HTTP para la solicitud de ejecución por lotes.

La respuesta de la solicitud de estado contiene la sección de estado . Proporciona detalles sobre el estado del trabajo por lotes, el número de registros que ya están en proceso (ya se están leyendo y procesando) y el estado de cada outputType/renderType (número de elementos en curso, con éxito y con errores). El estado también incluye la hora de inicio y finalización del trabajo por lotes junto con información sobre errores, si los hay. La hora de finalización es -1 hasta que se completa la ejecución por lotes.

NOTA
  • Cuando se solicitan varios formatos PRINT, el estado contiene varias entradas. Por ejemplo, IMPRIMIR/ZPL, IMPRIMIR/IPL.
  • Un trabajo por lotes no lee todos los registros simultáneamente, sino que el trabajo sigue leyendo e incrementando el número de registros. Por lo tanto, el estado devuelve -1 hasta que se hayan leído todos los registros.

Ver documentos generados

Al finalizar el trabajo, los documentos generados se almacenan en la variable success en la ubicación de destino especificada en la configuración del almacén de datos por lotes. Si hay algún error, el servicio crea un failure carpeta. Proporciona información sobre el tipo y el motivo de los errores.

Vamos a entender con la ayuda de un ejemplo: Supongamos que hay un archivo de datos de entrada record1.xml y dos tipos de salida: PDF y PCL. A continuación, la ubicación de destino contiene dos subcarpetas pdf y pcl, uno para cada uno de los tipos de salida. Supongamos que la generación de PDF se ha realizado correctamente y que la variable pdf la subcarpeta contiene la success subcarpeta que a su vez contiene el documento de PDF generado record1.pdf. Supongamos que la generación de PCL ha fallado y luego la pcl la subcarpeta contiene una failure subcarpeta que a su vez contiene un archivo de error record1.error.txt que contiene detalles del error. Además, la ubicación de destino contiene una carpeta temporal denominada __tmp__ que contiene ciertos archivos necesarios durante la ejecución por lotes. Esta carpeta se puede eliminar cuando no haya ejecuciones por lotes activas que hagan referencia a la carpeta de destino.

NOTA

Procesar un lote puede tardar algún tiempo dependiendo del número de registros de entrada y de la complejidad de la plantilla. Espere unos minutos antes de comprobar que las carpetas de destino tengan archivos de salida.

Documentación de referencia de API

La documentación de referencia de la API proporciona información detallada sobre todos los parámetros, métodos de autenticación y diversos servicios proporcionados por las API. La documentación de referencia de la API está disponible en formato .yaml . Puede descargar el API por lotes y cárguelo en Postman para comprobar la funcionalidad de las API.

En esta página