UIP PM アプリのデータ モデル、UIP PM アプリ モデル

Process Mining アプリの構造データ モデルとセマンティック モデル (表、フィールド、ダッシュボード、メトリック) を「uip PM apps data-model」と「uip pm apps model」を使用して編集するための構文とオプションです。

uip pmツールの一部です。このページでは、プロセス アプリの 2 つのモデル編集画面について説明します。

• apps data-model — 構造テーブル グラフ: 存在するテーブル、その主キー/外部キー、およびそれらが Casesに結合する方法。
• apps model — セマンティック モデルです。フィールドとそのデータの種類、計算フィールド、ダッシュボード、メトリックがあります。対象を絞って編集するための fields、 dashboards、 metrics のサブグループと、ドキュメント全体の get/update が含まれます。
• apps data-mapping — アプリの入力データのマッピングです。どのソース テーブル/列がどのターゲット フィールドをフィードするかを示します。上記のデータモデルとは異なります(これは、マッピング 後の クエリ可能な表グラフです)。

ここでのすべての書き込みは ETag で保護されています — 親ページの 概念 を参照してください。

概要

uip pm apps data-model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps data-model add-table <app-id> --file <json-file> [--stage dev|published]

uip pm apps model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps model update <app-id> --file <json-file> --etag <etag>

uip pm apps model fields list <app-id> [--stage dev|published]
uip pm apps model fields set <app-id> <field-id> [--kind <kind>] [--display-name <text>] [--expression <json>] [--table <table-id>]
uip pm apps model fields remove <app-id> <field-id>

uip pm apps model dashboards list <app-id> [--stage dev|published]
uip pm apps model dashboards get <app-id> [--dashboard <id-or-name>] [--stage dev|published] [--destination <file>]
uip pm apps model dashboards update <app-id> [--file <json-file>] [--metrics <json-file>] --etag <etag> [--dashboard <id-or-name>]

uip pm apps model metrics list <app-id> [--stage dev|published]

uip pm apps data-mapping get <app-id> [--stage dev] [--destination <file>]
uip pm apps data-mapping update <app-id> --file <json-file> --etag <etag> [--stage dev]

uip PM アプリのデータ モデルの取得

アプリの構造データ モデル (主キー/外部キーと列ロールを持つテーブル) を取得します。参照用にモデルの ETag を返します。 add-table 自体は、変更を再読み取ってマージするため、 --etag 必要はありません。

引数

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

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	アプリのステージ。
--destination <local-file>	パス	—	出力エンベロープではなくこのファイルにモデル JSON を書き込みます。

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

