UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

conformité uip pm, écarts uip pm, requête uip pm

Syntaxe et options d'analyse d'une application Process Mining — taux de conformité, écarts acceptés et requêtes de données ad hoc — avec `uip pm conformance`, `uip pm deviations` et `uip pm request`.

Une partie de l'outil uip pm . conformance et deviations sont des couches de commodité par rapport à query: elles résolvent les ID de champ de conformité interne de l'application pour vous et répondent en termes simples. query est la plate-forme d’échappement à usage général pour tout ce que ces deux éléments ne couvrent pas.

Remarque :

conformance et deviations fonctionnent uniquement sur une application basée sur un modèle (--miner inductive ou bpmn sur apps create, ou un modèle de référence BPMN téléchargé via conformance upload-model). Une application directly-follows n'a pas de modèle de référence et aucune donnée de conformité - chaque verbe de ce groupe échoue avec une erreur explicite nommant le mineur.

Synthèse​

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]

Taux de conformité uip pm​

Partage des incidents qui suivent le modèle de référence.

Options​

LongValeur (Value)Description
--process-id <id>stringProcessus à traiter; uniquement nécessaire pour une application multi-processus.
--stage <stage>dev | publishedPar défaut dev.

Exemple​

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

Format des données (--sortie 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 } }

activités de conformité uip pm​

Statut de conformité de chaque activité, avec les incidents qui la sous-tendent.

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 est l'un des ModelOnly, LogOnly, Conforming et Accepted.

Transitions de conformité uip pm​

Statut de conformité de chaque transition entre les activités.

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 }] }

écarts de conformité uip pm​

Écarts que les données affichent réellement (à ne pas confondre avec uip pm deviations, qui gère les écarts acceptés — cela permet de lire ce qui est actuellement en écart).

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 }] }

modèle de téléchargement de conformité uip pm​

Téléchargez un fichier BPMN comme modèle de référence de l'application. Étape de développement uniquement; prend effet lors de l’ingestion suivante - le téléchargement seul ne prend pas de nouveau mesures.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.
<bpmn-file>ouiFichier .bpmn local, maximum 6 Mo.

Options​

LongValeur (Value)Description
--process-id <id>stringTraiter le modèle auquel appartient; uniquement nécessaire pour une application multi-processus.

Exemple​

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

Format des données (--sortie 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": [] } }

Échoue si le fichier dépasse 6 Mo, ou si le serveur valide et rejette le BPMN (HasError dans la réponse): les raisons du rejet sont apparues dans le message d’échec, et non signalées silencieusement comme une réussite.

écarts uip pm​

Gérez la liste d'écarts acceptés par rapport à laquelle une application est vérifiée - l'acceptation d'un écart arrête le comptage des conformités. Rien ne prend effet tant que les transformations ne sont pas réexécutées; list rapporte cet écart comme statut par écart.

--process-id a pour valeur "Process" par défaut sur chaque verbe (ne compte que pour une application multi-processus).

liste des écarts uip pm​

OptionValeur (Value)Description
--process-id <id>stringPar défaut Process.
--stage <stage>dev | publishedPar défaut 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 est Applied (la dernière ingestion réussie l’a), NotApplied (accepté depuis cette ingestion) ou AppliedButDeleted (supprimé depuis) — ces deux derniers signifient tous deux des transformations et quota; réexécuter les transformations pour rattraper son retard ".")

Écarts uippm acceptés​

LongValeur (Value)RequisDescription
--type <deviation-type>stringouiType d'écart, tel que signalé par conformance deviations.
--activities <activities...>chaînes, séparées par des espacesouiNoms d'activité couverts par l'écart
--process-id <id>stringnonPar défaut 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" } }

Échoue si la combinaison exacte de types/activités/processus est déjà acceptée. Atteint uniquement les écarts de niveau supérieur - un imbriqué dans un sous-processus (non vide parentProcess) ne peut pas être mis en correspondance à partir de cette commande, car --activities n'envoie jamais une parentProcess.

suppression des écarts uip pm​

Mêmes options que accept. Arrêter l'acceptation d'un écart — le type, les activités et le processus parent doivent correspondre exactement à un écart accepté.

{ "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 Deviations Delete-all​

Arrêtez l'acceptation de chaque écart sur l'application.

LongValeur (Value)Description
-y, --yesDrapeauConfirmez cette opération irréversible. Requis.
--process-id <id>stringPar défaut Process.
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

Requête uip​

Requêtes de données à usage général relatives à une application extraite. Tous les verbes de prise de corps (run/details/rca/insights) partagent --body <json-file> / --body-json <json> ( mutuellement exclusif), --stage et (sauf insights... en fait tous quatre) --limit (serveur se bloque sur 1..1000).

Exécution de requête uip pm​

Requête agrégée (grouper par + métriques). Prend en charge une syntaxe de raccourci au-dessus du corps brut.

LongValeur (Value)Description
--group-by <cols>Séparé par des virgulesColonnes de champ (noms ou ID, de query info) par lesquels regrouper. Sugar; mutuellement exclusif avec --body/--body-json.
--metric <col:fn[:alias]>RépétableAgréger un champ. fn est l'un des any, average, count, distinct_count, forall, forany, max, median, min, percentage, sum ( insensible à la casse, -/_ interchangeable). L’alias par défaut est <fn>_<column>.
--process-graphDrapeauRéponse sur le graphique de processus (activités/transitions) plutôt que sur le modèle de données simple. Sugar uniquement — un corps brut porte isProcessGraph lui-même.
--conformanceDrapeauRéponse sur le côté modèle uniquement (étapes du modèle de référence attendu qu'un cas a ignoré) plutôt que ce que le journal a fait. Sugar uniquement.

Les autres fonctions d'agrégation (COUNT_ROWS, EXISTS, APPROX_DISTINCT_COUNT, PERCENTILE, CASE_AVERAGE) ne sont pas disponibles via --metric — créez-les avec --body/--body-json (utilisez query percentile pour les centiles) spécifiquement).

Exemples​

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

Format des données (--sortie json)​

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

Avec la syntaxe Sugar, la réponse colonne du moteur est reformée en objets de ligne clés par noms/alias de colonnes humains; un appel --body/--body-json brut renvoie la réponse du moteur telle quelle.

détails de la requête uip pm​

Lignes de tableau brutes.

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

rca - requête uip pm​

Analyse des causes profondes. Le corps a besoin d’une valeur selectedSet non vide.

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 } }

résultats de la requête uip​

Informations sur le processus. Le corps a besoin de processId et 1 à 10 metrics.

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

informations sur la requête uip pm​

Découvrez les champs, les mesures et les processus disponibles pour les corps de requête.

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

Mise en page de requête uip pm​

Obtenir la disposition du graphique global persistant d’une application de processus.

LongValeur (Value)DefaultDescription
--type <type>graph | process-modelgraphQuelle mise en page à lire.
{ "Code": "PmQueryLayout", "Data": {} }
{ "Code": "PmQueryLayout", "Data": {} }

Centile de requête uip pm​

Calculez les centiles d’un champ numérique.

LongValeur (Value)RequisDescription
--field <field-id>stringouiID de champ (query info).
--values <list>séparés par des virgules, 0..1ouiPoints de centile, par ex. 0.5,0.9,0.95.
--filters <json-file> / --filters-json <json>JSONnonSpécification de filtre (tableau des groupes de filtres basés sur ET). Captures mutuellement exclusives.
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 — vue d'ensemble et apps CRUD.
  • apps model — les définitions de champ/métriques auxquelles ces requêtes font référence.
  • ingestions et transformations — une requête nécessite une ingestion terminée à l'étape qu'elle cible.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour