Modèle de données d'exportation de données en temps réel

Vue d'ensemble (Overview)

Chaque modification apportée au système est représentée par un format JSON consigné dans un événement.

Les types d'événements suivants sont pris en charge :

• Événements décrivant les tâches :
  • job.created
  • job.started
  • job.stopped
  • job.pending
  • job.completed
  • job.faulted
  • job.stopping
  • job.terminating
• Événements décrivant les éléments de la file d'attente :
  • queueitem.added
  • queueItem.deferred
  • queueItem.reviewStatusChanged
  • queueItem.retried
  • queueItem.updated
  • queueItem.transactionAbandoned
  • queueItem.transactionCompleted
  • queueItem.transactionFailed
  • queueItem.transactionRetried
  • queueItem.transactionStarted
    Remarque :

    Les champs suivants seront supprimés des événements queueItem.deferred et queueItem.reviewStatusChanged :

    • Données spécifiques (SpecificData)
    • SpecificContent
    • Sortie
• Événements décrivant des machines :
  • machine.created
  • machine.updated
  • machine.deleted
  • machineSession.status
  • machine.assign
  • machine.unassign
• Événements décrivant les journaux du Robot :
  • robotlog

Étant donné que différents événements décrivent différentes entités et modifications du système, leur contenu (champs JSON) est différent.

Format et schéma des événements

Chaque événement est livré au format JSON et comporte les éléments suivants :

• Corps spécifique à l'événement
• Champs communs
• Metadata

Pour mieux comprendre, consultez l'exemple suivant concernant un événement job.created . L’exemple est formaté avec de nouvelles lignes et de commentaires décrivant chaque section pour plus de lisibilité. Les événements réels n'ont pas ce formatage et sont livrés sous forme de chaîne d'une seule ligne.

