UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip maestro bpmn validate

Syntax and options for `uip maestro bpmn validate`, which structurally validates a single .bpmn or Studio Web XML export file.

uip maestro bpmn validate validates a single .bpmn file (or a Studio Web BPMN XML export) for structural correctness — well-formed BPMN plus UiPath extensions — without touching any project metadata files. It's registered under the bpmn branch.

Synopsis​

uip maestro bpmn validate <file>
uip maestro bpmn validate <file>

Honors global options. Exit codes follow the standard contract.

Arguments​

  • <file> (required) — path to the .bpmn or .xml file to validate. This is a single file, not a project directory.

Examples​

uip maestro bpmn validate process.bpmn
uip maestro bpmn validate export.xml
uip maestro bpmn validate process.bpmn
uip maestro bpmn validate export.xml

Data shape (--output json)​

{
  "Code": "BpmnValidate",
  "Data": {
    "File": "process.bpmn",
    "Status": "Valid",
    "ProcessCount": 1,
    "StartEventCount": 1,
    "UiPathExtensionCount": 4
  }
}
{
  "Code": "BpmnValidate",
  "Data": {
    "File": "process.bpmn",
    "Status": "Valid",
    "ProcessCount": 1,
    "StartEventCount": 1,
    "UiPathExtensionCount": 4
  }
}

When the file is valid but has warnings, Data also carries Warnings: the warning count followed by one line per warning.

When validation fails, the command exits with code 1 and returns Result: "Failure" with Message: "Validation failed for <file>". Instructions holds the error count followed by one line per issue, with the element path, the rule code, the message, and the fix when one is known.

Checks​

The command checks the BPMN XML, the UiPath extensions, and the rules the Maestro canvas applies. These checks include:

Rule codeSeverityFires when
MISSING_DI_SHAPEerrorA flow node has no bpmndi:BPMNShape in the diagram. Run uip maestro bpmn format to regenerate the layout.
MISSING_DI_EDGEerrorA sequence flow has no bpmndi:BPMNEdge in the diagram. Run uip maestro bpmn format to regenerate the layout.
MISSING_BINDINGerror or warningA binding doesn't match a resource in the tenant: a connection, a release, or an action app. The fix line explains how to find the matching resource.
PLATFORM_BINDINGS_UNVERIFIEDwarningThe binding checks against the tenant couldn't complete, so the affected bindings weren't verified. Check uip login status, the selected tenant, and the network connection, then run validate again.

An unsupported UiPath extension type is reported as a warning. uip maestro bpmn pack treats it as an error.

See also​

  • Synopsis​
  • Arguments​
  • Examples​
  • Data shape (--output json)​
  • Checks​
  • See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated