List View Guide

The List View module in Ojoo Business OS is a metadata-driven dynamic data grid component that renders database records according to List View Configurations. It provides comprehensive control over visible grid columns, foreign table joins, action buttons, search filtering, sorting, pagination, and reporting utility exports.

Overview

List Views provide a structured, interactive presentation layer for all business features across Ojoo Business OS. Key operational capabilities include:

  • Dynamic data grid rendering driven by centralized database metadata
  • Automatic foreign table joins to display human-readable reference names
  • Instant global text search across administrator-configured filter columns
  • Click-to-sort column header ordering (Ascending / Descending)
  • Flexible pagination with configurable records per page (10, 25, 50, 100 rows)
  • Utility export controls (Excel, CSV, PDF, Clipboard Copy, Print)
  • Column visibility customization and layout resets
  • Row-level action buttons (View, Edit, Delete, Restore, Configure, Custom Actions)
  • Role-based access permissions verification for security

List View Functional Flow

1. List View Feature 2. List View Configuration 3. Configure Action 4. Query / Actions / Filters / Analytics / Layout 5. Rendered List View Grid

Displayed Grid Columns

The List View grid presents records using structured table columns configured in the List View Configuration builder:

Grid Column Header Description & Operational Meaning
Actions Row-level action column containing operational icons (View, Edit, Delete, Restore, Configure, Custom Actions).
List View ID Unique primary key identifier for the configuration record (nm_list_view_id).
Feature Name Human-readable display name of the associated feature.
Feature Slug URL-friendly unique string identifier used for routing and permissions checks.
Base Table Primary database table backing the feature list view.
Config Name / Status Configuration profile name or active status indicator badge.

Row-Level Action Buttons

Depending on administrator configuration and user role rights, table rows display the following action buttons:

Action Button Description & Functional Behavior
View Opens detailed read-only modal or page for the selected record.
Edit Opens form view to update existing record details.
Delete Prompts user confirmation and soft-deletes the record.
Restore Restores a soft-deleted record back to active state.
Configure Opens the List View Configuration builder (studio-engine/list-view-configure/{featureSlug}) for system administrators.

Top Toolbar Options

+ Create

Opens blank form view to add a new record to the list view grid.

APIs

Opens feature API reference and endpoint documentation.

Help Guide

Opens interactive YouTube tutorial video modal for training.

Export & Utility Options

The grid utility bar provides high-performance data export and layout controls:

  • Copy Records: Copies selected or all displayed rows directly to clipboard.
  • Export to Excel: Generates formatted .xlsx spreadsheet export.
  • Export to CSV: Downloads raw comma-separated value file for data analysis.
  • Export to PDF: Compiles print-ready PDF document of grid records.
  • Print Table: Launches native browser print dialog for current table view.
  • Column Visibility: Displays dynamic dropdown allowing users to show/hide table columns.
  • Restore Default Columns: Resets table layout to administrator default column arrangement.

Search & Pagination Controls

  • Instant Global Search: Typing text into top search bar filters rows in real time across columns selected under Additional Filters.
  • Records Per Page Selection: Choose 10, 25, 50, or 100 entries displayed per page.
  • Pagination Controls: Navigate cleanly between pages using Previous, Page Numbers, and Next buttons.

Role-Based Access Permissions

Access to List Views and action buttons is strictly controlled by Ojoo Business OS permission service (service('permission')->has($featureSlug)). Users without authorized permissions receive an Access Denied message or are redirected to /no-access.

Best Practices

  • Keep visible grid columns concise (4 to 7 key fields) for optimal readability.
  • Always enable instant search filter columns for fast record retrieval.
  • Use export options to generate executive reports and data backups.
  • Regularly test row action links to ensure smooth workflow transitions.