UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UIP-PM-Konformität, UIP-PM-Abweichungen, UIP-PM-Abfrage

Syntax und Optionen für die Analyse einer Process Mining-App – Konformitätsrate, akzeptierte Abweichungen und Ad-hoc-Datenabfragen – mit „uip per UiPath Conformance“, „uip UiP UiPathfunktions“ und „uip UiP UiPathprompt“.

Teil des Tools uip pm . conformance und deviations sind Convenience-Ebenen über query: Sie lösen die internen Konformitätsfeld-IDs der App für Sie auf und antworten in einfacher Sprache. query ist die universelle Escape-Taste für alles, was diese beiden nicht abdecken.

Hinweis:

conformance und deviations funktionieren nur für eine modellbasierte App (--miner inductive oder bpmn unter apps create oder ein BPMN-Referenzmodell, das über conformance upload-model hochgeladen wurde). Eine directly-follows -App hat kein Referenzmodell und keine Konformitätsdaten – jedes Verb in dieser Gruppe schlägt mit einem expliziten Fehler beim Benennen des Miners fehl.

Zusammenfassung​

uip pm conformance rate <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance activities <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance transitions <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance deviations <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance upload-model <app-id> <bpmn-file> [--process-id <id>]

uip pm deviations list <app-id> [--process-id Process] [--stage dev|published]
uip pm deviations accept <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete-all <app-id> -y [--process-id Process]

uip pm query run <app-id> [--body <file> | --body-json <json> | --group-by <cols> --metric <col:fn[:alias]>...] [--process-graph] [--conformance] [--limit <n>] [--stage dev|published]
uip pm query details <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query rca <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query insights <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query info <app-id> [--stage dev|published]
uip pm query layout <app-id> [--type graph|process-model] [--stage dev|published]
uip pm query percentile <app-id> --field <id> --values <list> [--filters <file> | --filters-json <json>] [--stage dev|published]
uip pm conformance rate <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance activities <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance transitions <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance deviations <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance upload-model <app-id> <bpmn-file> [--process-id <id>]

uip pm deviations list <app-id> [--process-id Process] [--stage dev|published]
uip pm deviations accept <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete-all <app-id> -y [--process-id Process]

uip pm query run <app-id> [--body <file> | --body-json <json> | --group-by <cols> --metric <col:fn[:alias]>...] [--process-graph] [--conformance] [--limit <n>] [--stage dev|published]
uip pm query details <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query rca <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query insights <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query info <app-id> [--stage dev|published]
uip pm query layout <app-id> [--type graph|process-model] [--stage dev|published]
uip pm query percentile <app-id> --field <id> --values <list> [--filters <file> | --filters-json <json>] [--stage dev|published]

UIP-PM-Konformitätsrate​

Anteil der Fälle, die dem Referenzmodell folgen.

Optionen​

LongWertBeschreibung
--process-id <id>stringProzess, über den gemeldet werden soll; wird nur für eine Multiprozess-App benötigt.
--stage <stage>dev | publishedDer Standardwert ist dev.

Beispiel​

uip pm conformance rate 9c46289e
uip pm conformance rate 9c46289e

Datenform (--output json)​

{ "Code": "PmConformanceRate", "Data": { "ProcessId": "Process", "Miner": "inductive", "ConformanceRate": 0.666667, "ConformingCases": 2, "TotalCases": 3 } }
{ "Code": "PmConformanceRate", "Data": { "ProcessId": "Process", "Miner": "inductive", "ConformanceRate": 0.666667, "ConformingCases": 2, "TotalCases": 3 } }

UIP-PM-Konformitätsaktivitäten​

Konformitätsstatus jeder Aktivität mit den installierten Fällen.

uip pm conformance activities 9c46289e
uip pm conformance activities 9c46289e
{ "Code": "PmConformanceActivities", "Data": [{ "Activity": "Approve", "Status": "Conforming", "Cases": 2 }, { "Activity": "Escalate", "Status": "LogOnly", "Cases": 1 }] }
{ "Code": "PmConformanceActivities", "Data": [{ "Activity": "Approve", "Status": "Conforming", "Cases": 2 }, { "Activity": "Escalate", "Status": "LogOnly", "Cases": 1 }] }

