UIP Maestro のケース

「uip Maestro Case」を使用して、ケース管理プロジェクトを作成、パッケージ化、デバッグ、検証、作成します。「uip Maestro Case」は、BPMN、フローと並ぶ 3 番目の Maestro オーケストレーション サーフェスです。

uip maestro case は、ケース 管理 プロジェクトの作成、パッケージ化、デバッグ、作成を行います。これは、 BPMN や Flow と並ぶ Maestro のオーケストレーションのサーフェスです。ケース プロジェクトは、人間が主導する長期実行の作業単位を ケース プランとしてモデル化します。これは、ステージ、タスク、SLA、トリガー、およびケースをステージ間で移動させる開始/終了条件を記述した JSON ドキュメント (caseplan.jsonです。これは、線形プロセスというよりも、ライフサイクルのある構造化されたワークフローに近いものです)。

このツールは個別の @uipath/case-tool パッケージとして出荷され、case ブランチの @uipath/maestro-toolによって動的に読み込まれます。ここでのすべてのコマンドは uip maestro case <verb>として呼び出され、スタンドアロン uip caseとして呼び出されることはありません。

このリソースは 9 ページに及びます

• このページ には、概念とプロジェクト ライフサイクル コマンド ( init、 pack、 debug、 validate、 specが記載されています。
• registry — ケースがタスクをワイヤリングしている自動化リソース カタログを参照/検索します。また、タスクの入力を変数にバインドする方法と記載されています。
• casesとstages — ケースプランの最上位レベルのメタデータとステージリストを読み取ります。
• tasks — ステージ内のタスクの定義を読み取る、強化する、説明します。
• task-entry-conditions — タスクが実行可能になったときに制限されるルールをお読みください。
• sla — SLA/エスカレーション ルールを読み取ります。
• triggers、sticky-notes、edges — ケース トリガー、キャンバスの注釈、ステージ間の遷移を読み取ります。
• case-exit-conditions、stage-entry-conditions、stage-exit-conditions — ケース レベルおよびステージ レベルの条件ルールを読み取ります。
• process、processes、job、instances、incidents — Orchestrator にケース インスタンスをデプロイして実行します。

概念

• 作成モデル: caseplan.json を直接編集してから、 validateします。ケースの内容に対する CLI 駆動型のミューテーション パスはありません。caseplan.json手動で作成または編集し (または、uipath-maestro-case スキルの JSON 形式の参照に基づいてエージェントに依頼して)、uip maestro case validateを実行して確認します。上記の兄弟のページに記載されている read 動詞 (cases get、 stages list、 tasks getなど) は、この方法でプランを作成する際にプランを検査するのに役立つために存在しています。これらは書き込み API の一部ではありません。
• ケース、BPMN、フロー — 3 つとも Maestro のオーケストレーション サーフェスであり、ランタイム プリミティブ (process/job/instances/incidents/registry) を.nupkgして共有しますが、ケース管理自体のプライマリ アセットは caseplan.json (および生成されたcaseplan.json.bpmn) であり、そのプロジェクトの種類は operate.json/project.uiproj でCaseManagementされています。これは、BPMN の.bpmnやフローとは異なります.flowです。
• 検証プロファイル — validate は、作成の進行状況に応じて 4 つのプロファイルのいずれかを実行します。 skeleton (構造のみ - ノード、エッジ、ID、型)、 skeleton-v2 (スケルトンと SLA/エスカレーション/エントリーと出口ルールの確認、タスクの内容は引き続きスキップ)、 strict (タスクのないステージ、未解決の $xref マーカー、コネクタ コンテキストの完全性 — 完了したケースのゲートを含むすべてのチェック) 既定の full プロファイル (部分的に作成されたファイルやすでにパッケージ化されたファイルの場合は寛大)。--sdd <path> は仕様書に対する完全性を監査し、 を暗 --strictします。
• spec は計画ツールであり、ケース プランのミューテーターではありません。Integration Service の 1 つのコネクタ アクティビティまたはトリガーの正規化された説明 (入力、出力、必須フィールド) を取得するため、caseplan.jsonのタスク/トリガーの定義に何を入力すればよいかを記述する前に把握できます。registry get-connector/get-connectionで、必要な--activity-type-id/--connection-id値を見つけます。

概要

uip maestro case init <name> [--force] [--skip-solution-registration]
uip maestro case pack <project-path> <output-path> [-n, --name <name>] [-v, --version <version>] [package-metadata options...]
uip maestro case debug <project-path> [--folder-id <id>] [--poll-interval <ms>] [--login-validity <minutes>]
uip maestro case validate <file> [--skeleton | --skeleton-v2 | --strict] [--sdd <path>]
uip maestro case spec --type <activity|trigger> --activity-type-id <uuid> --connection-id <id> [--object-name <name>] [--skip-case-shape | --input-details <json>]

UIP Maestro ケースの初期化

ボイラープレート ファイル ( project.uiproj、 operate.json、 entry-points.json、 bindings_v2.json、 package-descriptor.json、および最小限の caseplan.json (まだ存在しない場合にのみ記述されます。再実行 init 、作成済みのケース プランが破損することはありません) を使用して、新しいケース プロジェクトを作成します。既存のソリューションの外部で実行した場合、親 <name>Solution が自動的にスキャフォールディングされ、ケース プロジェクトはその中に入れ子になります。そのようなフィールド内で実行すると、プロジェクトは代わりにそのソリューションに登録されます。

引数

名前	Required	目的
<name>	○	ケース プロジェクト名。文字、数字、アンダースコア、ハイフンのみ。

オプション

長押し	値 (Value)	説明
--force	フラグ	ターゲット ディレクトリが空でなくても初期化します。既存の内容をクリアせずにファイルを書き込みます。
--skip-solution-registration	フラグ	このプロジェクトを周囲のソリューションに自動登録しないでください。

例

uip maestro case init my-case-project

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

{
  "Code": "CaseInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-case-project",
    "CasePlan": "/workspace/my-case-project/caseplan.json",
    "CasePlanStatus": "Created",
    "SolutionRegistration": { "Status": "Registered", "Solution": "...", "ProjectId": "..." },
    "AutoCreatedSolution": { "...": "present only when a parent solution was scaffolded" },
    "ProjectArtifacts": { "...": "present only when registered into a parent solution" },
    "NextSteps": "present only when SolutionRegistration.Instructions is set"
  }
}

CasePlanStatusは、既存のcaseplan.jsonがそのまま残されていた (すでに作成済みのプロジェクトでinitを再実行する) 新しい"Preserved"に"Created"されます。SolutionRegistration 常に存在します。つまり、親ソリューションが存在しない場合、フィールドが省略されるのではなく、 Status が "NotInSolution" されます。

UIP Maestro ケース パック

Case プロジェクト ディレクトリを .nupkg ファイルにパックし、プロジェクトのルートから caseplan.json 読み取ります。

引数

名前	Required	目的
<project-path>	○	ケース プロジェクト ディレクトリへのパス。
<output-path>	○	.nupkgの出力ディレクトリです。

オプション

長押し	値 (Value)	説明
-n, --name <name>	string	パッケージ名。既定: プロジェクトのフォルダー名です。
-v, --version <version>	string	パッケージ バージョン。既定 1.0.0です。

また、このリポジトリの共有パッケージメタデータオプション (--repository-url/--repository-commit/--repository-branch/--repository-type、 --release-notes、 --project-url、 --author、 --description) も受け入れます — このコマンドが同一に登録する完全な共有セットについては、他の pack コマンドの Options テーブル ( uip maestro bpmn packなど) を参照してください。

例

uip maestro case pack ./my-case-project ./dist --version 1.2.0

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

{
  "Code": "CasePack",
  "Data": {
    "Package": "my-case-project.1.2.0.nupkg",
    "Output": "./dist/my-case-project.1.2.0.nupkg"
  }
}

パッケージ化中のスキーマ エラー (形式が正しくない caseplan.json) は、失敗として表面化する前に、ケース固有のガイダンスで強化されます。生のパーサー エラーではなく、実用的な Instructionsを期待してください。

UIP Maestro の場合のデバッグ

ケース プロジェクトを Studio Web にアップロードしてそこでデバッグ セッションを実行することで、ケース プロジェクトをデバッグします。ケース管理には (他の Maestro デバッグ コマンドとは異なり) ローカル専用のデバッグ モードはありません。

引数

名前	Required	目的
<project-path>	○	ケース プロジェクト ディレクトリへのパス。project.uiprojが含まれている必要があります。

オプション

長押し	値 (Value)	説明
--folder-id <id>	integer	Orchestrator フォルダー ID (OrganizationUnitId)。省略すると自動検出されます。
--poll-interval <ms>	integer	ポーリング間隔 (ミリ秒)。既定 2000です。
--login-validity <minutes>	integer	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。既定 10です。

解決可能な組織、テナント、およびアクセス トークンを使用したアクティブなログイン (uip login) が必要です。ログイン ステートのうち欠落している方の名前が付けられた特定のメッセージが表示され、高速で失敗します。

例

uip maestro case debug ./my-case-project

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

{
  "Code": "CaseDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Completed",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "elementExecutions": [
      { "elementId": "Stage_1", "status": "Completed" },
      { "elementId": "Stage_2", "status": "Completed" }
    ]
  }
}

