uip maestro bpmn init

Syntax and options for `uip maestro bpmn init`, which scaffolds a new Maestro project with a valid BPMN 2.0 starter and Orchestrator metadata files.

uip maestro bpmn init scaffolds a new Maestro project directory with a valid BPMN 2.0 starter and the metadata files Orchestrator expects for process-orchestration packages. It's registered under the bpmn branch.

概要

uip maestro bpmn init <name> [--process-id <id>] [--force] [--skip-solution-registration]

グローバルオプションを優先します。終了コードは 標準コントラクトに従います。

引数

• <name> (必須) — プロジェクト フォルダーの名前。VALID_PROJECT_NAME_REGEXに対して検証されます。文字、数字、アンダースコア (_)、およびハイフン (-) のみ。

オプション

オプション	説明
--process-id <id>	BPMN process ID to write into the generated template. Default: Process_1.
--force	Initialize even if the target directory exists and is non-empty. Existing files are not cleared — files are written alongside; this is useful for reinitializing inside a pre-created folder.
--skip-solution-registration	Do not auto-register this project in the surrounding solution (see Behavior below).

動作

現在の作業ディレクトリに <name>/ を作成し、次の 6 つのファイルを書き込みます。

ファイル	目的
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	実行時のメタデータ — targetFramework: "Portable"、contentType: "processOrchestration"、runtimeOptions.isAttended: false
entry-points.json	スターター BPMN 内の Event_start を指す 1 つのエントリ ポイントと、空の入出力スキーマ
bindings_v2.json	{ "version": "2.0", "resources": [] }.
package-descriptor.json	パッカーによって消費されるファイル マニフェスト。
<name>.bpmn	Starter BPMN containing Event_start → _Implicit_EndEvent, wired with a uipath:entryPointId extension using --process-id (default Process_1).

スターター BPMN は、書き込み前に bpmn-moddle で解析されます。構造的な (UiPath 拡張機能以外の) 警告が表示された場合、コマンドは BPMN validation failed: …で失敗します。

<name>既に存在し、空でなく、--forceが設定されていない場合、コマンドは失敗し、エラーが表示されます。

Solution auto-registration: unless --skip-solution-registration is passed, init looks for a surrounding solution. If run inside one, the new project is registered into it. If run outside any solution, a parent <name>Solution is scaffolded automatically and the project is nested inside it — this happens by default, not only when explicitly requested.

例

# Create a new project in ./invoice-orchestration
uip maestro bpmn init invoice-orchestration

# Set a custom BPMN process ID
uip maestro bpmn init invoice-orchestration --process-id InvoiceApproval

# Reinitialize into an existing non-empty folder
uip maestro bpmn init invoice-orchestration --force

# Scaffold standalone, without touching any surrounding solution
uip maestro bpmn init invoice-orchestration --skip-solution-registration

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

{
  "Code": "MaestroInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/invoice-orchestration",
    "SolutionRegistration": { "...": "registration outcome against the surrounding or newly created solution" },
    "AutoCreatedSolution": { "...": "present only when a parent <name>Solution was scaffolded automatically" },
    "ProjectArtifacts": { "...": "present only when additional project artifacts were generated" },
    "NextSteps": "present only when SolutionRegistration carries follow-up instructions"
  }
}

AutoCreatedSolution, ProjectArtifacts, and NextSteps are omitted entirely when not applicable — only Status, Path, and SolutionRegistration are always present. On failure the response carries Result: "Failure", Message, and Instructions.

参照

• uip maestro bpmn pack — スキャフォールディングされたプロジェクトを梱包する
• uip maestro bpmn debug — Studio Web 経由で実行する
• uip maestro bpmn validate — 梱包前の検証
• Maestro の概要