uip maestro bpmn debug

Upload a local Maestro BPMN project (or a single .bpmn file) to Studio Web and run a server-side debug session with streamed status updates using `uip maestro bpmn debug`.

uip maestro bpmn debug uploads a local Maestro project — or a single .bpmn file — to Studio Web and runs a server-side debug session, streaming per-element status updates back to the console and returning a final status. It's registered under the bpmn branch.

Resumo

uip maestro bpmn debug [project-path]
                  [--bpmn-file <path>]
                  [--folder-id <id>]
                  [--poll-interval <ms>]
                  [-i, --inputs <json>]
                  [--login-validity <minutes>]

Requer uip login. Recebe opções globais. Os códigos de saída seguem o contrato padrão.

Argumentos

• [project-path] (optional) — path to the Maestro project directory. Must contain project.uiproj. Omit when using --bpmn-file. One of <project-path> or --bpmn-file is required; passing both is an error ("Provide either a project path or --bpmn-file, not both.").

Opções

Opção	Padrão	Description
--bpmn-file <path>	—	Debug a single .bpmn file directly instead of a project directory. Mutually exclusive with <project-path>.
--folder-id <id>	Detecção automática	Pasta do Orchestrator (OrganizationUnitId). Se omitido, a pasta na sessão de logon atual será usada. Analisado e validado por meio de parseFolderId.
--poll-interval <ms>	2000	Intervalo de pesquisa em milissegundos. Deve ser um número positivo.
-i, --inputs <json>	—	Argumentos de entrada como string @path/to/file.json ou.
--login-validity <minutes>	10	Mínimo de minutos antes da expiração do token para disparar uma atualização automática.

Comportamento

1. Valida o login e extrai a organização, tenant, URL base e token de autenticação da sessão.
2. Carrega o projeto para o Studio Web na pasta de destino.
3. Pesquisa o status final, emitindo linhas de status por elemento, como:

   Status: InProgress (2/5 elements completed)
     v Activity_1 [Completed]
     > Activity_2 [InProgress]
     - Activity_3 [NotStarted]
   

4. Em incidentes durante a execução, emite uma linha de log.
5. Sai de 0 se finalStatus for Completed ou Successful; 1 caso contrário.

Exemplos

# Debug with auto-detected folder
uip maestro bpmn debug ./invoice-orchestration

# Specify folder and inline inputs
uip maestro bpmn debug ./invoice-orchestration --folder-id 2553016 \
  --inputs '{"amount":100,"customer":"Acme"}'

# Inputs from a file
uip maestro bpmn debug ./invoice-orchestration --inputs @inputs.json

# Debug a single .bpmn file directly, without a full project directory
uip maestro bpmn debug --bpmn-file ./main.bpmn

Formato dos dados (--output json)

{
  "Code": "MaestroDebug",
  "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/studio_/designer/f6a7b8c9-...?solutionId=e5f6a7b8-...",
    "elementExecutions": [
      { "elementId": "Activity_1", "status": "Completed" }
    ]
  }
}

studioWebUrl links directly to the debug run in Studio Web.

Veja também

• uip maestro bpmn process run — execute um processo publicado
• uip maestro bpmn job traces — transmitir rastreamentos para um trabalho já iniciado
• Autenticação
• Visão geral do Maestro