Product Knowledge Base Review

Reviewed on: 2026-07-05

Scope: C:\_GIT\Velox\velox only. This review covers the Product Knowledge Base under velox-kb\VeloxPKB\docs\velox\ and compares it with the current active Velox source code in the velox repository. Other repositories in C:\_GIT\Velox were not reviewed for this task.

Source Basis

The review checked the PKB against:

• Application entry points: Velox.dpr, VeloxService.dpr, VeloxAPIService.dpr.
• Core active source areas: Classes, Classes\Service, Classes\Transports, Forms, Forms\Transports, Scripting\Imports.
• Active UI definitions: .dfm files under active source folders.
• Configuration enums and labels in Classes\Tools\vxTypes.pas.
• Registered persistable classes via RegisterClass(...) and RegisterClasses(...).
• Service and API behavior around system connection loading, setup loading, logging, REST dispatch, and API port binding.

Per AGENTS.md, these folders are ignored as trial, test, backup, or experimental code unless a task explicitly targets them:

• _BACKUP\
• Classes\_NEW\
• Forms\Action\
• Forms\LinkedAction\

The Vendor folder was not treated as product source for this review.

Review Method

• Read every PKB markdown document.
• Compared cross-document terminology and overlapping concepts.
• Checked documented entry points, services, modules, transports, forms, menus, dialogs, configuration fields, and enum values against active source.
• Ran source coverage checks for active DFM-backed UI artifacts, registered classes, and selected configuration enum values.
• Updated PKB files where the source comparison showed outdated, unclear, missing, over-stated, or out-of-scope documentation.

Coverage result after PKB updates:

• PKB markdown documents reviewed: 28 original documents; obsolete duplicate DOMAIN_MODEL_old.md deleted; new PKB_REVIEW.md added; current PKB markdown count remains 28.
• Active DFM-backed artifacts checked: 85; missing document mentions after update: 0.
• Registered classes checked: 70; missing document mentions after update: 0.
• Selected configuration enum values checked: 25; missing document mentions after update: 0.

Changes Made

• Updated KNOWLEDGE_MAP.md to remove outdated statements that the PKB centered mostly on architecture and that topic files were absent.
• Updated DEVELOPER_GUIDE.md, UI_INVENTORY.md, DIALOG_REFERENCE.md, MENU_REFERENCE.md, FEATURE_INVENTORY.md, TODO.md, and TECHNICAL_DEBT.md to reflect the ignored-folder guidance for Forms\Action, Forms\LinkedAction, Classes\_NEW, and _BACKUP.
• Updated DOMAIN_MODEL.md, FLOW_EXECUTION.md, MODULE_LIBRARY.md, and FLOW_CONFIGURATION.md to clarify that TvxActionAPI exists in source but has no confirmed current class registration or main Designer creation path.
• Updated DOMAIN_MODEL.md to distinguish Sub Action, legacy Call Action enum/display text, and linked-flow execution chaining.
• Updated MODULE_LIBRARY.md to include source-visible ReportBuilder support classes TvxppField, TppvxDataPipeline, and registered TppMasterFieldLink support.
• Updated Configuration_Reference\README.md to document TvxDataType values and display labels.
• Deleted obsolete duplicate DOMAIN_MODEL_old.md; DOMAIN_MODEL.md is the authoritative PKB domain model.

Findings By Category

Contradictions Resolved

• KNOWLEDGE_MAP.md described the PKB as centered on ARCHITECTURE.md and lacking topic files. The current PKB is now split across architecture, domain, API, service, database, configuration, UI, menu, dialog, module, logging, security, errors, data formats, and feature references.
• Several inventory and debt documents treated ignored trial/test/backup folders as active or unclear product source. Those references now identify the folders as ignored by repository guidance.
• TvxActionAPI was described too much like an active product action. Source shows the class exists, but no current registration or main flow setup creation path was found.
• Linked-flow documentation mixed three related concepts: Sub Action, legacy Call Action display text, and linked-flow chaining. DOMAIN_MODEL.md now separates these concepts.
• DOMAIN_MODEL_old.md duplicated current domain-model concepts while containing older assumptions. It was deleted so the PKB has a single authoritative domain model.

Missing Features, UI, Modules, And Configuration Resolved

• Added coverage for TvxppField, TppvxDataPipeline, and registered TppMasterFieldLink support in MODULE_LIBRARY.md.
• Added coverage for TvxDataType enum values in the configuration reference.
• Confirmed all active DFM-backed UI artifacts are now mentioned somewhere in the PKB.
• Confirmed all active registered class names discovered by the coverage scan are now mentioned somewhere in the PKB.

Duplicate Concepts Clarified

• Product terminology now consistently favors Flow and Action, with source-level Action classes documented as implementation details.
• API action is now separated into:
  • API endpoint mapping via TvxAPIActionItem.
  • Source-visible TvxActionAPI, an unconfirmed transport-derived action class.
• Sub Action is documented separately from linked-flow chaining.
• Ignored fork/trial folders are no longer treated as active duplicate product implementations.
• The obsolete duplicate domain model was removed; DOMAIN_MODEL.md is the single authoritative domain model.

