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.

registro de caso do uip Maestro

Navegue e pesquise o registro do Maestro Case Management de atividades, gatilhos, conectores e outros recursos de automação usando o "registro de caso do Maestro".

uip maestro case registry e pesquisa o registro de Gerenciamento de casos — um catálogo local em cache dos recursos de automação (processos, agentes, APIs, fluxos, atividades/gatilhos de conectores, apps de ação e, opcionalmente, os recursos próprios de uma solução em andamento) uma definição de caso pode conectar tarefas. Extraia o registro uma vez por sessão e, em seguida, pesquise ou busque recursos por identificador enquanto cria um caso.

Para o subsistema uip maestro case geral e como os recursos de registro alimentam a criação de tarefas, consulte a visão geral.

Resumo​

uip maestro case registry pull [-f, --force] [-s, --solution-id <solutionId>]
uip maestro case registry search [keyword] [-t, --type <type>] [-f, --filter <filter>] [--local]
uip maestro case registry list [--local]
uip maestro case registry get <identifier> [-t, --type <type>] [--connection-id <id>] [--local]
uip maestro case registry get-connector -t, --type <type> --activity-type-id <id>
uip maestro case registry get-connection -t, --type <type> --activity-type-id <id>
uip maestro case registry pull [-f, --force] [-s, --solution-id <solutionId>]
uip maestro case registry search [keyword] [-t, --type <type>] [-f, --filter <filter>] [--local]
uip maestro case registry list [--local]
uip maestro case registry get <identifier> [-t, --type <type>] [--connection-id <id>] [--local]
uip maestro case registry get-connector -t, --type <type> --activity-type-id <id>
uip maestro case registry get-connection -t, --type <type> --activity-type-id <id>

Fluxo de trabalho típico:

  1. uip maestro case registry pull — buscar e armazenar em cache o registro completo de recursos (executado uma vez por sessão).
  2. uip maestro case registry search <keyword> — encontre um recurso.
  3. uip maestro case registry get <identifier> — inspecione seu esquema completo.
  4. uip maestro case registry get <identifier> --output-filter "Node.inputDefinition.fields" — extraia apenas os campos de entrada.

Conceitos​

  • Tipos de recursos — o registro indexa 17 tipos de recursos: agent, process, api, processOrchestration, caseManagement, flow, action-apps, solution, mais 9 arquivos de índice de conector typecache-* dividido por origem do catálogo (typecache-activities, typecache-triggers, typecache-packages e as variantes -external-automation-*/-external-agent-* de cada). Eles são mantidos como arquivos de cache separados porque os catálogos subjacentes são separados — mesclá-los faria cada pull substituir as entradas do tipo anterior.
  • Modo--local — search, list e get aceitam --local para pesquisar apenas recursos de projeto irmãos na solução em vez do cache em todo o tenant. Requer um arquivo .uipx no diretório atual ou em um de seus dois diretórios pai; o identificador para get --local é a chave de recurso do irmãos ou seu ID do projeto .uipx.
  • Recursossolution — o tipo de recurso solution é armazenado em cache apenas quando pull é fornecido --solution-id <id>; pesquisar/obter --type solution sem tê-lo extraído primeiro retorna uma dica explícita para executar pull --solution-id primeiro.
  • Enriquecimento de conector — get enriquece automaticamente correspondências typecache-activities/typecache-triggers com metadados de conector em tempo real (pesquisados por uiPathActivityTypeId da entrada) quando possível; passe --connection-id para obter metadados de campo personalizado específicos da conexão. Esse enriquecimento é ignorado silenciosamente (não é um erro) se a pesquisa falhar.
  • get-connector / get-connection — pesquisas de nível inferior apenas no índice TypeCache local (não no cache de recursos geral): get-connector resolve uma atividade de conector/entrada de gatilho mais sua configuração de conector por --activity-type-id; get-connection faz a mesma pesquisa e, em seguida, busca as conexões disponíveis do conector no Integration Service.

pull do registro de caso do uip Maestro​

Buscar e armazenar em cache todos os tipos de recursos. Executa todos os tipos em paralelo e relata um detalhamento por tipo, incluindo aqueles que falharam.

Opções​

ShortLongValorDescription
-f--forceBandeiraIgnore o cache e busque novamente cada tipo de recurso.
-s--solution-id <solutionId>StringAlém disso, faça pull e cache dos próprios recursos da solução fornecida (o tipo de recurso solution).

Exemplo​

