UIP PM

「uip pm」ツールを使用して Process Mining のプロセス アプリ、データの取り込み、変換、分析を管理するためのコマンドです。

Process Mining ツールuip pm、プロセス アプリ (イベント ログ データから構築されたマイニングされたプロセス モデル) の作成と管理、ソース データのアップロードと取り込み、dbt 変換の実行、および結果 (参照モデルとの適合性、許容される逸脱、アドホック クエリ) の分析を行います。pm はコマンド プレフィックスです。基になるパッケージは @uipath/pm-toolです。

プロセス アプリは、 dev ステージ (構造を作成するステージ) と published ステージ (ダッシュボード/コンシューマーに表示される内容) を経ます。ほとんどの動詞は --stage dev|published (既定の dev) を要します。すべてのコマンドでは最初に uip login が必要です。

このリソースは 4 ページにまたがっています

• このページ — 概念、apps (作成/リスト作成/取得/削除/パブリッシュ)、app-types、files、simulations
• apps model — ETag で保護される構造的/セマンティック モデルの編集画面です。apps data-model、apps model (get/update/fields/dashboards/metrics)。
• ingestions & transformations — データ読み込みと dbt ビルドをトリガーして検査します。
• conformance、deviations、query — マイニングされたアプリを分析します。適合率、許容される逸脱、アドホック データ クエリ。

概念

• ETag で保護された書き込み。アプリのデータ モデル、セマンティック モデル、または変換ファイルへの書き込みには、以前のgetからの--etagが必要です (または、それ自体が独自のベースを取得する読み取り、変更、書き込みです)。古い ETag は競合で失敗します。修正は、再読み取り、編集のやり直し、再試行することです — 書き込みを強制するためだけに新しいETagを再取得しないでください。
• 開発とパブリッシュ。構造的/セマンティックな編集、取り込み、変換は、 devにのみ適用されます。apps publish は、dev の現在のモデルを published/dashboard レイヤーにプッシュします。 apps changes 、移動する内容をプレビューします。
• --wait ポーリング。ingestions create と transformations apply/run は、実行が終了ステートに達するまでブロックする--wait (--timeout、既定値は 51800秒、--poll-interval、既定値は 秒) を受け入れ、失敗時に終了するのではなく、実際の dbt/ローダー エラーを出力します。

概要

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 アプリのリスト

プロセス アプリのリストを表示します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	一覧表示するアプリ ステージです。

例

uip pm apps list

データシェイプ(--output json)

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

UIP PM Apps Get

1 つのプロセス アプリ (ステータス、最終取り込み、ビルド状態) を取得します。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	読み取るアプリのステージです。

例

uip pm apps get 9c46289e

データシェイプ(--output json)

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

UIP PM アプリの作成

アプリ テンプレートからプロセス アプリを作成します ( app-types listを参照)。

引数

名前	Required	目的
<name>	○	アプリ名。

オプション

長押し	値 (Value)	Required	説明
--type <app-type-key>	string	○	アプリ テンプレート キー (例:uipath.customです。
--type-version <version>	string	×	テンプレートのバージョンです。既定では、利用可能な最新バージョンです。
--miner <miner>	directly-follows | inductive | bpmn	×	プロセスマイナー。既定 directly-followsです。inductive/bpmnのみが、conformance/deviationsが必要とする参照モデルを生成します。
--description <text>	string	×	アプリの説明。
--data-mapping <json-file>	パス	×	入力データ (テーブル/フィールド) がマッピングされた JSON ファイルフィールドごとの IsNotNull/IsUnique/DataTypeSettings の欠落は、自動的に既定で設定されます。

例

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

データシェイプ(--output json)

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

UIP PM アプリの削除

プロセス アプリを削除します。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

オプション

長押し	値 (Value)	説明
-y, --yes	フラグ	この元に戻せない操作を確認します。必須 — CLI はプロンプトを表示しません。

例

uip pm apps delete 9c46289e --yes

データシェイプ(--output json)

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

UIP PM アプリのパブリッシュ

開発の変更をダッシュボード/クエリ レイヤーにパブリッシュします。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

例

uip pm apps publish 9c46289e

データシェイプ(--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 は、[ IngestionNeeded ] が trueされている場合にのみ存在します。

UIP PM アプリの変更

開発のどの部分がまだ公開されていないかを示します (ダッシュボード、変換、BPMN)。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

例

uip pm apps changes 9c46289e

データシェイプ(--output json)

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

UIP PM アプリのドキュメント

プロセス アプリのパブリッシュ履歴のリストを表示します。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

オプション

長押し	値 (Value)	説明
--limit <number>	integer	返されるパブリケーションの最大数。
--since-version <model-version>	integer	このモデル バージョンより新しいパブリケーションのみを返します。

データシェイプ(--output 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 アプリの種類の取得

テンプレート バージョンの完全なアプリ モデルを取得します。

名前	Required	目的
<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 つの同時パート)。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。
<file-path>	○	データ ファイルへのローカル パスです。

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	アップロード先のアプリ ステージです。
--input-table <name>	string	—	対象の入力テーブル: ファイルが属する (例:Event_log)。

例

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

データシェイプ(--output json)

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

UIP PM シミュレーションのリスト

プロセス アプリに保存されたプロセスのシミュレーション (what-if シナリオ) を読み取ります。読み取り専用 — create/update/deleteはありません。シミュレーションは別の場所で作成されており、ここにのみリストが記載されています。このツールの他の部分とは異なる API (アプリ スコープの PMT、トークン交換) によって提供されます。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	アプリのステージ。

例

uip pm simulations list 9c46289e

データシェイプ(--output 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 — マイニングされたアプリを分析します。

参照

• グローバル オプション
• 終了コード