uip pm

Commands for managing Process Mining process apps, data ingestion, transformations, and analysis using the `uip pm` tool.

uip pm is the Process Mining tool: it creates and manages process apps (mined process models built from event-log data), uploads and ingests source data, runs dbt transformations, and analyzes the result (conformance against a reference model, accepted deviations, ad hoc queries). pm is the command prefix; the underlying package is @uipath/pm-tool.

A process app moves through a dev stage (where you author its structure) and a published stage (what dashboards/consumers see) — most verbs take --stage dev|published (default dev). Every command requires uip login first.

This resource spans four pages

• This page — concepts, apps (create/list/get/delete/publish), app-types, files, simulations.
• apps model — the ETag-guarded structural/semantic model editing surface: apps data-model, apps model (get/update/fields/dashboards/metrics).
• ingestions & transformations — trigger and inspect data loads and dbt builds.
• conformance, deviations & query — analyze a mined app: conformance rate, accepted deviations, ad hoc data queries.

Conceitos

• ETag-guarded writes. Every write to an app's data model, semantic model, or a transformation file requires an --etag from a prior get (or is itself a read-modify-write that fetches its own base). A stale ETag fails with a conflict; the fix is to re-read, redo the edit, and retry — never re-fetch a fresh ETag just to force the write through, since that silently clobbers whatever changed in between.
• Dev vs. published. Structural/semantic edits, ingestion, and transformations only apply to dev. apps publish pushes dev's current model to the published/dashboard layer; apps changes previews what would move.
• --wait polling. ingestions create and transformations apply/run accept --wait (--timeout, default 1800s; --poll-interval, default 5s) to block until the run reaches a terminal state, printing the real dbt/loader error on failure instead of just exiting.

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]

uip pm apps list

List process apps.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	App stage to list.

Exemplo

uip pm apps list

Formato dos dados (--output json)

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

uip pm apps get

Get one process app: its status, last ingestion, and build state.

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	App stage to read.

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" }
  }
}

uip pm apps create

Create a process app from an app template (see app-types list).

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do aplicativo.

Opções

Long	Valor	Required	Description
--type <app-type-key>	String	sim	App template key, e.g. uipath.custom.
--type-version <version>	String	não	Template version. Defaults to the latest available.
--miner <miner>	directly-follows | inductive | bpmn	não	Process miner. Default directly-follows. Only inductive/bpmn produce a reference model, which conformance/deviations need.
--description <text>	String	não	Descrição do aplicativo.
--data-mapping <json-file>	Path	não	JSON file with the input data mapping (tables/fields). Missing IsNotNull/IsUnique/DataTypeSettings per field are defaulted automatically.

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" }
}

uip pm apps delete

Delete a process app.

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

Opções

Long	Valor	Description
-y, --yes	Bandeira	Confirm this irreversible operation. Required — the CLI never prompts.

Exemplo

uip pm apps delete 9c46289e --yes

Formato dos dados (--output json)

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

uip pm apps publish

Publish dev changes to the dashboards/query layer.

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

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 is present only when IngestionNeeded is true.

uip pm apps changes

Show which parts of dev are not published yet (dashboards, transformations, BPMN).

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

Exemplo

uip pm apps changes 9c46289e

Formato dos dados (--output json)

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

uip pm apps publications

List the publish history of a process app.

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

Opções

Long	Valor	Description
--limit <number>	Número inteiro	Max publications to return.
--since-version <model-version>	Número inteiro	Only return publications newer than this model version.

Formato dos dados (--output json)

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

uip pm app-types

Discover process app templates. Not stage-scoped — templates are tenant-global.

uip pm app-types list

List available app templates at their latest version.

uip pm app-types list

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

uip pm app-types get

Get the full app model of a template version.

Name	Required	Finalidade
<app-type-key>	sim	App template key.
<app-type-version>	sim	Template version.

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

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

uip pm files upload

Upload a data file to a process app via chunked blob upload (5 MB parts, 4 concurrent).

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.
<file-path>	sim	Local path to the data file.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	App stage to upload to.
--input-table <name>	String	—	Target input table the file belongs to (e.g. 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" }
}

uip pm simulations list

Read the process simulations (what-if scenarios) saved on a process app. Read-only — there is no create/update/delete; simulations are authored elsewhere and only listed here. Served by a different API (app-scoped PMT, token-exchanged) than the rest of this tool.

Argumentos

Name	Required	Finalidade
<app-id>	sim	Process app ID.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	App stage.

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 — edit the data model, semantic model, fields, dashboards, and metrics.
• ingestions & transformations — load data and run dbt.
• conformance, deviations & query — analyze a mined app.

Veja também

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