uip maestro case registry pull
uip maestro case registry pull

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "PullResourcesSuccess",
  "Data": {
    "TotalNodesCount": 128,
    "FromCache": false,
    "ResourceTypes": [
      {
        "Type": "typecache-activities",
        "NodesCount": 80,
        "FromCache": false,
        "AgeMinutes": null,
        "CacheWritten": true,
        "Info": null
      }
    ],
    "Errors": null
  }
}
{
  "Result": "Success",
  "Code": "PullResourcesSuccess",
  "Data": {
    "TotalNodesCount": 128,
    "FromCache": false,
    "ResourceTypes": [
      {
        "Type": "typecache-activities",
        "NodesCount": 80,
        "FromCache": false,
        "AgeMinutes": null,
        "CacheWritten": true,
        "Info": null
      }
    ],
    "Errors": null
  }
}

Result é "PartialSuccess, N failed" (não "Success") quando um ou mais tipos de recursos falham no pull — Errors em seguida lista cada tipo com falha com sua mensagem de erro; os tipos extraídos com sucesso ainda são armazenados em cache e refletidos em ResourceTypes.

Pesquise recursos em cache por palavra-chave e/ou filtros de campo. Pelo menos um dos [keyword] ou --filter é necessário.

Argumentos​

NameRequiredFinalidade
[keyword]não*Palavra-chave de texto livre para pesquisar.

* [keyword], --filter ou ambos devem ser fornecidos — a omissão de ambos falha antes de qualquer pesquisa.

Opções​

ShortLongValorDescription
-t--type <type>ENUMLimite a pesquisa a um tipo de recurso. Um dos tipos pesquisáveis — consulte Conceitos para a lista completa de 17 tipos (todos os valores RESOURCE_TYPES são válidos aqui).
-f--filter <filter>StringFiltros de campo: field=value ou field:operator=value, separados por vírgulas por vários (por exemplo name:contains=Apple,category=Pipelines). Campos: name, title, description, category, connectorKey. Operadores: equals, contains, in, startsWith, endsWith.
—--localBandeiraPesquise apenas recursos irmãos na solução. Consulte Conceitos.

Exemplos​

uip maestro case registry search invoice
uip maestro case registry search invoice
uip maestro case registry search --filter "name:contains=Apple,category=Pipelines"
uip maestro case registry search --filter "name:contains=Apple,category=Pipelines"

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "ResourceSearchSuccess",
  "Data": {
    "Keyword": "invoice",
    "Filters": null,
    "Type": null,
    "Local": false,
    "ResultCount": 1,
    "Resources": [
      {
        "resourceType": "typecache-activities",
        "resource": {
          "name": "InvoiceParser",
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001"
        }
      }
    ],
    "FailedTypes": null,
    "Hint": null
  }
}
{
  "Result": "Success",
  "Code": "ResourceSearchSuccess",
  "Data": {
    "Keyword": "invoice",
    "Filters": null,
    "Type": null,
    "Local": false,
    "ResultCount": 1,
    "Resources": [
      {
        "resourceType": "typecache-activities",
        "resource": {
          "name": "InvoiceParser",
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001"
        }
      }
    ],
    "FailedTypes": null,
    "Hint": null
  }
}

Hint é preenchido (em vez de omitido) especificamente quando --type solution retorna resultados zero e --local não foi passado — ele aponta você para registry pull --solution-id <id>. FailedTypes lista quaisquer tipos de recursos que falharam durante a pesquisa (resultados parciais ainda são retornados para os tipos que foram bem-sucedidos).

lista de registro de casos do uip Maestro​

Liste cada recurso em cache, agrupado por tipo. Não atinge a rede — reflete qualquer pull armazenado em cache pela última vez; execute pull primeiro (ou novamente) para atualizar.

Opções​

LongValorDescription
--localBandeiraListe apenas recursos irmãos na solução em vez do cache em todo o tenant. Consulte Conceitos.

Exemplo​

uip maestro case registry list
uip maestro case registry list

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "ResourceListSuccess",
  "Data": {
    "ResourcesCount": 128,
    "Local": false,
    "ResourceTypes": [
      { "Type": "typecache-activities", "Count": 80 },
      { "Type": "typecache-triggers", "Count": 48 }
    ],
    "resources": []
  }
}
{
  "Result": "Success",
  "Code": "ResourceListSuccess",
  "Data": {
    "ResourcesCount": 128,
    "Local": false,
    "ResourceTypes": [
      { "Type": "typecache-activities", "Count": 80 },
      { "Type": "typecache-triggers", "Count": 48 }
    ],
    "resources": []
  }
}

--local resolve a solução e verifica sua árvore de recursos diretamente (sem cache envolvido); uma solução ausente (sem .uipx encontrado) é relatada como um erro de limpeza em vez de uma lista vazia.

registro de caso do uip Maestro obter​

Obtenha um ou mais registros completos de recurso por identificador.

Argumentos​