{
    /*********************
            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>"
}

Champs communs

Des champs communs apparaissent dans chaque événement.

Nom	Saisie de texte	Description
TypeÉvénement	string	Type d'événement.
SchemaVersion	string	La version du schéma. Différentes versions peuvent avoir différents types d'événements et champs pris en charge.
Horodatage	timestamp	Horodatage UTC de l'événement.
TenantKey	Guid	L'identifiant unique du locataire qui a généré l'événement.
NomLocataire	string	Nom du locataire qui a généré l'événement.
NomDossier	string	Nom du dossier Orchestrator dans lequel l'événement a été généré.
FullFolderPath	string	Si un dossier est un sous-dossier d'un autre dossier, ce champ affiche le chemin d'accès complet.
FolderKey	Guid	L'identifiant unique du dossier.

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

Événements relatifs aux tâches

Nom	Saisie de texte	Description
Clé (Key)	Guid	Identificateur unique d'une tâche.
Heure de création	timestamp	Horodatage de la création de la tâche.
StartTime	timestamp	Horodatage du démarrage de la tâche.
EndTime	timestamp	Horodatage de la fin de la tâche.
État (State)	string	L'état de la tâche. Valeurs prises en charge : Pending Running Stopping Terminating Faulted Successful Stopped Suspended Resumed
ProcessName	string	Nom du package à partir duquel la tâche a été créée.
DisplayName	string	Nom fourni à un processus dans Orchestrator.
Nom du Robot (RobotName)	string	Nom du robot exécutant la tâche.
Nom de la machine hôte	string	Machine sur laquelle la tâche est exécutée.

{
    "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 ...
}

Événements liés aux éléments de la file d'attente

Nom	Saisie de texte	Description
QueueItem	Object JSON
Clé (Key)	Guid	Un identificateur unique de l'élément de la file d'attente.
QueueDefinitionId	number	Identificateur numérique d'une file d'attente à laquelle appartient l'élément de file d'attente.
État (Status)	string	Le statut de l'élément de file d'attente. Valeurs prises en charge : New InProgress Failed Successful Abandoned Retried Deleted Unknown
État de révision (ReviewStatus)	string	Le statut révision de l'élément de file d'attente. Valeurs prises en charge : None InReview Verified Retried Unknown
DueDate	datetime	Date et heure maximales auxquelles l'élément doit être traité.
Priorité (Priority)	string	La priorité de l'élément de la file d'attente. Valeurs prises en charge : High Normal Low Unknown
Heure de création	datetime	Horodatage de la création de l'élément de file d'attente.
Démarrer le traitement (StartProcessing)	datetime	Horodatage du début du traitement de l'élément de la file d'attente.
Terminer le traitement (EndProcessing)	datetime	Horodatage de la fin du traitement de l'élément de la file d'attente (avec succès ou non).
DefferDate	datetime	Date et heure les plus anciennes auxquelles l'élément doit être disponible pour le traitement. Si vide, l'élément peut être traité dès que possible.
SecondsInPreviousAttempts	number	Nombre de secondes pendant lesquelles la dernière tentative de traitement ayant échoué a duré.
Nombre de nouvelles tentatives (RetryNumber)	number	Le nombre de fois que cet élément de file d'attente a été traité.
Progression (Progress)	string	String filed added by developers in UiPath Studio which is used to keep track on the business flow progress.
Données d'analyse	string	A collection of key-value pairs containing the data from the Analytics property added by developers in Studio via the Set Transaction Status activity.
Sortie	string	A collection of key-value pairs containing the data from the Output property added by developers in Studio via the Set Transaction Status activity.
Données spécifiques (SpecificData)	string	Collection des paires clé-valeur contenant les données de la propriété Specific Content ajoutées par les développeurs dans Studio via l'activité Set Transaction Status . Une collection de paires clé-valeur contenant des données personnalisées configurées dans l'activité Ajouter un élément de file d'attente dans UiPath Studio.
CreatorJobId	number	ID de la tâche qui a créé l'élément de file d'attente.
ExecutorJobId	number	L'ID de la tâche qui a exécuté l'élément de file d'attente.
ProcessExceptionReason	string	Résumé de la raison pour laquelle le traitement de l'élément de file d'attente a échoué.
ProcessExceptionDetails	string	Détails supplémentaires sur l'échec de l'élément de file d'attente.
ProcessExceptionType	string	Pour les éléments de file d'attente qui se sont terminés avec une erreur, ce champ décrit le type d'erreur (exception). Valeurs prises en charge : ApplicationException BusinessException None
File d'attente (Queue)	Object JSON
Clé (Key)	Guid	Un identificateur unique de l'élément de la file d'attente.
Nom	string	Le nom de la file d'attente.
Description	string	Informations supplémentaires sur une file d'attente afin de mieux l'identifier.
MaxNumberOfRetries	number	Nombre de nouvelles tentatives d'un élément de cette file d'attente en cas d'échec de son traitement.
EnforceUniqueReference	boolean	Indique si le champ Item Reference doit être unique par élément de file d'attente.
SlaInMinutes	number	Valeur entière représentant le SLA de la file d'attente en minutes.
RiskSlaInMinutes	number	Valeur entière représentant le SLA Risque de file d'attente en minutes.

{
    "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 ...
}

Événements de session de machine

Nom	Saisie de texte	Description
MachineKey	Guid	Identifiant unique de la machine.
Nom de machine (Machine Name)	string	Nom personnalisé de la machine.
Nom de la machine hôte	string	Nom de la machine hôte mappée à la machine UiPath.
Nom d'utilisateur du service	string	Nom de l'utilisateur sous lequel le service Robot sur la machine s'exécute.
Statut de la machine	string	Statut de la machine. Valeurs prises en charge : Available Busy Disconnected Unknown
Horodatage	datetime	Horodatage de l'événement de session de machine.
IsUnresponsive	boolean	Une vérification pour voir si la machine répond à la connexion à partir d'Orchestrator. Valeurs prises en charge : true false Une machine peut toujours être disponible mais ne répond pas. Une fois qu'il ne répond pas pendant dix minutes, il devient déconnecté ou inconnu.

{
    "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 ...
}

Événements de machine

Nom	Saisie de texte	Description
AutomationCloudSlots	number	Nombre d’emplacements Automation Cloud<b>TM</b> à réserver au moment du runtime.
HeadlessSlots	number	Nombre d'emplacements Headless à réserver au moment de l'exécution.
Id de la machine	number	ID entier de machine, unique par instance Orchestrator.
MachineKey	Guid	Identifiant unique d'une machine.
Nom de machine (Machine Name)	string	Nom personnalisé de la machine.
NonProductionSlots	number	Nombre d'emplacements NonProduction à réserver au moment de l'exécution.
UnattendedSlots	number	Nombre d'emplacements Unattended à réserver au moment de l'exécution.

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

Événements d'attribution de machine

Nom	Saisie de texte	Values
MachineKey	Guid	Identifiant unique d'une machine.
Nom de machine (Machine Name)	string	Nom personnalisé de la machine.

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

Journal des évènements du Robot

Nom	Saisie de texte	Description
FileName	string	Le nom du fichier .xaml en cours d'exécution.
InitiéPar (initiatedBy)	string	La source de l’exécution. Valeurs possibles : Assistant Studio StudioX StudioPro Orchestrator CommandLine RobotAPI
JobId	string/guid	Le JobKey, un identifiant unique pour la tâche.
Niveau (Level)	string	Niveau de journalisation du journal. Valeurs possibles : Trace Info Warn Error Fatal
TypeJournal	string	Type de journal du robot. Valeurs possibles : User Default Error Business ExecutionStep BusinessIteration Info Security Technical
Id de la machine	number	ID entier de machine, unique par instance Orchestrator.
Nom de machine (Machine Name)	string	Nom personnalisé de la machine.
Message	string	Le message du journal du robot. Valeurs possibles: execution started execution ended Message personnalisé
ProcessName	string	Le nom du processus que le robot exécute.
Version du processus	string	Version du processus.
Nom du Robot (RobotName)	string	Le nom du Robot.
Identité Windows	string	Nom de l'utilisateur qui a effectué l'action consignée.
ProcessingExceptionReason	string	Raison de l'exception. Présent uniquement dans les journaux de fin de transaction.
Type d'exception de traitement	string	Type de l'exception. Présent uniquement dans les journaux de fin de transaction. Valeurs possibles : ApplicationException BusinessException
queueItemPriority	string	La priorité de l'élément de la file d'attente. Présent uniquement dans les journaux de fin de transaction. Valeurs possibles: High Normal Low
queueItemReviewStatus	string	Le statut révision de l'élément de file d'attente. Présent uniquement dans les journaux de fin de transaction. Valeurs possibles: InReview Verified Reported Retried
QueueName	string	Le nom de la file d'attente à partir de laquelle le Robot exécute les éléments de la file d'attente.
Délai d'exécution de la transaction (Transaction Execution Time)	number	Durée d'exécution en secondes de la transaction. Ne contient des valeurs que lors du traitement des éléments de la file d'attente.
Id de la transaction	string/Guid	La clé unique de la transaction. Ne contient des valeurs que lors du traitement des éléments de la file d'attente.
transactionState	string	L'état de la transaction. Ne contient des valeurs que lors du traitement des éléments de la file d'attente. Valeurs possibles : Started Ended Postponed
transactionStatus	string	Le statut de la transaction. Ne contient des valeurs que lors du traitement des éléments de la file d'attente. Valeurs possibles: ApplicationException Start SystemError Failed BusinessException Success InProgress
totalExecutionTimeInSeconds	number	Le temps d'exécution de la transaction, mesuré en secondes. Ne contient des valeurs que lors du traitement des éléments de la file d'attente.
InfoActivité	JSON	Informations sur l'activité JSON contenant DisplayName, State (Faulted, Closedou Executing), Activityet Arguments.
Horodatage	datetime	Heure à laquelle l’événement a été généré.
MachineKey	Guid	Identifiant unique de la machine exécutant la tâche.
Champs personnalisés	JSON	A JSON that contains the fields defined in the AddLogFields activity in 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 ...
    },
}