Skip to main content
El informe de procesamiento empresarial muestra qué tan bien se procesan los documentos y proporcionan trazabilidad de las transacciones de extremo a extremo para fines de auditoría. El Warehouse registra todas las transacciones —completadas y en curso— para su análisis y visualización en herramientas de inteligencia de negocios. Los datos se conservan durante 12 meses, lo que permite el análisis y la auditoría en períodos de tiempo definidos. Se realiza un seguimiento de los siguientes datos:
  • ID de transacción.
  • ID y versión de la skill.
  • Ruta de procesamiento por pasos:
    • Tipos de paso
    • Nombres
    • Fecha y hora de inicio y finalización del paso
    • Duración (en segundos)
  • Nombre y correo electrónico del operador de revisión manual.
  • Parámetros de registro del documento y de la transacción.
El Warehouse no almacena información sobre eventos de procesamiento de documentos en actividades que nunca se ejecutan según su configuración. Por ejemplo, la configuración Assemble by files corresponde al comportamiento predeterminado de Vantage, por lo tanto, el procesamiento de documentos en esta actividad se omitirá en el flujo de trabajo.

Migración de v1 a v2

En Vantage 3.0 y versiones posteriores, el endpoint transaction-steps v1 ha quedado obsoleto. Para garantizar la compatibilidad con versiones anteriores, el endpoint v2 funciona de manera similar, con un cambio en el nombre del endpoint y con los parámetros de consulta trasladados al cuerpo de la solicitud. El endpoint v2 ha pasado a un modelo asíncrono para gestionar mejor las solicitudes con grandes volúmenes de datos. Después de solicitar un informe, puede consultar periódicamente el estado hasta que el informe esté listo. Una vez completado, puede descargar los resultados.

¿Qué hay de nuevo?

En la solicitud (/api/reporting/v2/exports/transaction-steps):
  • Los filtros se han trasladado de los parámetros de consulta al cuerpo de la solicitud (objeto JSON filters).
  • startDate, especificado dentro del objeto filters, ahora es obligatorio.
  • Campo nuevo: sendEmailNotification (true/false): envía un correo electrónico al usuario que solicitó el informe cuando el informe esté listo para descargar.
En los archivos CSV descargados del resultado final (/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}), se han añadido dos columnas:
  • DocumentsCount: el número de documentos procesados en una transacción.
  • PagesCount: el número de páginas procesadas en una transacción.
Continúe leyendo más abajo para ver los detalles sobre cómo funciona el endpoint v2.

Descarga de un informe de datos

Solo los usuarios con los roles de Tenant Administrator y Processing Supervisor pueden descargar un informe de datos desde Warehouse. Para obtener más información, consulta la sección Control de acceso basado en roles.
Puedes obtener datos de Warehouse en un archivo CSV mediante la Vantage API. Para hacerlo, envía una solicitud POST al siguiente recurso: El cuerpo de la solicitud debe incluir las siguientes propiedades dentro de un objeto filters:
  • skillId. El ID de la skill cuyas transacciones se deben descargar. Opcional.
  • transactionId. El ID de la transacción por la que se debe filtrar. Opcional.
  • startDate. El primer día del período (formato de ejemplo: 2022-01-07T13:03:38, la hora debe estar en UTC) para el cual se deben descargar las transacciones. Obligatorio.
  • endDate. El último día del período (formato de ejemplo: 2022-09-07T13:03:38, la hora debe estar en UTC) para el cual se deben descargar las transacciones. Opcional.
  • sendEmailNotification. Enviar un correo electrónico al usuario que creó la solicitud de informe para informarle que el informe está listo para descargar. Opcional.
Las solicitudes de informes se procesan de forma asíncrona, por lo que la respuesta devuelve un requestId que se utiliza para comprobar el estado de la solicitud. Resultado:
Para consultar el estado del informe, incluya el requestId en la solicitud GET: Una vez creado el informe, el valor de status será “Succeeded” y totalFileCount mostrará el número de archivos disponibles para descargar:
Para descargar los archivos de informe resultantes, realice una solicitud GET a lo siguiente, pasando nuevamente el requestId y agregando el fileIndex, el índice que comienza en cero del archivo. Por ejemplo, si "totalFileCount": 3, entonces los índices de archivo disponibles serían 0, 1 y 2. Este es un ejemplo de cómo es la respuesta CSV:

Estructura de la respuesta

Cada fila de un archivo CSV es una operación realizada sobre una transacción. Por ejemplo, la importación de documentos, el reconocimiento o la revisión manual. Para cada operación en el Warehouse, sus detalles se almacenan en columnas: Los datos preparados se almacenan durante 2 semanas después de que se complete la solicitud. Los datos obtenidos en formato CSV pueden analizarse posteriormente en cualquier herramienta de BI.

Recuperar una lista de solicitudes de informes

Para recuperar la lista de solicitudes de informes realizadas dentro de un período de tiempo determinado, realice una solicitud GET al siguiente endpoint, donde createdFrom y createdTo representan el intervalo de fechas y statusFilter es uno de los siguientes valores: New,Queued,Processing,Succeeded,Failed, o Cancelled. Esto es útil en caso de extravío de identificadores de solicitud. La respuesta incluye una matriz de solicitudes de generación de informes.