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.

conformidade do uip pm, desvios do uip pm, consulta do uip pm

Sintaxe e opções para analisar um aplicativo do Process Mining — taxa de conformidade, desvios aceitos e consultas de dados ad hoc — com "uip pm conformidades", "uip pm desvios" e "uip pm Consulta".

Parte da ferramenta uip pm . conformance e deviations são camadas de conveniência sobre query: eles resolvem os IDs do campo de conformidade internos do aplicativo para você e respondem em termos simples. query é a janela de escape de uso geral para qualquer coisa que esses dois não cubram.

Observação:

conformance e deviations funcionam apenas em um aplicativo baseado em modelo (--miner inductive ou bpmn em apps create, ou um modelo de referência BPMN carregado via conformance upload-model). Um aplicativo directly-follows não tem modelo de referência nem dados de conformidade — cada verbo nesse grupo falha com um erro explícito de nomeação do miner.

Resumo​

uip pm conformance rate <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance activities <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance transitions <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance deviations <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance upload-model <app-id> <bpmn-file> [--process-id <id>]

uip pm deviations list <app-id> [--process-id Process] [--stage dev|published]
uip pm deviations accept <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete-all <app-id> -y [--process-id Process]

uip pm query run <app-id> [--body <file> | --body-json <json> | --group-by <cols> --metric <col:fn[:alias]>...] [--process-graph] [--conformance] [--limit <n>] [--stage dev|published]
uip pm query details <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query rca <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query insights <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query info <app-id> [--stage dev|published]
uip pm query layout <app-id> [--type graph|process-model] [--stage dev|published]
uip pm query percentile <app-id> --field <id> --values <list> [--filters <file> | --filters-json <json>] [--stage dev|published]
uip pm conformance rate <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance activities <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance transitions <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance deviations <app-id> [--process-id <id>] [--stage dev|published]
uip pm conformance upload-model <app-id> <bpmn-file> [--process-id <id>]

uip pm deviations list <app-id> [--process-id Process] [--stage dev|published]
uip pm deviations accept <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete <app-id> --type <type> --activities <activities...> [--process-id Process]
uip pm deviations delete-all <app-id> -y [--process-id Process]

uip pm query run <app-id> [--body <file> | --body-json <json> | --group-by <cols> --metric <col:fn[:alias]>...] [--process-graph] [--conformance] [--limit <n>] [--stage dev|published]
uip pm query details <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query rca <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query insights <app-id> [--body <file> | --body-json <json>] [--limit <n>] [--stage dev|published]
uip pm query info <app-id> [--stage dev|published]
uip pm query layout <app-id> [--type graph|process-model] [--stage dev|published]
uip pm query percentile <app-id> --field <id> --values <list> [--filters <file> | --filters-json <json>] [--stage dev|published]

taxa de conformidade uip pm​

Proporção de casos que seguem o modelo de referência.

Opções​

LongValorDescription
--process-id <id>StringProcesso a ser relatado; necessário apenas para um aplicativo de vários processos.
--stage <stage>dev | publisheddevPadrão.

Exemplo​

uip pm conformance rate 9c46289e
uip pm conformance rate 9c46289e

Formato dos dados (--output json)​

{ "Code": "PmConformanceRate", "Data": { "ProcessId": "Process", "Miner": "inductive", "ConformanceRate": 0.666667, "ConformingCases": 2, "TotalCases": 3 } }
{ "Code": "PmConformanceRate", "Data": { "ProcessId": "Process", "Miner": "inductive", "ConformanceRate": 0.666667, "ConformingCases": 2, "TotalCases": 3 } }

atividades de conformidade uip pm​

Status de conformidade de cada atividade, com os casos por trás dela.