Status ist einer von ModelOnly, LogOnly, Conforming, Accepted.

UIP-PM-Konformitätsübergänge​

Konformitätsstatus jedes Übergangs zwischen Aktivitäten.

uip pm conformance transitions 9c46289e
uip pm conformance transitions 9c46289e
{ "Code": "PmConformanceTransitions", "Data": [{ "FromNodeId": "Start", "ToNodeId": "Approve", "Status": "Conforming", "Cases": 2 }] }
{ "Code": "PmConformanceTransitions", "Data": [{ "FromNodeId": "Start", "ToNodeId": "Approve", "Status": "Conforming", "Cases": 2 }] }

UIP-PM-Konformitätsabweichungen​

Abweichungen, die die Daten tatsächlich anzeigen (nicht zu verwechseln mit uip pm deviations, das akzeptierte Abweichungen verwaltet – dies liest, was aktuell abweicht).

uip pm conformance deviations 9c46289e
uip pm conformance deviations 9c46289e
{ "Code": "PmConformanceDeviations", "Data": [{ "Deviation": "Activity Approve is skipped", "Type": "Skip", "Cases": 1, "AverageThroughputTime": 2700 }] }
{ "Code": "PmConformanceDeviations", "Data": [{ "Deviation": "Activity Approve is skipped", "Type": "Skip", "Cases": 1, "AverageThroughputTime": 2700 }] }

UIP-PM-Konformitätsupload-Modell​

Laden Sie eine BPMN-Datei als Referenzmodell der App hoch. Nur Entwicklungsphase; wird bei der nächsten Erfassung wirksam – das Hochladen allein misst nichts neu.

Argumente​

NameErforderlichZweck
<app-id>jaProzess-App-ID.
<bpmn-file>jaLokale .bpmn -Datei, max. 6 MB.

Optionen​

LongWertBeschreibung
--process-id <id>stringProzess, zu dem das Modell gehört; wird nur für eine Multiprozess-App benötigt.

Beispiel​

uip pm conformance upload-model 9c46289e ./order-to-cash.bpmn
uip pm conformance upload-model 9c46289e ./order-to-cash.bpmn

Datenform (--output json)​

{ "Code": "PmConformanceUploadModel", "Data": { "AppId": "9c46289e", "File": "./order-to-cash.bpmn", "Status": "Uploaded", "Messages": [] } }
{ "Code": "PmConformanceUploadModel", "Data": { "AppId": "9c46289e", "File": "./order-to-cash.bpmn", "Status": "Uploaded", "Messages": [] } }

Schlägt fehl, wenn die Datei 6 MB überschreitet oder wenn der Server das BPMN validiert und ablehnt (HasError in der Antwort) – die Ablehnungsgründe werden in der Fehlermeldung angezeigt und nicht im Hintergrund als Erfolg gemeldet.

UIP-PM-Abweichungen​

Verwalten Sie die Liste der akzeptierten Abweichungen, anhand deren eine App geprüft wird – wenn Sie eine Abweichung akzeptieren, wird diese konformitätsorientiert. Nichts wird wirksam, bis die Transformationen erneut ausgeführt werden; list meldet diese Lücke als Status pro Abweichung.

--process-id wird standardmäßig bei jedem Verb "Process" verwendet (nur bei einer Multi-Prozess-App wichtig).

UIP-PM-Ababweichungsliste​

OptionWertBeschreibung
--process-id <id>stringDer Standardwert ist Process.
--stage <stage>dev | publishedDer Standardwert ist dev.
{ "Code": "PmDeviationsList", "Data": [{ "Type": "activity_missing", "Activities": ["Approve order"], "ParentProcess": [], "Status": "NotApplied" }] }
{ "Code": "PmDeviationsList", "Data": [{ "Type": "activity_missing", "Activities": ["Approve order"], "ParentProcess": [], "Status": "NotApplied" }] }

Status ist Applied (die letzte erfolgreiche Erfassung hat es), NotApplied (da es von der Erfassung akzeptiert wurde) oder AppliedButDeleted (da es gelöscht wurde) – die letzten beiden bedeuten, dass Transformationen erneut ausgeführt werden .“

UIP-PM-Ababweichungen akzeptieren​

