uip maestro authoring commands

Syntax and options for `uip maestro flow`, `case`, and `bpmn` `compile`, `check`, `decompile`, and `merge`, which convert between authored TypeScript and Maestro artifacts.

The authoring commands convert between authored TypeScript source and the artifacts Maestro runs. The same four verbs are registered on each Maestro family:

Family	Authored source	Artifact
uip maestro flow	<name>.flow.ts	.flow Fichier
uip maestro case	<name>.case.ts	caseplan.json
uip maestro bpmn	<name>.bpmn.ts	.bpmn Fichier

uip maestro bpmn also registers tidy, which adds diagram layout to a compiled .bpmn file.

The connector library these commands read comes from uip maestro registry.

Prérequis

• @uipath/maestro-builder-sdk 6.11.1 or later, installed in the project or globally. The command looks for the package from the current directory first, then in the global npm folder. A project install takes precedence over a global one.
• Node.js on PATH.
• For uip maestro bpmn compile --connectors-local, and for uip maestro bpmn check when a connector library is available, @uipath/maestro-builder-sdk 6.15.0 or later.

When the package is missing or older than the required version, the command fails with Result: "ConfigError" and exit code 1. Instructions gives the install command: npm install --save-dev @uipath/maestro-builder-sdk@latest when the outdated copy is installed in the project, otherwise npm install -g @uipath/maestro-builder-sdk@latest.

Synthèse

uip maestro <family> compile   <source> [-o, --output <file>] [--library <dir>] [--bindings <file>] [--connectors-local <dir>] [--no-check]
uip maestro <family> check     <input> [--source] [--library <dir>] [--connectors-local <dir>] [--graph]
uip maestro <family> decompile <input> [-o, --output <file>] [--import <specifier>] [--strict] [--library <dir>] [--best-effort] [--style <style>] [--no-pipeline]
uip maestro <family> merge     <edited> --original <file> [-o, --output <file>] [--baseline <file>]
uip maestro bpmn tidy          <input> [-o, --output <file>]

<family> is flow, case, or bpmn. Some options apply to specific families only, as listed in each command's options table.

Toutes les invocations respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Sortie

Each command returns Code: "<Family><Verb>", for example FlowCompile, CaseCheck, or BpmnMerge. Data holds the builder SDK's result with PascalCase keys. The SDK's progress messages go to stderr.

When the SDK reports an error, the command returns Result: "Failure" with the SDK's reason in Message, and exits with the SDK's exit code.

Connector library

compile, the flow and bpmn check, and the case decompile read the connector library:

• --library <dir> sets the library directory.
• Without --library, the command uses the library that uip maestro registry pull downloaded.
• When the FLOW_SDK_LIBRARY_JSON environment variable is set and --library is not passed, the builder SDK reads the library from the variable.

--connectors-local <dir> points at the connection-resolved overlay that uip maestro registry prepare writes. Default: ./connectors-local.

compile

Compile an authored TypeScript source file to an artifact.

Arguments

• <source> (required) — the authored source file.

Options

Option	Families	Description
-o, --output <file>	Tout	Output artifact path.
--library <dir>	Tout	Connector library directory. Default: the pulled registry.
--bindings <file>	Tout	bindings.json path.
--connectors-local <dir>	Tout	Connection-resolved connector overlay. Default: ./connectors-local.
--no-check	flow	Skip the source-level check.

Exemples

uip maestro flow compile Order.flow.ts --output Order.flow
uip maestro case compile Claims.case.ts --output caseplan.json
uip maestro bpmn compile Approval.bpmn.ts --output Approval.bpmn

Format des données (--sortie json)

{
  "Code": "FlowCompile",
  "Data": {
    "Path": "/work/Order.flow",
    "Nodes": 3,
    "Edges": 2,
    "Sidecars": [],
    "Errors": 0,
    "Warnings": 0,
    "Diagnostics": []
  }
}

case compile returns { Path, Stages }. bpmn compile returns { Path, Elements }.

check

Check a source file for authoring errors before compiling it. To check a compiled artifact, use uip maestro <family> validate: flow, bpmn, or case.

