UiPath PM

Comandos para gerenciar aplicativos de processo, ingestão de dados, transformações e análise do Process Mining usando a ferramenta "uip pm".

uip pm é a ferramenta do Process Mining: ele cria e gerencia aplicativos de processo (modelos de processo extraídos construídos a partir de dados de log de eventos), carrega e ingere dados de origem, executa transformações dbt e analisa o resultado (conformidade em relação a um modelo de referência, desvios aceitos , consultas ad hoc). pm é o prefixo do comando; o pacote subjacente é @uipath/pm-tool.

Um aplicativo de processo passa por um estágio dev (onde você cria sua estrutura) e um estágio published (o que os painéis/consumidores veem) — a maioria dos verbos aceita --stage dev|published (padrão dev). Cada comando requer uip login primeiro.

Esse recurso abrange quatro páginas

• Esta página — conceitos, apps (criar/list/get/delete/publish), app-types, files, simulations.
• apps model — a superfície de edição do modelo estrutural/semântico protegido por ETag: apps data-model, apps model (get/update/fields/dashboards/metrics).
• ingestions e transformations — disparar e inspecionar cargas de dados e compilações de dbt.
• conformance, deviations e query — analise um aplicativo extraído: taxa de conformidade, desvios aceitos, consultas de dados ad hoc.

Conceitos

• Gravações protegidas por ETag. Cada gravação no modelo de dados, modelo semântico ou arquivo de transformação de um aplicativo requer um --etag de um get anterior (ou é a própria leitura-modificação-escrita que busca sua própria base). Uma ETag obsoleta falha com um conflito; a correção é reler, refazer a edição e tentar novamente — nunca buscar novamente uma ETag nova apenas para forçar a gravação, já que isso abafa silenciosamente o que mudou entre elas.
• Desenvolvedor versus publicado. As edições estruturas/semânticas, a ingestão e as transformações aplicam-se apenas a dev. apps publish envia o modelo atual do desenvolvedor para a camada publicada/de painel; apps changes visualiza o que seria movido.
• --wait enquete. ingestions create e transformations apply/run aceitam --wait (--timeout, padrão 1800s; --poll-interval, padrão 5s) para bloquear até que a execução atinja um estado terminal, imprimindo o dbt real erro /loader em falha em vez de apenas sair.

Resumo

uip pm apps list [--stage dev|published]
uip pm apps get <app-id> [--stage dev|published]
uip pm apps create <name> --type <app-type-key> [--type-version <v>] [--miner directly-follows|inductive|bpmn] [--description <text>] [--data-mapping <json-file>]
uip pm apps delete <app-id> -y
uip pm apps publish <app-id>
uip pm apps changes <app-id>
uip pm apps publications <app-id> [--limit <n>] [--since-version <v>]
uip pm app-types list
uip pm app-types get <app-type-key> <app-type-version>
uip pm files upload <app-id> <file-path> [--stage dev|published] [--input-table <name>]
uip pm simulations list <app-id> [--stage dev|published]

lista de aplicativos uip pm

Listar aplicativos de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio do aplicativo a ser listado.

Exemplo

uip pm apps list

Formato dos dados (--output json)

{ "Code": "PmAppsList", "Data": [{ "Id": "9c46289e", "Name": "Sample dataset" }] }

aplicativos uip pm obter

Obtenha um aplicativo de processo: seu status, última ingestão e estado de compilação.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio do aplicativo a ser lido.

Exemplo

uip pm apps get 9c46289e

Formato dos dados (--output json)

{
  "Code": "PmAppsGet",
  "Data": {
    "Id": "9c46289e",
    "Name": "Sample dataset",
    "AppStatus": "CREATED",
    "LastIngestion": { "Id": "1d7e1421", "Status": "SUCCESS" }
  }
}

aplicativos uip pm criar

Crie um aplicativo de processo a partir de um modelo de aplicativo (consulte app-types list).

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do aplicativo.

Opções

Long	Valor	Required	Description
--type <app-type-key>	String	sim	Chave de modelo do aplicativo. Por exemplo uipath.custom).
--type-version <version>	String	não	Versão do modelo. O padrão é o mais recente disponível.
--miner <miner>	directly-follows | inductive | bpmn	não	Process Miner. directly-followsPadrão. Apenas inductive/bpmn produzem um modelo de referência, do qual conformance/deviations precisam.
--description <text>	String	não	Descrição do aplicativo.
--data-mapping <json-file>	Path	não	Arquivo JSON com o mapeamento de dados de entrada (tabelas/campos). IsNotNull/IsUnique/DataTypeSettings ausentes por campo são padronizados automaticamente.

