UIP pm

用于使用“uip pm”工具管理 Process Mining 流程应用程序、数据提取、转换和分析的命令。

uip pm 是 Process Mining 工具：它可以创建和管理流程应用程序（根据事件日志数据构建的挖掘的流程模型），上传和提取源数据，运行 dbt 转换并分析结果（与参考模型的一致性、可接受的偏差）特别查询）。pm 是命令前缀；相关基础包为 @uipath/pm-tool。

流程应用程序会经过 dev 阶段（您将编写其结构）和 published 阶段（仪表板/使用者所看到的内容）——大多数动词均会出现 --stage dev|published（默认为 dev）。每个命令首先需要 uip login。

该资源跨越四个页面

• 本页— 概念、 apps （创建/列表/获取/删除/发布）、 app-types 、 files 、 simulations 。
• apps model — ETag 保护的结构/语义模型编辑界面： apps data-model 、 apps model （获取/更新/字段/仪表板/指标）。
• ingestions和transformations — 触发并检查数据加载和 dbt 构建。
• conformance 、 deviations和query — 分析一个挖掘的应用程序：符合率、可接受的偏差、临时数据查询。

概念

• ETag 保护写入。每次写入应用程序的数据模型、语义模型或转换文件时，都需要使用先前 --etag 中的 get（或其本身是获取自己的基数的读取-修改-写入操作）。过时的 ETag 会因冲突而失败；解决方法是重新读取、重做编辑，然后重试 — 切勿为了强制直写而重新获取新的 ETag，因为这会静默破坏其间发生的任何更改。
• 开发与已发布对比结构/语义编辑、提取和转换仅适用于 dev。apps publish 将开发的当前模型推送到已发布/仪表板层； apps changes 预览将要移动的内容。
• --wait轮询。ingestions create 和 transformations apply/run 接受 --wait（--timeout、默认 1800；--poll-interval，默认 5）进行阻止，直到运行达到终止状态，从而打印实际 dbt /loader 失败时显示错误，而不仅仅是退出。

大纲

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 应用程序列表

列出流程应用程序。

选项

长	值	默认	描述
--stage <stage>	dev | published	dev	待列出的应用程序阶段。

示例

uip pm apps list

数据形状（--输出 json）

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

uip pm Apps 获取

获取一个流程应用程序：状态、上次提取时间和构建状态。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

选项

长	值	默认	描述
--stage <stage>	dev | published	dev	要读取的应用程序阶段。

示例

uip pm apps get 9c46289e

数据形状（--输出 json）

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

uip pm 应用程序创建

从应用程序模板创建流程应用程序（请参阅 app-types list）。

参数

名称	必填	用途
<name>	是	应用程序名称。

选项

长	值	必填	描述
--type <app-type-key>	字符串	是	应用程序模板密钥，例如uipath.custom。
--type-version <version>	字符串	否	模板版本。默认为最新的可用版本。
--miner <miner>	directly-follows | inductive | bpmn	否	流程挖掘器。默认 directly-follows。只有 inductive/bpmn 会生成 conformance/deviations 需要的参考模型。
--description <text>	字符串	否	应用程序说明。
--data-mapping <json-file>	路径	否	具有输入数据映射（表/字段）的 JSON 文件。每个字段缺少 IsNotNull/IsUnique/DataTypeSettings 是系统会自动为其默认设置。

示例

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

数据形状（--输出 json）

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

uip pm 应用程序删除

删除流程应用程序。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

选项

长	值	描述
-y, --yes	标记	确认此不可逆操作。必需 — CLI 从不提示。

示例

uip pm apps delete 9c46289e --yes

数据形状（--输出 json）

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

uip pm 应用程序发布

将开发更改发布到仪表板/查询层。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

示例

uip pm apps publish 9c46289e

数据形状（--输出 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仅当IngestionNeeded 为true 时才存在。

uip pm 应用程序更改

显示开发的哪些部分尚未发布（仪表板、转换、BPMN）。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

示例

uip pm apps changes 9c46289e

数据形状（--输出 json）

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

uip pm 应用程序出版物

列出流程应用程序的发布历史记录。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

选项

长	值	描述
--limit <number>	整数	要返回的最大出版物数量。
--since-version <model-version>	整数	仅返回比此模型版本新的发布。

数据形状（--输出 json）

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

uip pm 应用程序类型

发现流程应用程序模板。并非阶段范围 — 模板是租户全局模板。

uip pm 应用程序类型列表

列出最新版本的可用应用程序模板。

uip pm app-types list

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

uip pm 应用程序类型获取

获取模板版本的完整应用程序模型。

名称	必填	用途
<app-type-key>	是	应用程序模板密钥。
<app-type-version>	是	模板版本。

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

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

uip pm 文件上传

通过分块 Blob 上传（5 MB 部分，4 个并发）将数据文件上传到流程应用程序。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。
<file-path>	是	数据文件的本地路径。

选项

长	值	默认	描述
--stage <stage>	dev | published	dev	要上传到的应用程序阶段。
--input-table <name>	字符串	—	文件所属的目标输入表（例如Event_log）。

示例

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

数据形状（--输出 json）

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

uip pm 模拟列表

读取流程应用程序中保存的流程模拟（假设场景）。只读 — 没有 create/update/delete；模拟在其他地方编写，仅在此处列出。由与此工具的其余部分不同的 API（应用程序范围的 PMT，已交换令牌）提供服务。

参数

名称	必填	用途
<app-id>	是	流程应用程序 ID。

选项

长	值	默认	描述
--stage <stage>	dev | published	dev	应用程序阶段。

示例

uip pm simulations list 9c46289e

数据形状（--输出 json）

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

相关内容

• apps model — 编辑数据模型、语义模型、字段、仪表板和指标。
• ingestions和transformations — 加载数据并运行 dbt。
• conformance 、 deviations和query — 分析挖掘的应用程序。

另请参阅

• 全局选项
• 退出代码