uip pm conformance activities 9c46289e
uip pm conformance activities 9c46289e
{ "Code": "PmConformanceActivities", "Data": [{ "Activity": "Approve", "Status": "Conforming", "Cases": 2 }, { "Activity": "Escalate", "Status": "LogOnly", "Cases": 1 }] }
{ "Code": "PmConformanceActivities", "Data": [{ "Activity": "Approve", "Status": "Conforming", "Cases": 2 }, { "Activity": "Escalate", "Status": "LogOnly", "Cases": 1 }] }

Status é um de ModelOnly, LogOnly, Conforming, Accepted.

transições de conformidade uip pm​

Status de conformidade de cada transição entre atividades.

uip pm conformance transitions 9c46289e
uip pm conformance transitions 9c46289e
{ "Code": "PmConformanceTransitions", "Data": [{ "FromNodeId": "Start", "ToNodeId": "Approve", "Status": "Conforming", "Cases": 2 }] }
{ "Code": "PmConformanceTransitions", "Data": [{ "FromNodeId": "Start", "ToNodeId": "Approve", "Status": "Conforming", "Cases": 2 }] }

desvios de conformidade do uiip pm​

Desvios que os dados realmente mostram (não devem ser confundidos com uip pm deviations, que gerencia desvios aceitos — isso lê o que está se desviando no momento).

uip pm conformance deviations 9c46289e
uip pm conformance deviations 9c46289e
{ "Code": "PmConformanceDeviations", "Data": [{ "Deviation": "Activity Approve is skipped", "Type": "Skip", "Cases": 1, "AverageThroughputTime": 2700 }] }
{ "Code": "PmConformanceDeviations", "Data": [{ "Deviation": "Activity Approve is skipped", "Type": "Skip", "Cases": 1, "AverageThroughputTime": 2700 }] }

modelo de upload de conformidade uip pm​

Carregue um arquivo BPMN como o modelo de referência do aplicativo. Somente estágio de desenvolvimento; entra em vigor na próxima ingestão — o upload sozinho não mede nada.

Argumentos​

NameRequiredFinalidade
<app-id>simID do aplicativo de processo.
<bpmn-file>simArquivo .bpmn local, máx. de 6 MB.

Opções​

LongValorDescription
--process-id <id>StringProcesso ao qual o modelo pertence; necessário apenas para um aplicativo de vários processos.

Exemplo​

uip pm conformance upload-model 9c46289e ./order-to-cash.bpmn
uip pm conformance upload-model 9c46289e ./order-to-cash.bpmn

Formato dos dados (--output json)​

{ "Code": "PmConformanceUploadModel", "Data": { "AppId": "9c46289e", "File": "./order-to-cash.bpmn", "Status": "Uploaded", "Messages": [] } }
{ "Code": "PmConformanceUploadModel", "Data": { "AppId": "9c46289e", "File": "./order-to-cash.bpmn", "Status": "Uploaded", "Messages": [] } }

Falha se o arquivo exceder 6 MB ou se o servidor validar e rejeitar o BPMN (HasError na resposta) — os motivos da rejeição são exibidos na mensagem de falha, não relatados silenciosamente como sucesso.

desvios de uip pm​

Gerencie a lista de desvios aceitos na qual um aplicativo é verificado — aceitar um desvio faz com que a conformidade pare de contá-lo. Nada entrará em vigor até que as transformações sejam executadas novamente; list relata essa lacuna como um status por desvio.

o padrão é--process-id definido como em cada verbo (importa apenas para um aplicativo de vários processos)."Process"

lista de desvios de uip pm​

OpçãoValorDescription
--process-id <id>StringProcessPadrão.
--stage <stage>dev | publisheddevPadrão.
{ "Code": "PmDeviationsList", "Data": [{ "Type": "activity_missing", "Activities": ["Approve order"], "ParentProcess": [], "Status": "NotApplied" }] }
{ "Code": "PmDeviationsList", "Data": [{ "Type": "activity_missing", "Activities": ["Approve order"], "ParentProcess": [], "Status": "NotApplied" }] }

