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.

il y a

Commandes pour gérer les applications de processus Process Mining, l'ingestion des transformations et l'analyse à l'aide de l'outil `uip pm`.

uip pm est l'outil de Process Mining: il crée et gère des applications de processus (modèles de processus extraits créés à partir des données du journal des événements), télécharge et ingère des données sources, exécute des transformations dbt et analyse le résultat (conformité par rapport à un modèle de référence, écarts acceptés , requêtes ad hoc). pm est le préfixe de la commande; le package sous-jacent est @uipath/pm-tool.

Une application de processus passe par une étape dev (où vous créez sa structure) et une étape published (ce que voient les tableaux de bord/les consommateurs) - la plupart des verbes prennent --stage dev|published (par défaut dev). Chaque commande nécessite d'abord uip login.

Cette ressource s’étend sur quatre pages​

  • Cette page — concepts, apps , app-types, files, simulations.
  • apps model — l'espace de modification du modèle structurel/sémantique verrouillé par ETag: apps data-model, apps model .
  • ingestions et transformations — déclencher et inspecter les charges de données et les constructions dbt.
  • conformance, deviations et query — analyse une application extraite: taux de conformité, écarts acceptés, requêtes de données ad hoc.

Concepts​

  • Écritures protégées par l'ETag. Chaque écriture dans le modèle de données d'une application, le modèle sémantique ou un fichier de transformation nécessite une --etag d'une get précédente (ou est elle-même une lecture-modification-écriture qui récupère sa propre base). Un ETag obsolète échoue avec un conflit; le correctif consiste à lire à nouveau, refaire la modification et réessayer - ne récupère jamais un nouvel ETag simplement pour forcer l’écriture, car cela écrase en mode silencieux tout ce qui a changé entre.
  • Développement vs. publié. Les modifications structurées/sémantiques, l’ingestion et les transformations s’appliquent uniquement à dev. apps publish transfère le modèle actuel de développement vers la couche publiée/tableau de bord; apps changes donne un aperçu de ce qui doit être déplacé.
  • --wait interrogation. ingestions create et transformations apply/run acceptent --wait (--timeout, par défaut 1800s; --poll-interval, par défaut 5s) pour bloquer jusqu'à ce que l'exécution atteigne un état terminal, en imprimant le dbt réel /loader Error en cas d'échec au lieu de simplement quitter.

Synthèse​

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

liste des applications uip pm​

Répertoriez les applications de processus.

Options​

LongValeur (Value)DefaultDescription
--stage <stage>dev | publisheddevÉtape de l'application à répertorier.

Exemple​

uip pm apps list
uip pm apps list

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

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

Obtenir les applications uip pm​

Obtenez une application de processus: son statut, sa dernière ingestion et son état de compilation.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Options​

LongValeur (Value)DefaultDescription
--stage <stage>dev | publisheddevÉtape de l'application à lire.

Exemple​

uip pm apps get 9c46289e
uip pm apps get 9c46289e

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

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

création d'applications uip pm​

Créez une application de processus à partir d'un modèle d'application (voir app-types list).

Arguments​

NomRequisObjectif
<name>ouiNom de l'application.

Options​

LongValeur (Value)RequisDescription
--type <app-type-key>stringouiClé de modèle d'application, par exemple uipath.custom.
--type-version <version>stringnonVersion du modèle. La valeur par défaut est la plus récente disponible.
--miner <miner>directly-follows | inductive | bpmnnonMineur de processus. Par défaut directly-follows. Seuls inductive/bpmn produisent un modèle de référence, dont conformance/deviations a besoin.
--description <text>stringnonDescription de l'application.
--data-mapping <json-file>Chemin d'accèsnonFichier JSON avec le mappage des données d’entrée (tableaux/champs). Les valeurs IsNotNull/IsUnique/DataTypeSettings manquantes par champ sont automatiquement définies par défaut.

Exemple​

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

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

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

suppression d’applications uip pm​

Supprimer une application de processus.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Options​

LongValeur (Value)Description
-y, --yesDrapeauConfirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple​

uip pm apps delete 9c46289e --yes
uip pm apps delete 9c46289e --yes

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

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

publication d'applications uip pm​

Publiez les modifications de développement dans les tableaux de bord/la couche de requête.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Exemple​

uip pm apps publish 9c46289e
uip pm apps publish 9c46289e

Format des données (--sortie 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." } }
{ "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 est présent uniquement lorsque IngestionNeeded est true.

Modifications des applications uip pm​

Affichez les parties du développement qui ne sont pas encore publiées (tableaux de bord, transformations, BPMN).

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Exemple​

uip pm apps changes 9c46289e
uip pm apps changes 9c46289e

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

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

Publications d'applications uip pm​

Répertoriez l'historique de publication d'une application de processus.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Options​

LongValeur (Value)Description
--limit <number>IntegerNombre maximal de publications à renvoyer.
--since-version <model-version>IntegerRenvoyez uniquement les publications plus récentes que cette version du modèle.

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

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

uip pm-types d'applications​

Découvrez des modèles d'application de processus. Pas à l'échelle de l'étape - les modèles sont globaux au locataire.

liste des types d'applications uip pm​

Répertorie les modèles d'applications disponibles dans leur dernière version.

uip pm app-types list
uip pm app-types list
{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }
{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }

uip pm-types d'applications obtenir​

Obtenez le modèle d'application complet d'une version de modèle.

NomRequisObjectif
<app-type-key>ouiClé de modèle d'application.
<app-type-version>ouiVersion du modèle.
uip pm app-types get uipath.custom 2604.192.1-ci.5
uip pm app-types get uipath.custom 2604.192.1-ci.5
{ "Code": "PmAppTypesGet", "Data": {} }
{ "Code": "PmAppTypesGet", "Data": {} }

téléchargement de fichiers uip pm​

Chargez un fichier de données dans une application de processus via un téléchargement d'objets blob groupé (portions 5 Mo, 4 simultanées).

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.
<file-path>ouiChemin d’accès local au fichier de données.

Options​

LongValeur (Value)DefaultDescription
--stage <stage>dev | publisheddevÉtape d’application vers laquelle télécharger.
--input-table <name>string—Table d’entrée cible à laquelle le fichier appartient (par exemple Event_log).

Exemple​

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

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

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

liste des simulations uip pm​

Lisez les simulations de processus (scénarios hypothétiques) enregistrées dans une application de processus. En lecture seule — il n’y a pas de create/update/delete; les simulations sont créées ailleurs et sont répertoriées ici uniquement. Concerné par une API différente (PMT à l'échelle de l'application, échange de jetons) que le reste de cet outil.

Arguments​

NomRequisObjectif
<app-id>ouiID de l'application de processus.

Options​

LongValeur (Value)DefaultDescription
--stage <stage>dev | publisheddevÉtape de l’application.

Exemple​

uip pm simulations list 9c46289e
uip pm simulations list 9c46289e

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

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

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