UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Depuração do fluxo do uip Maestro

Sintaxe e opções para a "uip Maestro flow debug", que carrega um projeto de fluxo local no Studio Web e executa uma sessão de depuração no lado do servidor com atualizações de status transmitidas.

uip maestro flow debug um projeto de fluxo local no Studio Web e executa uma sessão de depuração no lado do servidor, transmitindo atualizações de status por elemento de volta para o console e retornando um status final.

Resumo

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

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

Argumentos

  • <project-path> (necessário) — caminho para o diretório do projeto Fluxo. Deve conter um project.uiproj.

Opções

OpçãoPadrãoDescription
--folder-id <id>Detecção automáticaPasta do Orchestrator (OrganizationUnitId), um número inteiro positivo. mutuamente exclusivo com --folder-key/--folder-path. Se nenhum dos três for fornecido, a pasta na sessão de logon atual será usada.
--folder-key <key>Chave da pasta do Orchestrator (UUID) — resolvida para o ID da pasta pela CLI. mutuamente exclusivo com --folder-id/--folder-path.
--folder-path <path>Caminho da pasta do Orchestrator, por exemplo Shared/Sub — resolvido para o ID da pasta pela CLI. mutuamente exclusivo com --folder-id/--folder-key. Use uip or folders list para descobrir chaves/caminhos válidos.
--poll-interval <ms>2000Intervalo de pesquisa em milissegundos enquanto aguarda o Studio Web avançar a sessão.
-i, --inputs <json>Argumentos de entrada como uma string JSON ou @path/to/file.json para ler de um arquivo.
--attachment <name=path>Carregue um arquivo local para o Orchestrator e associe-o como uma variável de entrada de tipo de arquivo. Repetível, por exemplo --attachment file1=./resume.pdf). Substitui o mesmo nome de variável se também estiver presente em --inputs.
--open-in-browserAbra o URL da sessão do Studio Web em um navegador quando disponível.
--login-validity <minutes>10Mí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, nome da organização 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 Node_1 [Completed]
      > Node_2 [InProgress]
      - Node_3 [NotStarted]
    Status: InProgress (2/5 elements completed)
      v Node_1 [Completed]
      > Node_2 [InProgress]
      - Node_3 [NotStarted]
    
  4. Em incidentes durante a execução, emite uma linha de aviso.
  5. Sai de 0 se finalStatus for Completed ou Successful; 1 caso contrário.

Exemplos

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

Formato dos dados (--output 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": {}
  }
}
{
  "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": {}
  }
}

studioWebUrl em um navegador para inspecionar a sessão interativamente.

Entrega do gatilho de conversa

Um fluxo cujo ponto de entrada é core.trigger.conversation só pode ser orientado por uma interface gráfica de chat — a CLI não pode iniciar uma sessão de depuração para ele. Em vez disso, ele carrega o projeto no Studio Web e entrega:

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

Nenhum campo elementExecutions/finalStatus está presente — nada foi executado, então não há nada para pesquisar. Passe --open-in-browser para que a CLI seja aberta studioWebUrl automaticamente.

Execução com falha — incidentes em linha

Uma execução com falha é retornada como um envelope Result: "Failure" (código de saída 1), com detalhes do incidente já incorporados em Data.incidents — nenhum comando de acompanhamento é necessário para ver o que interrompeu:

{
  "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."
      }
    ]
  }
}
{
  "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."
      }
    ]
  }
}

Em uma execução com falha, o erro Instructions aponta para você em uip maestro flow debug-instance incidents <instanceId> para inspecionar a carga útil de back-end bruta — consulte debug-instance para essa superfície de controle de nível inferior.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades