Saltar al contenido principal
Los informes de procesamiento empresarial muestran 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.
Nota: 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.
// v1: Una llamada síncrona con parámetros de consulta
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: Múltiples llamadas asíncronas
1. POST {base_url}/api/reporting/v2/exports/transaction-steps
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
// Recibir el ID de solicitud

2. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status

// Una vez que el estado = "Succeeded", descargar los archivos del informe
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Sigue leyendo para obtener detalles sobre cómo funciona el endpoint v2.

Descarga de un informe de datos

Nota: Solo los usuarios con los roles de Tenant Administrator y Processing Supervisor pueden descargar un informe de datos desde el Warehouse. Para obtener más información, consulta la sección Role-Based Access Control.
Puedes obtener datos del Warehouse en un archivo CSV mediante la API de Vantage. Para hacerlo, envía una solicitud POST al siguiente recurso:
POST {base_url}/api/reporting/v2/exports/transaction-steps
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.
  • startDate. El primer día del período (formato de ejemplo: 2022-01-07T13:03:38, la hora debe estar en UTC) para el que se deben descargar las transacciones.
  • endDate. El último día del período (formato de ejemplo: 2022-09-07T13:03:38, la hora debe estar en UTC) para el que se deben descargar las transacciones.
  • sendEmailNotification. Enviar un correo electrónico al usuario que creó la solicitud de informe para informarle de que el informe está listo para su descarga.
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
Las solicitudes de informes se ejecutan de forma asíncrona, por lo que la respuesta devuelve un requestId que se utiliza para verificar el estado de la solicitud. Resultado:
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
Para comprobar el estado del informe, incluye el requestId en la solicitud GET:
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
Una vez creado el informe, el status es “Succeeded” y totalFileCount muestra el número de archivos disponibles para descargar:
{
  "status": "Succeeded",
  "totalFileCount": 3,
  "filters": {
      "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
      "startDate": "2025-11-03T17:19:54.386+00:00",
      "endDate": "2025-11-17T20:05:26.097+00:00"
  }
}
Para descargar los archivos de informe generados, haga una solicitud GET a lo siguiente, volviendo a pasar el requestId y agregando el fileIndex, el índice del archivo comenzando en cero. Por ejemplo, si "totalFileCount": 3, entonces los índices de archivo disponibles serían 0, 1 y 2.
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
A continuación se muestra un ejemplo de cómo se ve la respuesta CSV:
SkillIdSkillVersionSkillNameTransactionIdStepNameStepTypeManualReviewOperatorNameManualReviewOperatorEmailStartedUtcCompletedUtcStatusDurationDocumentsCountPagesCountdocument_SourceFileNamedocument_SourceTypetransaction_App
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fInputInput11/17/2025 19:37:5211/17/2025 19:38:01FinishedSuccessfully9Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOCROcr11/17/2025 19:38:0211/17/2025 19:38:17FinishedSuccessfully15Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fClassifyClassification11/17/2025 19:38:1711/17/2025 19:38:20FinishedSuccessfully3Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fExtractExtraction11/17/2025 19:38:2111/17/2025 19:38:44FinishedSuccessfully23Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOutputOutput11/17/2025 19:38:4711/17/2025 19:39:01Failed13Invoice CA_2.pdfPublicAPIPublicAPI

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:
ColumnDescription
SkillIdEl ID del skill.
SkillVersionLa versión del skill.
SkillNameEl nombre del skill.
TransactionIdID de la transacción.
StepNameEl nombre del evento o el nombre de la actividad en el caso del skill de tipo Process.
StepTypeEl tipo de evento. Valores posibles:
- Input (disponible para todos los tipos de skill)
- Ocr (disponible para skills de OCR o skills de tipo Process con actividad de OCR agregada)
- Classification (disponible para skills de Classification o skills de tipo Process con actividad de Classification agregada)
- Extraction (disponible para todos los tipos de skill)
- Condition (disponible para skills de tipo Process con actividad de Condition agregada)
- CustomActivity (disponible para skills de tipo Process con actividad Custom agregada)
- WaitingForManualReview (disponible para skills de tipo Process con la actividad Manual Review agregada). El tiempo durante el cual una transacción está en espera de revisión manual
- ManualReview (disponible para skills de tipo Process con la actividad Manual Review agregada). El tiempo durante el cual el Operador está verificando una transacción
- Output (disponible para todos los tipos de skill)
ManualReviewOperatorNameEl nombre del Operador de Manual Review.
ManualReviewOperatorEmailEl correo electrónico del Operador de Manual Review.
StartedUtcHora de inicio del evento (UTC). Por ejemplo, 5/3/2022 1:59:02 PM.
CompletedUtcHora de finalización del evento (UTC).
StatusEl estado del evento. Valores posibles:
- Processing
- Finished Successfully
- Canceled
- Failed
DurationDuración del evento (en segundos).
document_*, transaction_*Parámetros de documento o de transacción pasados para el procesamiento. El prefijo document_ se agrega a los parámetros de documento en el encabezado, y el prefijo transaction_ se agrega a los parámetros de transacción. Por ejemplo, document_SourceFileName. Si una transacción contiene documentos con parámetros idénticos en nombre pero diferentes en valor, el Warehouse enumerará todos los valores únicos de este parámetro separados por comas. Por ejemplo, todos los nombres de archivo dentro de una transacción.
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.
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
La respuesta incluye una matriz de solicitudes de generación de informes.
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Nuevo",
      "completedUtc": "2025-11-18T22:22:00.294Z",
      "createdUtc": "2025-11-18T22:20:49.294Z",
      "totalFileCount": "2",
      "filters": {
        "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    },
    {
      "requestId": "48293032-5717-4562-b3fc-2c963f66afa6",
      "status": "Correcto",
      "completedUtc": "2025-12-18T22:22:00.294Z",
      "createdUtc": "2025-12-18T22:20:49.294Z",
      "totalFileCount": "4",
      "filters": {
        "skillId": "dk3ioda-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    }
  ]
}