UIP-PM

Befehle zum Verwalten von Process Mining-Prozess-Apps, Datenerfassung, Transformationen und Analysen mit dem Tool „uip pm“.

uip pm ist das Process Mining-Tool: Es erstellt und verwaltet Prozess-Apps (abgerufene Prozessmodelle, die aus Ereignisprotokolldaten erstellt wurden), lädt Quelldaten hoch und erfasst sie, führt dbt-Transformationen aus und analysiert das Ergebnis (Konformität mit einem Referenzmodell, akzeptierte Abweichungen). , Ad-hoc-Abfragen). pm ist das Befehlspräfix Das zugrunde liegende Paket ist @uipath/pm-tool.

Eine Prozess-App durchläuft eine Phase dev (wo Sie ihre Struktur erstellen) und eine Phase published (was Dashboards/Verbraucher sehen) – die meisten Verben verwenden --stage dev|published (Standardwert: dev). Jeder Befehl erfordert zuerst uip login.

Diese Ressource umfasst vier Seiten

• Diese Seite – Konzepte, apps (create/list/get/Delete/Publish), app-types, files, simulations.
• apps model – die ETag-geschützte Oberfläche zur Bearbeitung von strukturellen/semantischen Modellen: apps data-model, apps model (get/update/fields/dashboards/metrics).
• ingestions und transformations – lösen Datenladungen und dbt-Builds aus und überprüfen sie.
• conformance, deviations und query – analysieren eine extrahierte App: Konformitätsrate, akzeptierte Abweichungen, Ad-hoc-Datenabfragen.

Konzepte

• ETag-geschützte Schreibvorgänge. Jeder Schreibvorgang in das Datenmodell, semantische Modell oder eine Transformationsdatei einer App erfordert ein --etag aus einer vorherigen get (oder ist selbst ein Lese-Modifikator-Schreib, der seine eigene Basis abruft). Ein veraltetes ETag schlägt mit einem Konflikt fehl; Die Lösung besteht darin, erneut zu lesen, die Bearbeitung zu wiederholen und es erneut zu versuchen – Sie können niemals ein neues ETag erneut abrufen, nur um den Schreibvorgang zu erzwingen, da dies im Hintergrund alles, was sich geändert hat, überlappt.
• Entwicklung vs. veröffentlicht. Strukturelle/semantische Bearbeitungen, Erfassungen und Transformationen gelten nur für dev. apps publish verschiebt das aktuelle Modell des Entwicklers in die veröffentlichte Ebene/Dashboard; apps changes zeigt eine Vorschau an, was verschoben werden würde.
• --wait Abrufe. ingestions create und transformations apply/run akzeptieren --wait (--timeout, Standard- 1800s; --poll-interval, Standard- 5s), um zu blockieren, bis die Ausführung einen Endstatus erreicht, und geben das echte dbt aus /loader-Fehler bei einem Fehler, anstatt einfach zu beenden.

Zusammenfassung

uip pm apps list [--stage dev|published]
uip pm apps get <app-id> [--stage dev|published]
uip pm apps create <name> --type <app-type-key> [--type-version <v>] [--miner directly-follows|inductive|bpmn] [--description <text>] [--data-mapping <json-file>]
uip pm apps delete <app-id> -y
uip pm apps publish <app-id>
uip pm apps changes <app-id>
uip pm apps publications <app-id> [--limit <n>] [--since-version <v>]
uip pm app-types list
uip pm app-types get <app-type-key> <app-type-version>
uip pm files upload <app-id> <file-path> [--stage dev|published] [--input-table <name>]
uip pm simulations list <app-id> [--stage dev|published]

UIP-PM-Apps-Liste

Listen Sie Prozess-Apps auf.

Optionen

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

Beispiel

uip pm apps list

Datenform (--output json)

{ "Code": "PmAppsList", "Data": [{ "Id": "9c46289e", "Name": "Sample dataset" }] }

Abrufen von UIP-PM-Apps

Rufen Sie eine Prozess-App ab: ihren Status, die letzte Erfassung und den Buildstatus.

Argumente

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

Optionen

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

Beispiel

uip pm apps get 9c46289e

Datenform (--output json)

{
  "Code": "PmAppsGet",
  "Data": {
    "Id": "9c46289e",
    "Name": "Sample dataset",
    "AppStatus": "CREATED",
    "LastIngestion": { "Id": "1d7e1421", "Status": "SUCCESS" }
  }
}

UIP-PM-Apps erstellen

Erstellen Sie eine Prozess-App aus einer App-Vorlage (siehe app-types list).

Argumente

Name	Erforderlich	Zweck
<name>	ja	Name der App.

Optionen

Long	Wert	Erforderlich	Beschreibung
--type <app-type-key>	string	ja	App-Vorlagenschlüssel, z. B. uipath.custom).
--type-version <version>	string	nein	Vorlagenversion. Standardmäßig die neueste verfügbare.
--miner <miner>	directly-follows | inductive | bpmn	nein	Process Miner. Der Standardwert ist directly-follows. Nur inductive/bpmn erzeugen ein Referenzmodell, das conformance/deviations benötigen.
--description <text>	string	nein	App-Beschreibung.
--data-mapping <json-file>	Pfad	nein	JSON-Datei mit der Eingabedatenzuordnung (Tabelle/Felder). Fehlende IsNotNull/IsUnique/DataTypeSettings pro Feld werden automatisch standardmäßig angegeben.

