WEBcnx 2024.1 is out now bringing with it a host of new features and performance enhancements. Read more.

Open navigation

Database Lists

When viewing a Dashboard, you might see lists of customers, projects, or drawing layers. The information shown in these lists is organised into columns, which are set up by an administrator. These customised lists are referred to as Database Lists.


Depending on how you prefer to view the data, you can choose between different display options. For example, you might view the information in a detailed table format or in a thumbnail layout. Since different views can show varying amounts of information, each Database List has multiple configurations designed to match the available views.


Where to Configure Database Lists

Database Lists are configured and managed in the administration settings under Maintenance > Database Administration. Select a supported table and click the Lists page in the main window.


Database List Views

Database Lists can be displayed in several view types, each designed to present data in a format suitable for different needs. Users can only select views that have been set up with a corresponding Database List. 

  • Detail View: Displays data in a table format, with each item represented by a row and specific fields shown as columns. This view is ideal for quickly comparing detailed information across multiple items. This is the ideal view for filtering the data to help find the information you're looking for.
  • Content View: Provides a thumbnail layout that shows six fields of information across two columns. This view is useful for distinguishing similar items by their associated details at a glance.
  • Card View: A compact thumbnail layout displaying only three fields of information. This view works well when the thumbnail itself helps identify the item.
  • Tile View: A larger thumbnail layout showing just two fields of information. It is especially useful for lists where minimal details, such as a name and description, are sufficient - for example, when displaying standards.


Database Tables Supporting Database Lists

The following database tables support Database Lists for display throughout WEBcnx:

TableView TypesContextsWhere Displayed
ADDRESSDetail, Content, Card-Customer, Customer Group, User and Site dialogs
CUSTOMERDetail, Content, Card-Dashboard Widget (Customer List), Customer Group and Site dialogs
DRAWINGSDetail, Content, Card, TileProjects, StandardsTask Design Selector, Dashboard Widget (Design Saved Search List and Standards List), Design Search (Drawings Display), Launch > Browse Standards
LAYERSDetail, Content, Card, TileLayers, Project LayersTask Design Selector, Dashboard Widget (Design Saved Search List), Design Search (Layers Display)
Layer Types (ONE_UP, MULTI_UP, THREE_D, custom)Detail, Content, Card, Tile

Layers, Project LayersDashboard Widget (Design Saved Search List), Design Search (Layer Type Display)
SITESDetail, Card-Dashboard Widget (Site List)
All Custom TablesDetail-Data Management, and Customer*, Customer Group* and Address* dialogs


* Viewable via a Linked Table List type of Custom Page.


Understanding Database List Contexts

Each Database List is designed for a specific context, allowing administrators to tailor the displayed information to match the needs of that context. Different contexts require separate Database Lists, each customised to show only the most relevant fields for its purpose. For example:

  • Projects vs. Standards: A Database List for viewing projects may include fields like the customer's name, since each project is associated with a customer. However, a separate Database List for viewing standards would not include a customer field, as standards themselves are not tied to a customer.
  • Layers and Layer Types: When viewing a list of layers within a single project, fields like the project number may not be necessary since all layers share the same project number. Conversely, when viewing layers across multiple projects, it is useful to display the project number to help differentiate between layers.


By creating separate Database Lists for each context, administrators ensure that users see only the information they need, improving both clarity and usability.


Managing Database Lists

When you click on the 'Lists' page for a selected table in Database Administration, you will see a list of all the Database Lists (DBLs) configured for that table.


You can organise this list by sorting it using any of the column headings. If there are many Database Lists configured for a table, you can also use the search and filter options to quickly find the list you're looking for. These tools make it easy to manage and navigate large sets of information.


Note: Check that the list isn't already filtering out some content as this may stop you finding the Database List you're looking for.


The Action Bar contains the following tools:

  • Add: Creates a completely new DBL from scratch.
  • Copy: Creates a new DBL using a copy of the selected item.
  • Edit: Allows you to view and update the configuration of a DBL.
  • Delete: Permanently removes all of the selected DBL's. Please note that you can only remove unused DBL's.


Configuring a Database List

When creating a Database List, you will need to define in the following options:

  • Name: A unique name for the DBL. End users do not see this. The name can be translated using the button on the entry field.
  • Table: This is read-only and shows the table that was selected, that the DBL belongs to.
  • Context: Visible only for those tables that support a context (see above).
  • Description: Optional field to display a more detailed description for the setting. Useful for particularly complex installations. The description can be translated.
  • View Type: Selects the view for this DBL. See above table for supported views. This option will limit the number of selected fields.
  • Default: If this DBL is to be seen by all users, unless otherwise overridden. See 'References' below.
Note: Only one Database List of the same Context and View Type combination can be set as Default.


Fields

Select all fields that should be displayed in the Database List, noting that the thumbnail type view support up to a fixed number (see above Database List Views).


The order of fields displayed in a Database List can be adjusted by clicking and dragging the fields up or down in the list.

Tip: If your database table contains many fields and you need to select multiple fields from across the list, you can simplify reordering by first selecting the fields you want. Click 'OK' to save your changes, then reopen the Database List editor. The selected fields will now appear at the top of the list, making it easier to arrange them in the desired order.


Field Details and Properties

For reference, the field list displays key details for each column in the table, including:

  • The table's column name and display name.
  • The field's data type, e.g. Character, Distance, Angle, Area.
  • The field's status indicating whether it is Sortable, Searchable, or Filterable.

These options are managed through the field properties in Database Administration, allowing administrators to control how fields behave and appear in Database Lists.


References

A Database List can be set as 'Default,' meaning all users will see this list unless they have a customised override. For non-default Database Lists, administrators need to specify which users and user groups should have access to the list.


To manage user access, select the appropriate Users and User Groups in the configuration screen. Clicking on a user or group that has already been selected will remove them from the list.


Note: You cannot share the Database List with the system 'Everyone' User Group. If all users should see the DBL, select the 'Default' checkbox.



Further Reading

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

You may like to read -