Exemplo

uip pm apps create "Sample dataset" --type uipath.custom --data-mapping ./mapping.json

Formato dos dados (--output json)

{
  "Code": "PmAppsCreate",
  "Data": { "AppId": "9c46289e-e2e3-4da4-a2ea-95c98f719ff7", "Name": "Sample dataset", "Type": "uipath.custom" }
}

exclusão de aplicativos uip pm

Exclua um aplicativo de processo.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Description
-y, --yes	Bandeira	Confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip pm apps delete 9c46289e --yes

Formato dos dados (--output json)

{ "Code": "PmAppsDelete", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

publicação de aplicativos uip pm

Publique alterações de desenvolvimento na camada de painéis/consultas.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Exemplo

uip pm apps publish 9c46289e

Formato dos dados (--output json)

{ "Code": "PmAppsPublish", "Data": { "AppId": "9c46289e", "Changes": {}, "IngestionNeeded": true, "Hint": "Published changes need data — run 'uip pm ingestions create <app> --wait' to load them into the dashboards." } }

Hint está presente apenas quando IngestionNeeded é true.

alterações nos aplicativos uip pm

Mostre quais partes do dev ainda não foram publicadas (painéis, transformações, BPMN).

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Exemplo

uip pm apps changes 9c46289e

Formato dos dados (--output json)

{ "Code": "PmAppsChanges", "Data": { "AppId": "9c46289e", "ModelVersion": 3, "Changes": {}, "IngestionNeeded": false } }

publicações de aplicativos uip pm

Lista o histórico de publicação de um aplicativo de processos.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Description
--limit <number>	Número inteiro	Máximo de publicações a serem retornadas.
--since-version <model-version>	Número inteiro	Retorne apenas publicações mais recentes que esta versão do modelo.

Formato dos dados (--output json)

{ "Code": "PmAppsPublications", "Data": [] }

tipos de aplicativos uip pm

Descubra modelos de aplicativos de processos. Sem escopo de estágio — os modelos são tenant-global.

lista de tipos de aplicativos uip pm

Listar os modelos de aplicativos disponíveis em sua versão mais recente.

uip pm app-types list

{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }

tipos de aplicativos uip pm obter

Obtenha o modelo de aplicativo completo de uma versão do modelo.

Name	Required	Finalidade
<app-type-key>	sim	Chave de modelo do aplicativo.
<app-type-version>	sim	Versão do modelo.

uip pm app-types get uipath.custom 2604.192.1-ci.5

{ "Code": "PmAppTypesGet", "Data": {} }

upload de arquivos uip pm

Carregue um arquivo de dados para um aplicativo de processo via upload de blob em partes (5 partes de MB, 4 simultâneas).

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.
<file-path>	sim	Caminho local para o arquivo de dados.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio de aplicativo para o qual carregar.
--input-table <name>	String	—	A tabela de entrada de destino à qual o arquivo pertence (por exemplo Event_log).

Exemplo

uip pm files upload 9c46289e ./Event_log.csv --input-table Event_log

Formato dos dados (--output json)

{
  "Code": "PmFilesUpload",
  "Data": { "Filename": "Event_log/.../Event_log.csv", "UploadId": "...", "Size": 12345, "Parts": 1, "InputTable": "Event_log" }
}

lista de simulações de uip pm

Leia as simulações de processos (cenários e se) salvas em um aplicativo de processo. Somente leitura — não há create/update/delete; as simulações são criadas em outro lugar e apenas listadas aqui. Fornecido por uma API diferente (PMT com escopo de aplicativo, trocada por token) do restante desta ferramenta.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio de aplicativo.

Exemplo

uip pm simulations list 9c46289e

Formato dos dados (--output json)

{
  "Code": "PmSimulationsList",
  "Data": [
    {
      "DefinitionMetadata": { "Name": "Two more approvers", "SimulationId": "bfd3d274-...", "IngestionId": "7792c4cd-...", "ProcessId": "Process" },
      "RunMetadata": { "Status": "successWithWarnings", "NumberOfCases": 1000, "NumberOfRuns": 40 }
    }
  ]
}

Relacionado

• apps model — edite o modelo de dados, o modelo semântico, campos, painéis e métricas.
• ingestions e transformations — carregar dados e executar dbt.
• conformance, deviations e query — analise um aplicativo extraído.

Veja também

• Opções globais
• Códigos de saída