UIP UiPath Apps-Datenmodell, UIP UiPath Apps-Modell

Syntax und Optionen für die Bearbeitung des strukturierten Datenmodells und semantischen Modells einer Process Mining-App – Tabellen, Felder, Dashboards und Metriken – mit „uip UiPath Apps Data-Model“ und „Uip UiPath Apps Model“.

Teil des Tools uip pm . Diese Seite behandelt die beiden Modellbearbeitungsoberflächen für eine Prozess-App:

• apps data-model – das strukturelle Tabellendiagramm: Welche Tabellen vorhanden sind, ihre Primär-/Fälleschlüssel und wie sie mit Cases verbunden werden.
• apps model – Das semantische Modell: Felder und deren Datenarten, berechnete Felder, Dashboards und Metriken. Enthält fields-, dashboards- und metrics -Untergruppen für gezielte Bearbeitungen sowie get/update für das gesamte Dokument.
• apps data-mapping – Die Eingabedatenzuordnung der App: Welche Quelltabelle/-spalte feeds welches Zielfeld. Unterscheiden Sie sich vom obigen Datenmodell (das ist das abfragebare Tabellendiagramm nach der Zuordnung).

Jeder Schreibvorgang ist ETag-geschützt – siehe Konzepte auf der übergeordneten Seite.

Zusammenfassung

uip pm apps data-model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps data-model add-table <app-id> --file <json-file> [--stage dev|published]

uip pm apps model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps model update <app-id> --file <json-file> --etag <etag>

uip pm apps model fields list <app-id> [--stage dev|published]
uip pm apps model fields set <app-id> <field-id> [--kind <kind>] [--display-name <text>] [--expression <json>] [--table <table-id>]
uip pm apps model fields remove <app-id> <field-id>

uip pm apps model dashboards list <app-id> [--stage dev|published]
uip pm apps model dashboards get <app-id> [--dashboard <id-or-name>] [--stage dev|published] [--destination <file>]
uip pm apps model dashboards update <app-id> [--file <json-file>] [--metrics <json-file>] --etag <etag> [--dashboard <id-or-name>]

uip pm apps model metrics list <app-id> [--stage dev|published]

uip pm apps data-mapping get <app-id> [--stage dev] [--destination <file>]
uip pm apps data-mapping update <app-id> --file <json-file> --etag <etag> [--stage dev]

Abrufen des Datenmodells für UIP-PM-Apps

Rufen Sie das Strukturdatenmodell der App ab (Tabellen mit Primär-/ Fremdschlüsseln und Spaltenrollen). Gibt das ETag des Modells als Referenz zurück; add-table selbst benötigt kein --etag, da es die eigene Änderung erneut liest und zusammenführt.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.

Optionen

Long	Wert	Standard	Beschreibung
--stage <stage>	dev | published	dev	App-Phase.
--destination <local-file>	Pfad	–	Schreiben Sie die Modell-JSON in diese Datei anstelle des Ausgabeumschlags.

Datenform (--output json)

