UiPath CLI - uip maestro bpmn job

uipath-cli

latest

false

UiPath CLI user guide

uip maestro bpmn job

Syntax and options for `uip maestro bpmn job`, which streams execution traces and fetches detailed status for individual Maestro BPMN jobs.

uip maestro bpmn job inspects an individual Maestro job — one execution attempt of a process instance — by streaming its traces or fetching its detailed status. It's registered under the bpmn branch.

All subcommands require uip login and honor global options. Exit codes follow the standard contract.

Synopsis

uip maestro bpmn job traces <job-key>
                       [-f, --folder-key <key>] [--poll-interval <ms>]
                       [--traces-service <name>] [--pretty]
                       [--login-validity <minutes>]

uip maestro bpmn job status <job-key>
                       --folder-key <key> [--detailed]
                       [--login-validity <minutes>]
uip maestro bpmn job traces <job-key>
                       [-f, --folder-key <key>] [--poll-interval <ms>]
                       [--traces-service <name>] [--pretty]
                       [--login-validity <minutes>]

uip maestro bpmn job status <job-key>
                       --folder-key <key> [--detailed]
                       [--login-validity <minutes>]

uip maestro bpmn job traces

Stream execution trace events for a running or recently completed job.

Arguments

<job-key> (required) — job key (GUID from process run).

Options

Option	Default	Description
`-f, --folder-key <key>`	—	Folder key (GUID). Optional — used only to scope the trace request.
`--poll-interval <ms>`	`2000`	Polling interval. Must be a positive number.
`--traces-service <name>`	`llmopstenant_`	Traces service name.
`--pretty`	off	Pretty-print trace events. Without it, each event is emitted as a single JSON line.
`--login-validity <minutes>`	`10`	Token-refresh threshold.

Behavior

Writes a heading line: Streaming traces for job: <key> Polling every Ns...
Streams each trace event via ScreenLogger.progress (stderr).
On completion, emits Job <key> completed with state <finalState> (<durationMs>ms).
Exit code: 0 if result.success, 1 otherwise.

Examples

# Raw JSON lines
uip maestro bpmn job traces b2c3d4e5-… | jq -c 'select(.level=="error")'

# Human-readable
uip maestro bpmn job traces b2c3d4e5-… --pretty

# Slower polling
uip maestro bpmn job traces b2c3d4e5-… --poll-interval 5000

# Scope the trace request to a folder
uip maestro bpmn job traces b2c3d4e5-… --folder-key <folder-key>
# Raw JSON lines
uip maestro bpmn job traces b2c3d4e5-… | jq -c 'select(.level=="error")'

# Human-readable
uip maestro bpmn job traces b2c3d4e5-… --pretty

# Slower polling
uip maestro bpmn job traces b2c3d4e5-… --poll-interval 5000

# Scope the trace request to a folder
uip maestro bpmn job traces b2c3d4e5-… --folder-key <folder-key>

Output: traces are streamed directly — no final Data payload.

uip maestro bpmn job status

Get the status of a Maestro job. Returns a curated 14-field summary by default; --detailed returns the full Orchestrator response.

Arguments

<job-key> (required) — job key (GUID).

Options

Option	Required	Default	Description
`--folder-key <key>`	yes	—	Folder key (GUID, from `process list`). No default — every call must pass it explicitly.
`--detailed`	no	off	Return the full response instead of the 14-field summary.
`--login-validity <minutes>`	no	`10`	Token-refresh threshold.

Data shape (default summary)

{
  "Code": "MaestroJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "ProcessOrchestration",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceOrchestration",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}
{
  "Code": "MaestroJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "ProcessOrchestration",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceOrchestration",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}

With --detailed, Data is the full Orchestrator job object.

Examples

# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
           --release-key <release-key> --inputs '{}' --output-filter "jobKey" --output plain)
uip maestro bpmn job traces "$JOB_KEY" --pretty

# Summary once done
uip maestro bpmn job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip maestro bpmn job status "$JOB_KEY" --folder-key "<folder-key>" --detailed
# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
           --release-key <release-key> --inputs '{}' --output-filter "jobKey" --output plain)
uip maestro bpmn job traces "$JOB_KEY" --pretty

# Summary once done
uip maestro bpmn job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip maestro bpmn job status "$JOB_KEY" --folder-key "<folder-key>" --detailed

Was this page helpful?

PREVIOUSincidents

NEXTregistry

Synopsis​

uip maestro bpmn job traces​

Arguments​

Options​

Behavior​

Examples​

uip maestro bpmn job status​

Arguments​

Options​

Data shape (default summary)​

Examples​

See also​

Was this page helpful?

Synopsis

uip maestro bpmn job traces

Arguments

Options

Behavior

Examples

uip maestro bpmn job status

Arguments

Options

Data shape (default summary)

Examples

See also