processo de fluxo do uip Maestro e processos de fluxo do uip Maestro

Sintaxe e opções para "uip Maestro Flow Process" e "uip Maestro Flow Process", cobrindo operações de processo Flow publicadas por pasta e em todo o tenant.

Depois que um pacote de fluxo é publicado no Orchestrator, ele se torna um processo. Esta página abrange dois grupos de comando relacionados:

• uip maestro flow process operações por pasta em uma única definição de processo (listar em uma pasta, obter seu esquema, executá-la).
• uip maestro flow processes plral) — resumos de todo o tenant e pesquisa de incidentes por processo.

Resumo

# Singular — per-folder, operational
uip maestro flow process list (-f <folder-key> | --folder-path <path>) [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list [--folder-key <key>] [-l, --limit <number>] [--offset <number>] [--status <status>]
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

Todos os subcomandos exigem uip login e honram as opções globais. Os códigos de saída seguem o contrato padrão.

---

lista de processos do fluxo do uip Maestro

Lista os processos de fluxo disponíveis (versões) em uma pasta específica.

Opções

Opção	Required	Description
-f, --folder-key <key>	one of --folder-key or --folder-path	Chave da pasta (GUID).
--folder-path <path>	one of --folder-key or --folder-path	Folder path, e.g. Shared/Invoices. When you pass both options, they must refer to the same folder.
--filter <odata>	não	Filtro OData adicional aplicado no lado do servidor.
--login-validity <minutes>	não	Limite de atualização do token (padrão 10).

Passing neither --folder-key nor --folder-path fails with exit code 3.

Formato dos dados (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "releaseActive": "Yes",
      "releaseLatest": "Yes"
    }
  ]
}

releaseActive and releaseLatest reflect the Orchestrator release state: whether the release is marked active, and whether it is the highest version. They do not indicate whether the process is deployed or runnable.

---

processo de fluxo do uip Maestro obter

Buscar o esquema de ponto de entrada (esquemas JSON de entrada/saída) para um processo de Flow. Use o resultado para criar uma carga --inputs válida para process run.

Argumentos

• <process-key> (necessário) — chave de processo, por exemplo MyFlow.flow.Flow:1.0.0 ou <package-id>:<version>.
• <feed-id> (necessário) — ID do feed (da saída do list ).

Opções

• -f, --folder-key <key> (necessário)
• --login-validity

Formato dos dados

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema e OutputSchema são JSON com nova string; analise-os como esquema JSON para direcionar a construção de entrada.

---

execução do processo de fluxo do uip Maestro

Inicie um trabalho de fluxo para um processo publicado.

Argumentos

• <process-key> (necessário) — chave do processo (por exemplo MyFlow.flow.Flow:1.0.0).
• <folder-key> necessário) — chave de pasta (GUID).

Opções

Opção	Description
-i, --inputs <json>	Entradas como uma string JSON ou @path/to/file.json. Se omitido e stdin estiver tabulado, stdin será analisado como entradas.
--release-key <key>	Release key (GUID) — from process list. When omitted, the command looks up the release that matches <process-key> (name and version) in the folder. If no release or more than one release matches, the command fails with Code: "FlowReleaseKeyRequired"; pass the matching releaseKey from process list.
--feed-id <id>	ID do feed para pesquisa de pacote (opcional).
--robot-ids <ids>	IDs de robô separados por vírgulas (inteiros). Os valores inválidos falham rapidamente.
--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.
--wait	Bloquear até que o trabalho atinja um estado terminal em vez de retornar imediatamente Pending com.
--timeout <seconds>	Maximum seconds to wait. 0 = no timeout. Default: 1800. Requires --wait.
--poll-interval <seconds>	Seconds between status checks while waiting. Default: 5. Requires --wait.
--validate	Valide entradas em relação ao esquema do processo antes de executar. Executa apenas verificações básicas — campos necessários presentes e correspondência de tipos primitivos. Restrições complexas (enums, padrões, referências) não são aplicadas por este passe.
--login-validity <minutes>	Limite de atualização do token (padrão 10).

Precedência de entrada: --inputs <json> / --inputs @file.json > stdin > empty object {}.

Exemplos

# Run with inline JSON (the release key is looked up)
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --inputs '{"amount":100}'

# Run a specific release
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Bind a local file to a file-typed input variable
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --attachment file1=./resume.pdf

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Formato dos dados

{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "folderKey": "c3d4e5f6-0000-0000-0000-000000000001"
  }
}

Next step: uip maestro flow job traces <jobKey> --folder-key <folder-key> to stream execution or uip maestro flow job status <jobKey> to poll. With --wait, the command keeps polling after this output until the job reaches a terminal state.

---

