processo de caso uip Maestro e; Trabalho

Sintaxe e opções para "uip Maestro case process", "processes", "job", "instance" e "incident" — executando e inspecionando processos de Gerenciamento de casos e suas execuções.

Comandos de runtime para uip maestro case: process executa um processo de caso e gerencia suas configurações/tags de variáveis, job inspeciona uma tentativa de execução, instance inspeciona/orienta a instância do processo resultante, processes fornece um resumo dos processos visualizar e incident lê incidentes. Consulte Visão geral do caso para conceitos compartilhados em todo o subsistema case .

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

instance, incident e processes compartilham sua implementação com os comandos BPMN e Flow equivalentes (módulo de comandos compartilhados do @uipath/maestro-sdk) — mesmos defeitos, as mesmas correções se aplicam, parametrizados aqui para o Caso (toolLabel: "Case", processType: "CaseManagement"). Uma diferença comportamental real: --folder-key deinstance é opcional aqui (folderKeyRequired: false), onde é necessário nos equivalentes do BPMN/Flow.

Resumo

uip maestro case process list --folder-key <key> [--filter <odata>] [--login-validity <minutes>]
uip maestro case process get <process-key> <feed-id> --folder-key <key> [--login-validity <minutes>]
uip maestro case process run <process-key> <folder-key> [--inputs <json|@file>] [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>] [--validate] [--login-validity <minutes>]
uip maestro case process settings get <process-key> --folder-key <key>
uip maestro case process settings set <process-key> --folder-key <key> --inputs <json|@file>
uip maestro case process variable-tags get <process-key> --folder-key <key>
uip maestro case process variable-tags set <process-key> --folder-key <key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <true|false>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

uip maestro case processes list [--folder-key <key>] [--limit <n>] [--offset <n>] [--status <status>]
uip maestro case processes incidents <process-key> --folder-key <key>
uip maestro case processes diagnose <process-key> --folder-key <key>
uip maestro case processes error-codes <process-key> --folder-key <key>

uip maestro case job traces <job-key> [--folder-key <key>] [--poll-interval <ms>] [--traces-service <name>] [--pretty] [--login-validity <minutes>]
uip maestro case job status <job-key> [--folder-key <key>] [--detailed] [--login-validity <minutes>]

uip maestro case instance list --folder-key <key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro case instance get <instance-id> [--folder-key <key>]
uip maestro case instance pause|resume|cancel|retry <instance-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance migrate <instance-id> <new-version> [--folder-key <key>] [--comment <text>]
uip maestro case instance incidents|asset|cursors|element-executions|variables|variables-all|global-variables <instance-id> [--folder-key <key>]
uip maestro case instance variables-set <instance-id> [--folder-key <key>] --inputs <json|@file>
uip maestro case instance goto <instance-id> <transitions> [--folder-key <key>]
uip maestro case instance element cancel|retry <instance-id> <element-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance message send [--folder-key <key>] [--inputs <json|@file>]

uip maestro case incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <k>] [--status <status>] [--severity <severity>]
uip maestro case incident get <incident-id> --folder-key <key>

processo de caso do uip Maestro

Gerenciar processos de caso: liste o que está publicado em uma pasta, inspecione o esquema de entrada/saída de um ponto de entrada e execute um.

Observação:

process run leva <folder-key> como um argumento posicional, não um sinalizador — diferente de todos os outros verbos nesta página (list/get/settings/variable-tags), que usam --folder-key/-f. Essa assimetura é real, não um erro de digitação — verifique --help se um exemplo de copiar-colar parece falhar.

lista de processos de caso do uip Maestro

Listar processos de caso publicados em uma pasta.

Opções

Opção	Required	Description
-f, --folder-key <key>	sim	Chave da pasta (GUID).
--filter <odata>	não	Filtro OData adicional.
--login-validity <minutes>	não	Mínimo de minutos antes da expiração do token para disparar uma atualização. 10Padrão.

Formato dos dados

{
  "Code": "CaseProcessList",
  "Data": [
    {
      "name": "InvoiceReview",
      "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,
      "active": "Yes",
      "latest": "Yes"
    }
  ]
}

