Modelo de datos de exportación de datos en tiempo real

Información general

Cada cambio en el sistema está representado por un formato JSON de evento registrado.

Se admiten los siguientes tipos de eventos:

• Eventos que describen trabajos:
  • job.created
  • job.started
  • job.stopped
  • job.pending
  • job.completed
  • job.faulted
  • job.stopping
  • job.terminating
• Eventos que describen elementos de la cola:
  • queueitem.added
  • ElementoDeCola.diferido
  • QueueItem.reviewStatusChanged
  • queueItem.retried
  • queueItem.updated
  • queueItem.transactionAbandoned
  • queueItem.transactionCompleted
  • queueItem.transactionFailed
  • queueItem.transactionRetried
  • queueItem.transactionStarted
  Nota: Los siguientes campos se eliminarán de los eventos queueItem.deferred y queueItem.reviewStatusChanged :

  • Datos específicos
  • SpecificContent
  • Salida

• Eventos que describen máquinas:

  • machine.created
  • machine.updated
  • machine.deleted
  • machineSession.status
  • machine.assign
  • machine.unassign
• Eventos que describen los registros del robot:
  • registro de robot

Como los diferentes eventos describen diferentes entidades y cambios en el sistema, tienen un contenido diferente (campos JSON).

Formato y esquema de eventos

Cada evento se entrega en formato JSON y tiene lo siguiente:

• Cuerpo específico del evento
• Campos comunes
• Metadatos

Para entender mejor el evento, consulte el siguiente ejemplo para un evento job.created . El ejemplo está formateado con nuevas líneas y comentarios que describen cada sección para facilitar la lectura. Los eventos reales no tienen este formato y se entregan como una cadena de una sola línea.

{
    /*********************
            event-specific body
    **********************/
    "body": {
        "Job": {
            "Key": "<job-key>",
            "CreationTime": null,
            "State": "Pending",
            "StartTime": "<job-start-time>",
            "EndTime": null,
            "ProcessName": "<process-name>",
          "DisplayName": "<display-name>",
            "RobotName": "<robot-name>",
            "HostMachineName": "<host-machine-name>"
        },
    /*********************
            common fields
    **********************/
        "EventType": "job.started",
        "SchemaVersion": "0.0.1",
        "Timestamp": "<timestamp>",
        "TenantKey": "<tenant-key>",
        "TenantName": "<tenant-name>",
        "FolderName": "<folder-name>",
        "FullFolderPath": "<folder-path>",
        "FolderKey": "<folder-key>"
        },
    /*********************
            metadata
    **********************/
    "x-opt-sequence-number": <sequence-number>,
    "x-opt-offset": "<offset>",
    "x-opt-enqueued-time": <enqueued-time>,
    "Diagnostic-Id": "<diagnostic-id>"
}

Campos Comunes

Los campos comunes aparecen en todos los eventos.

Nombre	Tipo	Descripción
TipoDeEvento	string	El tipo de evento.
SchemaVersion	string	La versión del esquema. Las diferentes versiones pueden tener diferentes tipos de eventos y campos compatibles.
Marca de tiempo	timestamp	Marca de tiempo UTC del evento.
TenantKey	Guid	El identificador único del tenant que generó el evento.
NombreDeTenant	string	Nombre del tenant que generó el evento.
NombreDeCarpeta	string	Nombre de la carpeta de Orchestrator en la que se generó el evento.
FullFolderPath	string	Si una carpeta es una subcarpeta de otra carpeta, este campo muestra la ruta completa.
FolderKey	Guid	El identificador único de la carpeta.

{
    "EventType": "queueItem.transactionCompleted",
    "SchemaVersion": "0.0.1",
    "Timestamp": "<timestamp>",
    "TenantKey": "<tenant-key>",
    "TenantName": "<tenant-name>",
    "FolderName": "<folder-name>",
    "FullFolderPath": "<folder-path>",
    "FolderKey": "<folder-key>"
}

Eventos de trabajo