Status é Applied (a última ingestão bem-sucedida o tem), NotApplied (aceito desde essa ingestão) ou AppliedButDeleted (excluído desde isso) — os dois últimos significam “executar novamente transformações para alcançar .&co;

desvios do uip pm aceitar​

LongValorRequiredDescription
--type <deviation-type>StringsimTipo de desvio, conforme relatado por conformance deviations.
--activities <activities...>strings, separadas por espaçosimNomes da atividade que o desvio cobre.
--process-id <id>StringnãoProcessPadrão.
uip pm deviations accept 9c46289e --type activity_missing --activities "Approve order"
uip pm deviations accept 9c46289e --type activity_missing --activities "Approve order"
{ "Code": "PmDeviationsAccept", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Accepted" } }
{ "Code": "PmDeviationsAccept", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Accepted" } }

A falha ocorre se a combinação exata de tipo/atividades/processo já for aceita. Atinge apenas desvios de nível superior — um aninhado em um subprocesso (não vazio parentProcess) não pode ser correspondente a esse comando, já que --activities nunca envia um parentProcess.

exclusão de desvios de uip pm​

Mesmas opções de accept. Pare de aceitar um desvio — o tipo, as atividades e o processo pai devem corresponder exatamente a um desvio aceito.

{ "Code": "PmDeviationsDelete", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Deleted" } }
{ "Code": "PmDeviationsDelete", "Data": { "AppId": "9c46289e", "Type": "activity_missing", "Activities": ["Approve order"], "Status": "Deleted" } }

desvios de pm do uip excluir-todos​

Pare de aceitar todos os desvios no aplicativo.

LongValorDescription
-y, --yesBandeiraConfirme esta operação irreversível. Obrigatório.
--process-id <id>StringProcessPadrão.
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

consulta uip pm​

Consultas de dados de uso geral em um aplicativo extraído. Todos os verbos que levam ao corpo (run/details/rca/insights) compartilham --body <json-file> / --body-json <json> ( mutuamente exclusivo ), --stage, e (exceto insights... na verdade todos quatro) --limit (servidor trava em 1..1000).

execução de consulta uip pm​

Consulta agregada (agrupar por + métricas). Suporta uma sintaxe de Sugar na parte superior do corpo bruto.

LongValorDescription
--group-by <cols>separados por vírgulaColunas do campo (nomes ou IDs, de query info) pelas quais agrupar. Açúcar; mutuamente exclusivo com --body/--body-json.
--metric <col:fn[:alias]>repetívelAgregar um campo. fn é um(a) any, average, count, distinct_count, forall, forany, max, median, min, percentage, sum ( sem diferenciação entre maiúsculas e minúsculas, -/_ intercambiáveis). O alias padrão é <fn>_<column>.
--process-graphBandeiraResponda sobre o gráfico de processo (atividades/transições) em vez do modelo de dados simples. Somente alocação de ajuda — um corpo bruto carrega a isProcessGraph si mesmo.
--conformanceBandeiraResponda no lado somente do modelo (etapas que o modelo de referência esperava que um caso ignorasse) em vez do que o log fez. Somente Sugar.

Outras funções de agregação (COUNT_ROWS, EXISTS, APPROX_DISTINCT_COUNT, PERCENTILE, CASE_AVERAGE) não estão disponíveis por meio de --metric — crie-as com --body/--body-json (use query percentile para percentil especificamente).

Exemplos​

uip pm query run 9c46289e --group-by Open_year --metric Event_count:average
uip pm query run 9c46289e --group-by Open_year --metric Event_count:average
uip pm query run 9c46289e --body-json '{"groupBy":["F__Cases__Priority__..."],"aggregates":[{"id":"n","argument":"Case_ID","aggregation":"COUNT"}]}'
uip pm query run 9c46289e --body-json '{"groupBy":["F__Cases__Priority__..."],"aggregates":[{"id":"n","argument":"Case_ID","aggregation":"COUNT"}]}'
uip pm query run 9c46289e --metric Case_conforming:percentage
uip pm query run 9c46289e --metric Case_conforming:percentage
# Skipped steps: activities the reference model expected that a case didn't take
uip pm query run 9c46289e --group-by Node_id,Node_label --metric Case_ID:distinct_count --process-graph --conformance
# Skipped steps: activities the reference model expected that a case didn't take
uip pm query run 9c46289e --group-by Node_id,Node_label --metric Case_ID:distinct_count --process-graph --conformance

Formato dos dados (--output json)​

{ "Code": "PmQueryRun", "Data": [{ "Open_year": 2014, "average_Event_count": 9.16 }] }
{ "Code": "PmQueryRun", "Data": [{ "Open_year": 2014, "average_Event_count": 9.16 }] }

Com a sintaxe do Sugar, a resposta colunar do mecanismo é reformulada em objetos de linha codificados por nomes/aliases de colunas humanas; uma chamada --body/--body-json bruta retorna a resposta do mecanismo como está.

detalhes da consulta uip pm​

Linhas de tabela brutas.

{ "Code": "PmQueryDetails", "Data": {} }
{ "Code": "PmQueryDetails", "Data": {} }

consulta uip pm rca​

Análise de causa raiz. O corpo precisa de um selectedSet não vazio.

uip pm query rca 9c46289e --body-json '{"argument":"Case_ID","exploreAttributes":["Case_type"],"selectedSet":[[{"kind":"values","dimension":"Case_status","type":"string","values":["Open"],"invert":false,"displayType":"list"}]]}'
uip pm query rca 9c46289e --body-json '{"argument":"Case_ID","exploreAttributes":["Case_type"],"selectedSet":[[{"kind":"values","dimension":"Case_status","type":"string","values":["Open"],"invert":false,"displayType":"list"}]]}'
{ "Code": "PmQueryRca", "Data": { "Data": {}, "Warnings": null } }
{ "Code": "PmQueryRca", "Data": { "Data": {}, "Warnings": null } }

insights da consulta uip pm​

Insights do processo. O corpo precisa de processId e 1 a 10 metrics.

{ "Code": "PmQueryInsights", "Data": {} }
{ "Code": "PmQueryInsights", "Data": {} }

informações de consulta uip pm​

Descubra os campos, métricas e processos disponíveis para corpos de consulta.

uip pm query info 9c46289e
uip pm query info 9c46289e
{ "Code": "PmQueryInfo", "Data": { "fields": [], "processes": [] } }
{ "Code": "PmQueryInfo", "Data": { "fields": [], "processes": [] } }

layout de consulta uip pm​

Obtenha o layout de gráfico global persistente de um aplicativo de processo.

LongValorPadrãoDescription
--type <type>graph | process-modelgraphQual layout ler.
{ "Code": "PmQueryLayout", "Data": {} }
{ "Code": "PmQueryLayout", "Data": {} }

percentil da consulta uip pm​

Calcular percentil de um campo numérico.

LongValorRequiredDescription
--field <field-id>StringsimID do campo (query info).
--values <list>separados por vírgulas, 0..1simPontos percentuais, por exemplo 0.5,0.9,0.95).
--filters <json-file> / --filters-json <json>JSONnãoEspecificação do filtro (array de grupos de filtros com AND). Mutualmente exclusivos.
uip pm query percentile 9c46289e --field PF__throughput_time --values 0.5,0.9,0.95
uip pm query percentile 9c46289e --field PF__throughput_time --values 0.5,0.9,0.95
{ "Code": "PmQueryPercentile", "Data": { "values": [3600, 86400, 172800] } }
{ "Code": "PmQueryPercentile", "Data": { "values": [3600, 86400, 172800] } }
  • uip pm — visão geral e CRUD apps .
  • apps model — definições de campo/métrica a que essas consultas fazem referência.
  • ingestions e transformations — uma consulta precisa de uma ingestão concluída no estágio a que alvo.

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