Débogage du flux uip maestro

Syntaxe et options pour `uip maestro flow debug`, qui charge un projet Flow local dans Studio Web et exécute une session de débogage côté serveur avec des mises à jour de statut diffusées.

uip maestro flow debug charge un projet Flow local dans Studio Web et exécute une session de Debug côté serveur, en streaming les mises à jour de statut par élément vers la console et en renvoyant un statut final.

Synthèse

uip maestro flow debug <project-path>
               [--folder-id <id> | --folder-key <key> | --folder-path <path>]
               [--poll-interval <ms>]
               [-i, --inputs <json>]
               [--attachment <name=path>]...
               [--open-in-browser]
               [--login-validity <minutes>]

Nécessite uip login. Les options globales sont respectées. Les codes de sortie suivent le contrat standard.

Arguments

• <project-path> (obligatoire) : chemin d'accès au répertoire du projet Flow. Doit contenir une project.uiproj.

Options

Option	Default	Description
--folder-id <id>	Détecté automatiquement	Dossier Orchestrator (OrganizationUnitId), un entier positif. mutuellement exclusif avec --folder-key/--folder-path. Si aucun des trois n'est fourni, le dossier de la session de connexion actuelle est utilisé.
--folder-key <key>	—	Clé de dossier Orchestrator — résolue en l'ID de dossier par la CLI. Capture mutuellement exclusive avec --folder-id/--folder-path.
--folder-path <path>	—	Chemin du dossier Orchestrator, par exemple Shared/Sub — résolu en l'ID de dossier par la CLI. mutuellement exclusif avec --folder-id/--folder-key. Utilisez uip or folders list pour découvrir des clés/chemins valides.
--poll-interval <ms>	2000	Intervalle d’interrogation en millisecondes en attendant que Studio Web fasse progresser la session.
-i, --inputs <json>	—	Arguments d'entrée sous forme de chaîne JSON ou @path/to/file.json à lire dans un fichier.
--attachment <name=path>	—	Chargez un fichier local dans Orchestrator et liez-le en tant que variable d'entrée de type fichier. Répétable, par exemple --attachment file1=./resume.pdf. Remplace le même nom de variable s'il est également présent dans --inputs.
--open-in-browser	—	Ouvrez l'URL de la session Studio Web dans un navigateur une fois disponible.
--login-validity <minutes>	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation automatique.

Comportement

1. Valide la connexion et extrait l'organisation, le locataire, l'URL de base, le nom de l'organisation et le jeton d'authentification de la session.
2. Charge le projet dans Studio Web sous le dossier cible.
3. Interrogation pour un statut final, extrayant des lignes de statut par élément comme:

   Status: InProgress (2/5 elements completed)
     v Node_1 [Completed]
     > Node_2 [InProgress]
     - Node_3 [NotStarted]
   

4. En cas d'incident pendant l'exécution, génère une ligne d'avertissement.
5. Quitte 0 si finalStatus est Completed ou Successful; 1 dans le cas contraire.

Exemples

# Debug a local project, auto-detect folder, default poll interval
uip maestro flow debug ./invoice-flow

# Debug against a specific folder with inline JSON inputs
uip maestro flow debug ./invoice-flow --folder-id 2553016 \
  --inputs '{"amount":100,"customer":"Acme"}'

# Debug with inputs from a file
uip maestro flow debug ./invoice-flow --inputs @inputs.json

# Slower polling for long-running flows
uip maestro flow debug ./invoice-flow --poll-interval 5000

Format des données (--sortie json)

{
  "Code": "FlowDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Completed",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "elementExecutions": [
      { "elementId": "Node_1", "status": "Completed" }
    ],
    "variables": {}
  }
}

Ouvrez studioWebUrl dans un navigateur pour inspecter la session de manière interactive.

Transfert du déclencheur conversationnel

Un flux dont le point d'entrée est core.trigger.conversation ne peut être généré que par une interface utilisateur de chat — la CLI ne peut pas démarrer une session de débogage pour elle. Au lieu de cela, il charge le projet dans Studio Web et transmet:

{
  "Code": "FlowDebugStudioWebHandoff",
  "Data": {
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/studio_/designer/a1b2c3d4?solutionId=e5f6a7b8",
    "handedOff": true
  }
}

Aucun champ elementExecutions/finalStatus n’est présent, il n’y a rien qui a été exécuté, il n’y a donc rien à interroger. Transmettez --open-in-browser pour que la CLI ouvre automatiquement studioWebUrl.

Exécution défaillante — incidents en ligne

Une exécution défaillante est renvoyée sous la forme d'une enveloppe Result: "Failure" (code de sortie 1), avec les détails de l'incident déjà incorporés dans Data.incidents — aucune commande de suivi n'est nécessaire pour voir ce qui a cassé:

{
  "Code": "FlowDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Faulted",
    "incidents": [
      {
        "incidentId": "inc-1",
        "elementId": "Node_3",
        "errorCode": "Process.UnhandledException",
        "errorMessage": "Object reference not set to an instance of an object."
      }
    ]
  }
}

Sur une exécution défaillante, l'erreur Instructions vous dirige vers uip maestro flow debug-instance incidents <instanceId> pour inspecter la charge utile backend brute - voir debug-instance pour cette surface de contrôle de niveau inférieur.

Voir également

• uip maestro flow debug-instance — Contrôle étape par étape d'une session de débogage pour créer des outils personnalisés
• uip maestro flow validate — vérification statique avant l'exécution
• uip maestro flow process run — exécute un processus publié
• uip maestro flow job traces — traçages de flux pour une tâche déjà démarrée
• Authentification
• Vue d’ensemble du flux