LongWertErforderlichBeschreibung
--type <deviation-type>stringjaAbweichungstyp, wie von conformance deviations gemeldet.
--activities <activities...>Zeichenfolgen, durch Leerzeichen getrenntjaDie Aktivität benennt die Abweichungsabdeckungen.
--process-id <id>stringneinDer Standardwert ist Process.
uip pm deviations accept 9c46289e --type activity_missing --activities "Approve order"
uip pm deviations accept 9c46289e --type activity_missing --activities "Approve order"
{ "Code": "PmDeviationsAccept", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Accepted" } }
{ "Code": "PmDeviationsAccept", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Accepted" } }

Schlägt fehl, wenn die genaue Kombination aus Typ/Aktivitäten/Prozess bereits akzeptiert wird. Es erreicht nur Abweichungen auf höchster Ebene – eine, die in einem Teilprozess verschachtelt ist (nicht leeres parentProcess), kann mit diesem Befehl nicht abgeglichen werden, da --activities nie ein parentProcess sendet.

UIP-PM-Ababweichungen löschen​

Die gleichen Optionen wie accept. Akzeptieren Sie keine Abweichung mehr – der Typ, die Aktivitäten und der übergeordnete Prozess müssen exakt einer akzeptierten Abweichung entsprechen.

{ "Code": "PmDeviationsDelete", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Deleted" } }
{ "Code": "PmDeviationsDelete", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Deleted" } }

UIP-PM-Ababweichungen – Alle löschen​

Akzeptieren Sie nicht mehr jede Abweichung in der App.

LongWertBeschreibung
-y, --yesMarkierenBestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich.
--process-id <id>stringDer Standardwert ist Process.
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

UIP-PM-Abfrage​

Allgemeine Datenabfragen für eine extrahierte App. Alle Verben, die den Textkörper übernehmen (run/details/rca/insights) teilen sich --body <json-file> / --body-json <json> (ausschließend), --stage, und (außer insights…) eigentlich alle vier) --limit (Server wird auf 1..1000 festgelegt).

Ausführung der UIP-PM-Abfrage​

Aggregierte Abfrage (Group-nach + Metriken). Unterstützt eine Sugar-Syntax über dem unformatierten Textkörper.

LongWertBeschreibung
--group-by <cols>durch Kommas getrennt sindFeldspalten (Namen oder IDs, von query info), nach denen gruppiert werden soll. Sugar; sich gegenseitig mit --body/--body-json ausschließen.
--metric <col:fn[:alias]>wiederholbarEin Feld aggregieren. fn ist einer von any, average, count, distinct_count, forall, forany, max, median, min, percentage, sum ( Groß-/Kleinschreibung wird nicht beachtet, -/_ austauschbar). Der Standard-Alias ist <fn>_<column>.
--process-graphMarkierenAntworten Sie über das Prozessdiagramm (Aktivitäten/Übergänge) und nicht über das einfache Datenmodell. Nur Sugar – Ein unformatierter Textkörper trägt isProcessGraph sich selbst.
--conformanceMarkierenAntworten Sie auf die reine Modellseite (Schritte, die das Referenzmodell erwartet hat, dass ein Fall übersprungen wurde) und nicht auf das, was das Protokoll getan hat. Nur Sugar.

Andere Aggregationsfunktionen (COUNT_ROWS, EXISTS, APPROX_DISTINCT_COUNT, PERCENTILE, CASE_AVERAGE) sind nicht über --metric verfügbar – erstellen Sie sie mit --body/--body-json (verwenden Sie query percentile für Perzentile). insbesondere).

Beispiele​

uip pm query run 9c46289e --group-by Open_year --metric Event_count:average
uip pm query run 9c46289e --group-by Open_year --metric Event_count:average
uip pm query run 9c46289e --body-json '{"groupBy":["F__Cases__Priority__..."],"aggregates":[{"id":"n","argument":"Case_ID","aggregation":"COUNT"}]}'
uip pm query run 9c46289e --body-json '{"groupBy":["F__Cases__Priority__..."],"aggregates":[{"id":"n","argument":"Case_ID","aggregation":"COUNT"}]}'
uip pm query run 9c46289e --metric Case_conforming:percentage
uip pm query run 9c46289e --metric Case_conforming:percentage
# Skipped steps: activities the reference model expected that a case didn't take
uip pm query run 9c46289e --group-by Node_id,Node_label --metric Case_ID:distinct_count --process-graph --conformance
# Skipped steps: activities the reference model expected that a case didn't take
uip pm query run 9c46289e --group-by Node_id,Node_label --metric Case_ID:distinct_count --process-graph --conformance

Datenform (--output json)​

{ "Code": "PmQueryRun", "Data": [{ "Open_year": 2014, "average_Event_count": 9.16 }] }
{ "Code": "PmQueryRun", "Data": [{ "Open_year": 2014, "average_Event_count": 9.16 }] }

Mit der Sugar-Syntax wird die Spaltenantwort der Engine in Zeilenobjekte umgestaltet, die durch menschliche Spaltennamen/Alias verschlüsselt sind; Ein unformatierter --body/--body-json -Aufruf gibt die Antwort der Engine unverändert zurück.

Details zur UIP-PM-Abfrage​

Unformatierte Tabellenzeilen.

{ "Code": "PmQueryDetails", "Data": {} }
{ "Code": "PmQueryDetails", "Data": {} }

UIP-PM-Abfrage rca​

Ursachenanalyse. Text benötigt ein nicht leeres selectedSet.

uip pm query rca 9c46289e --body-json '{"argument":"Case_ID","exploreAttributes":["Case_type"],"selectedSet":[[{"kind":"values","dimension":"Case_status","type":"string","values":["Open"],"invert":false,"displayType":"list"}]]}'
uip pm query rca 9c46289e --body-json '{"argument":"Case_ID","exploreAttributes":["Case_type"],"selectedSet":[[{"kind":"values","dimension":"Case_status","type":"string","values":["Open"],"invert":false,"displayType":"list"}]]}'
{ "Code": "PmQueryRca", "Data": { "Data": {}, "Warnings": null } }
{ "Code": "PmQueryRca", "Data": { "Data": {}, "Warnings": null } }

Einblicke in die UIP-PM-Abfrage​

Prozesseinblicke. Text benötigt processId und 1–10 metrics.

{ "Code": "PmQueryInsights", "Data": {} }
{ "Code": "PmQueryInsights", "Data": {} }

Informationen zur UIP-PM-Abfrage​

Entdecken Sie die Felder, Metriken und Prozesse, die für Abfragekörper verfügbar sind.

uip pm query info 9c46289e
uip pm query info 9c46289e
{ "Code": "PmQueryInfo", "Data": { "fields": [], "processes": [] } }
{ "Code": "PmQueryInfo", "Data": { "fields": [], "processes": [] } }

UIP-PM-Abfragelayout​

Rufen Sie das beibehaltene globale Diagrammlayout einer Prozess-App ab.

LongWertStandardBeschreibung
--type <type>graph | process-modelgraphWelches Layout gelesen werden soll.
{ "Code": "PmQueryLayout", "Data": {} }
{ "Code": "PmQueryLayout", "Data": {} }

UIP PM Abfrage-Perzentil​

Berechnen Sie Perzentile eines numerischen Felds.

LongWertErforderlichBeschreibung
--field <field-id>stringjaFeld-ID (query info).
--values <list>durch Komma getrennt, 0..1jaPerzentilpunkte, z. B. 0.5,0.9,0.95).
--filters <json-file> / --filters-json <json>JSONneinFilterspezifikation (Array von UND-verknüpften Filtergruppen). Sich gegenseitig ausschließen.
uip pm query percentile 9c46289e --field PF__throughput_time --values 0.5,0.9,0.95
uip pm query percentile 9c46289e --field PF__throughput_time --values 0.5,0.9,0.95
{ "Code": "PmQueryPercentile", "Data": { "values": [3600, 86400, 172800] } }
{ "Code": "PmQueryPercentile", "Data": { "values": [3600, 86400, 172800] } }
  • uip pm – Übersicht und apps CRUD.
  • apps model – Feld-/Metrikdefinitionen, auf die diese Abfragen verweisen.
  • ingestions & transformations – Eine Abfrage benötigt eine abgeschlossene Erfassung in der Phase, auf die sie abzielt.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben