Insights
2023.4
False
Echtzeit-Datenexport-Datenmodell - Automation Suite 2023.4
Logo
Insights
Letzte Aktualisierung 3. Nov. 2023

Echtzeit-Datenexport-Datenmodell

Überblick

Jede Änderung im System wird durch ein ereignisprotokolliertes JSON-Format dargestellt.

Die folgenden Ereignistypen werden unterstützt:

  • Ereignisse, die Aufträge beschreiben:

    • job.created
    • job.started
    • job.stopped
    • job.pending
    • job.completed
    • job.faulted
    • job.stopping
    • job.terminating
  • Ereignisse, die Warteschlangenelemente beschreiben:

    • queueitem.added
    • queueItem.retried
    • queueItem.updated
    • queueItem.transactionAbandoned
    • queueItem.transactionCompleted
    • queueItem.transactionFailed
    • queueItem.transactionRetried
    • queueItem.transactionStarted
  • Ereignisse, die Maschinen beschreiben:

    • machine.created
    • machine.updated
    • machine.deleted
    • machineSession.status
    • machine.assign
    • machine.unassign

Da verschiedene Ereignisse verschiedene Entitäten und Änderungen am System beschreiben, haben sie unterschiedliche Inhalte (JSON-Felder).

Format und Schema von Ereignissen

Jedes Ereignis wird im JSON-Format bereitgestellt und hat Folgendes:

  • Ereignisspezifischer Textkörper
  • Allgemeine Felder
  • Metadata

Zum besseren Verständnis sehen Sie sich das folgende Beispiel für ein job.created -Ereignis an. Das Beispiel ist aus Gründen der Lesbarkeit mit neuen Zeilen und Kommentaren formatiert, die jeden Abschnitt beschreiben. Reale Ereignisse haben diese Formatierung nicht und werden als einzeilige Zeichenfolge bereitgestellt.

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

Allgemeine Felder

Allgemeine Felder werden in jedem Ereignis angezeigt.

Name

Typ

Beschreibung

Ereignistyp

string

Der Typ des Ereignisses.

SchemaVersion

string

Die Version des Schemas. Unterschiedliche Versionen können unterschiedliche Ereignistypen und unterstützte Felder haben.

Zeitstempel

timestamp

UTC-Zeitstempel des Ereignisses.

TenantKey

Guid

Der eindeutige Bezeichner des Mandanten, der das Ereignis generiert hat.

Mandantenname

string

Name des Mandanten, der das Ereignis generiert hat.

Ordnername

string

Name des Orchestrator-Ordners, in dem das Ereignis generiert wurde.

FullFolderPath

string

Wenn ein Ordner ein Unterordner eines anderen Ordners ist, zeigt dieses Feld den vollständigen Pfad an.

FolderKey

Guid

Die eindeutige Kennung des Ordners.

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

Job-Ereignisse

Name

Typ

Beschreibung

Schlüssel

Guid

Eindeutiger Bezeichner eines Auftrags.

Erstellungszeit

timestamp

Zeitstempel, wann der Auftrag erstellt wurde.

StartTime

timestamp

Zeitstempel, wann der Auftrag gestartet wurde.

EndTime

timestamp

Zeitstempel, wann der Auftrag abgeschlossen wurde.

Status (State)

string

Der Status des Auftrags. Unterstützte Werte:

Pending

Running

Stopping

Terminating

Faulted

Successful

Stopped

Suspended

Resumed

ProcessName

string

Name des Pakets, aus dem der Auftrag erstellt wurde.

DisplayName

string

Name, der einem Prozess im Orchestrator bereitgestellt wird.

RoboterName (RobotName)

string

Name des Roboters, der den Auftrag ausführt.

Name der Hostmaschine

string

Maschine, auf der der Auftrag ausgeführt wird.

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

QueueItem-Ereignisse

Name

Typ

Beschreibung

     

Warteschlangenelement

JSON-Objekt

 
     