NameRequiredFinalidade
<identifier>simOs entityKey (tipos semelhantes a processos) ou id (action-apps) do recurso — consulte o campo id de cada tipo por meio de Conceitos. Com --local, a chave de recurso do projeto irmãos ou o ID do projeto .uipx.

Opções​

ShortLongValorDescription
-t--type <type>ENUMLimite a pesquisa a um tipo de recurso (igual a search --type).
—--connection-id <id>StringID de conexão para metadados de campo do Integration Service específicos do conector (campos personalizados). Aplica-se apenas a correspondências de atividade/gatilho typecache-*.
—--localBandeiraResolva usando recursos irmãos na solução em vez do cache do tenant. Consulte Conceitos.

Exemplo​

uip maestro case registry get a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "ResourceGetSuccess",
  "Data": {
    "MatchCount": 1,
    "Local": false,
    "Resources": [
      {
        "ResourceType": "typecache-activities",
        "Resource": {
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "InvoiceParser"
        }
      }
    ]
  }
}
{
  "Result": "Success",
  "Code": "ResourceGetSuccess",
  "Data": {
    "MatchCount": 1,
    "Local": false,
    "Resources": [
      {
        "ResourceType": "typecache-activities",
        "Resource": {
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "InvoiceParser"
        }
      }
    ]
  }
}

Correspondências zero é uma falha (resposta de erro sem Code), não um sucesso vazio — a Instructions do erro difere conforme o modo: uma falha --local sugere uma nova verificação da chave de recurso do irmãos ou ID do projeto por meio de registry list --local; uma falha --type solution sugere a execução de pull --solution-id primeiro; qualquer outra coisa apenas relata “nenhum recurso encontrado”.

registro de caso do uip Maestro get-connector​

Pesquise uma única entrada de atividade/gatilho de conector (e sua configuração de conector) diretamente do índice TypeCache local, ignorando a pesquisa geral de recursos.

Opções​

ShortLongValorRequiredDescription
-t--type <type>ENUMsimÍndice de TypeCache para procurar: typecache-activities, typecache-triggers, typecache-external-automation-activities, typecache-external-automation-triggers, typecache-external-agent-activities ou typecache-external-agent-triggers.
—--activity-type-id <id>StringsimO uiPathActivityTypeId a ser pesquisado.

Exemplo​

uip maestro case registry get-connector --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get-connector --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "ConnectorGetSuccess",
  "Data": {
    "Entry": {
      "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "InvoiceParser"
    },
    "Config": { "connectorKey": "uipath-connector-a" }
  }
}
{
  "Result": "Success",
  "Code": "ConnectorGetSuccess",
  "Data": {
    "Entry": {
      "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "InvoiceParser"
    },
    "Config": { "connectorKey": "uipath-connector-a" }
  }
}

registro de caso do uip Maestro get-connection​

Procure uma atividade/gatilho de conector (mesma pesquisa que get-connector) e, em seguida, busque suas conexões do Integration Service disponíveis.

Opções​

ShortLongValorRequiredDescription
-t--type <type>ENUMsimMesmas opções de índice TypeCache que get-connector.
—--activity-type-id <id>StringsimO uiPathActivityTypeId a ser pesquisado.

Exemplo​

uip maestro case registry get-connection --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get-connection --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{
  "Result": "Success",
  "Code": "ConnectionGetSuccess",
  "Data": {
    "Entry": { "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001" },
    "Config": { "connectorKey": "uipath-connector-a" },
    "Connections": [
      { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Default" }
    ]
  }
}
{
  "Result": "Success",
  "Code": "ConnectionGetSuccess",
  "Data": {
    "Entry": { "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001" },
    "Config": { "connectorKey": "uipath-connector-a" },
    "Connections": [
      { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Default" }
    ]
  }
}

Vinculando uma entrada de tarefa a uma variável​

A entrada de uma tarefa é conectada a um valor/expressão literal ou à saída de outra tarefa editando o arquivo de esquema JSON de gerenciamento de casos diretamente. Referência de campo: a entrada de uma tarefa em um <field-path> separado por pontos (<input-name>[.<key1>[.<key2>...]] — nenhum conjunto de pontos input.value diretamente; cada segmento de ponto percorre um nível de propriedade, por exemplo body.body.body para o corpo da solicitação aninhada de uma atividade do conector) leva uma string literal, uma expressão com um prefixo permitido (=vars., =bindings., =js:, =metadata., =datafabric., =orchestrator.JobAttachments, =response, =result, =Error, =jsonString:), ou uma expressão =vars.<id> gerada ao gerar a saída de outra tarefa. Edite a entrada da tarefa caseplan.json diretamente para definir qualquer uma dessas opções e, em seguida, execute uip maestro case validate <file>.

  • Caso uip Maestro — visão geral e o restante do subsistema de Gerenciamento de casos.

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