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.

Synthèse

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

Les options globales sont respectées. Les codes de sortie suivent le contrat standard.

Arguments

• <name> (obligatoire) : nom du dossier du projet. Validé par rapport à VALID_PROJECT_NAME_REGEX: lettres, chiffres, traits de soulignement (_) et traits d’union (-) uniquement.

Options

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

Comportement

Crée <name>/ dans le répertoire de travail actuel et écrit six fichiers:

Fichier	Objectif
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	Métadonnées de runtime — targetFramework: "Portable", contentType: "processOrchestration", runtimeOptions.isAttended: false.
entry-points.json	Un point d'entrée pointant sur Event_start à l'intérieur du BPMN de démarrage, avec des schémas d'entrée/de sortie vides.
bindings_v2.json	{ "version": "2.0", "resources": [] }.
package-descriptor.json	Manifest de fichier utilisé par le packer.
<name>.bpmn	Starter BPMN containing Event_start → _Implicit_EndEvent, wired with a uipath:entryPointId extension using --process-id (default Process_1).

Le BPMN de démarrage est analysé via bpmn-moddle avant d'écrire; si des avertissements de structure (n'appartenant pas à l'extension UiPath) apparaissent, la commande échoue avec BPMN validation failed: ….

Si <name> existe déjà et n’est pas vide et que --force n’est pas défini, la commande échoue avec une erreur.

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.

Exemples

# 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

Format des données (--sortie 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.

Voir également

• uip maestro bpmn pack — compresser le projet structuré
• uip maestro bpmn debug — Exécuter via Studio Web
• uip maestro bpmn validate — valider avant la mise en package
• Vue d’ensemble de Maestro