processo de caso do uip Maestro obter

Obtenha os esquemas de ponto de entrada de um processo — a forma de entrada/saída process run espera.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo.
<feed-id>	sim	ID do feed, do campo feedId de process list.

Opções

Opção	Required	Description
-f, --folder-key <key>	sim	Chave da pasta (GUID).
--login-validity <minutes>	não	10Padrão.

Formato dos dados

{
  "Code": "CaseProcessGet",
  "Data": [
    {
      "Path": "/content/caseplan.json.bpmn#Trigger_1",
      "DisplayName": "Start",
      "Type": "CaseManagement",
      "InputSchema": "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

Data é uma matriz — uma entrada por ponto de entrada que o processo expõe, não um único objeto. Falha com um erro explícito se o processo tiver zero pontos de entrada.

execução de processo de caso do uip Maestro

Inicie uma instância de processo de Caso.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo.
<folder-key>	sim	Chave de pasta (GUID) — posicional aqui, não um sinalizador.

Opções

Opção	Required	Description
-i, --inputs <json>	não	Parâmetros de entrada como uma string JSON @file.json ou. Em vez disso, omita para ler a partir de stdin; omita ambos para entradas vazias ({}).
--release-key <key>	não	Chave de lançamento (GUID), de process list.
--feed-id <id>	não	ID do feed para pesquisa de pacote.
--robot-ids <ids>	não	IDs de robô numéricos separados por vírgula. Falha rápida se alguma entrada não for um número.
--validate	não	Execute a validação básica do lado do cliente (campos obrigatórios + tipos primitivos) no esquema de entrada do processo antes de enviar. Impressão ✅/❌ e sai 1 em caso de falha sem iniciar um trabalho.
--login-validity <minutes>	não	10Padrão.

Exemplo

uip maestro case process run a1b2c3d4-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001 \
  --inputs '{"amount":100}'

Formato dos dados

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

A mensagem de sucesso aponta você para uip maestro case job traces <jobKey> para assistir à execução.

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

Ler ou substituir o objeto de configurações brutas de um processo (o mesmo objeto variable-tags lê/grava um campo).

Texto	Argumentos	Opções	Observações
get	<process-key>	-f, --folder-key <key> necessário	Code: "ProcessSettingsGet".
set	<process-key>	-f, --folder-key <key> necessário, --inputs <json|@file>	Leitura-modificação-escrita: GETs configurações atuais, PUTs sua carga como o novo objeto. Code: "ProcessSettingsSet").

variáveis-tags de processo de caso do uip Maestro

Marque as variáveis de saída de um processo (por exemplo, marcar uma pesquisável para filtragem de lista de instâncias). Dois modos independentes — escolha um, não ambos:

• Modo amigável: --variable <name> (repetível) + --element-id/--all para segmentar, mais --searchable <true|false> ou o --tags/--add-tags/--remove-tags de nível inferior para alterar.
• Modo bruto: --inputs <json|@file> com a carga completa variableTags .

Texto	Argumentos	Opções	Observações
get	<process-key>	-f, --folder-key <key> necessário	Retorna apenas o objeto variableTags. Code: "ProcessVariableTagsGet").
set	<process-key>	-f, --folder-key <key> requirements, além dos sinalizadores amigáveis/brutos acima	Combinar --inputs com qualquer sinalizador amigável é um erro. --element-id só funciona com exatamente um --variable. --searchable não pode ser combinado com --tags/--add-tags/--remove-tags. Code: "ProcessVariableTagsSet".

Exemplo

# Mark the "amount" output searchable
uip maestro case process variable-tags set a1b2c3d4-… --folder-key <key> --variable amount --searchable true

processos de caso do uip Maestro

Visualização de resumo entre processos — liste as contagens agregadas de cada processo ou avalie uma por chave. Compartilha a implementação com BPMN processes e o equivalente do Fluxo, filtrado para processType: "CaseManagement".

Texto	Argumentos	Opções	Observações
list	—	--folder-key <key>, -l/--limit <n>, --offset <n>, --status <status>	Code: "ProcessList".
incidents	<process-key>	--folder-key <key> necessário	Code: "ProcessIncidents".
diagnose	<process-key>	--folder-key <key> necessário	Correlaciona resumo + incidentes + códigos de erro em uma chamada. Code: "ProcessDiagnostics" com agregações FaultedCount/RunningCount/IncidentCount/ErrorCodeCount.
error-codes	<process-key>	--folder-key <key> necessário	Code: "ProcessIncidentErrorCodes".

trabalho de caso do uip Maestro

Inspecione uma tentativa de execução (um trabalho) de um processo de Caso.

rastreamentos de trabalho de caso do uip Maestro

Eventos de trace de execução de transmissão para um trabalho em execução ou concluído recentemente.

Opções

Opção	Padrão	Description
--folder-key <key>	—	Opcional — abrange a solicitação de trace.
--poll-interval <ms>	2000	Intervalo de pesquisa.
--traces-service <name>	llmopstenant_	Nome do serviço de traces.
--pretty	desativada	Linhas de trace legíveis por humanos em vez de JSON bruto.
--login-validity <minutes>	10	Limite de atualização do token.

Os traces são transmitidos diretamente para a saída — sem carga final.Data Código de saída 0 se for bem-sucedido, caso contrário, 1.

status do trabalho do caso do uip Maestro

Obtenha o status de um trabalho.

Opções

Opção	Required	Padrão	Description
--folder-key <key>	não	pasta autenticada	Chave da pasta (GUID, de process list). Opcional aqui — não deixe que o back-end resolva sua pasta padrão.
--detailed	não	desativada	Resposta completa em vez do resumo selecionado.
--login-validity <minutes>	não	10	Limite de atualização do token.

Formato dos dados (resumo padrão)

{
  "Code": "CaseJobStatus",
  "Data": {
    "key": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Successful",
    "runtimeType": "…",
    "processType": "CaseManagement",
    "startTime": "2025-04-15T10:30:00Z",
    "endTime": "2025-04-15T10:32:11Z",
    "creationTime": "…",
    "inputArguments": "…",
    "outputArguments": "…",
    "info": "…",
    "releaseName": "InvoiceReviewProcess",
    "processKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "robotName": "…",
    "hostMachineName": "…"
  }
}

instância de caso do uip Maestro

Inspecionar e orientar instâncias de processos individuais — uma execução de um processo de caso. Compartilha a implementação com BPMN instance e Fluxo instance; consulte qualquer página para a referência completa verbo por verbo (list, get, pause, resume, cancel, retry, migrate, variables, variables-set, variables-all, global-variables, incidents, asset, cursors, goto, element-executions, element cancel/retry, message send) — cada nome de opção, padrão e forma de dados é idêntica.

A única diferença real: -f, --folder-key é opcional em cada subcomando instance para Caso (folderKeyRequired: false na configuração de comandos compartilhados), onde o BPMN e o Fluxo exigem isso. Omita o escopo para sua pasta padrão autenticada.

incidente de caso do uip Maestro

Leia incidentes entre processos ou por ID. Implementação idêntica à BPMN incident/equivalente do Fluxo — consulte qualquer página para obter a tabela de Opções completa de 6 sinalizadores summary e a única necessária --folder-key do get.

Exemplos

# Publish check, then run
uip maestro case process list --folder-key <key>
uip maestro case process get a1b2c3d4-… default --folder-key <key>
uip maestro case process run a1b2c3d4-… <key> --inputs '{"amount":100}'

# Watch it through to completion
JOB_KEY=$(uip maestro case process run a1b2c3d4-… <key> --inputs '{}' --output-filter "Data.jobKey" --output plain)
uip maestro case job traces "$JOB_KEY" --pretty
uip maestro case job status "$JOB_KEY" --detailed

# Diagnose a failing process in one call
uip maestro case processes diagnose a1b2c3d4-… --folder-key <key>

Veja também

• Case overview
• uip maestro bpmn instance / uip maestro flow instance — referência completa de instância compartilhada
• uip maestro bpmn incident — referência completa de incidente compartilhado
• Trabalhos do Orchestrator