Configurable Screens, Lists & Templates — business view

Technical trace: Configurable Lists, Grids, Templates & Custom Fields

1. Business Summary

Most operational screens are not hard-coded layouts — they are templates (lists, columns, filters, search fields, joins, custom fields, exports) that can be assigned globally, by role, or per user.

2. Business Value

Lets the business adapt screens to evolving processes, brand-specific needs, and role-specific information without engineering changes — a major time-saver for operational teams.

3. Users / Stakeholders

Power users, department leads, administrators.

4. Workflows

  • An administrator defines a list template (filters, columns, joins, search fields) and assigns it to roles or users.
  • Custom fields can be added per entity.
  • Users star records as favourites for quick access.
  • Reports can be scheduled for periodic email delivery.

5. Sub-Features

  • Reusable list templates (with searcher overrides).
  • Per-template join and filter definitions.
  • Per-entity custom fields.
  • Favourites.
  • Scheduled report definitions and history log.

6. Business Rules

  • Templates can be global, role-based, or user-specific.
  • Export rights are controlled by template/role.

7. Data Entities

List Templates, List Template Fields/Filters/Joins/Searchers, Template Views and View Maps, Custom Fields, Favourites, Scheduled Report logs.

8. Entry Points

  • Admin configuration screens for templates and custom fields.
  • Operational list pages that consume the templates.

9. Inputs & Outputs

  • Inputs: template definitions, search parameters.
  • Outputs: filtered grids, exports (Excel/CSV), scheduled emails.

10. Integrations

  • Email; Excel export plugin.

11. Calculations / Logic

  • Dynamic SQL composition based on the template definition.

12. Status Lifecycle

  • N/A (configuration data).

13. Permissions

  • Administrators maintain templates; templates filter what users see.

14. Reports & KPIs

  • Scheduled report success/failure logs.

15. Risks & Observations

  • A corrupt or missing template can break many screens at once.
  • Heavy reliance on metadata configuration means operational risk if it is not under change control.
  • Several .orig and .orig.orig backup files exist alongside live controllers, which suggests in-flight experiments without cleanup.

16. Source Code Evidence

  • app/Model/ListTemplate*.php, TemplateView.php, ViewMap.php.
  • app/Plugin/admin/Controller/CustomFieldsController.php, CustomFieldsEntitiesController.php.
  • app/Controller/ScheduleReportsController.php.

← Deep dives index