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.

exécution, débogage et amp; Exécution

Syntaxe et options pour `uip rpa run`, le groupe `debug` et `exécution Cancel` — l'interface principale actuelle pour l'exécution et le débogage d'un workflow ou d'un fichier codé, remplaçant l'ancienne version `run-file`/` stop-execution` verbes.

uip rpa run, uip rpa debug *, et uip rpa execution cancel exécutent et déboguent un workflow ou un fichier codé via Studio. Les 17 verbes de cette page sont répartis dans les deux mêmes outils sous-jacents que uip rpa run-file et uip rpa stop-execution exposent sous forme d'une seule énumération de --command étendue — il s'agit de la forme actuelle, principale et détectable de cette même fonctionnalité, divisée en un verbe par comportement au lieu d'un indicateur avec 19 valeurs. run-file/stop-execution fonctionnent toujours (ils sont conservés en tant qu’alias de compatibilité masqués pour les compétences installées), mais cette page est ce que --help affiche réellement.

L'exécution se produit via Studio, ces commandes ne fonctionnent donc que sur les exécuteurs Windows (Studio est uniquement compatible Windows). Si Studio n'est pas déjà en cours d'exécution, il est activé automatiquement. Exécutez d'abord uip rpa start-studio si vous souhaitez que les coûts de démarrage soient payés dans une étape de configuration dédiée.

Synthèse​

uip rpa run --file-path <path> [--input-arguments <json>] [--log-level <level>] [--skip-build] [--profiling] [--profiling-mode endOfRun|stream] [--remote]

