init de bpmn do uip Maestro

Sintaxe e opções para "uip Maestro bpmn init", que estrutura um novo projeto do Maestro com um inicializador do BPMN 2.0 válido e arquivos de metadados do Orchestrator.

uip maestro bpmn init estrutura um novo diretório de projeto do Maestro com um inicial BPMN 2.0 válido e os arquivos de metadados que o Orchestrator espera para pacotes de processo-Orchestration. Ele está registrado na ramificação bpmn.

Resumo

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

Recebe opções globais. Os códigos de saída seguem o contrato padrão.

Argumentos

• <name> necessário) — nome da pasta do projeto. Validado com VALID_PROJECT_NAME_REGEX: apenas letras, números, sublinhados (_) e hifens (-).

Opções

Opção	Description
--process-id <id>	ID do processo BPMN a ser gravado no modelo gerado. Process_1Padrão:.
--force	Inicialize mesmo que o diretório de destino exista e não esteja vazio. Os arquivos existentes não são limpos — os arquivos são escritos ao lado; isso é útil para reinicializar dentro de uma pasta pré-criada.
--skip-solution-registration	Não registre este projeto automaticamente na solução ao redor (consulte Comportamento abaixo).

Comportamento

Cria <name>/ no diretório de trabalho atual e grava seis arquivos:

de transações	Finalidade
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	Metadados de runtime — targetFramework: "Portable", contentType: "processOrchestration", runtimeOptions.isAttended: false.
entry-points.json	Um ponto de entrada apontando para Event_start dentro do BPMN inicial, com esquemas de entrada/saída vazios.
bindings_v2.json	{ "version": "2.0", "resources": [] }.
package-descriptor.json	Manifesto do arquivo consumido pelo empacotador.
<name>.bpmn	Inicializador BPMN contendo Event_start → _Implicit_EndEvent, conectado a uma extensão uipath:entryPointId usando --process-id (padrão Process_1).

O BPMN inicial é analisado por meio de bpmn-moddle antes de escrever; se os avisos estrutural (não UiPath-extension) aparecerem, o comando falhará com BPMN validation failed: ….

Se <name> já existir e não estiver vazio e --force não estiver definido, o comando falhará com um erro.

Registro automático da solução: a menos que --skip-solution-registration seja passado, init procurará uma solução alternativa. Se executado dentro de um, o novo projeto será registrado nele. Se executado fora de qualquer solução, um <name>Solution pai é estruturado automaticamente e o projeto é aninhado dentro dele. Isso acontece por padrão, não apenas quando explicitamente solicitado.

Exemplos

# 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

Formato dos dados (--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 e NextSteps são omitidos totalmente quando não são aplicáveis — apenas Status, Path e SolutionRegistration estão sempre presentes. Na falha, a resposta traz Result: "Failure", Message e Instructions.

Veja também

• uip maestro bpmn pack — empacotar o projeto com escopo
• uip maestro bpmn debug — execute-o por meio do Studio Web
• uip maestro bpmn validate — validar antes do empacotamento
• Visão geral do Maestro