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.

Sinopsis

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

Prevalece las opciones globales. Los códigos de salida siguen el contrato estándar.

Argumentos

• <name> obligatorio) : nombre de la carpeta del proyecto. Validado para VALID_PROJECT_NAME_REGEX: solo letras, números, guiones bajos (_) y guiones (-).

Opciones

Opción	Descripción
--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).

Comportamiento

Crea <name>/ en el directorio de trabajo actual y escribe seis archivos:

Archivo	Propósito
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	Metadatos de runtime: targetFramework: "Portable", contentType: "processOrchestration", runtimeOptions.isAttended: false.
entry-points.json	Un punto de entrada que apunta a Event_start dentro del BPMN de inicio, con esquemas de entrada/salida vacíos.
bindings_v2.json	{ "version": "2.0", "resources": [] }.
package-descriptor.json	Manifiesto de archivo consumido por el empaquetador.
<name>.bpmn	Starter BPMN containing Event_start → _Implicit_EndEvent, wired with a uipath:entryPointId extension using --process-id (default Process_1).

El BPMN de inicio se analiza a través de bpmn-moddle antes de escribir; si aparecen advertencias estructurales (extensión no UiPath), el comando falla con BPMN validation failed: ….

Si <name> ya existe y no está vacío y --force no está establecido, el comando falla con un error.

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.

Ejemplos

# 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

Forma de datos (--json de salida)

{
  "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.

Ver también

• uip maestro bpmn pack — empaqueta el proyecto andamiado
• uip maestro bpmn debug : ejecútalo a través de Studio Web
• uip maestro bpmn validate — validar antes de empaquetar
• Descripción general de Maestro