uip rpa debug start --file-path <path> [same options as run] [--breakpoints <json>]
uip rpa debug start-from-here [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug test-activity [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug break [--wait-timeout-seconds <n>]
uip rpa debug continue [--wait-timeout-seconds <n>]
uip rpa debug resume [--wait-timeout-seconds <n>]
uip rpa debug continue-retry [--wait-timeout-seconds <n>]
uip rpa debug continue-ignore [--wait-timeout-seconds <n>]
uip rpa debug step-into [--wait-timeout-seconds <n>]
uip rpa debug step-over [--wait-timeout-seconds <n>]
uip rpa debug step-out [--wait-timeout-seconds <n>]
uip rpa debug state [--wait-timeout-seconds <n>]
uip rpa debug set-breakpoints --breakpoints <json>
uip rpa debug apply-file-changes --file-changes <json>
uip rpa debug toggle-breakpoint
uip rpa debug restart-from-top

uip rpa execution cancel
uip rpa run --file-path <path> [--input-arguments <json>] [--log-level <level>] [--skip-build] [--profiling] [--profiling-mode endOfRun|stream] [--remote]

uip rpa debug start --file-path <path> [same options as run] [--breakpoints <json>]
uip rpa debug start-from-here [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug test-activity [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug break [--wait-timeout-seconds <n>]
uip rpa debug continue [--wait-timeout-seconds <n>]
uip rpa debug resume [--wait-timeout-seconds <n>]
uip rpa debug continue-retry [--wait-timeout-seconds <n>]
uip rpa debug continue-ignore [--wait-timeout-seconds <n>]
uip rpa debug step-into [--wait-timeout-seconds <n>]
uip rpa debug step-over [--wait-timeout-seconds <n>]
uip rpa debug step-out [--wait-timeout-seconds <n>]
uip rpa debug state [--wait-timeout-seconds <n>]
uip rpa debug set-breakpoints --breakpoints <json>
uip rpa debug apply-file-changes --file-changes <json>
uip rpa debug toggle-breakpoint
uip rpa debug restart-from-top

uip rpa execution cancel

Concepts​

  • L'un des deux backends. Studio Desktop et le backend Helm sans affichage les implémentent tous deux; plusieurs options (--profiling-mode stream, debug set-breakpoints, debug apply-file-changes et l'interrogation longue --wait-timeout-seconds) sont disponibles dans Helm uniquement et sont ignorées ou indisponibles dans le backend de Studio — indiqué par verbe ci-dessous.
  • --remote (sur run/debug start/debug start-from-here/debug test-activity uniquement) s'exécute sur l'agent distant configuré (un robot Unattended Orchestrator) plutôt que localement - voir uip rpa remote pour savoir comment configurer la cible en premier.
  • Chaque commande de mi-session revient à l'état stable suivant. continue/resume/continue-retry/continue-ignore/les verbes d'étape/break/state attendent tous que la session atteigne un état stable (Paused, Suspended, ou Completed) avant de revenir; si aucun n'est atteint dans --wait-timeout-seconds, il renvoie DebugState: "Running" au lieu de être suspendu.

Exécution RPA uip​

Exécutez un workflow ou un fichier codé via Studio, sans débogueur joint.

Options​

LongValeur (Value)Description
--file-path <path>stringRequis. Chemin d'accès au workflow .xaml ou au fichier codé .cs.
--input-arguments <json>Object JSONArguments d'entrée au niveau du projet en JSON simple, par exemple {"customerId":"ACME-1234"}.
--log-level <level>Verbose|Trace|Information|Warning|Error|CriticalNiveau de journalisation minimum dans le flux de sortie. Par défaut Trace.
--skip-buildDrapeauIgnorer la validation/la création, en supposant que le projet a déjà été créé. À utiliser pour une réexécution rapide lorsque rien n'a changé.
--profilingDrapeauCollectez les données de profilage par activité, renvoyées sous la forme d'un champ Profiling. Nécessite un profil Studio Develop avec EnableProfiling défini - si non disponible, l'exécution se termine toujours et Profiling est simplement omis. false par défaut.
--profiling-mode <mode>endOfRun|streamDélai de livraison des données de profilage. endOfRun (par défaut) renvoie le résumé une fois à la fin; stream active également la collection par lui-même et transmet en outre chaque entrée d'activité en direct sous forme de [Profiling] ligne, plus écrit les données exhaustives dans le fichier .uistat de l'exécution. Helm backend uniquement; ignoré lors de l’exécution à distance.
--remoteDrapeauExécuter sur l’agent distant configuré plutôt que localement. Configurez d'abord la cible avec uip rpa remote configure. false par défaut.

Exemple​

uip rpa run --file-path ./Main.xaml --input-arguments '{"customerId": "ACME-1234"}'
uip rpa run --file-path ./Main.xaml --input-arguments '{"customerId": "ACME-1234"}'

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

{ "Code": "RunResult", "Data": { "DebugState": "Completed", "Result": {} } }
{ "Code": "RunResult", "Data": { "DebugState": "Completed", "Result": {} } }

La forme Data exacte correspond à la charge utile du résultat d'exécution de l'outil sous-jacent - voir uip rpa run-file pour le contrat de résultat complet (les deux verbes renvoient la même forme).

début du débogage uip rpa​

Démarrez une session de débogage pour un workflow ou un fichier codé. Mêmes options que run, plus --breakpoints.

Options​

Toutes les options de run, plus:

LongValeur (Value)Description
--breakpoints <json>Tableau JSONEnsemble de points d’arrêt initial. Chaque entrée: workflowFile (obligatoire, chemin d'accès relatif à la racine du projet), activityIdRef (le sap2010:WorkflowViewState.IdRef de l'activité du XAML — le moyen stable de l'adresser) ou activityId (ID de runtime), plus facultatif condition (expression VB/C#; interrompt uniquement lorsque la valeur est true), hitCount (interrompez uniquement le Nième résultat), enabled (par défaut true). Éléments key=value répétitifs séparés par des virgules, une entrée de tableau par occurrence ou un fichier JSON via @breakpoints.json / --breakpoints-file.

Exemple​

uip rpa debug start --file-path ./Main.xaml \
  --breakpoints 'workflowFile=Main.xaml,activityIdRef=Assign_1'
uip rpa debug start --file-path ./Main.xaml \
  --breakpoints 'workflowFile=Main.xaml,activityIdRef=Assign_1'

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

Même forme que run; une session qui atteint un point d'arrêt signale DebugState: "Paused" avec l'activité et les locaux dans DebugDetails.

Débogage rpa uip - à partir d’ici​

Commencez le débogage à partir de l’activité actuellement ciblée, en ignorant tout ce qui la précède. Non --file-path — il fonctionne sur ce qui est concentré dans le projet ouvert.

Options​

LongValeur (Value)Description
--input-arguments <json>JSONEntrées au niveau du projet. Contrairement à run/debug start, les valeurs sont ici des expressions VB.NET ou C#, et non des littéraux JSON simples.
--input-variables <json>JSONValeurs des variables au niveau du workflow pour référencer l'état dans l'étendue (expressions, non littéraux).
--log-level <level>même enum que runNiveau de journalisation minimum.
--profiling / --profiling-mode <mode>—Identique à run.

Exemple​

uip rpa debug start-from-here --input-variables '{"greeting": "\"Hello World\""}'
uip rpa debug start-from-here --input-variables '{"greeting": "\"Hello World\""}'

uip rpa - activité de test de débogage​

Identisez et exécutez l'activité actuellement ciblée, en utilisant --input-arguments/--input-variables (expressions, même convention que start-from-here) pour référencer l'état dans l'étendue.

Options​

Identique à debug start-from-here.

Exemple​

uip rpa debug test-activity --input-variables '{"greeting": "\"Hello World\""}'
uip rpa debug test-activity --input-variables '{"greeting": "\"Hello World\""}'

interruption de débogage uip rpa​

Suspendez l’exécution à la prochaine activité exécutée dans la session active.

Options​

LongValeur (Value)Description
--wait-timeout-seconds <n>NumériqueNombre maximal de secondes à attendre pour le prochain état stable avant de renvoyer DebugState: "Running". Par défaut 120. Helm backend uniquement — le backend de Studio applique sa propre limite de 120 s fixes et ignore une valeur explicite.

uip rpa débogage continuer/reprendre/reprendre-reprise​

Reprenez l'exécution dans la session active. continue reprend depuis la pause; resume reprend depuis la suspension; continue-retry reprend et tente à nouveau d'exécuter l'activité qui vient d'être lancée; continue-ignore reprend et avale l'exception de l'activité qui vient d'être générée.

Options​

Même --wait-timeout-seconds que debug break.

uip rpa débogage step-into/step-over/step-out​

Pas à pas du débogueur standard dans la session active. step-out, appelé sans session active, démarre une activité suspendue avant la première activité.

Options​

Même --wait-timeout-seconds que debug break.

état de débogage uip rpa​

Indiquez l’état de la session de débogage active (Running/Paused/Suspended/Completed/None) sans effet secondaire.

Options​

LongValeur (Value)Description
--wait-timeout-seconds <n>NumériqueInterrogez longuement une session en cours d'exécution pour déterminer son prochain état stable. Par défaut 0 (une sonde instantanée). Helm backend uniquement — sur le backend de Studio, il s'agit toujours d'une sonde instantanée.

uip rpa - Définir les points d’arrêt​

Remplacez l’ensemble de points d’arrêt de la session de débogage active. Helm backend uniquement — sur le backend de Studio, utilisez debug toggle-breakpoint ou passez des points d'arrêt à debug start à la place.

Options​

LongValeur (Value)RequisDescription
--breakpoints <json>Tableau JSONouiMême forme que debug start celle --breakpoints de. Remplace l’ensemble, pas une fusion.

uip rpa debug Apply-file-changes​

Lorsque vous êtes en pause/suspendu dans une session de débogage, réconciliez les modifications de la propriété de l'activité sur le disque dans la session en cours d'exécution via le rechargement à grande échelle, afin qu'il les récupère sans redémarrage. Modifiez d'abord le fichier de workflow, puis appelez ce nom ce qui a changé.

Options​

LongValeur (Value)RequisDescription
--file-changes <json>Tableau JSONouiUn objet par propriété modifiée: workflowFile (obligatoire), activityIdRef, plus le nom/la valeur de la propriété modifiée. Formulaire key=value répétable ou @changes.json / --file-changes-file.

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

{ "Code": "ApplyFileChanges", "Data": { "applied": [], "rejected": [], "debugState": "Paused" } }
{ "Code": "ApplyFileChanges", "Data": { "applied": [], "rejected": [], "debugState": "Paused" } }

applied modifications sont dynamiques dans la session (par exemple continue-retry réexécute une activité défaillante avec le correctif); rejected modifications (chacune avec une raison) sont des modifications structurées qui nécessitent un redémarrage de la session pour prendre effet.

uip rpa - point d'arrêt de débogage​

Activez/Désactivez un point d'arrêt au niveau de l'activité actuellement ciblée (.xaml) ou de la ligne (.cs). Aucune option. Cycles XAML activés → désactivés → aucun; le cycle des workflows codés est activé/désactivé.

uip rpa debug redirect- from-top​

Redémarrez la session de débogage active depuis le début. Aucune option.

annulation de l’exécution uip rpa​

Annuler la session d’exécution ou de débogage en cours - fonctionne de manière uniforme pour run et debug start. Aucune option.

Exemple​

uip rpa execution cancel
uip rpa execution cancel
  • uip rpa run-file / uip rpa stop-execution — les alias hérités cachés par ces verbes remplacés; les mêmes outils sous-jacents.
  • uip rpa start-studio — payez le coût de démarrage de Studio dans une étape de configuration dédiée.
  • uip rpa remote — configurez la cible pour --remote.
  • uip rpa get-errors — inspecter les diagnostics après une exécution.

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