Modelo de dados de exportação de dados em tempo real

Visão geral

Cada alteração no sistema é representada por um formato JSON registrado no evento.

Os seguintes tipos de eventos são suportados:

• Eventos que descrevem trabalhos:
  • job.created
  • job.started
  • job.stopped
  • job.pending
  • job.completed
  • job.faulted
  • job.stopping
  • job.terminating
• Eventos que descrevem itens de fila:
  • queueitem.added
  • queueItem.adiado
  • queueItem.ReviewStatusAlterado
  • queueItem.retried
  • queueItem.updated
  • queueItem.transactionAbandoned
  • queueItem.transactionCompleted
  • queueItem.transactionFailed
  • queueItem.transactionRetried
  • queueItem.transactionStarted
  Observação: os seguintes campos serão removidos dos eventos queueItem.deferred e queueItem.reviewStatusChanged :

  • Dados Específicos
  • ConteúdoEspecífico
  • Saída

• Eventos descrevendo máquinas:

  • machine.created
  • machine.updated
  • machine.deleted
  • machineSession.status
  • machine.assign
  • machine.unassign
• Eventos descrevendo logs do robô:
  • Log do robô

Como diferentes eventos descrevem diferentes entidades e alterações no sistema, eles têm conteúdo diferente (campos JSON).

Formato e Esquema de Eventos

Cada evento é entregue no formato JSON e tem o seguinte:

• Corpo específico do evento
• Campos comuns
• Metadata

Para uma melhor compreensão, verifique o exemplo abaixo para um evento job.created . O exemplo é formatado com novas linhas e comentários descrevendo cada seção para facilitar a leitura. Os eventos reais não têm essa formatação e são entregues como uma string de linha única.