configurações de processo do fluxo do Maestro do uip

Obter ou atualizar as configurações de runtime de um processo.

configurações do processo de fluxo do uip Maestro obter

Argumentos

• <process-key> necessário) — chave de definição de processo.

Opções

• -f, --folder-key <key> (necessário)

Formato dos dados

Code: "ProcessSettingsGet", Data é o objeto de configurações do processo.

conjunto de configurações do processo de fluxo do uip Maestro

Argumentos

• <process-key> (necessário)

Opções

Opção	Description
-f, --folder-key <key>	(obrigatório) Chave da pasta (GUID).
--inputs <value>	Configurações da carga como uma string JSON, um caminho @file ou canalizado via stdin.

Formato dos dados

Code: "ProcessSettingsSet".

variáveis-tags de processo do fluxo do UIP Maestro

Obtenha ou atualize tags de pesquisa nas variáveis de saída de um processo — quais variáveis podem ser usadas para filtrar instâncias.

variável-tags de processo do fluxo do uip Maestro obter

Argumentos

• <process-key> (necessário)

Opções

• -f, --folder-key <key> (necessário)

Formato dos dados

Code: "ProcessVariableTagsGet", Data é o mapa variableTags do processo ({} se nenhum tiver sido definido).

conjunto de tags e variáveis de processo do fluxo do uip Maestro

Dois estilos de entrada mutuamente exclusivos: passe --inputs com uma carga JSON completa ou use os sinalizadores amigáveis --variable/--all/--searchable/--tags/--add-tags/--remove-tags — a combinação de ambos falha com um erro.

Argumentos

• <process-key> (necessário)

Opções

Opção	Description
-f, --folder-key <key>	(obrigatório) Chave da pasta (GUID).
--variable <name>	Nome de uma variável (saída) a ser marcada. Repetível, para marcar várias em uma chamada.
--element-id <id>	Elemento que possui a variável — desambigua quando o mesmo nome aparece em vários elementos. Válido apenas com um único --variable.
--all	Aplique a alteração a cada variável marcável.
--searchable <bool>	Marque a(s) variável(is) pesquisável(is) para a filtragem de instância (true/false).
--tags <csv>	Avançado: substitua imediatamente as tags atuais da variável. Um valor vazio os limpa.
--add-tags <csv>	Adicione tags às tags atuais da variável.
--remove-tags <csv>	Remova tags das tags atuais da variável.
--inputs <value>	Carga completa de variáveis-tags como uma string JSON, um caminho @file ou tabulada via stdin — uma alternativa aos sinalizadores acima.

Formato dos dados

Code: "ProcessVariableTagsSet". With --inputs, Data is the updated process settings. With the flags, Data is { updated, variableTags }.

---

uip maestro flow processes list [--folder-key ] [-l, --limit ] [--offset ] [--status ]

Tenant-wide summary of Flow processes.

Opções

Opção	Description
--folder-key <key>	Folder key, to scope the summary to one folder.
-l, --limit <number>	Number of items to return (1–10000).
--offset <number>	Number of items to skip (0–1000000). Default: 0.
--status <status>	Filtrar por status do processo.

Formato dos dados

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}

Observação:

O conjunto de campos exato de cada resumo de processo é especificado pelo runtime do Maestro e pode evoluir; execute o comando uma vez com --output json em um tenant com dados para ver os campos que você consumirá e fixe @uipath/cli no CI se você analisar campos específicos.

---

incidentes de processos de fluxo do uip Maestro

Obtenha todos os incidentes para uma definição específica do processo Flow (não uma única instância).

Argumentos

• <process-key> necessário) — chave de definição de processo.

Opções

• --folder-key <key> necessário) — chave de pasta para delimitar a pesquisa.

Formato dos dados

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

Consulte uip maestro flow incident para obter o formato por incidente.

diagnóstico de processos de fluxo do uiip Maestro

Correlacione o resumo, incidentes e códigos de erro de um processo em uma chamada — um comando de triagem rápida.

Argumentos

• <process-key> necessário) — chave de definição de processo.

Opções

• --folder-key <key> (necessário)

Formato dos dados

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

códigos de erro de processos de fluxo do uip Maestro

Obtenha o conjunto exclusivo de códigos de erro vistos nos incidentes de um processo.

Argumentos

• <process-key> (necessário)

Opções

• --folder-key <key> (necessário)

Formato dos dados

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

Veja também

• uip maestro flow instance — inspeciona e orienta execuções em execução
• uip maestro flow job — rastreamentos e status para um único trabalho
• uip maestro flow incident — resumos e detalhes de incidentes
• Trabalhos do Orchestrator, Processos do Orchestrator
• Visão geral do fluxo