caso do uip Maestro

Crie, empacote, depure, valide e crie projetos de Gerenciamento de Caso usando o "uip Maestro Case", a terceira superfície de orquestração do Maestro ao lado de BPMN e Flow.

uip maestro case cria, empacota, depura e cria projetos de Gerenciamento de Casos — uma terceira superfície de orquestração do Maestro ao lado de BPMN e Flow. Um projeto de caso modela uma unidade de trabalho de longa duração e orientada por humanos como um plano de caso: um documento JSON (caseplan.json) descrevendo estágios, tarefas, SLAs, gatilhos e as condições de entrada/saída que movem um caso entre os estágios — mais próximo de um fluxo de trabalho estruturado com um ciclo de vida do que de um processo linear.

A ferramenta é enviada como o pacote @uipath/case-tool separado, carregado dinamicamente por @uipath/maestro-tool na ramificação case — cada comando aqui é invocado como uip maestro case <verb>, nunca como um uip case autônomo.

Esse recurso abrange nove páginas

• Esta página — conceitos e os comandos do ciclo de vida do projeto: init, pack, debug, validate, spec.
• registry — navegar/pesquisar o catálogo de recursos de automação para o qual um caso conecta tarefas, além de como vincular uma entrada de tarefa a uma variável.
• cases e stages — leia os metadados de nível superior do plano de caso e a lista de estágios.
• tasks — ler, enriquecer e descrever definições de tarefas dentro de um estágio.
• task-entry-conditions — leia as regras que controlam quando uma tarefa se torna executável.
• sla — leia regras de SLA/escalonamento.
• triggers, sticky-notes, edges — leia gatilhos de casos, anotações de tela e transições entre estágios.
• case-exit-conditions, stage-entry-conditions, stage-exit-conditions — leia as regras de condição para os níveis de caso e de estágio.
• process, processes, job, instances, incidents — implantar e executar instâncias de caso no Orchestrator.

Conceitos

• O modelo de criação: edite caseplan.json diretamente, depois validate. Não há caminho de transformação orientado por CLI para o conteúdo do caso. Crie ou edite caseplan.json manualmente (ou peça que um agente faça isso, guiado pelas referências em forma de JSON da habilidade uipath-maestro-case ) e, em seguida, execute uip maestro case validate para verificá-lo. Os verbos read documentados nas páginas irmãs acima (cases get, stages list, tasks get etc.) existem para ajudar você a inspecionar o plano enquanto o cria dessa forma — eles não fazem parte de uma API de gravação.
• Caso versus BPMN versus Fluxo — todos as três são superfícies de orquestração do Maestro que empacotam para .nupkg e compartilham primitivos de runtime (process/job/instances/incidents/registry), mas o próprio Gerenciamento de casos o ativo principal é caseplan.json (mais um caseplan.json.bpmn gerado), e seu tipo de projeto é CaseManagement em operate.json/project.uiproj — distinto do .bpmn do BPMN e do .flow do Fluxo.
• Perfis de validação — validate executa um de quatro perfis, dependendo de até que ponto a criação está: skeleton (apenas estrutura — nós, bordas, identidade, tipos), skeleton-v2 (esqueleto mais SLA/escalation/entry-exit-rule verificações, ainda ignorando o conteúdo da tarefa), strict (cada verificação, incluindo estágio sem tarefas, marcadores $xref não resolvidos e integridade do contexto do conector — a porta de caso concluído) e o perfil padrão full ( Modelo, para arquivos parcialmente autorizados ou já empacotados). --sdd <path> audita a integridade de um documento específico e implica --strict.
• spec uma ferramenta de planejamento, não um modificador de planos de casos: ele busca uma descrição normalizada de uma atividade ou gatilho do conector do Integration Service (entradas, saídas, campos obrigatórios) para que você saiba o que colocar na tarefa de caseplan.json / definições de gatilho antes de escrevê-las. Encontre os valores --activity-type-id/--connection-id necessários por meio de registry get-connector/get-connection.

