Dashboard Data Model
This page defines the data structures for dashboards, rows, columns, and schema in the Ema platform.
DashboardRow
A single row in a dashboard.
| Field | Type | Description |
|---|---|---|
row_id | string | Unique identifier (UUID) for the row |
dashboard_id | string | UUID of the parent dashboard |
state | DashboardRowState | Current processing state |
column_values | map<string, ColumnValue> | Map of column name to value |
workflow_run_id | string | UUID of the associated workflow run |
created_at | string | ISO 8601 creation timestamp |
updated_at | string | ISO 8601 last update timestamp |
created_by | string | User ID who created the row |
error_message | string | Error details if state is FAILED |
DashboardRowState Enum
| Value | Integer | Description |
|---|---|---|
UNSPECIFIED | 0 | Default/unspecified |
INITIAL | 1 | Row is in initial state |
QUEUED | 2 | Row is queued for processing |
RUNNING | 3 | Workflow is currently executing |
SUCCESS | 4 | Workflow finished successfully |
FAILED | 5 | Workflow encountered an error |
REVIEWING | 6 | Row is under review (e.g., HITL) |
Complete list of DashboardRowState values and integer mappings.
ColumnValue
The value of a single cell in a dashboard row.
| Field | Type | Description |
|---|---|---|
string_value | string | String representation of the value |
value | Value | Typed value (uses the workflow Value type) |
column_type | ColumnType | The column's data type |
ColumnDetails
Metadata for a single column in the dashboard schema.
| Field | Type | Description |
|---|---|---|
name | string | Internal column identifier |
display_name | string | User-friendly column name |
column_type | ColumnType | Data type of the column |
is_input | bool | Whether this is an input column |
is_output | bool | Whether this is an output column |
description | string | Description of the column |
type_reference | TypeReference | Full type reference |
action_name | string | Action that produces this output column |
output_name | string | Output parameter name for output columns |
ColumnType Enum
| Value | Integer | Description |
|---|---|---|
UNSPECIFIED | 0 | Default/unspecified |
STRING | 1 | Text string |
NUMBER | 2 | Numeric value (double) |
BOOLEAN | 3 | True/false |
DATE | 4 | Date value |
TIME | 5 | Time value |
DOCUMENT | 6 | Document reference |
VALIDATION_REPORT | 7 | Validation report |
ARRAY | 8 | Array of values |
OBJECT | 9 | Object/map |
INTEGER | 10 | Integer value (int64) |
ENUM | 11 | GWE enum type defined in workflow_def |
DOCUMENT_VERSION_ID | 12 | Document version identifier |
Complete list of ColumnType values from the proto definition.
DashboardSchema
The schema defining the structure of a dashboard.
| Field | Type | Description |
|---|---|---|
columns | repeated ColumnDetails | List of column definitions |
The schema is derived from the workflow's input/output definitions. Input columns correspond to workflow inputs, and output columns correspond to workflow outputs (or named results).
DashboardRowResult
Result data for a processed row, used by the HTTP API.
| Field | Type | Description |
|---|---|---|
row_id | string | UUID of the row |
state | DashboardRowState | Processing state |
column_values | map<string, ColumnValue> | Output values |
error_message | string | Error message if failed |
SubDashboard
A filtered view of the main dashboard.
| Field | Type | Description |
|---|---|---|
sub_dashboard_id | string | UUID of the sub-dashboard |
dashboard_id | string | UUID of the parent dashboard |
name | string | Display name |
filter | object | Filter criteria |
Related
- Dashboard Overview -- Concepts and architecture
- Dashboard HTTP API -- REST endpoints
- Dashboard RPC Calls -- gRPC-Web endpoints