Schlüssel

Guid

Eindeutiger Bezeichner des Warteschlangenelements.

ID Warteschlangendefinition (QueueDefinitionId)

number

Numerischer Bezeichner einer Warteschlange, zu der das Warteschlangenelement gehört.

Status

string

Der Status des Warteschlangenelements. Unterstützte Werte:

New

InProgress

Failed

Successful

Abandoned

Retried

Deleted

Unknown

Status überprüfen (Review Status)

string

Der Überprüfungsstatus des Warteschlangenelements. Unterstützte Werte:

None

InReview

Verified

Retried

Unknown

Fälligkeitsdatum (DueDate)

datetime

Spätestes Datum und Uhrzeit, zu der das Element verarbeitet werden soll.

Priorität

string

Die Priorität des Warteschlangenelements. Unterstützte Werte:

High

Normal

Low

Unknown

Erstellungszeit

datetime

Zeitstempel, wann das Warteschlangenelement erstellt wurde.

Verarbeitung starten (StartProcessing)

datetime

Zeitstempel, wann die Verarbeitung des Warteschlangenelements gestartet wurde.

Verarbeitung beenden (EndProcessing)

datetime

Zeitstempel, wann das Warteschlangenelement die Verarbeitung abgeschlossen hat (erfolgreich oder nicht).

DefferDate

datetime

Geben Sie das früheste Datum und die früheste Uhrzeit ein, zu der die Transaktion für die Verarbeitung verfügbar sein sollte. Ist das Objekt leer, kann es baldmöglichst bearbeitet werden.

SecondsInPreviousAttempt

number

Die Anzahl der Sekunden, die der letzte fehlgeschlagene Verarbeitungsversuch gedauert hat.

Wiederholungsanzahl (RetryNumber)

number

Die Häufigkeit, mit der dieses Warteschlangenelement verarbeitet wurde.

Fortschritt

string

Von Entwicklern in UiPath Studio hinzugefügte Zeichenfolge, die verwendet wird, um den Fortschritt des Geschäftsablaufs zu verfolgen.

Analysedaten

string

Eine Sammlung von Schlüssel-Wert-Paaren, die die Daten aus der Eigenschaft Analytics enthält, die von Entwicklern in Studio über die Aktivität Set Transaction Status hinzugefügt wurde.

Ausgabe

string

Eine Sammlung von Schlüssel-Wert-Paaren, die die Daten aus der Eigenschaft Output enthält, die von Entwicklern in Studio über die Aktivität Set Transaction Status hinzugefügt wurde.

Spezielle Daten (SpecificData)

string

Eine Sammlung von Schlüssel-Wert-Paaren, die die Daten aus der Eigenschaft Specific Content enthält, die von Entwicklern in Studio über die Aktivität Set Transaction Status hinzugefügt wurde.

Eine Sammlung von Schlüssel-Wert-Paaren mit benutzerdefinierten Daten, die in der Aktivität Warteschlangenelement hinzufügen in . konfiguriert sind

UiPath Studio.

CreatorJobId

number

Die ID des Auftrags, der das Warteschlangenelement erstellt hat.

ExecutorJobId

number

Die ID des Auftrags, der das Warteschlangenelement ausgeführt hat.

ProcessExceptionReason

string

Zusammenfassung des Grundes, warum die Verarbeitung des Warteschlangenelements fehlgeschlagen ist.

ProcessExceptionDetails

string

Zusätzliche Details zum Fehler des Warteschlangenelements.

ProcessExceptionType

string

Bei Warteschlangenelementen, die mit einem Fehler beendet wurden, beschreibt dieses Feld den Fehlertyp (Ausnahme). Unterstützte Werte:

ApplicationException

BusinessException

None

     

Warteschlange

JSON-Objekt

 
     

Schlüssel

Guid

Eindeutiger Bezeichner der Warteschlange.

Name

string

Der Name der Warteschlange.

Beschreibung

string