Resumo

uip maestro case init <name> [--force] [--skip-solution-registration]
uip maestro case pack <project-path> <output-path> [-n, --name <name>] [-v, --version <version>] [package-metadata options...]
uip maestro case debug <project-path> [--folder-id <id>] [--poll-interval <ms>] [--login-validity <minutes>]
uip maestro case validate <file> [--skeleton | --skeleton-v2 | --strict] [--sdd <path>]
uip maestro case spec --type <activity|trigger> --activity-type-id <uuid> --connection-id <id> [--object-name <name>] [--skip-case-shape | --input-details <json>]

init de caso do uip Maestro

Crie um novo projeto Case com arquivos boilerplate: project.uiproj, operate.json, entry-points.json, bindings_v2.json, package-descriptor.json e um caseplan.json mínimo (escrever apenas se ainda não existir nenhum — executando novamente init nunca supera um plano de caso criado). Se executado fora de uma solução existente, um <name>Solution pai será estruturado automaticamente e o projeto do caso será aninhado dentro dele; se for executado dentro de um, o projeto será registrado nessa solução.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do projeto do caso. Somente letras, números, sublinhados e hifens.

Opções

Long	Valor	Description
--force	Bandeira	Inicialize mesmo que o diretório de destino não esteja vazio. Grava arquivos sem limpar o conteúdo existente.
--skip-solution-registration	Bandeira	Não registre automaticamente este projeto na solução ao redor.

Exemplo

uip maestro case init my-case-project

Formato dos dados (--output json)

{
  "Code": "CaseInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-case-project",
    "CasePlan": "/workspace/my-case-project/caseplan.json",
    "CasePlanStatus": "Created",
    "SolutionRegistration": { "Status": "Registered", "Solution": "...", "ProjectId": "..." },
    "AutoCreatedSolution": { "...": "present only when a parent solution was scaffolded" },
    "ProjectArtifacts": { "...": "present only when registered into a parent solution" },
    "NextSteps": "present only when SolutionRegistration.Instructions is set"
  }
}

CasePlanStatus é "Created" em uma estrutura nova ou "Preserved" quando um caseplan.json existente foi deixado intacto (executando init em um projeto que você já criou). SolutionRegistration está sempre presente — seu Status é "NotInSolution" em vez do campo que está sendo omitido quando não existe nenhuma solução pai.

pacote de casos uip Maestro

Empacote um diretório de projeto Caso em um arquivo .nupkg, lendo caseplan.json da raiz do projeto.

Argumentos

Name	Required	Finalidade
<project-path>	sim	Caminho para o diretório do projeto Caso.
<output-path>	sim	Diretório de saída para o .nupkg.

Opções

Long	Valor	Description
-n, --name <name>	String	Nome do pacote. Padrão: nome da pasta do projeto.
-v, --version <version>	String	Versão do pacote. 1.0.0Padrão.

Também aceita as opções de metadados de pacote compartilhados deste repositório (--repository-url/--repository-commit/--repository-branch/--repository-type, --release-notes, --project-url, --author, --description) — veja qualquer outro comando pack Tabela de opções (por exemplo uip maestro bpmn pack) para o conjunto compartilhado completo, que esse comando registra de forma idêntica.

Exemplo

uip maestro case pack ./my-case-project ./dist --version 1.2.0

Formato dos dados (--output json)

{
  "Code": "CasePack",
  "Data": {
    "Package": "my-case-project.1.2.0.nupkg",
    "Output": "./dist/my-case-project.1.2.0.nupkg"
  }
}

Um erro de esquema durante o empacotamento (um caseplan.json malformado) é enriquecido com orientação específica de casos antes de aparecer como uma falha — espere um Instructions acionável, não um erro de analisador bruto.

Depuração de caso do uip Maestro

Depurar um projeto de caso carregando-o para o Studio Web e executando uma sessão de depuração lá — não há modo de depuração somente local para Gerenciamento de caso (ao contrário de alguns outros comandos de depuração do Maestro).