{
    /*********************
            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 Comuns

Campos comuns aparecem em todos os eventos.

Name	Tipo	Description
TipoDeEvento	string	O tipo de evento.
SchemaVersion	string	A versão do esquema. Versões diferentes podem ter diferentes tipos de eventos e campos suportados.
Carimbo de data/hora	timestamp	Carimbo de data/hora UTC do evento.
TenantKey	Guid	O identificador exclusivo do locatário que gerou o evento.
NomeDoTenant	string	Nome do inquilino que gerou o evento.
NomeDaPasta	string	Nome da pasta do orquestrador na qual o evento foi gerado.
FullFolderPath	string	Se uma pasta for uma subpasta de outra pasta, esse campo exibirá o caminho completo.
FolderKey	Guid	O identificador exclusivo da pasta.

{
    "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 do trabalho

Name	Tipo	Description
Chave	Guid	Identificador exclusivo de um trabalho.
Hora de Criação	timestamp	Carimbo de data e hora em que o trabalho foi criado.
StartTime	timestamp	Carimbo de data/hora quando o trabalho foi iniciado.
EndTime	timestamp	Carimbo de data/hora quando o trabalho foi concluído.
Estado	string	O estado do trabalho. Valores suportados: • Pending • Running • Stopping • Terminating • Faulted • Successful • Stopped • Suspended • Resumed
ProcessName	string	Nome do pacote a partir do qual o trabalho foi criado.
NomeDeExibição	string	Nome fornecido a um processo no Orchestrator.
Nome do Robô	string	Nome do robô que executa o trabalho.
Nome da Máquina do Host	string	Máquina na qual o trabalho está sendo executado.

{
    "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 do QueueItem

Name	Tipo	Description
Item de Fila	JsonObject
Chave	Guid	Um identificador exclusivo para o item da fila.
IdDeDefiniçãoDeFila	number	Identificador numérico de uma fila à qual pertence o item da fila.
Status	string	O status do item da fila. Valores suportados: • New • InProgress • Failed • Successful • Abandoned • Retried • Deleted • Unknown
ReviewStatus	string	O status de revisão do item da fila. Valores suportados: • None • InReview • Verified • Retried • Unknown
DueDate	datetime	A data e a hora mais recente na qual o item deve ser processado.
Prioridade	string	A prioridade do item da fila. Valores suportados: • High • Normal • Low • Unknown
Hora de Criação	datetime	Carimbo de data/hora quando o item da fila foi criado.
StartProcessing	datetime	Carimbo de data/hora em que o item da fila começou a ser processado.
Encerrar Processamento	datetime	Carimbo de data/hora quando o item da fila concluiu o processamento (com sucesso ou não).
DefferDate	datetime	A primeira data e hora em que o item deve estar disponível para processamento. Se estiver vazio, o item estará disponível para ser processado de imediato.
SegundosEmAnteriorTentativa	number	O número de segundos que durou a última tentativa de processamento com falha.
Número da Tentativa	number	O número de vezes que este item da fila foi processado.
Progresso	string	String arquivada adicionada por desenvolvedores no UiPath Studio , que é usada para acompanhar o progresso do fluxo de negócios.
Dados de Análise	string	Uma coleção de pares chave-valor contendo os dados da propriedade Analytics adicionados por desenvolvedores no Studio por meio da atividade Definir status da transação .
Saída	string	Uma coleção de pares chave-valor contendo os dados da propriedade Output adicionados por desenvolvedores no Studio por meio da atividade Definir status da transação .
Dados Específicos	string	Uma coleção de pares chave-valor contendo os dados da propriedade Specific Content adicionados por desenvolvedores no Studio por meio da atividade Definir status da transação . Uma coleção de pares de chave-valor contendo dados personalizados configurados na atividade Adicionar Item de Fila em UiPath Studio
ID do Trabalho do Criador	number	A ID do trabalho que criou o item da fila.
ID do Trabalho do Executador	number	O ID do trabalho que executou o item da fila.
ProcessExceptionReason	string	Resumo do motivo pelo qual o processamento do item da fila falhou.
ProcessExceptionDetails	string	Detalhes adicionais sobre a falha do item da fila.
ProcessExceptionType	string	Para itens de fila que terminaram com um erro, este campo descreve o tipo de erro (exceção). Valores suportados: • ApplicationException • BusinessException • None
Fila	JsonObject
Chave	Guid	Identificador exclusivo da fila.
Name	string	O nome da fila.
Description	string	Informações adicionais sobre uma fila para melhor identificá-la.
MaxNumberOfRetries	number	O número de vezes que um item desta fila pode ser repetido se seu processamento falhar.
EnforceUniqueReference	boolean	Informa se o campo Item Reference deve ser exclusivo por item da Fila.
SlaInMinutes	number	Valor inteiro que representa o SLA da Fila em minutos.
RiskSlaInMinutes	number	Valor inteiro que representa o SLA de risco de fila em 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 Sessão de Máquina

Name	Tipo	Description
MachineKey	Guid	Identificador único da máquina.
Nome da máquina	string	Nome personalizado da máquina.
Nome da Máquina do Host	string	Nome da máquina host que é mapeada para a máquina UiPath.
Nome de Usuário do Serviço	string	Nome do usuário sob o qual o serviço do robô na máquina está sendo executado.
Status da Máquina	string	Estado da máquina. Valores suportados: • Available • Busy • Disconnected • Unknown
Carimbo de data/hora	datetime	Registro de data e hora do evento de sessão da máquina.
IsUnresponsive	boolean	Uma verificação para ver se a máquina está respondendo à conexão do Orchestrator. Valores suportados: • true • false Uma máquina ainda pode estar disponível, mas não responder. Uma vez que não responde por dez minutos, torna-se desconectado ou desconhecido.

{
    "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 máquina

Name	Tipo	Description
AutomationCloudSlots	number	Número de slots<b>TM</b> do Automation Cloud a serem reservados no tempo de execução.
HeadlessSlots	number	Número de slots sem cabeça a serem reservados no tempo de execução.
ID da Máquina	number	ID de número inteiro da máquina, exclusivo por instância do orquestrador.
MachineKey	Guid	Identificador único de uma máquina.
Nome da máquina	string	Nome personalizado da máquina.
NonProductionSlots	number	Número de NonProduction slots a serem reservados no tempo de execução.
UnattendedSlots	number	Número de Unattended slots a serem reservados no tempo de execução.

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

Eventos de Atribuição de Máquina

Name	Tipo	Valores
MachineKey	Guid	Identificador único de uma máquina.
Nome da máquina	string	Nome personalizado da máquina.

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

Logs do Robot

Name	Tipo	Description
NomeDoArquivo	string	O nome do arquivo .xaml que está sendo executado.
initiatedBy	string	A origem da execução. Valores possíveis: • Assistant • Studio • StudioX • StudioPro • Orchestrator • CommandLine • RobotAPI
JobId	string/guid	O JobKey, um identificador exclusivo para o trabalho.
Nível	string	Nível de log do log. Valores possíveis: • Trace • Info • Warn • Error • Fatal
TipoDeLog	string	O tipo de log do robô. Valores possíveis: • User • Default • Error • Business • ExecutionStep • BusinessIteration • Info • Security • Technical
ID da Máquina	number	ID de número inteiro da máquina, exclusivo por instância do orquestrador.
Nome da máquina	string	Nome personalizado da máquina.
Mensagem	string	A mensagem do log do robô. Valores possíveis: • execution started • execution ended • mensagem personalizada
ProcessName	string	O nome do processo que o robô está executando.
Versão do Processo	string	A versão do processo.
Nome do Robô	string	O nome do robô.
Identidade do Windows	string	O nome do usuário que realizou a ação que foi registrada.
ProcessingExceptionReason	string	O motivo da exceção. Presente apenas nos logs de Fim da Transação.
Tipo da Exceção de Processamento	string	O tipo da exceção. Presente apenas nos logs de Fim da Transação. Valores possíveis: • ApplicationException • BusinessException
queueItemPriority	string	A prioridade do item da fila. Presente apenas nos logs de Fim da Transação. Valores possíveis: • High • Normal • Low
StatusDeRevisãoDeItemDaFila	string	O status de revisão do item da fila. Presente apenas nos logs de Fim da Transação. Valores possíveis: • InReview • Verified • Reported • Retried
QueueName	string	O nome da fila da qual o robô está executando itens da fila.
Tempo de Execução da Transação	number	O tempo de execução em segundos para a transação. Só tem valores ao processar itens da fila.
ID da Transação	string/Guid	A chave exclusiva da transação. Só tem valores ao processar itens da fila.
transactionState	string	O estado da transação. Só tem valores ao processar itens da fila. Valores possíveis: • Started • Ended • Postponed
transactionStatus	string	O status da transação Só tem valores ao processar itens da fila. Valores possíveis: • ApplicationException • Start • SystemError • Failed • BusinessException • Success • InProgress
TempoTotalDeExecuçãoEmSegundos	number	O tempo de execução da transação, medido em segundos. Só tem valores ao processar itens da fila.
InformaçõesDaAtividade	JSON	O JSON de informações da atividade contendo DisplayName, State (Faulted, Closedou Executing), Activitye Arguments.
Carimbo de data/hora	datetime	Hora em que o evento foi gerado.
MachineKey	Guid	Identificador exclusivo da máquina que executa o trabalho.
Custom Fields	JSON	Um JSON que contém os campos definidos na atividade AddLogFields no 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 ...
    },
}