Inconsistent Terminology Addressed

• Linked Flow, Linked Action, Sub Action, and Call Action now identify their source-code meanings where they differ.
• REST API documentation now stays aligned with fstREST, TvxAPIActionItem, and VeloxAPIService source behavior.
• Data type terminology now includes the source enum names and display labels.
• Trial/test/backup folders are described consistently as ignored source unless explicitly targeted.

Outdated Or Unclear Information Still Marked As Unclear

These areas remain intentionally marked as unclear rather than invented:

• TvxActionAPI is present in source, but no current class registration or main Designer creation path was found.
• fatPlugin / Call Plugin remains in the active action type enum, but no active main Designer creation path or concrete current action class was confirmed.
• AS2 appears in configuration enums/documentation, but active AS2 transport implementation coverage remains unclear.
• API SSL-related configuration exists in setup/domain documentation, but the current VeloxAPIService startup path binds the Indy WebBroker bridge to a port and no SSL binding path was confirmed in the reviewed source.
• C# IIS/API hosting references were not verified as current because this task was scoped to the Delphi velox repository.

Document Review Matrix

Document	Review result
API_REFERENCE.md	Reviewed against VeloxAPIService, REST dispatch, API action mapping, and service behavior. Existing uncertainty around SSL/IIS remains appropriate.
ARCHITECTURE.md	Reviewed against project entry points and major source areas; ignored linked-action setup form is now marked out-of-scope.
DATABASE_REFERENCE.md	Reviewed for consistency with system setup, Flow/Action, and configuration terminology. No required updates found.
DATA_FORMAT_REFERENCE.md	Reviewed against documented data-definition and data-type coverage. TvxDataType coverage was added to the configuration reference.
DEVELOPER_GUIDE.md	Updated ignored-folder guidance and active Flow setup reference.
DIALOG_REFERENCE.md	Updated active dialog scope to exclude ignored trial/test/backup folders.
DOMAIN_MODEL.md	Updated TvxActionAPI, Sub Action, linked-flow terminology, and active UI/source references.
DOMAIN_MODEL_old.md	Deleted as an obsolete duplicate; DOMAIN_MODEL.md is authoritative.
ERROR_REFERENCE.md	Updated ignored-folder error note; active runtime error coverage remains source-grounded.
FEATURE_INVENTORY.md	Updated ignored-folder scope and reduced plugin coverage to active enum evidence only.
FLOW_EXECUTION.md	Updated action class coverage and marked the ignored linked setup form out-of-scope.
KNOWLEDGE_MAP.md	Updated outdated PKB structure description and active source scope.
LOGGING_REFERENCE.md	Updated linked trial form logging notes so they are not treated as active product UI.
MENU_REFERENCE.md	Updated active menu scope to exclude ignored trial/test/backup folders.
MODULE_LIBRARY.md	Updated ReportBuilder support classes, active source references, and TvxActionAPI status.
SECURITY_REFERENCE.md	Reviewed against API and setup/security configuration notes. Existing SSL uncertainty remains appropriate.
SERVICE_REFERENCE.md	Reviewed against VeloxService.dpr, VeloxAPIService.dpr, worker startup, connection loading, and API port behavior. No required updates found.
TECHNICAL_DEBT.md	Updated ignored-folder debt items so they are not active product architecture/debt findings.
TODO.md	Updated ignored-folder TODO items and removed the now-answered open question about _BACKUP and Classes\_NEW.
UI_INVENTORY.md	Updated active UI scope to exclude ignored trial/test/backup folders.
Configuration_Reference\README.md	Updated enum coverage for TvxDataType.
Configuration_Reference\TRANSPORT_CONFIGURATION.md	Reviewed against transport source and UI coverage. No required updates found.
Configuration_Reference\SYSTEM_RUNTIME_CONFIGURATION.md	Reviewed against application/service startup and setup loading. No required updates found.
Configuration_Reference\MODULE_CONFIGURATION.md	Reviewed against module/action class coverage. No required updates found.
Configuration_Reference\GENERAL_SETUP_CONFIGURATION.md	Reviewed against setup and API port/security configuration. No required updates found.
Configuration_Reference\FLOW_CONFIGURATION.md	Updated TvxActionAPI status and transport-class wording.
Configuration_Reference\DATA_DEFINITION_CONFIGURATION.md	Reviewed against data format/type terminology. No required updates found.
Configuration_Reference\CONNECTION_CONFIGURATION.md	Reviewed against startup connection loading and connection configuration terminology. No required updates found.

Verification

Validation performed after documentation updates, excluding repository-guidance ignored folders:

• Re-ran active DFM coverage checks against velox-kb\VeloxPKB\docs\velox\: 85 checked, 0 missing mentions.
• Re-ran registered-class coverage checks against velox-kb\VeloxPKB\docs\velox\: 70 checked, 0 missing mentions.
• Re-ran selected enum-value coverage checks against velox-kb\VeloxPKB\docs\velox\: 25 checked, 0 missing mentions.
• Searched for removed outdated phrases and obsolete legacy action-class references in the PKB.

No Delphi source files were changed. No Delphi build or runtime test was run because this task only changed documentation.