Skip to main content

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.

Terminology Note

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 NameData TypeDescription
idIntID of the component. Primary key for this table.
nameStringName of the component.
pathStringPerspective view path of the component.

ex_lp_widget_parameter_types

Stores the parameter types that are available to configure for a component.

Column NameData TypeDescription
idIntID of the parameter type. Primary key for this table.
typeStringName of the parameter type.
pathStringPerspective view path of the parameter type.

ex_lp_widget_parameters

Defines which parameters are available for a given component type.

Column NameData TypeDescription
idIntID of the parameter. Primary key for this table.
widget_idIntID of the component. Corresponds to ex_lp_widgets.id.
parameter_nameStringDisplay name of the parameter.
parameterStringName of the parameter for the Perspective view (case-sensitive).
parameter_type_idIntID of the parameter type. Corresponds to ex_lp_widget_parameter_types.id.
default_valueStringDefault value of the parameter.
configurationStringConfiguration 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 NameData TypeDescription
idIntID of the dashboard. Primary key for this table.
nameStringName of the dashboard.
iconStringIcon of the dashboard. Icons available with the Icon Component can be used.
urlStringURL of the dashboard.
usernameStringUser who created the dashboard.
gridStringGrid layout mode of the dashboard. It can be fixed or stretch. More information about fixed vs stretch can be found here.
cell_sizeIntWidth and height of a grid cell. Exclusively for fixed mode.
grid_rowsIntThe number of rows in the grid.
grid_colsIntThe number of columns in the grid.
row_gutter_sizeIntThe gap size between grid rows.
col_gutter_sizeIntThe gap size between grid columns.
last_modifiedDatetimeWhen the dashboard was last modified.

ex_lp_dashboard_widgets

Stores components that have been configured.

Column NameData TypeDescription
idIntID of the configured component. Primary key for this table.
dashboard_idStringID of the dashboard that contains the component. Corresponds to ex_lp_dashboards.id.
widget_idIntID that represents the type of component configured. Corresponds to ex_lp_widgets.id.
nameStringName of the configured component.
positionStringComma-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 NameData TypeDescription
idIntID of the parameter. Primary key for this table.
dashboard_widget_idIntID of the configured component. Corresponds to ex_lp_dashboard_widgets.id.
parameter_idIntID that represents the parameter definition. Corresponds to ex_lp_widget_parameters.id.
parameter_valueStringValue of the parameter.