キーはネイティブのキャメルケース(パスカルケースではない)に保持されます — このペイロードは、評価チェッカーとSDKによってプログラムで読み取られるように設計されており、フローのデバッグコマンドと registry getで使用されるのと同じカーブアウトと一致します。finalStatusが "Completed"/"Successful"以外の場合は、エンベロープ自体が Result: "Success" を報告する場合でも、コマンドはゼロ以外で終了します — スクリプトに Dataが存在するだけでなく、終了コードを確認してください。

UIP Maestro ケースの検証

ケース管理の JSON ファイルをケース管理の構造ルールおよびビジネス ルールに照らして検証します。

引数

名前	Required	目的
<file>	○	ケース管理の JSON ファイルへのパスです (通常は caseplan.json)。

オプション

長押し	説明
--skeleton	構造チェックのみ (ノード、エッジ、ID、型)。タスクの内容、SLA、エスカレーション、開始/終了ルールをスキップします。これは、作成のスケルトン フェーズで役立ちます。--skeleton-v2/--strictと競合します。
--skeleton-v2	スケルトン チェックに加えて、SLA、エスカレーション、開始/終了ルールのチェック。それでもタスクの内容はスキップされます。--skeleton/--strictと競合します。
--strict	すべてのチェックに加えて、厳密なセット (タスク、未解決の $xref マーカー、吊り上げられた conditionExpression、形式引数/出力バインドの図形、コネクタ コンテキストの完全性) を示します。完成したケースのゲート。--skeleton/--skeleton-v2と競合します。
--sdd <path>	指定された SDD (仕様書) に対するケースプランの完全性を監査します — 宣言するすべてのステージ、タスク、タスク タイプ、条件行、SLA、トリガー、およびケース変数が存在する必要があります。--strictを意味します。