Argumentos

Name	Required	Finalidade
<project-path>	sim	Caminho para o diretório do projeto do caso. Deve conter project.uiproj.

Opções

Long	Valor	Description
--folder-id <id>	Número inteiro	ID da pasta do Orchestrator (OrganizationUnitId). Detectado automaticamente quando omitido.
--poll-interval <ms>	Número inteiro	Intervalo de pesquisa em milissegundos. 2000Padrão.
--login-validity <minutes>	Número inteiro	Mínimo de minutos antes da expiração do token para disparar uma atualização. 10Padrão.

Requer um login ativo (uip login) com uma organização, tenant e token de acesso resolvidos — falha rapidamente com uma mensagem específica nomeando qualquer parte do estado de login que está faltando.

Exemplo

uip maestro case debug ./my-case-project

Formato dos dados (--output json)

{
  "Code": "CaseDebug",
  "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": "Stage_1", "status": "Completed" },
      { "elementId": "Stage_2", "status": "Completed" }
    ]
  }
}

As chaves são mantidas em seu CamelCase nativo (não PascalCased) — essa carga é projetada para ser lida programaticamente por verificadores de avaliação e SDKs, correspondendo ao mesmo escopo usado pelo comando debug do Flow registry get e. O comando sai de diferente de zero quando finalStatus é qualquer coisa diferente de "Completed"/"Successful", mesmo que o próprio envelope reporte Result: "Success" — verifique o código de saída, não apenas a presença de Data, em scripts.

validação de caso do uip Maestro

Validar um arquivo JSON de gerenciamento de caso em relação às regras estrutural e de negócios do Gerenciamento de caso.

Argumentos

Name	Required	Finalidade
<file>	sim	Caminho para o arquivo JSON de gerenciamento de caso (normalmente caseplan.json).

Opções

Long	Description
--skeleton	Apenas verificações estruturados (nós, bordas, identidade, tipos). Ignora o conteúdo da tarefa, SLAs, escalonamentos e regras de entrada/saída — útil durante a fase de esqueleto da criação. Entre em conflito com --skeleton-v2/--strict.
--skeleton-v2	Verificações de esqueleto, além de SLA, escalonamento e verificações de regras de entrada/saída. Ainda ignora o conteúdo da tarefa. Entre em conflito com --skeleton/--strict.
--strict	Cada verificação, mais o conjunto restrito: um estágio sem tarefas, marcadores $xref não resolvidos, um conditionExpression suspenso, formas de vinculação de saída/argumento oficial e integridade do contexto do conector. A porta de caso concluído. Entre em conflito com --skeleton/--skeleton-v2.
--sdd <path>	Audite o plano de caso para obter integridade em relação ao SDD (documento das especificações) fornecido — cada estágio, tarefa, tipo de tarefa, linha de condição, SLA, gatilho e variável de caso que ele declara deve estar presente. Implica --strict.

A omissão de todos os quatro executa o perfil padrão full: suave, portanto, arquivos parcialmente autorizados ou já empacotados ainda validam.

Exemplos

uip maestro case validate case.json
uip maestro case validate case.json --skeleton
uip maestro case validate case.json --strict
uip maestro case validate case.json --sdd ./spec.md

Formato dos dados (--output json)

{
  "Code": "CaseValidate",
  "Data": {
    "File": "case.json",
    "Status": "Valid",
    "Warnings": "2 warning(s):\n  - [stages[0].tasks[1]] ...",
    "Issues": [
      { "Code": "UNRESOLVED_REFERENCE", "Path": "stages[0].tasks[1]", "Message": "...", "Severity": "warning" }
    ]
  }
}