{ "Code": "PmAppsDataModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

--destinationを渡すと、Destination がModelを置き換えます。

UIP PM アプリのデータ - モデル add-table

カスタム dbt モデルをクエリ可能なデータ モデル テーブルとして登録します。Process Mining は大文字と小文字中心です。クエリ可能なテーブルは Cases ルートまたはそれへのリンクである必要があります。テーブルに外部キー付きの (null 許容の) Case_ID 列を指定します。この列は、スタンドアロンの分析テーブルを疎リンクするために Cases します。その後、再摂取して具体化します。--etag不要 : 現在のデータモデル自体を読み取り、正確にそのドキュメントにマージするため、競合し、コマンドが再実行される間に書き込みが着陸します。

引数

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

オプション

長押し	値 (Value)	Required	説明
--file <json-file>	パス	○	JSON と追加するテーブル (単一のデータ モデル テーブル、配列、または { tables } オブジェクト)各: { name, primaryKey, foreignKeys: [{ table: "Cases", column: "Case_ID" }] } (type 既定値は "Object"です)。
--stage <stage>	dev | published	×	既定 devです。

テーブルは nameによって一致します。既存のエントリが置換され、新しいエントリが追加されます。

例

uip pm apps data-model add-table 9c46289e --file ./Workload_weekly.table.json

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

{
  "Code": "PmAppsDataModelAddTable",
  "Data": {
    "AppId": "9c46289e",
    "AddedTables": ["Workload_weekly"],
    "IngestionNeeded": true,
    "Instructions": "Re-ingest to materialize the table(s): uip pm ingestions create 9c46289e --wait — then query them. Run 'uip pm apps publish 9c46289e' to push to dashboards."
  }
}

テーブルに へのパスがない場合、クエリ レイヤーで UserError_TableIsDeletedスタイルの拒否で失敗Cases名前のないテーブルエントリ、または使用可能なテーブルのないファイルは、書き込み前にクライアント側で失敗します。

UIP PM Apps モデルの取得

アプリのセマンティック モデル (データの種類を含むフィールド、計算フィールド、メトリック、ダッシュボード ビュー) を取得します。 update の形状です。モデルの ETag を返します。この ETag は --etagとして必要model update。

引数

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

オプション

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	アプリのステージ。
--destination <local-file>	パス	—	出力エンベロープではなくこのファイルにモデル JSON を書き込みます。

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

{ "Code": "PmAppsModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

UIP PM アプリ モデルの更新

アプリ モデル全体をローカルの JSON ファイルから置き換えます。開発にのみ適用されます。1 つのフィールドの場合は、その場で編集する apps model fields setを優先します。完全な置換は、書き込まれた model get のETagを運ぶ必要があります—ここで新しいETagを取得すると、同時実行チェックが無効になります。

引数

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

オプション

長押し	値 (Value)	Required	説明
--file <json-file>	パス	○	完全なモデルを含むローカル JSON ファイル ( model getによって返される)
--etag <etag>	string	○	この編集の基になるモデルの ETag。

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

{ "Code": "PmAppsModelUpdate", "Data": { "AppId": "9c46289e", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

古い --etag は競合で失敗します。 model getで再読み込み、編集をやり直し、リトライしてください。UnsupportedOperatorArgumentDataKindエラーとは、ダッシュボード フィルター、計算フィールド、またはメトリックのしきい値によって、フィールドがまだ古いデータの種類の定数と比較されていることを意味します。種類を変更する前に、その比較を修正または削除してください。

UIP PM アプリ モデルのフィールド リスト

アプリのテーブルのすべてのフィールドを、そのデータの種類、およびマッピングされた列か計算フィールドかと併せてリストします。

引数

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

オプション

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

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

{ "Code": "PmAppsFieldsList", "Data": [{ "Table": "Cases", "Id": "Case_status", "Display": "Status", "Kind": "nominal", "Type": "column" }] }

Type が "column" (マッピング) または "calculated"です。

UIP PM アプリ モデルのフィールド セット

フィールドを作成または編集します (内部的には ETag セーフ — 独自のベースを読み取ってマージします)。データの種類を変更したり、名前を変更したり、計算フィールドに変換したりします。

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。
<field-id>	○	フィールド ID

オプション

長押し	値 (Value)	説明
--kind <kind>	ordinal|nominal|numeric|datetime|boolean|percentage|currency|duration	データの種類。(id/ref は構造的であり、設定できません。
--display-name <text>	string	表示名。
--expression <json>	JSON (インラインまたは @file.json)	計算フィールド式ノード。指定すると、フィールドは計算フィールドに変換されます。
--table <table-id>	string	ターゲット テーブル — 新しいフィールドを作成する場合にのみ必須です。

--kind/--display-name/--expression のうち少なくとも 1 つが必要です。フィールドを作成するには、 --table、 --expression、 --kindが必要です。マップされた列はこの方法では作成できません (取り込まれたデータから取得されます)。マッピングされた既存の列に --expression を設定することは拒否されます。代わりに、別の ID で新しい計算フィールドを作成します。ID が 別の テーブルのフィールドと競合する作成は、そのフィールドをサイレントに編集するのではなく拒否されます。

例

uip pm apps model fields set 9c46289e Case_status --kind ordinal

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

{ "Code": "PmAppsFieldsSet", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Action": "updated", "Table": "Cases", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

Action が "created" か "updated"です。

UIP PM アプリ モデルのフィールド 削除

モデルからフィールドを削除する

引数

名前	Required	目的
<app-id>	○	プロセス アプリ ID です。
<field-id>	○	フィールド ID

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

{ "Code": "PmAppsFieldsRemove", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Table": "Cases", "Versions": [4], "Instructions": "..." } }

UIP PM アプリ モデル ダッシュボード

同じモデルのドキュメントのダッシュボード状のビュー model get/update 往復 — list/get/update view.dashboardsで作業します。

UIP PM アプリ モデル ダッシュボードのリスト

プロセス アプリのダッシュボードのリストを表示します。

名前/オプション	Required	目的
<app-id>	○	プロセス アプリ ID です。
--stage <stage>	×	dev | published、既定値は devです。

{ "Code": "PmAppsDashboardsList", "Data": [{ "Id": "overview", "Name": "Overview", "Layout": "three-left-one-right", "Charts": 4, "Metrics": 5, "IsVisible": true }] }

Charts は、ダッシュボードの Chart-ID マトリックスのフラット化された数です。

UIP PM Apps モデルのダッシュボードは、以下を取得します。

ETag update のニーズを含むプロセス アプリのダッシュボードを取得します。

長押し	値 (Value)	説明
--stage <stage>	dev|published	既定 devです。
--dashboard <id-or-name>	string	[ view ] セクション全体ではなく、このダッシュボードのみを返します。最初に ID で一致し、次に正確な名前で一致 — あいまいな名前 (複数のダッシュボードがそれを共有している) は失敗し、ID で選択するように求められます。
--destination <local-file>	パス	エンベロープではなくこのファイルに JSON を書き込みます。

uip pm apps model dashboards get 9c46289e --dashboard 'Overview' --destination ./dashboard.json

{ "Code": "PmAppsDashboardsGet", "Data": { "Dashboard": "Overview", "ETag": "W/\"3\"", "Destination": "./dashboard.json" } }

UIP PM アプリ モデル ダッシュボードの更新

ローカルの JSON ファイルからプロセス アプリのダッシュボードを更新します。開発ステージのみ。

長押し	値 (Value)	Required	説明
--file <local-file>	パス	いいえ*	--dashboardが与えられている場合は 1 つのダッシュボード、それ以外の場合はviewセクション全体。
--metrics <local-file>	パス	いいえ*	ID で追加または置換するメトリック定義の JSON 配列です。--fileと同じ要求に書き込まれるため、導入されるグラフで同じ書き込みで追加されたメトリックを参照できます。
--etag <etag>	string	○	この編集の基になるモデルの ETag。
--dashboard <id-or-name>	string	×	--file置き換えるダッシュボード — --fileが必要です。--fileなしで渡すと拒否されます。

※ --file/--metrics のいずれか1つ以上が必要です。

uip pm apps model dashboards update 9c46289e --dashboard 'Overview' --file ./dashboard.json --etag 'W/"3"'

{ "Code": "PmAppsDashboardsUpdate", "Data": { "Dashboard": "Overview", "Versions": [4], "Instructions": "Saved on dev. Run 'uip pm apps publish 9c46289e' to push the change to the dashboards; if the publish reports IngestionNeeded, re-ingest with 'uip pm ingestions create 9c46289e --wait'." } }

UIP PM アプリ モデルのメトリック リスト

アプリのデータ モデルから、グラフで参照できるメトリックを一覧表示します。を追加するか、 に置き換え dashboards update --metrics。

名前/オプション	Required	目的
<app-id>	○	プロセス アプリ ID です。
--stage <stage>	×	dev|published、既定値は devです。

{ "Code": "PmAppsMetricsList", "Data": [{ "Id": "avg_throughput", "Display": "Avg. throughput", "Aggregation": "AVERAGE", "Argument": "Case_throughput_time" }] }

UIP PM アプリのデータ マッピング Get

アプリの入力データのマッピングを取得します。 apps create --data-mapping の形状と同じであるため、 data-mapping updateで編集したりプッシュバックしたりできます。マッピングの ETag を返します。その更新には --etagとして必要です。

長押し	値 (Value)	既定 (Default)	説明
--stage <stage>	dev | published	dev	読み取るアプリのステージです。
--destination <local-file>	パス	—	出力エンベロープではなくこのファイルにマッピング JSON を書き込みます。

uip pm apps data-mapping get 9c46289e --destination ./mapping.json

{ "Code": "PmAppsDataMappingGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"639204059477096903\"", "Destination": "./mapping.json" } }

UIP PM アプリのデータ マッピングの更新

アプリの入力データ マッピングをローカルの JSON ファイルから置き換えます (ETag セーフ) — アプリを再作成するのではなく、間違ったマッピングを修正します。次回の取り込みに適用されます。変換の修正と異なり、マッピングの変更によって RAW ファイルの 解析方法が決まるため、その transformations apply を遡及的に適用することはできません。

オプション

長押し	値 (Value)	Required	説明
--file <json-file>	パス	○	入力データの完全マッピング ({ "Tables": [...] }) — 保存されているマッピングを完全に置き換えます。フィールドごとの既定値は apps create --data-mappingと同じです。
--etag <etag>	string	○	この編集の基になるマッピングの ETag。
--stage <stage>	dev	×	devのみ書き込み可能 — バックエンドは両方のステージでGETを提供しますが、devでの書き込みのみを受け入れます。

uip pm apps data-mapping update 9c46289e --file ./mapping.json --etag 'W/"639204059477096903"'

{ "Code": "PmAppsDataMappingUpdate", "Data": { "AppId": "9c46289e", "Tables": ["Event_log"], "IngestionNeeded": true, "Instructions": "Re-ingest for the new mapping to take effect: uip pm ingestions create 9c46289e --wait. Re-upload first (uip pm files upload) only if the source columns changed." } }

古い --etag は競合で失敗します。 data-mapping getで再読み込み、編集をやり直し、リトライしてください。テーブルが含まれていないマッピング ファイルは、アプリのマッピングが消去されるのではなく、クライアント側で失敗します。

関連

• uip pm — 概要と apps CRUD
• ingestions &; transformations — データ モデルまたはフィールドの変更を具体化します。
• conformance、deviations、query — 結果のデータを分析します。

参照

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