{ "Code": "PmAppsDataModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

Destination ersetzt Model, wenn --destination übergeben wird.

UIP PM Apps Datenmodell Add-Table

Registrieren Sie ein benutzerdefiniertes dbt-Modell als abfragebare Datenmodelltabelle. Process Mining ist fallzentriert: Eine abfragebare Tabelle muss der Cases -Stamm oder ein Link dazu sein – geben Sie der Tabelle eine (null-fähige) Case_ID -Spalte mit einem Fremdschlüssel zu Cases, um eine eigenständige analytische Tabelle lose zu verknüpfen. Danach erneut erfassen, um es zu Ressourcen2 zu Ressourcen. Akzeptiert kein --etag: Es liest das aktuelle Datenmodell selbst und wird mit genau diesem Dokument zusammengeführt, sodass ein Schreibvorgang zwischen Konflikten und dem Befehl einfach erneut ausgeführt wird.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file <json-file>	Pfad	ja	JSON mit den hinzuzufügenden Tabellen – eine einzelne Datenmodelltabelle, ein Array oder ein { tables } -Objekt. Jeder: { name, primaryKey, foreignKeys: [{ table: "Cases", column: "Case_ID" }] } (type wird standardmäßig auf "Object" festgelegt).
--stage <stage>	dev | published	nein	Der Standardwert ist dev.

Eine Tabelle wird mit name abgeglichen: Ein vorhandener Eintrag wird ersetzt, ein neuer angefügt.

Beispiel

uip pm apps data-model add-table 9c46289e --file ./Workload_weekly.table.json

Datenform (--output json)

{
  "Code": "PmAppsDataModelAddTable",
  "Data": {
    "AppId": "9c46289e",
    "AddedTables": ["Workload_weekly"],
    "IngestionNeeded": true,
    "Instructions": "Re-ingest to materialize the table(s): uip pm ingestions create 9c46289e --wait — then query them. Run 'uip pm apps publish 9c46289e' to push to dashboards."
  }
}

Schlägt mit einer Ablehnung im UserError_TableIsDeleted-Stil auf der Abfrageebene fehl, wenn die Tabelle keinen Pfad zu Cases hat. Ein namensloser Tabelleneintrag oder eine Datei ohne nutzbare Tabelle schlägt auf der Clientseite vor jedem Schreibvorgang fehl.

Abrufen des UIP-Apps-Modells

Rufen Sie das semantische Modell der App ab (Felder mit Datenarten, berechnete Felder, Metriken und die Dashboardansicht) – die Form, die update annimmt. Gibt das ETag des Modells zurück, das model update als --etag benötigt.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.

Optionen

Long	Wert	Standard	Beschreibung
--stage <stage>	dev | published	dev	App-Phase.
--destination <local-file>	Pfad	–	Schreiben Sie die Modell-JSON in diese Datei anstelle des Ausgabeumschlags.

Datenform (--output json)

{ "Code": "PmAppsModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

Aktualisierung des UIP-Apps-Modells

Ersetzen Sie das gesamte App-Modell durch eine lokale JSON-Datei. Gilt nur für die Entwicklung. Bevorzugen Sie für ein einzelnes Feld apps model fields set, das bearbeitet wird; Ein vollständiger Ersatz muss das ETag des model get enthalten, aus dem es geschrieben wurde – das Abrufen eines neuen ETags hier würde die Gleichzeitigkeitsprüfung zunichte machen.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file <json-file>	Pfad	ja	Lokale JSON-Datei mit dem vollständigen Modell (wie von model get zurückgegeben).
--etag <etag>	string	ja	ETag des Modells, auf dem diese Bearbeitung basiert.

Datenform (--output json)

{ "Code": "PmAppsModelUpdate", "Data": { "AppId": "9c46289e", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

Eine veraltete --etag schlägt mit einem Konflikt fehl – lesen Sie sie erneut über model get, wiederholen Sie die Bearbeitung und versuchen Sie es erneut. Ein UnsupportedOperatorArgumentDataKind -Fehler bedeutet, dass ein Dashboard-Filter, ein berechnetes Feld oder ein Metrikschwellenwert ein Feld immer noch mit einer Konstante seiner alten Datenart vergleicht – korrigieren oder entfernen Sie diesen Vergleich, bevor Sie die Art ändern.

Liste der UIP-PM-Apps-Modellfelder

Listen Sie jedes Feld in den Tabellen der App mit seiner Datenart auf und geben Sie an, ob es sich um eine zugeordnete Spalte oder ein berechnetes Feld handelt.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.

Optionen

Long	Wert	Standard	Beschreibung
--stage <stage>	dev | published	dev	App-Phase.

Datenform (--output json)

{ "Code": "PmAppsFieldsList", "Data": [{ "Table": "Cases", "Id": "Case_status", "Display": "Status", "Kind": "nominal", "Type": "column" }] }

Type ist "column" (Zuordnung) oder "calculated".

UIP-PM-Apps-Modellfelder festgelegt

Erstellen oder bearbeiten Sie ein Feld (ETag-intern sicher – liest und führt seine eigene Basis zusammen). Ändern Sie die Datenart, benennen Sie sie um oder wandeln Sie es in ein berechnetes Feld um.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.
<field-id>	ja	Feld-ID.

Optionen

Long	Wert	Beschreibung
--kind <kind>	ordinal|nominal|numeric|datetime|boolean|percentage|currency|duration	Datenart. (id/ref sind strukturell und nicht konfigurierbar.)
--display-name <text>	string	Anzeigename.
--expression <json>	JSON (inline oder @file.json)	Ausdrucksknoten für berechnetes Feld. Wenn Sie diese angeben, wird das Feld zu einem berechneten Feld.
--table <table-id>	string	Zieltabelle – nur beim Erstellen eines neuen Felds erforderlich.

Mindestens eines von --kind/--display-name/--expression ist erforderlich. Das Erstellen eines Felds erfordert --table, --expression und --kind. zugeordnete Spalten können nicht auf diese Weise erstellt werden (sie stammen aus erfassten Daten). Das Festlegen von --expression für eine vorhandene zugeordnete Spalte wird abgelehnt – erstellen Sie stattdessen ein neues berechnetes Feld mit einer anderen ID. Eine Erstellung, deren ID mit einem Feld in einer anderen Tabelle kollaboriert, wird abgelehnt, anstatt dieses Feld im Hintergrund zu bearbeiten.

Beispiel

uip pm apps model fields set 9c46289e Case_status --kind ordinal

Datenform (--output json)

{ "Code": "PmAppsFieldsSet", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Action": "updated", "Table": "Cases", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

Action ist "created" oder "updated".

UIP-PM-Apps-Modellfelder werden entfernt

Entfernt ein Feld aus dem Modell.

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.
<field-id>	ja	Feld-ID.

Datenform (--output json)

{ "Code": "PmAppsFieldsRemove", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Table": "Cases", "Versions": [4], "Instructions": "..." } }

UIP PM Apps Modell-Dashboards

Die Dashboard-seitige Ansicht desselben Modelldokuments model get/update Round Trip – list/get/update Arbeit an view.dashboards.

UIP PM Apps Modell-Dashboards-Liste

Listen Sie die Dashboards einer Prozess-App auf.

Name/Option	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.
--stage <stage>	nein	dev | published.Standardmäßig dev.

{ "Code": "PmAppsDashboardsList", "Data": [{ "Id": "overview", "Name": "Overview", "Layout": "three-left-one-right", "Charts": 4, "Metrics": 5, "IsVisible": true }] }

Charts ist die vereinfachte Anzahl der Diagramm-ID-Matrix des Dashboards.

Abrufen von UIP-PM-Apps-Modelldashboards

Rufen Sie die Dashboards einer Prozess-App mit den ETag-Anforderungen für update ab.

Long	Wert	Beschreibung
--stage <stage>	dev|published	Der Standardwert ist dev.
--dashboard <id-or-name>	string	Nur dieses Dashboard anstelle des gesamten Abschnitts view zurückgeben. Zuerst nach ID, dann nach dem genauen Namen – ein mehrdeutiger Name (mehrere Dashboards teilen es) schlägt fehl und Sie werden aufgefordert, nach ID auszuwählen.
--destination <local-file>	Pfad	Schreiben Sie JSON in diese Datei anstelle des Umschlags.

uip pm apps model dashboards get 9c46289e --dashboard 'Overview' --destination ./dashboard.json

{ "Code": "PmAppsDashboardsGet", "Data": { "Dashboard": "Overview", "ETag": "W/\"3\"", "Destination": "./dashboard.json" } }

Aktualisierung der Dashboards des UIP-PM-Apps-Modells

Aktualisieren Sie die Dashboards einer Prozess-App aus einer lokalen JSON-Datei. Nur Entwicklungsphase.

Long	Wert	Erforderlich	Beschreibung
--file <local-file>	Pfad	Nein*	Ein Dashboard, wenn --dashboard angegeben ist, andernfalls der gesamte Abschnitt view.
--metrics <local-file>	Pfad	Nein*	JSON-Array von Metrikdefinitionen, die durch ID hinzugefügt oder ersetzt werden sollen – geschrieben in derselben Anforderung wie --file, sodass ein eingeführtes Diagramm auf eine Metrik verweisen kann, die im selben Schreibvorgang hinzugefügt wurde.
--etag <etag>	string	ja	ETag des Modells, auf dem diese Bearbeitung basiert.
--dashboard <id-or-name>	string	nein	Welches Dashboard --file ersetzt – erfordert --file; Die Übergabe ohne --file wird abgelehnt.

* Mindestens eines von --file/--metrics ist erforderlich.

uip pm apps model dashboards update 9c46289e --dashboard 'Overview' --file ./dashboard.json --etag 'W/"3"'

{ "Code": "PmAppsDashboardsUpdate", "Data": { "Dashboard": "Overview", "Versions": [4], "Instructions": "Saved on dev. Run 'uip pm apps publish 9c46289e' to push the change to the dashboards; if the publish reports IngestionNeeded, re-ingest with 'uip pm ingestions create 9c46289e --wait'." } }

Liste der UIP-PM-Apps mit Modellmetriken

Listen Sie die Metriken aus dem Datenmodell der App auf, auf die ein Diagramm verweisen kann. Fügen Sie eine hinzu oder ersetzen Sie sie durch dashboards update --metrics.

Name/Option	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.
--stage <stage>	nein	dev|published.Standardmäßig dev.

{ "Code": "PmAppsMetricsList", "Data": [{ "Id": "avg_throughput", "Display": "Avg. throughput", "Aggregation": "AVERAGE", "Argument": "Case_throughput_time" }] }

Abrufen der Datenzuordnung für UIP UiPath Apps

Rufen Sie die Eingabedatenzuordnung der App ab – die gleiche Form hat apps create --data-mapping, sodass sie mit data-mapping update bearbeitet und zurückgesetzt werden kann. Gibt das ETag der Zuordnung, das diese Aktualisierung benötigt, als --etag zurück.

Long	Wert	Standard	Beschreibung
--stage <stage>	dev | published	dev	Zu lesende App-Phase.
--destination <local-file>	Pfad	–	Schreiben Sie die Zuordnungs-JSON in diese Datei anstelle des Ausgabeumschlags.

uip pm apps data-mapping get 9c46289e --destination ./mapping.json

{ "Code": "PmAppsDataMappingGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"639204059477096903\"", "Destination": "./mapping.json" } }

Aktualisierung der Datenzuordnung für UIP UiPath Apps

Ersetzen Sie die Eingabedatenzuordnung der App durch eine lokale JSON-Datei (ETag-Safe) – korrigieren Sie eine falsche Zuordnung, anstatt die App neu zu erstellen. Wird bei der nächsten Erfassung angewendet Im Gegensatz zu einer Transformationskorrektur regelt eine Zuordnungsänderung, wie die Rohdatei analysiert wird, sodass transformations apply sie nicht rückwirkend anwenden kann.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file <json-file>	Pfad	ja	Vollständige Eingabedatenzuordnung ({ "Tables": [...] }) – ersetzt die gespeicherte Zuordnung direkt. Dieselbe Standardeinstellung pro Feld wie bei apps create --data-mapping.
--etag <etag>	string	ja	ETag der Zuordnung, auf der diese Bearbeitung basiert.
--stage <stage>	dev	nein	Nur dev ist beschreibbar – das Backend stellt GET in beiden Phasen bereit, akzeptiert aber nur das Schreiben für die Entwicklung.

uip pm apps data-mapping update 9c46289e --file ./mapping.json --etag 'W/"639204059477096903"'

{ "Code": "PmAppsDataMappingUpdate", "Data": { "AppId": "9c46289e", "Tables": ["Event_log"], "IngestionNeeded": true, "Instructions": "Re-ingest for the new mapping to take effect: uip pm ingestions create 9c46289e --wait. Re-upload first (uip pm files upload) only if the source columns changed." } }

Eine veraltete --etag schlägt mit einem Konflikt fehl – lesen Sie sie erneut über data-mapping get, wiederholen Sie die Bearbeitung und versuchen Sie es erneut. Eine Zuordnungsdatei ohne Tabellen schlägt auf der Clientseite fehl, anstatt die Zuordnung der App zu löschen.

Zugehörig

• uip pm – Übersicht und apps CRUD.
• ingestions & transformations – eine Datenmodell- oder Feldänderung ausführen.
• conformance, deviations und query – analysieren Sie die resultierenden Daten.

Siehe auch

• Globale Optionen
• Exitcodes