Beispiel

uip pm apps create "Sample dataset" --type uipath.custom --data-mapping ./mapping.json

Datenform (--output json)

{
  "Code": "PmAppsCreate",
  "Data": { "AppId": "9c46289e-e2e3-4da4-a2ea-95c98f719ff7", "Name": "Sample dataset", "Type": "uipath.custom" }
}

UIP-PM-Apps löschen

Eine Prozess-App löschen.

Argumente

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

Optionen

Long	Wert	Beschreibung
-y, --yes	Markieren	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.

Beispiel

uip pm apps delete 9c46289e --yes

Datenform (--output json)

{ "Code": "PmAppsDelete", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

UIP-PM-Apps veröffentlichen

Entwicklungsänderungen an der Dashboard-/Abfrageebene veröffentlichen.

Argumente

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

Beispiel

uip pm apps publish 9c46289e

Datenform (--output json)

{ "Code": "PmAppsPublish", "Data": { "AppId": "9c46289e", "Changes": {}, "IngestionNeeded": true, "Hint": "Published changes need data — run 'uip pm ingestions create <app> --wait' to load them into the dashboards." } }

Hint ist nur vorhanden, wenn IngestionNeeded gleich true ist.

Änderungen an UIP-PM-Apps

Anzeigen, welche Teile der Entwicklung noch nicht veröffentlicht wurden (Dashboards, Transformationen, BPMN).

Argumente

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

Beispiel

uip pm apps changes 9c46289e

Datenform (--output json)

{ "Code": "PmAppsChanges", "Data": { "AppId": "9c46289e", "ModelVersion": 3, "Changes": {}, "IngestionNeeded": false } }

Veröffentlichungen von UIP-PM-Apps

Listen Sie den Veröffentlichungsverlauf einer Prozess-App auf.

Argumente

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

Optionen

Long	Wert	Beschreibung
--limit <number>	Integer	Max. zurückzugebende Veröffentlichungen.
--since-version <model-version>	Integer	Nur Veröffentlichungen zurückgeben, die neuer als diese Modellversion sind.

Datenform (--output json)

{ "Code": "PmAppsPublications", "Data": [] }

UIP-PM-App-Typen

Entdecken Sie Prozess-App-Vorlagen. Nicht phasenbezogene – Vorlagen sind mandanten global.

UIP PM-Liste der App-Typen

Listen Sie verfügbare App-Vorlagen in ihrer neuesten Version auf.

uip pm app-types list

{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }

Abrufen von UIP-PM-App-Typen

Rufen Sie das vollständige App-Modell einer Vorlagenversion ab.

Name	Erforderlich	Zweck
<app-type-key>	ja	App-Vorlagenschlüssel.
<app-type-version>	ja	Vorlagenversion.

uip pm app-types get uipath.custom 2604.192.1-ci.5

{ "Code": "PmAppTypesGet", "Data": {} }

UIP-PM-Dateien hochladen

Laden Sie eine Datendatei über einen gesammelten Blob-Upload in eine Prozess-App hoch (5 MB Teile, 4 gleichzeitig).

Argumente

Name	Erforderlich	Zweck
<app-id>	ja	Prozess-App-ID.
<file-path>	ja	Lokaler Pfad zur Datendatei.

Optionen

Long	Wert	Standard	Beschreibung
--stage <stage>	dev | published	dev	App-Phase, in die hochgeladen werden soll.
--input-table <name>	string	–	Zieleingabetabelle, zu der die Datei gehört (z. B Event_log).

Beispiel

uip pm files upload 9c46289e ./Event_log.csv --input-table Event_log

Datenform (--output json)

{
  "Code": "PmFilesUpload",
  "Data": { "Filename": "Event_log/.../Event_log.csv", "UploadId": "...", "Size": 12345, "Parts": 1, "InputTable": "Event_log" }
}

Liste der UIP-PM-Simulationen

Lesen Sie die Prozesssimulationen (Was-wenn-Szenarien), die in einer Prozess-App gespeichert wurden. Schreibgeschützt – create/update/delete ist nicht vorhanden; Simulationen werden anderswo erstellt und nur hier aufgeführt. Wird von einer anderen API (PMT mit App-Scope, Token-Austausch) bereitgestellt als der Rest dieses Tools.

Argumente

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

Optionen

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

Beispiel

uip pm simulations list 9c46289e

Datenform (--output json)

{
  "Code": "PmSimulationsList",
  "Data": [
    {
      "DefinitionMetadata": { "Name": "Two more approvers", "SimulationId": "bfd3d274-...", "IngestionId": "7792c4cd-...", "ProcessId": "Process" },
      "RunMetadata": { "Status": "successWithWarnings", "NumberOfCases": 1000, "NumberOfRuns": 40 }
    }
  ]
}

Zugehörig

• apps model – Bearbeiten Sie das Datenmodell, das semantische Modell, die Felder, die Dashboards und die Metriken.
• ingestions und transformations – Daten laden und dbt ausführen.
• conformance, deviations und query – analysieren eine extrahierte App.

Siehe auch

• Globale Optionen
• Exitcodes