4 つの実行をすべて省略すると、既定の full プロファイル (lenient) が実行されるため、部分的に作成されたファイルやすでにパッケージ化されたファイルも引き続き検証されます。

例

uip maestro case validate case.json
uip maestro case validate case.json --skeleton
uip maestro case validate case.json --strict
uip maestro case validate case.json --sdd ./spec.md

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

{
  "Code": "CaseValidate",
  "Data": {
    "File": "case.json",
    "Status": "Valid",
    "Warnings": "2 warning(s):\n  - [stages[0].tasks[1]] ...",
    "Issues": [
      { "Code": "UNRESOLVED_REFERENCE", "Path": "stages[0].tasks[1]", "Message": "...", "Severity": "warning" }
    ]
  }
}

Profile: "strict" は、--strict (または --sdd) が渡された場合にのみDataに追加されます。Warnings/Issues は、有効なファイルで警告がまだ生成されている場合にのみ表示されます。障害が発生すると (Result: "Failure"、 出口 1)、 Data.Issues は、すべてのエラーと警告を安定した Code、 Path、 Message、 Severity で保存します。修復ループを実行している場合は、人間が判読できる Instructions テキストではなく、この配列を解析してください。

UIP Maestro のケース仕様

正規化された ConnectorTaskSpec を生成する — 実行可能な Integration Service アクティビティやトリガー タスクをケース プラン内に構築するために必要なものがすべて揃っています。ローカルの TypeCache で型を検索し、コネクタに対する Integration Service のコネクションのリストを取得して、Integration Service のメタデータを取得します。

