Syntax and options for `uip insights dashboards`, which reads, creates, updates, deletes, and copies the standalone Insights dashboards of Maestro processes.

uip insights dashboards manages the standalone Insights monitoring dashboards of Maestro processes. Each Maestro process has one process dashboard slot and one case-management dashboard slot. A slot either holds a saved dashboard, with a numeric ID, or serves a built-in template, with a template-keyed UiPath- ID.

Address a dashboard in one of two ways:

The ID argument and --process-key are mutually exclusive.

These commands honor the global options and the standard exit codes. For a dashboard's global filters, refer to uip insights dashboard-filters.

create and update read a dashboard definition from --file. get --output-file and copy --output-file write one. A definition file holds the dashboard definition object with the backend's camelCase keys and no CLI envelope. Its layout.type must be custom, and its chart types must be among line, multi_line, bar, table, distribution, pie, kpi, and placeholder. The file that get --output-file writes is a valid starting point.

Get one dashboard: by process key, the process's monitoring dashboard, saved or template; or by dashboard ID. Standard output carries a summary of the definition. Pass --output-file to write the full definition to a file.

The command returns Code: "InsightsDashboardGet" and a summary with these fields:

Create a Maestro process's monitoring dashboard from a definition file. The slot must be free.

The command returns Code: "InsightsDashboardCreate" and these fields: DashboardId (the ID get accepts), ProcessKey, SlotId, Name, Version, MetricCount, ChartCount, FilterValuesDefaulted, CreateState, VerificationState, and SlotState. The command reads the dashboard back after the create, and VerificationState is ReadBackSucceeded on success.

Replace a saved dashboard's whole definition from a file. Members that the file omits are deleted.

--expected-version is a client-side staleness check: the CLI stops the update when the stored dashboard's version differs from the one you pass. The backend accepts no version precondition, so the check is best-effort. The backend keeps no history; pass --backup-file to keep a copy of the definition as it was before the update.

The command returns Code: "InsightsDashboardUpdate" and these fields: DashboardId, ProcessKey and SlotId (when addressed by process key), Name, SourceType, PreviousVersion, Version, VersionSource, MetricCount, ChartCount, GlobalFilterCount, FilterValuesDefaulted, UpdateState, VerificationState, and BackupFile (when --backup-file is passed).

Delete a saved dashboard and every alert definition the backend has linked to it. The backend keeps no copy. Pass --backup-file to keep the definition; dashboards create --file can recreate it as a new dashboard.

The command returns Code: "InsightsDashboardDelete" and these fields: DashboardId, ProcessKey and SlotId (when addressed by process key), Name, SourceType, DeleteState, VerificationState, SlotState (when available), LinkedAlertsDeleted (the number of linked alert definitions deleted), LinkedAlerts, and BackupFile (when --backup-file is passed).

Give one Maestro process the dashboard another process has: the source's saved dashboard, or the template its free slot serves. The destination slot must be free. --case applies to both processes. The two process keys must differ.

The command returns Code: "InsightsDashboardCopy" and these fields: DashboardId (the new dashboard), FromProcessKey, ToProcessKey, SlotId, SourceState, SourceDashboardId, NameDerived, SourceOnlyFieldIds, Name, Version, MetricCount, ChartCount, FilterValuesDefaulted, CopyState, VerificationState, SlotState, and OutputFile (when --output-file is passed).