- 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
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?
/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 objetofilters, 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.
/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.
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.
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.
requestId que se utiliza para comprobar el estado de la solicitud.
Resultado:
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:
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
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
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.