Zusätzliche Informationen zu einer Warteschlange, um sie besser zu identifizieren.

MaxNumberOfRetries

number

Die Häufigkeit, mit der ein Element dieser Warteschlange wiederholt werden kann, wenn seine Verarbeitung fehlschlägt.

EnforceUniqueReference

boolean

Gibt an, ob das Feld Item Reference pro Warteschlangenelement eindeutig sein soll.

SlaInMinutes

number

Integer-Wert, der das Warteschlangen-SLA in Minuten darstellt.

RiskSlaInMinutes

number

Integer-Wert, der das SLA für das Warteschlangenrisiko in Minuten darstellt.

     

Roboter

JSON-Objekt

 
     

Schlüssel

Guid

Eindeutiger Bezeichner, der jedem Roboter zugeordnet ist.

Name

name

Name, der dem Roboter zugewiesen wurde.

UserName

string

Der Benutzername der Maschine. Wenn sich der Benutzer in einer Domäne befindet, müssen Sie ihn auch im Format DOMAIN/username angeben.

Typ

string

Der Typ eines Roboters, der dieses Warteschlangenelement verarbeitet hat. Unterstützte Werte:

NonProduction

Attended

Unattended

Studio

StudioX

Headless

StudioPro

TestAutomation

Other

{
    "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
        },
        "Robot": {
            "Key": "<robot-key>",
            "Name": "<robot-name>",
            "UserName": "<username>",
            "Type": "Unattended"
        }
    },
    ... common fields ...
}{
    "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
        },
        "Robot": {
            "Key": "<robot-key>",
            "Name": "<robot-name>",
            "UserName": "<username>",
            "Type": "Unattended"
        }
    },
    ... common fields ...
}

Maschinensitzungsereignisse

Name

Typ

Beschreibung

MachineKey

Guid

Eindeutiger Bezeichner der Maschine.

Maschinenname

string

Benutzerdefinierter Name der Maschine.

Name der Hostmaschine

string

Name der Hostmaschine, die der UiPath-Maschine zugeordnet ist.

Dienstbenutzername

string

Name des Benutzers, unter dem der Roboterdienst auf der Maschine ausgeführt wird.

Maschinenstatus

string

Status der Maschine. Unterstützte Werte:

Available

Busy

Disconnected

Unknown

Zeitstempel

datetime

Zeitstempel des Maschinensitzungsereignisses.

IsUnresponsive

boolean

Eine Überprüfung, ob die Maschine auf die Verbindung vom Orchestrator reagiert. Unterstützte Werte:

true

false

Eine Maschine kann weiterhin verfügbar sein, aber nicht mehr reagieren. Wenn sie zehn Minuten lang nicht reagiert, wird die Verbindung getrennt oder ist unbekannt.

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

Maschinenereignisse

Name

Typ

Beschreibung

AutomationCloudSlots

number

Anzahl der Automation Cloud-<b>TM</b> -Slots, die zur Laufzeit reserviert werden sollen.

HeadlessSlots

number

Anzahl der Headless-Slots, die zur Laufzeit reserviert werden sollen.

Maschinen-ID

number

Ganzzahlige Maschinen-ID, die pro Orchestrator-Instanz eindeutig ist.

MachineKey

Guid

Eindeutiger Bezeichner einer Maschine.

Maschinenname

string

Benutzerdefinierter Name der Maschine.

NonProductionSlots

number

Anzahl der NonProduction Slots, die zur Laufzeit reserviert werden sollen.

UnattendedSlots

number

Anzahl der Unattended Slots, die zur Laufzeit reserviert werden sollen.

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

Maschinenzuweisungsereignisse

Name

Typ

Values

MachineKey

Guid

Eindeutiger Bezeichner einer Maschine.

Maschinenname

string

Benutzerdefinierter Name der Maschine.

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

Roboter-Protokolle

Name

Typ

Beschreibung

FileName

string

