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.

Zusammenfassung

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

Beachten Sie globale Optionen. Austrittscodes folgen dem Standardvertrag.

Argumente

• <name> (erforderlich) – Name des Projektordners. Validiert gegen VALID_PROJECT_NAME_REGEX: Nur Buchstaben, Ziffern, Unterstriche (_) und Bindestriche (-).

Optionen

Option	Beschreibung
--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).

Verhalten

Erstellt <name>/ im aktuellen Arbeitsverzeichnis und schreibt sechs Dateien:

Datei	Zweck
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	Laufzeitmetadaten – targetFramework: "Portable", contentType: "processOrchestration", runtimeOptions.isAttended: false.
entry-points.json	Ein Einstiegspunkt, der auf Event_start innerhalb des Start-BPMN verweist, mit leeren Eingabe-/Ausgabeschemas.
bindings_v2.json	{ "version": "2.0", "resources": [] }.
package-descriptor.json	Dateimanifest, das vom Packer verbraucht wird.
<name>.bpmn	Starter BPMN containing Event_start → _Implicit_EndEvent, wired with a uipath:entryPointId extension using --process-id (default Process_1).

Das Start-BPMN wird vor dem Schreiben durch bpmn-moddle geparst; wenn strukturierte Warnungen (nicht von UiPath-Extension) angezeigt werden, schlägt der Befehl mit BPMN validation failed: … fehl.

Wenn <name> bereits vorhanden und nicht leer ist und --force nicht festgelegt ist, schlägt der Befehl mit einem Fehler fehl.

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.

Beispiele

# 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

Datenform (--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.

Siehe auch

• uip maestro bpmn pack – Packen Sie das Gerüst-Projekt
• uip maestro bpmn debug – Führen Sie es über Studio Web aus
• uip maestro bpmn validate – Vor dem Packen validieren
• Maestro-Übersicht