View Your Database Data Dictionary

You can use the data dictionary to view information about the tables and fields in your site’s database.

The information returned in reports and dashboards is stored in your site’s database, allowing you to see vital information about your customers, staff members, and interfaces. Using the data dictionary, you can view details about all the tables and fields in the database, such as field names, descriptions, and database types. You can add the Data Dictionary component to any navigation list. See Change Your Navigation Pane Settings.
Note: Not all the information in the database is accessible to Analytics.
  1. Click Configuration on the navigation pane.
  2. Expand Database, and then double-click Data Dictionary.
    The content pane displays a list of all the tables in the database.
  3. Click a table to view the table information.
    The details that display depend on the table you have selected.

    Table Information

    Field Description
    Table Label Lists the descriptive table name used in the data dictionary.
    Table Description Displays a description of the table.
    Tbl Displays the table ID number.
    Visibility Indicates the products and components that use the table, such as Service and Chat.
    Custom Fields Indicates whether custom fields are allowed in the table.
    Primary Key Lists the primary key columns. Click a column to view the column information.
    Columns Lists the columns contained in the table. Click a column to view the column information.
    Indexes Lists the indexed columns in the table. Click an indexed column to view the column information.
  4. To view column details, click a column in the Table Information section. The details that display depend on the column you select.

    Column Information

    Field Description
    Column Label Displays the descriptive column label used by the data dictionary.
    Column Suffixes Indicates the suffixes that can be used with this column in analytics, such as .id or .name.
    Column Description Displays a description of the column.
    Column Type Displays the type of column, such as menu field or major join field.
    Data Type Lists the column data type, such as integer or varchar.
    Length Lists the number of characters allowed in the field.
    Column Attributes Lists the column attributes, such as not nullable or unique.
    Analytics Usage

    Indicates how the column can be used in analytics.

    • All—Can be used anywhere in the report.
    • Display—Can be used in a display column.
    • Exception—Can be used in an exception.
    • Filter—Can be used in a regular (node) filter.
    • Group—Can be used to group.
    • Group Filter—Can be used in a group filter.
    • Join Filter—Can be used in a join filter.
    • No Search—Can be used in a display column, exception, or group filter, and can be used to group or sort.
    • Search—Can be used in a regular, group, or join filter, and exception.
    • Sort—Can be used to sort.
    Joins Lists the columns that the selected column is joined to.