Arguments

• <input> (required) — the authored source file.

Options

Option	Families	Description
--source	Tout	Check authored TypeScript.
--library <dir>	flow, bpmn	Connector library directory. Default: FLOW_SDK_LIBRARY_JSON, then the pulled library.
--connectors-local <dir>	flow, bpmn	Connection-resolved connector overlay. Default: ./connectors-local.
--graph	bpmn	Also print the resolved wiring: every element with the sequence flows leaving it. Implied flows are marked ~>.

Exemple

uip maestro flow check Order.flow.ts --source

Format des données (--sortie json)

{
  "Code": "FlowCheck",
  "Data": { "Errors": 0, "Warnings": 0, "Diagnostics": [] }
}

All three families return the same { Errors, Warnings, Diagnostics } shape.

decompile

Convert an artifact to authored TypeScript.

Arguments

• <input> (required) — the artifact: a .flow file, a caseplan.json file, or a .bpmn file.

Options

Option	Families	Description
-o, --output <file>	Tout	Output source path (.flow.ts, .case.ts, or .bpmn.ts).
--import <specifier>	Tout	SDK import specifier in the generated source.
--strict	flow	Fail on unsupported constructs.
--library <dir>	case	Connector library directory. Default: the pulled registry.
--best-effort	case	Emit a marked repair scaffold for unsupported constructs.
--style <style>	bpmn	explicit (default) or nested. nested lifts boundary events, gateways, and event subprocesses into nesting constructs where the resulting graph is the same.
--no-pipeline	flow, case	Do not write the pipeline helper (<name>.pipeline.mjs) next to the source.

Exemples

uip maestro flow decompile Order.flow --output Order.flow.ts
uip maestro case decompile caseplan.json --output Claims.case.ts
uip maestro bpmn decompile Approval/Approval.bpmn --output Approval.bpmn.ts --style nested

Format des données (--sortie json)

{
  "Code": "FlowDecompile",
  "Data": {
    "Path": "/work/Order.flow.ts",
    "Pipeline": "/work/Order.pipeline.mjs"
  }
}

case decompile also returns Diagnostics. bpmn decompile returns { Path }.

merge

Merge an edited artifact into its original artifact.

Arguments

• <edited> (required) — the edited artifact.

Options

Option	Families	Description
--original <file>	Tout	Original artifact to merge into. Required.
-o, --output <file>	Tout	Merged output path.
--baseline <file>	flow, bpmn	The compiled output of the unedited decompiled source.

Exemples

uip maestro flow merge Edited.flow --original Original.flow --output Merged.flow --baseline Baseline.flow
uip maestro case merge edited.caseplan.json --original original.caseplan.json --output merged.caseplan.json

# BPMN: elements you did not edit are kept byte for byte
uip maestro bpmn merge Edited.bpmn --original Original.bpmn --output Merged.bpmn --baseline Baseline.bpmn

Format des données (--sortie json)

{
  "Code": "BpmnMerge",
  "Data": {
    "Path": "/work/Merged.bpmn",
    "Preserved": 5,
    "Authored": 1,
    "Removed": 0
  }
}

flow merge returns { Path, Nodes, Edges }. case merge returns { Path, Stages }.

uip maestro bpmn tidy

Add diagram layout to a compiled .bpmn file. To generate or replace the layout of any .bpmn file without the builder SDK, use uip maestro bpmn format.

Arguments

• <input> (required) — the compiled .bpmn file.

Options

Option	Description
-o, --output <file>	Output .bpmn path.

Exemple

uip maestro bpmn tidy Approval.bpmn --output Approval.tidied.bpmn

Format des données (--sortie json)

{
  "Code": "BpmnTidy",
  "Data": { "Path": "/work/Approval.tidied.bpmn", "Shapes": 4 }
}

Associé

• uip maestro registry — download, locate, search, and prepare the connector library.
• uip maestro flow init — --sdk-source writes the authored source for a new Flow project.
• uip maestro flow, uip maestro case, uip maestro bpmn