Database Tables
While the Dashboard component is capable of storing its configuration using any Ignition-supported storage mechanism, the configuration for this Launchpad Dashboard is stored via the Launchpad database connection. The following six tables are included for this database connection.
While this documentation refers to Dashboard elements as "components," the database table and column names below use the term "widget." These terms are synonymous in this context.
ex_lp_widgets
Stores the component types that are available to add to a dashboard.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the component. Primary key for this table. |
| name | String | Name of the component. |
| path | String | Perspective view path of the component. |
ex_lp_widget_parameter_types
Stores the parameter types that are available to configure for a component.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the parameter type. Primary key for this table. |
| type | String | Name of the parameter type. |
| path | String | Perspective view path of the parameter type. |
ex_lp_widget_parameters
Defines which parameters are available for a given component type.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the parameter. Primary key for this table. |
| widget_id | Int | ID of the component. Corresponds to ex_lp_widgets.id. |
| parameter_name | String | Display name of the parameter. |
| parameter | String | Name of the parameter for the Perspective view (case-sensitive). |
| parameter_type_id | Int | ID of the parameter type. Corresponds to ex_lp_widget_parameter_types.id. |
| default_value | String | Default value of the parameter. |
| configuration | String | Configuration to pass into the parameter view. For example, a list of options for a dropdown can be stored in this column. |
ex_lp_dashboards
Stores dashboards that have been configured.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the dashboard. Primary key for this table. |
| name | String | Name of the dashboard. |
| icon | String | Icon of the dashboard. Icons available with the Icon Component can be used. |
| url | String | URL of the dashboard. |
| username | String | User who created the dashboard. |
| grid | String | Grid layout mode of the dashboard. It can be fixed or stretch. More information about fixed vs stretch can be found here. |
| cell_size | Int | Width and height of a grid cell. Exclusively for fixed mode. |
| grid_rows | Int | The number of rows in the grid. |
| grid_cols | Int | The number of columns in the grid. |
| row_gutter_size | Int | The gap size between grid rows. |
| col_gutter_size | Int | The gap size between grid columns. |
| last_modified | Datetime | When the dashboard was last modified. |
ex_lp_dashboard_widgets
Stores components that have been configured.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the configured component. Primary key for this table. |
| dashboard_id | String | ID of the dashboard that contains the component. Corresponds to ex_lp_dashboards.id. |
| widget_id | Int | ID that represents the type of component configured. Corresponds to ex_lp_widgets.id. |
| name | String | Name of the configured component. |
| position | String | Comma-separated values that defines the position of the component. The format is: rowStart, rowEnd, columnStart, columnEnd. |
ex_lp_dashboard_widget_parameters
Stores parameter values for components that have been configured.
| Column Name | Data Type | Description |
|---|---|---|
| id | Int | ID of the parameter. Primary key for this table. |
| dashboard_widget_id | Int | ID of the configured component. Corresponds to ex_lp_dashboard_widgets.id. |
| parameter_id | Int | ID that represents the parameter definition. Corresponds to ex_lp_widget_parameters.id. |
| parameter_value | String | Value of the parameter. |