List View Configuration Guide

The List View Configuration module is an administration builder screen—NOT a normal record creation form. When a Feature is created with Engine = List View, its configuration entry is generated automatically. Administrators click "Configure" to open this builder and customize the 9 operational layout sections.

Overview

List View Configuration controls how records are fetched and displayed to end users. Key administrative responsibilities include:

  • Inspecting pre-populated feature engine details and base table references
  • Selecting Query Builder records to govern database query execution
  • Setting live web navigation links for target list view pages
  • Enabling standard grid action toggles (+ Create, View, Edit, Delete, Restore)
  • Defining interactive custom action buttons with icons and link targets
  • Selecting search filter columns enabled for global text searching
  • Configuring dashboard analytics widgets (Charts, Tables, Number Cards)
  • Designing custom page layout content (Top, Left, Right, Bottom HTML banners & Help Video URLs)
  • Configuring dynamic breadcrumb navigation link titles and routing

Automatic Availability Lifecycle

List View Configuration entries are generated automatically as part of Feature creation:

1. Feature Creation (Engine = List View) 2. Automatic Record in nm_app_features_list_view 3. Appears in List View Config List 4. Click "Configure" Link

1. LIST VIEW ENGINE DETAILS

Pre-populated, read-only operational metadata displaying details fetched from the parent feature definition:

FieldDescription
Application NameParent application grouping associated with the feature.
Module NameParent module grouping associated with the feature.
Feature NameDisplay title of the target feature being configured.
Feature SlugUnique URL identifier segment used for routing and access control.
Base TablePrimary database table backing the feature.

2. SELECT QUERY BUILDER

Selects a Query Builder record (from query-builder) governing dataset loading. Capabilities include:

  • Selecting predefined query builder rules
  • Configuring SELECT column lists and display aliases
  • Managing relational table JOINs (LEFT, RIGHT, INNER)
  • Defining default WHERE filtering conditions
  • Setting default table column sorting order

3. LIST VIEW LINK

Defines the live navigation link route (e.g. feature/{featureSlug}) that opens or redirects to the rendered List View grid page.

4. LIST VIEW ACTIONS

Checkbox toggles allowing administrators to enable or disable standard grid buttons:

Action Button ToggleFunctional Behavior when Enabled
CreateRenders "+ Create" button at top right of the grid toolbar.
ViewRenders Eye icon on each row for read-only record view.
EditRenders Pencil icon on each row for editing records.
DeleteRenders Trash icon on each row for deleting records.
RestoreRenders Restore icon for soft-deleted records.

5. CUSTOM ACTIONS

Interactive builder for defining custom row action buttons (e.g. Configuration, Workflows, Export):

  • Custom Action Title: Display text or tooltip title for the button.
  • Assign Icon: FontAwesome icon class (e.g. fa-solid fa-gear).
  • Target URL Route: Target web route or modal trigger template.
  • Action Type: Button style and target execution context.

6. ADDITIONAL FILTERS

Dynamic column selector generated based on the selected Query Builder query. Administrators select which columns are enabled for global instant search text filtering across data rows.

7. ANALYTICS DATA

Configure visual analytics components rendered above or inside the list view header:

  • Charts: Configure Bar, Line, or Pie charts specifying Chart Type, Row Label column, Value Field, and Aggregation function (COUNT, SUM, AVG).
  • Summary Tables: Configure embedded summary data tables.
  • Number Cards: Configure KPI summary metric cards displaying total counts or aggregated metrics.

8. LAYOUT CONFIGURATION

Layout content blocks allowing administrators to customize page appearance:

  • YouTube Help Link: YouTube video URL enabling the help video tour popup modal.
  • Top Content: Custom HTML content block rendered directly above data grid.
  • Left / Right Content: Custom HTML blocks rendered on side layout containers.
  • Bottom Content: Custom HTML footer text or quick link cards rendered below data grid.

9. BREADCRUMBS

Dynamic breadcrumb navigation builder allowing administrators to define page breadcrumb link titles, target URLs, and display hierarchy order.

Best Practices

  • Select appropriate Query Builder records to optimize SQL query execution.
  • Always select search target columns under Additional Filters so users can search effectively.
  • Use table joins to display human-readable reference names instead of raw numeric IDs.
  • Keep custom row actions focused and relevant to business workflows.
  • Test layout content banners on mobile and desktop screens for responsive layout.