Nombre	Tipo	Descripción
Clave	Guid	Identificador único de un trabajo.
Hora de creación	timestamp	La hora en que se creó el trabajo.
HoraDeInicio	timestamp	La hora en que se inició el trabajo.
HoraDeFinalización	timestamp	La hora en que se completó el trabajo.
Estado	string	El estado de trabajo. Valores admitidos: • Pending • Running • Stopping • Terminating • Faulted • Successful • Stopped • Suspended • Resumed
NombreDelProceso	string	Nombre del paquete desde el que se creó el trabajo.
NombreParaMostrar	string	Nombre proporcionado a un proceso en Orchestrator.
Nombre del robot	string	Nombre del robot que ejecuta el trabajo.
Nombre del equipo host	string	Máquina en la que se está ejecutando el trabajo.

{
    "body": {
        "Job": {
        "Key": "<job-key>",
        "CreationTime": "<creation-time>",
        "State": "Running",
        "StartTime": "<start-time>",
        "EndTime": null,
        "ProcessName": "<process-name>",
        "DisplayName": "<display-name>",
        "RobotName": "<robot-name>",
        "HostMachineName": "<host-machine-name>",
    },
    ... common fields ...
    "EventType": "job.started",
    ... more common fields ...
}

Eventos QueueItem

Nombre	Tipo	Descripción
Elemento de cola	ObjetoJson
Clave	Guid	Un identificador único para el elemento de cola.
QueueDefinitionId	number	Identificador numérico de una cola a la que pertenece el elemento de cola.
Estado	string	El estado del elemento de cola. Valores admitidos: • New • InProgress • Failed • Successful • Abandoned • Retried • Deleted • Unknown
ReviewStatus	string	El estado de revisión del elemento de cola. Valores admitidos: • None • InReview • Verified • Retried • Unknown
DueDate	datetime	La fecha y la hora máximas en las que debe procesarse el elemento.
Prioridad	string	La prioridad del elemento de la cola. Valores admitidos: • High • Normal • Low • Unknown
Hora de creación	datetime	Marca de tiempo en la que se creó el elemento de la cola.
StartProcessing	datetime	Marca de tiempo en la que se inició el procesamiento del elemento de la cola.
Finalizar procesamiento	datetime	Marca de tiempo en que el elemento de la cola terminó de procesarse (con éxito o no).
DefferDate	datetime	La fecha y hora más tempranas en las que el elemento está disponible para su procesamiento. Si está vacío, el elemento puede ser procesado tan pronto como sea posible.
SecondsInPre anterior	number	El número de segundos que duró el último intento de procesamiento fallido.
Número de reintento	number	El número de veces que se ha procesado este elemento de la cola.
Progreso	string	Cadena archivada agregada por los desarrolladores en UiPath Studio que se usa para realizar un seguimiento del progreso del flujo comercial.
Datos de análisis	string	Una colección de pares clave-valor que contiene los datos de la propiedad Analytics añadidos por los desarrolladores en Studio a través de la actividad Establecer estado de transacción .
Salida	string	Una colección de pares clave-valor que contiene los datos de la propiedad Output añadidos por los desarrolladores en Studio a través de la actividad Establecer estado de transacción .
Datos específicos	string	Una colección de pares clave-valor que contiene los datos de la propiedad Specific Content añadidos por los desarrolladores en Studio a través de la actividad Establecer estado de transacción . Una colección de pares de valores clave que contienen datos personalizados configurados en la actividad Añadir elemento de cola de UiPath Studio.
ID de trabajo del creador	number	El ID del trabajo que creó el elemento de la cola.
ID de trabajo del ejecutor	number	El ID del trabajo que ejecutó el elemento de la cola.
ProcessExceptionReason	string	Resumen de las razones por las que falló el procesamiento del elemento de la cola.
ProcessExceptionDetails	string	Detalles adicionales sobre el error del artículo en cola.
ProcessExceptionType	string	Para los elementos de la cola que finalizaron con un error, este campo describe el tipo de error (excepción). Valores admitidos: • ApplicationException • BusinessException • None
Cola	ObjetoJson
Clave	Guid	Identificador único del evento.
Nombre	string	El nombre de la cola.
Descripción	string	Información adicional sobre una cola para identificarla mejor.
MaxNumberOfRetries	number	El número de veces que se puede reintentar un elemento de esta cola si su procesamiento falla.
EnforceUniqueReference	boolean	Establece si el campo Item Reference debe ser único por elemento de la cola.
SlaInMinutes	number	Valor entero que representa el SLA de la cola en minutos.
RiskSlaInMinutes	number	Valor entero que representa el SLA de riesgo de cola en minutos.

{
    "body": {
        "QueueItem": {
            "Key": "<queue-item-key>",
            "QueueDefinitionId": <queue-definition-id>,
          "Status": "New",
            "ReviewStatus": "None",
            "DueDate": "<due-date>",
            "Priority": "High",
            "CreationTime": "<creation-time>",
            "StartProcessing": "<start-processing-time>",
            "EndProcessing": null,
            "DefferDate": "<deffer-time>",
            "SecondsInPreviousAttempt": 0,
            "RetryNumber": 1,
            "Progress": "<progress>",
            "ProcessExceptionReason": null,
            "ProcessExceptionDetails": null,
            "ProcessExceptionType": null
        },
        "Queue": {
            "Key": "<queue-key>",
            "Name": "<queue-name>",
            "Description": "<queue-description>",
            "MaxNumberOfRetries": 1,
            "EnforceUniqueReference": false,
            "SlaInMinutes": 0,
            "RiskSlaInMinutes": 0
        },
    },
    ... common fields ...
}

Eventos de sesión de la máquina

Nombre	Tipo	Descripción
Clave de máquina	Guid	Identificador único de la máquina.
Nombre de la máquina	string	Nombre personalizado de la máquina.
Nombre del equipo host	string	Nombre de la máquina host asignada a la máquina de UiPath.
Nombre de usuario del servicio	string	Nombre del usuario con el que se ejecuta el servicio de robot en la máquina.
Estado de la máquina	string	Estado de la máquina. Valores admitidos: • Available • Busy • Disconnected • Unknown
Marca de tiempo	datetime	Marca de tiempo del evento de sesión de la máquina.
IsUnresponsive	boolean	Una comprobación para ver si la máquina responde a la conexión de Orchestrator. Valores admitidos: • true • false Una máquina aún puede estar disponible pero no responder. Una vez que no responde durante diez minutos, se desconecta o se desconoce.

{
    "body": {
        "MachineSession": {
            "MachineKey": "<machine-key>",
            "MachineName": "<machine-name>",
            "MachineId": <machine-id>,
            "HostMachineName": "<host-machine-name>",
            "ServiceUsername": "<service-username>",
            "MachineStatus": "Disconnected",
            "ReportingTime": "<reporting-time>",
            "IsUnresponsive": false
        },
        ... common fields ...
        "EventType":"machineSession.status",
        ... more common fields ...
}

Eventos de la máquina

Nombre	Tipo	Descripción
AutomationCloudSlots	number	Número de ranuras de Automation Cloud<b> TM </b> que se reservarán en runtime.
HeadlessSlots	number	Número de ranuras sin interfaz que se reservarán en runtime.
ID de equipo	number	ID entero de la máquina, único por instancia de Orchestrator.
Clave de máquina	Guid	Identificador único de una máquina.
Nombre de la máquina	string	Nombre personalizado de la máquina.
NonProductionSlots	number	Número de NonProduction ranuras que se reservarán en tiempo de ejecución.
UnattendedSlots	number	Número de Unattended ranuras que se reservarán en tiempo de ejecución.

{
    "body": {
        "Machine": {
            "MachineName": "<machine-name>",
            "MachineKey": "<machine-key>",
            "NonProductionSlots": 1,
            "HeadlessSlots": 0,
            "AutomationCloudSlots": 0,
            "UnattendedSlots": 0
        },
        ... common fields ...
}

Máquina Asignación de eventos

Nombre	Tipo	Valores
Clave de máquina	Guid	Identificador único de una máquina.
Nombre de la máquina	string	Nombre personalizado de la máquina.

{
    "body": {
        "MachineAssign": {
            "MachineKey": "<machine-key>",
            "MachineName": "<machine-name>"
        },
        "EventType": "machine.unassigned",
        ... common fields ...
    }
}

Registros de robot

Nombre	Tipo	Descripción
NombreDeArchivo	string	El nombre del archivo .xaml que se ejecuta.
iniciado por	string	El origen de la ejecución. Valores posibles: • Assistant • Studio • StudioX • StudioPro • Orchestrator • CommandLine • RobotAPI
ID del trabajo	string/guid	El JobKey, un identificador único para el trabajo.
Nivel	string	Nivel de registro del registro. Valores posibles: • Trace • Info • Warn • Error • Fatal
TipoDeRegistro	string	El tipo de registro del robot. Valores posibles: • User • Default • Error • Business • ExecutionStep • BusinessIteration • Info • Security • Technical
ID de equipo	number	ID entero de la máquina, único por instancia de Orchestrator.
Nombre de la máquina	string	Nombre personalizado de la máquina.
Mensaje	string	El mensaje del registro del robot. Valores posibles: • execution started • execution ended • mensaje personalizado
NombreDelProceso	string	El nombre del proceso que está ejecutando el robot.
Versión de proceso	string	La versión del proceso.
Nombre del robot	string	El nombre del robot.
Identidad de Windows	string	El nombre del usuario que realizó la acción que se registra.
ProcessingExceptionReason	string	El motivo de la excepción. Solo presente en los registros de finalización de transacción.
TipoDeExcepciónDeProcedimiento	string	El tipo de excepción. Solo presente en los registros de finalización de transacción. Valores posibles: • ApplicationException • BusinessException
PrioridadDeElementoDeCola	string	La prioridad del elemento de la cola. Solo presente en los registros de fin de transacción. Valores posibles: • High • Normal • Low
EstadoDeRevisiónDeArtículoEnCola	string	El estado de revisión del elemento de cola. Solo presente en los registros de fin de transacción. Valores posibles: • InReview • Verified • Reported • Retried
NombreDeCola	string	El nombre de la cola desde la que el robot ejecuta los elementos de la cola.
TiempoDeEjecuciónDeTransacción	number	El tiempo de ejecución en segundos para la transacción. Solo tiene valores al procesar elementos en cola.
ID de transacción	string/Guid	La clave única de la transacción. Solo tiene valores al procesar elementos en cola.
EstadoDeTransacción	string	El estado de la transacción. Solo tiene valores al procesar elementos en cola. Valores posibles: • Started • Ended • Postponed
EstatusDeTransacción	string	El estado de la transacción. Solo tiene valores al procesar elementos de la cola. Valores posibles: • ApplicationException • Start • SystemError • Failed • BusinessException • Success • InProgress
TiempoTotalDeEjecuciónEnSegundos	number	El tiempo de ejecución de la transacción, medido en segundos. Solo tiene valores al procesar elementos en cola.
InformaciónDeActividad	JSON	El JSON de información de la actividad que contiene DisplayName, State (Faulted, Closedo Executing), Activityy Arguments.
Marca de tiempo	datetime	Hora en que se generó el evento.
Clave de máquina	Guid	Identificador único de la máquina que ejecuta el trabajo.
Campos personalizados	JSON	Un JSON que contiene los campos definidos en la actividad AñadirCamposDeRegistro en Studio.

{
    "body": {
        "Level": "Info",
        "MachineKey": "<machine-key>",
        "RobotLog": {
            "Message": "Transaction Ended",
            "Level": "Information",
            "LogType": "Default",
            "CustomFields": {
                "Custom fields 1": "value1",
                "Custom fields 2": 2,
            },
        "TimeStamp": "<timestamp>",
        "Fingerprint": "<fingerprint>",
        "WindowsIdentity": "<windows-identity>",
        "MachineName": "<machine-name>",
        "FileName": "<filename>",
        "TransactionExecutionTime": 0.6733966,
        "QueueItemPriority": "Normal",
        "ProcessingExceptionReason": "",
        "TransactionStatus": "Successful",
        "QueueName": "<queue-name>",
        "TransactionState": "Ended",
        "ProcessingExceptionType": "",
        "TransactionId": "<transaction-id>",
        "QueueItemReviewStatus": "None",
        "ProcessName": "<process-name>",
        "ProcessVersion": "1.0.6",
        "JobId": "<job-id>",
        "RobotName": "<robot-name>",
        "MachineId": <machine-id>,
        "OrganizationUnitId": <organization-unit-id>
        },
        "EventType": "robotlog",
        ... common fields ...
    },
}