Der Name der Datei .xaml, die ausgeführt wird.

initiatedBy

string

Die Quelle der Ausführung. Mögliche Werte:

Assistant

Studio

StudioX

StudioPro

Orchestrator

CommandLine

RobotAPI

JobId

string/guid

Der JobKey, ein eindeutiger Bezeichner für den Auftrag.

Ebene

string

Protokollierungsebene des Protokolls. Mögliche Werte:

Trace

Info

Warn

Error

Fatal

LogType

string

Der Typ des Roboterprotokolls. Mögliche Werte:

User

Default

Error

Business

ExecutionStep

BusinessIteration

Info

Security

Technical

Maschinen-ID

number

Ganzzahlige Maschinen-ID, die pro Orchestrator-Instanz eindeutig ist.

Maschinenname

string

Benutzerdefinierter Name der Maschine.

Meldung

string

Die Meldung des Roboterprotokolls. Mögliche Werte:

execution started

execution ended

• benutzerdefinierte Nachricht

ProcessName

string

Der Prozessname, den der Roboter ausführt.

Prozessversion

string

Die Version des Prozesses.

RoboterName (RobotName)

string

Der Name des Roboters.

Windows-Identität

string

Der Name des Benutzers, der die protokollierte Aktion durchgeführt hat.

Grund für Verarbeitungsausnahme

string

Der Grund für die Ausnahme. Nur in Transaktionsendeprotokollen vorhanden.

Der Typ Verarbeitungsausnahme

string

Der Typ der Ausnahme. Nur in Transaktionsendeprotokollen vorhanden. Mögliche Werte:

ApplicationException

BusinessException

queueItemPriority

string

Die Priorität des Warteschlangenelements. Nur in Transaktionsendeprotokollen vorhanden. Mögliche Werte:

High

Normal

Low

queueItemReviewStatus

string

Der Überprüfungsstatus des Warteschlangenelements. Nur in Transaktionsendeprotokollen vorhanden. Mögliche Werte:

InReview

Verified

Reported

Retried

Warteschlangenname (QueueName)

string

Der Name der Warteschlange, aus der der Roboter Warteschlangenelemente ausführt.

Transaktionsausführungszeit

number

Die Ausführungszeit in Sekunden für die Transaktion. Hat nur Werte, wenn Warteschlangenelemente verarbeitet werden.

Transaktions-ID

string/Guid

Der eindeutige Schlüssel der Transaktion. Hat nur Werte, wenn Warteschlangenelemente verarbeitet werden.

transactionState

string

Der Transaktionsstatus. Hat nur Werte, wenn Warteschlangenelemente verarbeitet werden. Mögliche Werte:

Started

Ended

Postponed

transactionStatus

string

Der Transaktionsstatus. Hat nur Werte, wenn Warteschlangenelemente verarbeitet werden. Mögliche Werte:

ApplicationException

Start

SystemError

Failed

BusinessException

Success

InProgress

totalExecutionTimeInSeconds

number

Die Ausführungszeit für die Transaktion, gemessen in Sekunden. Hat nur Werte, wenn Warteschlangenelemente verarbeitet werden.

activityInfo

JSON

Die Aktivitätsinfo-JSON, die DisplayName, State (Faulted, Closedoder Executing), Activityund Argumentsenthält.

Zeitstempel

datetime

Zeitpunkt, zu dem das Ereignis generiert wurde.

MachineKey

Guid

Eindeutiger Bezeichner der Maschine, die den Auftrag ausführt.

Benutzerdefinierte Felder

JSON

Eine JSON, die die Felder enthält, die in der AddLogFields- Aktivität in Studio definiert sind.

{
    "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 ...
    },
}{
    "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 ...
    },
}
Logo
Hilfe erhalten
Logo
RPA lernen – Automatisierungskurse
Logo
UiPath Community-Forum
UiPath Logo weiß
Vertrauen und Sicherheit
© 2005-2023 UiPath. All rights reserved.