Query Builder List Guide

The Query Builder module allows administrators to create, manage, and maintain reusable SQL query definitions throughout Ojoo Business OS. Query Builders are used for List Views, Dashboards, Reports, APIs, Workflows, Analytics, and Dynamic Components.

Overview

The Query Builder List view provides a centralized management console for all query definitions in Ojoo Business OS. Key functional capabilities include:

  • Viewing all registered query builder records and custom SQL statements
  • Searching and filtering query definitions by Name or Slug
  • Accessing the Query Builder Form to create new query definitions
  • Editing existing query rules, joins, conditions, or custom SQL
  • Viewing read-only query summary and generated JSON data
  • Deleting unneeded query definitions safely
  • Exporting query definition lists to Excel, CSV, PDF, Print, or Clipboard

Query Builder Navigation Flow

1. Workflow Dashboard (Page ID 3) 2. Query Builder Card Click 3. Query Builder List (Page ID 48) 4. Query Builder Form (Page ID 49)

Displayed Columns & Fields

Column Name Description & Operational Meaning
Actions Row action buttons (View, Edit, Delete).
Query Builder Name Human-readable name of the query definition (e.g. User Details, Sales Invoices).
Query Builder Slug Unique system slug used for query execution calls (e.g. user-details).
Query Type Badge indicating query operation: SELECT, INSERT, or UPDATE.
Store Variable Name of PHP variable storing query result set (e.g. $userDetails).
Mode Indicator Badge indicating whether query uses Normal Builder or Custom Query Mode.
Created Date Timestamp when query was created or last updated.

Available Actions & Buttons

Button / Action Description & Functional Behavior
+ Create Query Builder Opens blank Query Builder Form (Page ID 49) to create a new query definition.
View Opens read-only modal displaying query configuration and compiled JSON.
Edit Opens Query Builder Form loaded with existing query rules for editing.
Delete Prompts user confirmation and soft-deletes query definition.

Export & Utility Controls

  • Copy Data: Copies query list rows to clipboard.
  • Export to Excel: Generates formatted .xlsx spreadsheet export file.
  • Export to CSV: Downloads comma-separated value file for analysis.
  • Export to PDF: Compiles print-ready PDF list document.
  • Print Table: Launches native browser print dialog for current list view.
  • Column Visibility: Dropdown allowing users to show or hide table columns.
  • Restore Defaults: Resets table layout to administrator default column view.

Search & Pagination Controls

  • Instant Global Search: Filters query rows in real time by Name or Slug as text is typed.
  • Column Header Sorting: Click any column header to sort rows ascending or descending.
  • Entries Per Page Selection: Choose 10, 25, 50, or 100 entries per page.
  • Pagination Navigation: Navigate pages using Previous, Page Numbers, and Next buttons.

Best Practices

  • Use clear, unique query slugs following lowercase hyphenated naming (e.g. dms-sales-report).
  • Regularly inspect and delete outdated or unused query definitions.
  • Use search filters to locate specific queries quickly.