Profile: "strict" é adicionado a Data apenas quando --strict (ou --sdd) é passado. Warnings/Issues estão presentes apenas quando o arquivo válido ainda produziu avisos. Em caso de falha (Result: "Failure", saída 1), Data.Issues carrega todos os erros e avisos com um Code, Path, Message e Severity estáveis — analise essa matriz em vez do Instructions legível por humanos } se você estiver direcionando um loop de reparo.

especificação do caso do uip Maestro

Gerar um ConnectorTaskSpec normalizado — tudo o necessário para construir uma atividade executável do Integration Service ou disparar tarefa dentro de um plano de caso. Pesquisa o tipo no TypeCache local, lista as conexões do Integration Service para o conector e busca os metadados do Integration Service.

Opções

Long	Valor	Required	Description
--type <type>	activity | trigger	sim	Qual TypeCache procurar.
--activity-type-id <uuid>	UUID	sim	Studio Web uiPathActivityTypeId. Encontre-o por meio de registry pull + lendo o arquivo de cache typecache-{activities,triggers}-index.json ou registry get-connector.
--connection-id <id>	UUID	sim	ID de conexão. Listar candidatos com registry get-connection --type typecache-{activities,triggers} --activity-type-id <uuid>.
--object-name <name>	String	não	Substitua o TypeCache objectName. Obrigatório para gatilhos selecionados tipo entidade cujo TypeCache armazena um espaço reservado (por exemplo Data Service {tenantEntityName|folderEntityName}) — escolha um nome de entidade real.
--skip-case-shape	Bandeira	não	Omita caseShape (inputs[]/outputs[]/context[]) da resposta — use durante o planejamento quando você precisa apenas do contrato do conector. mutuamente exclusivo com --input-details.
--input-details <json>	JSON	não	Preencha previamente os valores segmentados no caseShape gerado. A forma difere por --type: a atividade aceita {bodyParameters, queryParameters, pathParameters, filter}; o gatilho aceita {eventParameters, filter}. mutuamente exclusivo com --skip-case-shape.

Exemplos

# Curated connector activity (Send Email)
uip maestro case spec --type activity \
  --activity-type-id c7ce0a96-2091-3d94-b16f-706ebb1eb351 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

# Curated connector trigger (Email Received)
uip maestro case spec --type trigger \
  --activity-type-id 7dc57f24-894c-5ae2-a902-66056fa40609 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

Formato dos dados (--output json)

{
  "Code": "ConnectorTaskSpec",
  "Data": {
    "specVersion": 1,
    "identity": {
      "target": "activity",
      "uiPathActivityTypeId": "c7ce0a96-2091-3d94-b16f-706ebb1eb351",
      "connectorKey": "uipath-microsoft-outlook365",
      "objectName": "send-mail-v2",
      "typecacheEntry": { "displayName": "Send Email" }
    },
    "operation": { "name": "POST", "verb": "create", "httpMethod": "POST", "path": "/hubs/productivity/send-mail-v2" },
    "inputs": { "bodyFields": [{ "name": "message.toRecipients", "required": true }] }
  }
}

A forma operation de uma especificação de gatilho difere (eventModenome do evento em vez de um verbo/caminho HTTP) — consulte o segundo exemplo acima.

Relacionado

• registry — descubra recursos para fazer referência em um plano de caso e como associar uma entrada de tarefa a uma variável.
• cases e stages — inspecionar metadados e estágios do plano de caso.
• tasks — inspecionar, enriquecer e descrever definições de tarefas.
• task-entry-conditions — inspecione as regras de entrada no nível da tarefa.
• sla — inspecione as regras de SLA/escalonamento.
• triggers, sticky-notes, edges — inspecionar gatilhos, notas de tela e transições.
• condições — inspecione as regras de condição de entrada/saída nos níveis de casos e de estágio.
• process, processes, job, instances, incidents — implantar e executar instâncias de caso.
• uip maestro — Orquestração BPMN, a superfície irmã.
• uip maestro flow — Orquestração de fluxo, a outra superfície irmã.

Veja também

• Visão geral da ferramenta Maestro
• Opções globais
• Códigos de saída