UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

uip pm 一致性、uip pm 偏差、uip pm 查询

用于使用“uip pm一致性”、“uip pm偏差”和“uip pm查询”分析 Process Mining 应用程序的语法和选项(符合率、可接受的偏差和临时数据查询)。

作为uip pm工具的一部分。conformance 和 deviations 是 query 上的便捷层:它们为您解析应用程序的内部一致性字段 ID,并以简单的语言给出答案。query 是通用目的退出方式,用于这两个命令未涵盖的任何内容。

备注:

conformance和deviations仅适用于基于模型的应用程序( --miner inductive或apps create中的bpmn ,或通过conformance upload-model上传的 BPMN 参考模型)。directly-follows 应用程序没有参考模型,也没有一致性数据 — 该组中的每个动词都失败,并显示命名挖掘器的明确错误。

大纲​

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]

UIP PM 符合率​

遵循参考模型的案例比例。

选项​

长值描述
--process-id <id>字符串要报告的流程;仅多流程应用程序需要。
--stage <stage>dev | published默认 dev。

示例​

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

数据形状(--输出 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 } }

UIP PM 一致性活动​

每个活动的一致性状态及其背后的案例。

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 为 ModelOnly、LogOnly、Conforming 和 Accepted 之一。

uip pm 一致性转换​

活动之间每次转换的一致性状态。

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

uip pm 一致性偏差​

数据实际显示的偏差(不要与uip pm deviations混淆,后者管理可接受的偏差 — 这将读取当前的偏差)。

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

uip pm 一致性上传模型​

上传一个 BPMN 文件作为应用程序的参考模型。仅限开发阶段;在下次提取时生效 — 单独上传不会重新度量任何内容。

参数​

名称必填用途
<app-id>是流程应用程序 ID。
<bpmn-file>是本地 .bpmn 文件,最大 6 MB。

选项​

长值描述
--process-id <id>字符串模型所属的流程;仅多流程应用程序需要。

示例​

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

数据形状(--输出 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": [] } }

如果文件超过 6 MB,或服务器验证并拒绝 BPMN(响应中的HasError),则失败 — 拒绝原因显示在失败消息中,不会默认报告为成功。

uip pm 偏差​

管理检查应用程序所针对的可接受偏差列表 — 接受偏差将导致合规性停止计数。在重新运行转换之前,任何内容都不会生效; list将该差距报告为每个偏差的状态。

每个动词上的 --process-id 默认为 "Process"(仅适用于多流程应用程序)。

uip pm 偏差列表​

选项值描述
--process-id <id>字符串默认 Process。
--stage <stage>dev | published默认 dev。
{ "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(最后一次成功提取)、NotApplied(自该提取后已接受)或 AppliedButDeleted(自该提取后已删除)— 后两者都表示“重新运行转换以跟进”。

uip pm 偏差接受​

长值必填描述
--type <deviation-type>字符串是偏差类型,由 conformance deviations 报告。
--activities <activities...>字符串,以空格分隔是偏差涵盖的活动名称。
--process-id <id>字符串否默认 Process。
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" } }

如果确切的类型/活动/流程组合已被接受,则失败。仅涉及顶级偏差 — 无法从此命令匹配嵌套在子流程中的偏差(非空 parentProcess),因为 --activities 从不发送 parentProcess。

uip pm 偏差删除​

与 accept 相同的选项。停止接受偏差 — 类型、活动和父流程必须与已接受的偏差完全匹配。

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

uip pm 偏差全部删除​

停止接受应用程序上的所有偏差。

长值描述
-y, --yes标记确认此不可逆操作。必需。
--process-id <id>字符串默认 Process。
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }
{ "Code": "PmDeviationsDeleteAll", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

uip pm 查询​

针对挖掘的应用程序的通用型数据查询。所有正文动词 (run/details/rca/insights) 共享 --body <json-file>/--body-json <json>(互斥)、--stage 和(insights 除外...实际上四个)--limit(服务器固定为 1..1000)。

uip pm 查询运行​

聚合(分组依据 + 指标)查询。支持在原始正文之上使用 Sugar 语法。

长值描述
--group-by <cols>逗号分隔要作为分组依据的字段列(名称或 ID,来自 query info)。标签:与 --body/--body-json 互斥。
--metric <col:fn[:alias]>可重复聚合字段。fn 为 any、average、count、distinct_count、forall、forany、max、median、min、percentage 或 sum 之一 (不区分大小写,-/_ 可互换)。默认别名为 <fn>_<column>。
--process-graph标记通过流程图(活动/转换)进行回答,而不是使用纯数据模型。仅Sugar — 原始正文携带 isProcessGraph 本身。
--conformance标记跳过仅模型侧的回答(参考模型预期案例会跳过的步骤),而不是日志的执行操作。仅包含 Sugar。

其他聚合函数(COUNT_ROWS、EXISTS、APPROX_DISTINCT_COUNT、PERCENTILE、CASE_AVERAGE)无法通过 --metric 使用 — 使用 --body/--body-json 创作(将 query percentile 用于百分比特别是)。

示例​

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

数据形状(--输出 json)​

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

使用 Sugar 语法,引擎的列响应将被重新调整为由人工列名称/别名键控的行对象;原始 --body/--body-json 调用按原样返回引擎的响应。

UIP PM 查询详细信息​

原始表格行。

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

uip pm 查询 rca​

根本原因分析。正文需要非空 selectedSet。

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

uip pm 查询见解​

流程洞察。正文需要 processId 和 1-10 metrics。

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

uip pm 查询信息​

发现可用于查询正文的字段、指标和流程。

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

uip pm 查询布局​

获取流程应用程序的暂留全局图形布局。

长值默认描述
--type <type>graph | process-modelgraph要读取的布局。
{ "Code": "PmQueryLayout", "Data": {} }
{ "Code": "PmQueryLayout", "Data": {} }

uip pm 查询百分比​

计算数值字段的百分位数。

长值必填描述
--field <field-id>字符串是字段 ID (query info)。
--values <list>逗号分隔,0..1是百分位,例如0.5,0.9,0.95。
--filters <json-file> / --filters-json <json>JSON否筛选器规格(进行 AND 运算的筛选器组的数组)。互斥。
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] } }

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新