オプション

長押し	値 (Value)	Required	説明
--type <type>	activity | trigger	○	検索する TypeCache。
--activity-type-id <uuid>	UUID	○	Studio Web uiPathActivityTypeIdregistry pull + typecache-{activities,triggers}-index.json キャッシュ ファイルの読み取り、または registry get-connectorで見つけることができます。
--connection-id <id>	UUID	○	コネクション IDregistry get-connection --type typecache-{activities,triggers} --activity-type-id <uuid>で候補者のリストを取得。
--object-name <name>	string	×	TypeCache objectNameを上書きします。TypeCache にプレースホルダーが格納されるエンティティ型のキュレーション済みトリガーに必要です (例:Data Service {tenantEntityName|folderEntityName}) — 実際のエンティティ名を選択します。
--skip-case-shape	フラグ	×	応答から caseShape を省略します (inputs[]/outputs[]/context[]) — コネクタ コントラクトのみが必要な場合に、計画時に使用します。--input-detailsと相互に排他的です。
--input-details <json>	JSON	×	生成された caseShapeに折りたたまれた値を事前に入力します。形状が --typeによって異なる : アクティビティは {bodyParameters, queryParameters, pathParameters, filter}を受け入れます。トリガーは {eventParameters, filter}を受け入れます。--skip-case-shapeと相互に排他的です。

例

# Curated connector activity (Send Email)
uip maestro case spec --type activity \
  --activity-type-id c7ce0a96-2091-3d94-b16f-706ebb1eb351 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

# Curated connector trigger (Email Received)
uip maestro case spec --type trigger \
  --activity-type-id 7dc57f24-894c-5ae2-a902-66056fa40609 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

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

{
  "Code": "ConnectorTaskSpec",
  "Data": {
    "specVersion": 1,
    "identity": {
      "target": "activity",
      "uiPathActivityTypeId": "c7ce0a96-2091-3d94-b16f-706ebb1eb351",
      "connectorKey": "uipath-microsoft-outlook365",
      "objectName": "send-mail-v2",
      "typecacheEntry": { "displayName": "Send Email" }
    },
    "operation": { "name": "POST", "verb": "create", "httpMethod": "POST", "path": "/hubs/productivity/send-mail-v2" },
    "inputs": { "bodyFields": [{ "name": "message.toRecipients", "required": true }] }
  }
}

トリガー仕様の operation 形状は異なります ( HTTP 動詞/パスではなく /event 名eventMode) — 上記の 2 番目の例を参照してください。

関連

• registry — ケース プランで参照するリソースと、タスクの入力を変数にバインドする方法を発見します。
• casesとstages — ケースプランのメタデータとステージを検査します。
• tasks — タスク定義を検査、強化、記述します。
• task-entry-conditions — タスク レベルのエントリ ルールを調べます。
• sla — SLA/エスカレーション ルールを検査します。
• triggers、sticky-notes、edges — トリガー、キャンバスのメモ、トランジションを検査します。
• 条件 — ケース レベルおよびステージ レベルの開始/終了条件ルールを検査します。
• process、processes、job、instances、incidents — ケース インスタンスをデプロイして実行します。
• uip maestro — BPMN オーケストレーション、兄弟サーフェス。
• uip maestro flow — フロー オーケストレーション、もう一方の兄弟サーフェス。

参照

• Maestro ツールの概要
• グローバル オプション
• 終了コード