Skip to main content

Velox Knowledge Map

This document groups the Velox codebase into logical subsystems. It is intended as a navigation aid for future development, review, and onboarding.

Complexity is estimated from code surface area, coupling, runtime risk, database impact, threading, persistence compatibility, and number of dependencies. It is not a formal metric.

Related documentation is now split across the PKB topic files in this folder, including architecture, domain model, feature inventory, module library, flow execution, API, services, UI/dialog/menu inventories, database, logging, security, errors, data formats, and configuration references. _Documentation contains user-maintained topic notes and is referenced only where those notes add context outside the PKB.

Runtime Entrypoints and Project Composition​

Purpose:

  • Defines the main executable boundaries and process roles for Velox Designer, VeloxService, VeloxAPIService, and VeloxTest.
  • Sets global runtime flags such as Designer/server/background/test mode.
  • Performs early memory manager, exception reporting, connection, setup, logging, and database-upgrade initialization.

Main classes:

  • TMain
  • TVeloxWorker
  • TVeloxAPIWorker
  • VeloxTest main form
  • Global startup helpers such as CheckTrial, CreateSystemLog, CheckDatabaseUpgrade, SwitchSystemConnectionMode

Dependencies:

  • VCL application/service framework
  • Modified Vcl.SvcMgr
  • FastMM5
  • madExcept
  • vxCon
  • vxSetup
  • vxDBUpdate
  • vxConfigPath
  • vxModule

Important entry points:

  • Velox.dpr
  • VeloxService.dpr
  • VeloxAPIService.dpr
  • VeloxTest.dpr
  • VeloxGroup.groupproj

Important configuration:

  • Command-line connection key parameter
  • Test mode command-line flags
  • AppDataFolder.cfg
  • Connections.json
  • VX_SETUP
  • vxConstant.MajorVersion

Related documentation:

  • ARCHITECTURE.md: Overall Architecture, Purpose of Each Major Project, Startup Sequence

Estimated complexity: Medium

Velox Designer GUI​

Purpose:

  • Provides the Windows GUI for designing, configuring, importing, exporting, testing, and managing Velox flows and modules.
  • Manages the main tree, form lifecycle, Designer mode changes, and service control UI.

Main classes:

  • TMain
  • TvxModuleManager
  • Form manager classes under Classes\GUI
  • Designer forms under Forms
  • Flow setup forms under Forms
  • Transport configuration forms under Forms\Transports

Dependencies:

  • VCL
  • DevExpress VCL controls
  • Custom components under Components
  • TvxModuleManager
  • gServiceManager
  • gSystemConnection
  • gSetup
  • gVariableGroups
  • IPC/service manager code

Important entry points:

  • Velox.dpr
  • Forms\frmMain.pas
  • TMain.FormCreate
  • TMain.InitialiseForm
  • TMain.ChangeMode
  • Designer menu actions, including Tools > Sync Relations and Tools > Create XSD

Important configuration:

  • Active system connection key
  • Test/production mode
  • VX_SETUP
  • Module tree/folder configuration
  • Service state and service names

Related documentation:

  • ARCHITECTURE.md: Velox Designer, Startup Sequence
  • _Documentation\_Development

Estimated complexity: High

Configuration and ProgramData​

Purpose:

  • Resolves application data paths.
  • Loads the active system database connection configuration.
  • Loads general Velox setup from the configuration database.
  • Supplies filesystem locations for config, logs, data, files, schemas, scripts, resources, certificates, temp files, and comparison output.

Main classes:

  • TvxConnection
  • TvxDBParams
  • TvxSetup
  • Path helper functions in vxConfigPath

Dependencies:

  • SuperObject JSON
  • vxEncryption
  • vxConstant
  • vxConfig
  • vxDBParams
  • Windows known folders and common application data paths

Important entry points:

  • gSystemConnection.Load
  • SwitchSystemConnectionMode
  • TvxSetup.CreateAndLoad
  • TvxSetup.Reload
  • Path accessors in Classes\Tools\vxConfigPath.pas

Important configuration:

  • AppDataFolder.cfg
  • C:\ProgramData\Velox\Config\Connections.json
  • Installer ProgramData template at C:\_GIT\Velox\Install\ProgramData\install-veloxprogramdata
  • VX_SETUP
  • Config, Log, Data, Files, Files_Test, Temp, Schema, Script, Resource, Certificate, Compare

Related documentation:

  • ARCHITECTURE.md: Configuration Loading
  • _Documentation\OpenSSL

Estimated complexity: Medium

Database Connectivity and Connection Pools​

Purpose:

  • Connects Velox to SQL Server.
  • Provides per-thread pooled connections for system databases and business data connections.
  • Supports query creation, transaction handling, and ReportBuilder database settings.

Main classes:

  • TvxDBParams
  • TvxSQLConnection
  • TvxSystemConnectionPool
  • TvxSQLConPool
  • TvxSystemDB
  • TvxDBCon
  • TvxSQL

Dependencies:

  • Microsoft SQL Server
  • Devart dbExpress SQL Server driver
  • dbexpsda41.dll
  • OLE DB provider settings
  • ReportBuilder data settings and pipelines
  • Connections.json
  • VX_DBCON

Important entry points:

  • TvxSQLConnection.VxConnect
  • TvxSQLConnection.NewQuery
  • TvxSystemConnectionPool.Load
  • gSysConPool.GetConnection
  • gSQLConPool.GetConnection
  • TvxSystemDB.NewConfigQuery
  • TvxSystemDB.NewLogQuery
  • TvxSystemDB.NewDataQuery

Important configuration:

  • Connections.json
  • TvxDBParams
  • Config, log, and data database keys
  • Windows or SQL authentication settings
  • Encrypted database passwords
  • Trust server certificate setting

Related documentation:

  • ARCHITECTURE.md: Database Access Architecture

Estimated complexity: High

Database Schema Upgrades​

Purpose:

  • Owns all Velox database schema changes.
  • Creates and upgrades VX_* tables and indexes.
  • Tracks the current schema version through VX_VERSION.

Main classes:

  • TVxDBUpdate
  • TVxDBUpdateVersion
  • TVxDBUpdateVersion300 through TVxDBUpdateVersion311
  • TDatabaseUpgrade

Dependencies:

  • TvxSQLConnection
  • TvxSQL
  • vxConstant.MajorVersion
  • vxDBUpdateVersion
  • Designer modal upgrade UI

Important entry points:

  • CheckDatabaseUpgrade
  • TVxDBUpdate.CheckDatabaseVersion
  • TVxDBUpdate.UpdateDatabase
  • TVxDBUpdate.UpgradeTo
  • TVxDBUpdateVersion.Execute

Important configuration:

  • vxConstant.MajorVersion
  • VX_VERSION
  • Config and log database connections

Related documentation:

  • ARCHITECTURE.md: Database Access Architecture, Areas of Technical Debt

Estimated complexity: Medium

Module Persistence and Compatibility​

Purpose:

  • Provides the base persistence model for Velox configuration objects.
  • Loads and saves module metadata and streamed module configuration.
  • Preserves compatibility with old module class names and missing streamed properties.

Main classes:

  • TvxModule
  • TvxModuleTemplate
  • TvxModuleManager
  • TModuleOwner
  • TvxConfigTemplate
  • ConvertOldClass

Dependencies:

  • ReportBuilder TppTemplate
  • Delphi class registration
  • TvxSystemDB
  • VX_* module tables
  • VX_RELATION
  • Missing property logging

Important entry points:

  • TvxModule.LoadModule
  • TvxModule.AddModule
  • TvxModule.SaveModule
  • TvxModule.ExportModule
  • TvxModule.SaveModuleRelations
  • TvxModuleTemplate.LoadError
  • TvxModuleTemplate.FindComponentClass
  • Tools > Sync Relations
  • .cfg import/export paths

Important configuration:

  • Module table names
  • Module FIDs and parent FIDs
  • Active/archive flags
  • Revision/version/test/prod metadata
  • .cfg export files
  • VX_RELATION

Related documentation:

  • ARCHITECTURE.md: Plugin and Module Architecture, Serialization Formats

Estimated complexity: High

Flow and Action Model​

Purpose:

  • Represents a Velox Flow as an ordered set of executable action items.
  • Defines the persisted business process that moves, transforms, validates, reports, and integrates data.

Main classes:

  • TvxActionMan
  • TvxActionItem
  • TvxActionMap
  • TvxActionReport
  • TvxActionCustomScript
  • TvxActionTransport
  • TvxActionAPI (source-visible transport-derived subclass; no current class registration or main setup creation path was found)
  • TvxActionFileRouter
  • TvxActionShellExecute
  • TvxActionSQL
  • TvxActionSubAction
  • TvxRouteItem

Dependencies:

  • Module persistence
  • Maps
  • Reports
  • Scriptlets
  • Transports
  • Database/file definitions
  • Variable groups
  • Logging
  • Connection pools

Important entry points:

  • TvxActionMan.Execute
  • TvxActionMan.ExecuteOnce
  • TvxActionMan.CheckTransports
  • TvxActionMan.LoadLinkedActions
  • Designer action configuration forms

Important configuration:

  • VX_ACTION
  • Flow execution type, including scheduled, monitored, and REST/API execution
  • Action order and active flags
  • Retry behavior
  • Linked actions
  • Test mode

Related documentation:

  • ARCHITECTURE.md: Flow Execution Architecture

Estimated complexity: High

Service Execution Managers and Threading​

Purpose:

  • Runs service-managed flow execution.
  • Synchronises database-defined work into active service runtime items.
  • Starts, limits, tracks, and shuts down worker threads.

Main classes:

  • TvxExecutionManager
  • TvxExecutionItem
  • TvxScheduleManager
  • TvxScheduleItem
  • TvxMonitorManager
  • TvxMonitorItem
  • TvxTransportManagerIn
  • TvxTransportManagerOut
  • TvxRESTManager
  • TvxExecutionMonitor
  • TActionThread
  • TScheduleActionThread
  • TMonitorActionThread
  • TTransportInActionThread
  • TTransportOutActionThread
  • TRESTActionThread
  • TvxStopWaitThread

Dependencies:

  • VeloxService
  • VeloxAPIService
  • TvxActionPool
  • TvxModuleOwner
  • Connection pools
  • Logging
  • Timers
  • IPC
  • COM initialization

Important entry points:

  • TVeloxWorker.ServiceExecute
  • TVeloxAPIWorker.ServiceExecute
  • Manager Synchronise methods
  • Manager Disable methods
  • Thread Execute methods
  • Service shutdown paths

Important configuration:

  • gSetup.ServiceState
  • Schedule and repeat timings
  • Max pending/running threads per action
  • gSetup.MaxWaitBeforeTermination
  • Transport retry settings
  • Execution type on flows/actions

Related documentation:

  • ARCHITECTURE.md: VeloxService Startup, VeloxAPIService Startup, Flow Execution Architecture, Areas of Technical Debt

Estimated complexity: High

REST API Service Dispatch​

Purpose:

  • Hosts REST/API-triggered flows in the Delphi VeloxAPIService.
  • Maps HTTP endpoints to active REST flow execution items.
  • Dispatches WebBroker requests into Velox flow execution.

Main classes:

  • TVeloxAPIWorker
  • TRESTModule
  • TvxRESTManager
  • TvxRESTItem
  • TRESTActionThread
  • TvxAPIRequest
  • TvxAPIResponse

Dependencies:

  • WebBroker
  • Indy TIdHTTPWebBrokerBridge
  • TvxActionPool
  • TvxActionMan
  • API stream wrappers
  • Logging
  • Connection pools
  • gSetup

Important entry points:

  • VeloxAPIService.dpr
  • TVeloxAPIWorker.ServiceStart
  • TVeloxAPIWorker.ServiceExecute
  • RegisterWebModule
  • TRESTModule.WebModuleBeforeDispatch
  • TvxRESTManager.Synchronise
  • TvxRESTManager.ExecuteAPIForEndpoint

Important configuration:

  • API domain
  • API port
  • API SSL setting
  • REST endpoint path
  • VX_ACTION rows with fstREST
  • X-UserNum request header

Related documentation:

  • ARCHITECTURE.md: VeloxAPIService Startup, Flow Execution Architecture, Architecture Questions

Estimated complexity: High

API Definitions and OpenAPI Schema​

Purpose:

  • Groups REST flows into API definitions.
  • Generates OpenAPI JSON schemas for REST API documentation.
  • Supplies schema output to the separate C# IIS VeloxAPIService frontend.

Main classes:

  • TvxAPI
  • TvxAPIActionItem
  • OpenAPI schema generation methods in TvxAPI

Dependencies:

  • TvxActionMan
  • REST execution type fstREST
  • System.JSON
  • Neon JSON serialization
  • OpenAPI-Delphi
  • C# IIS VeloxAPIService frontend

Important entry points:

  • API module configuration in Designer
  • TvxAPI.CreateOpenAPISchema
  • TvxAPI.ExportOpenAPISchema
  • Linking REST flows into TvxAPIActionItem

Important configuration:

  • VX_API
  • VX_API_ACTION
  • REST flow endpoints
  • AppData resource/schema output paths
  • C# frontend schema load process

Related documentation:

  • ARCHITECTURE.md: Flow Execution Architecture, Serialization Formats

Estimated complexity: Medium

C# IIS VeloxAPIService Frontend​

Purpose:

  • Acts as the current IIS-hosted gateway/frontend to the Delphi VeloxAPIService.
  • Currently handles SSL termination.
  • Loads OpenAPI schema generated by TvxAPI so it can present Swagger/API documentation.

Main classes:

  • Not visible in this repository.

Dependencies:

  • IIS
  • C#/.NET project outside this repository
  • Generated OpenAPI JSON from Velox
  • Delphi VeloxAPIService
  • SSL certificate configuration in IIS

Important entry points:

  • IIS application startup outside this repository
  • Schema load path outside this repository
  • Gateway calls into the Delphi API service

Important configuration:

  • IIS site/application settings
  • SSL certificate binding
  • Generated OpenAPI schema location
  • Delphi API service address and port

Related documentation:

  • ARCHITECTURE.md: Flow Execution Architecture, Architecture Questions

Estimated complexity: Medium

Transports​

Purpose:

  • Implements inbound and outbound integration transports.
  • Allows flows to receive, monitor, send, retry, and log transport activity.

Main classes:

  • TvxTransport
  • TvxTransportLink
  • TvxTransportFTPIn
  • TvxTransportFTPOut
  • TvxTransportSFTPIn
  • TvxTransportSFTPOut
  • TvxTransportLANIn
  • TvxTransportLANOut
  • TvxTransportHTTPIn
  • TvxTransportHTTPOut
  • TvxTransportMSMQIn
  • TvxTransportMSMQOut
  • TvxTransportIBMMQIn
  • TvxTransportIBMMQOut
  • TvxTransportIMAP
  • TvxTransportPOP
  • TvxTransportSMTP
  • TvxTransportManagerIn
  • TvxTransportManagerOut

Dependencies:

  • Indy
  • SecureBridge/SFTP components
  • MSMQ/IBM MQ support where configured
  • File connections
  • Flow execution
  • Logging
  • Service managers

Important entry points:

  • Transport action execution
  • TvxTransportManagerIn.Synchronise
  • TvxTransportManagerOut.Synchronise
  • TTransportInActionThread.Execute
  • TTransportOutActionThread.Execute
  • Transport StartDownload and outbound execute/send methods

Important configuration:

  • VX_TRANSPORT
  • Transport direction
  • Transport retry settings in setup
  • File connection FIDs
  • Transport log tables

Related documentation:

  • ARCHITECTURE.md: Flow Execution Architecture, Logging
  • _Documentation\AS2
  • _Documentation\OAuth SMPT SASL

Estimated complexity: High

Data Definitions and File Engines​

Purpose:

  • Defines structured access to database data and files.
  • Reads and writes flat, XML, JSON, EDI, and Excel formats.
  • Supplies data views and datasets used by maps, reports, scripts, and actions.

Main classes:

  • TvxDBDef
  • TvxFileDef
  • TvxFileDefFlat
  • TvxFileDefXML
  • TvxFileDefJSON
  • TvxFileDefExcel
  • TvxFileDefEDI
  • TvxDataDef
  • TvxDefManager
  • TvxDefDB
  • TvxDefFile
  • TvxFileEngine
  • Flat, XML, JSON, Excel, and EDI file engine classes

Dependencies:

  • SQL connection pools
  • File connections
  • NativeExcel
  • NativeXML/MSXML
  • System.JSON and custom JSON helpers
  • XML schema files under ProgramData Schema
  • API request/response streams

Important entry points:

  • File/data definition Designer forms
  • File engine load/save methods
  • API stream load paths
  • Map/report/action data access

Important configuration:

  • VX_DBDEF
  • VX_FILEDEF
  • File type settings
  • Delimiter/fixed-width settings
  • XML schema and transform settings
  • Excel workbook/template settings
  • ProgramData Schema, Files, Files_Test, and Temp folders

Related documentation:

  • ARCHITECTURE.md: Serialization Formats
  • _Documentation\Fast Delphi Code

Estimated complexity: High

Mapping and Transformation​

Purpose:

  • Maps fields between definitions, views, files, databases, scripts, variables, and runtime data.
  • Implements core data transformation behavior for Velox flows.

Main classes:

  • TvxMap
  • TvxViewMap
  • TvxFieldMap
  • TvxActionMap

Dependencies:

  • Database definitions
  • File definitions
  • Scriptlets
  • Variables
  • Logging
  • Module relations
  • Connection pools

Important entry points:

  • TvxActionMap execution
  • Map Designer forms
  • TvxModule.SaveModuleRelations
  • Map import/export

Important configuration:

  • VX_MAP
  • Source and target definition FIDs
  • Field mappings
  • Scriptlet and variable relations
  • VX_RELATION

Related documentation:

  • ARCHITECTURE.md: Flow Execution Architecture, Plugin and Module Architecture

Estimated complexity: High

Scripting​

Purpose:

  • Provides custom script execution and reusable scriptlets.
  • Extends flow behavior through Pascal Script and Velox script functions.

Main classes:

  • TvxScriptlet
  • TvxScriptItem
  • TvxActionCustomScript
  • Pascal Script integration classes under Scripting

Dependencies:

  • RemObjects Pascal Script
  • Velox module persistence
  • Variables
  • Data definitions
  • Maps
  • Logging
  • Modified PascalScript code under Modified

Important entry points:

  • Custom script action execution
  • Scriptlet execution
  • Script Designer/configuration forms
  • Script function registration under Scripting

Important configuration:

  • VX_SCRIPTLET
  • ProgramData Script folder
  • Scriptlet relations
  • Runtime variables and parameters

Related documentation:

  • ARCHITECTURE.md: Key Frameworks and Libraries, Flow Execution Architecture
  • _Documentation\Scripting

Estimated complexity: High

Reporting​

Purpose:

  • Generates reports as part of Velox flows.
  • Persists report definitions and ReportBuilder templates.

Main classes:

  • TvxReport
  • TvxPPReport
  • TvxPPChildReport
  • TvxActionReport

Dependencies:

  • ReportBuilder
  • Data definitions
  • Connection pools
  • Module persistence
  • Logging
  • Native file/output handling

Important entry points:

  • Report action execution
  • Report Designer forms
  • Report template load/save
  • TvxActionReport

Important configuration:

  • VX_REPORT
  • Report template streams
  • Data definition relations
  • Output file settings

Related documentation:

  • ARCHITECTURE.md: Plugin and Module Architecture, Serialization Formats

Estimated complexity: Medium

Logging, Audit, and Diagnostics​

Purpose:

  • Records flow execution, system startup/shutdown, warnings, errors, files, transports, SQL/log details, audit events, and diagnostics.
  • Provides both database logs and file/event-log diagnostics.

Main classes:

  • TvxLog
  • TvxSystemLog
  • TvxLogItem
  • TvxCustomLogItem
  • TvxCustomDBLogItem
  • TvxLogFile
  • Transport log classes
  • Event logger helpers in vxEventLogger

Dependencies:

  • VX_LOG
  • VX_LOG_ITEM
  • VX_LOG_FILE
  • VX_LOG_TRANSPORT
  • gSetup
  • Windows Event Log
  • madExcept
  • FastMM5
  • AppData log paths

Important entry points:

  • CreateSystemLog
  • SaveSystemLog
  • FinaliseSystemLog
  • TvxLog.MessageLog
  • TvxLog.SaveLog
  • LogAudit
  • LogAuditDebug
  • LogUser

Important configuration:

  • Setup logging/debug flags
  • Detailed system audit flag
  • AppData Log folder
  • Missing properties log
  • API request debug log
  • FastMM and madExcept report paths

Related documentation:

  • ARCHITECTURE.md: Logging

Estimated complexity: High

Variables and Runtime Context​

Purpose:

  • Provides reusable and runtime values used by flows, maps, scripts, APIs, and execution context.
  • Loads variable groups at startup and during mode/service changes.

Main classes:

  • TvxVariableGroup
  • TvxVariable
  • TvxParameter
  • gVariableGroups

Dependencies:

  • Module persistence
  • Flow/action execution
  • Scriptlets
  • Maps
  • REST query fields and request context

Important entry points:

  • gVariableGroups.LoadVariableGroups
  • Designer variable configuration forms
  • Action execution variable lookup
  • REST thread query-field setup

Important configuration:

  • VX_VARIABLE
  • Variable group module data
  • Runtime local variables
  • REST query parameters

Related documentation:

  • ARCHITECTURE.md: Startup Sequence, Flow Execution Architecture

Estimated complexity: Medium

Import, Export, Templates, and Relations​

Purpose:

  • Exports and imports module configuration bundles.
  • Maintains dependency relations between modules.
  • Supports legacy .cfg imports and migration to current Tvx* classes.

Main classes:

  • TvxConfigTemplate
  • TvxModuleTemplate
  • TvxModule
  • ConvertOldClass

Dependencies:

  • Module persistence
  • ReportBuilder template streams
  • VX_RELATION
  • AppData compare path
  • Legacy class mapping

Important entry points:

  • TvxModule.ExportModule
  • TvxConfigTemplate.SaveAllModules
  • Import paths in Designer
  • TvxModule.SaveModuleRelations
  • Tools > Sync Relations

Important configuration:

  • .cfg files
  • VX_RELATION
  • Module FIDs
  • AppData Compare folder
  • Legacy class mapping table in code

Related documentation:

  • ARCHITECTURE.md: Plugin and Module Architecture, Serialization Formats

Estimated complexity: High

IPC and Service Control​

Purpose:

  • Allows the Designer to query and control Velox services.
  • Provides internal service-management messaging for status, enabling/disabling work, task counts, ending tasks, and connection details.

Main classes:

  • TIPCServer
  • Service manager classes used by the Designer
  • IPC request handlers in TVeloxWorker
  • IPC request handlers in TVeloxAPIWorker

Dependencies:

  • Cromis IPC
  • Windows services
  • Service name/config key conventions
  • gActionPool
  • gSQLConPool
  • gSysConPool
  • Execution managers

Important entry points:

  • TVeloxWorker.ServiceCreate
  • TVeloxWorker.ServiceStart
  • TVeloxWorker IPC handlers
  • TVeloxAPIWorker.ServiceCreate
  • TVeloxAPIWorker.ServiceStart
  • Designer service-control actions

Important configuration:

  • Config key
  • Test mode suffix
  • IPC server name constants
  • Service state
  • Service display name/startup parameters

Related documentation:

  • ARCHITECTURE.md: Startup Sequence, Flow Execution Architecture

Estimated complexity: Medium

Security, Licensing, Encryption, and Certificates​

Purpose:

  • Handles trial/licensing checks, encrypted stored values, password handling, certificate folders, and future direct API-service SSL management.

Main classes:

  • CheckTrial
  • Encryption helpers in vxEncryption
  • TvxDBParams
  • Setup SSL-related properties

Dependencies:

  • Startup code in each executable
  • Encrypted passwords in connection configuration
  • ProgramData Certificate folder
  • Future OpenSSL/Indy SSL integration
  • IIS SSL for the current C# API frontend

Important entry points:

  • CheckTrial
  • TvxDBParams.Password getter/setter behavior
  • gSystemConnection.Load
  • API service startup SSL-related setup fields

Important configuration:

  • Encrypted database passwords
  • API SSL setting in setup
  • ProgramData Certificate\Public
  • ProgramData Certificate\Private
  • IIS SSL binding for the C# frontend

Related documentation:

  • ARCHITECTURE.md: Configuration Loading, Flow Execution Architecture, Architecture Questions
  • _Documentation\OpenSSL

Estimated complexity: Medium

Custom Components and UI Infrastructure​

Purpose:

  • Supplies custom VCL components and UI helpers used by the Designer and forms.
  • Encapsulates tree views, combo boxes, editor/memo controls, and other reusable UI pieces.

Main classes:

  • Custom components under Components
  • vxTreeView
  • vxTreeComboBox
  • vxSynMemo
  • Form classes under Forms

Dependencies:

  • VCL
  • DevExpress VCL
  • SynEdit
  • VirtualTreeView
  • DFM streaming and published properties

Important entry points:

  • Form creation and DFM loading
  • Designer module forms
  • Main tree/UI setup in TMain

Important configuration:

  • .dfm resources
  • Published component properties
  • Designer layout/form state where persisted

Related documentation:

  • ARCHITECTURE.md: Velox Designer, Key Frameworks and Libraries

Estimated complexity: Medium

Test Harness and Developer Utilities​

Purpose:

  • Provides internal testing, diagnostics, and helper tooling outside the main production executables.

Main classes:

  • VeloxTest main form
  • Test buttons/actions in VeloxTest\frmMain.pas
  • VeloxXSD utility
  • EventMessages project artifacts

Dependencies:

  • Designer units
  • Service units
  • API service units
  • Managers and transports
  • XSD/schema libraries for VeloxXSD

Important entry points:

  • VeloxTest.dpr
  • VeloxTest\frmMain.pas
  • VeloxXSD\Program.cs
  • Designer Tools > Create XSD

Important configuration:

  • Test mode flags
  • Active Connections.json
  • VX_SETUP
  • ProgramData Testing
  • ProgramData Schema

Related documentation:

  • ARCHITECTURE.md: Purpose of Each Major Project
  • _Documentation\_Development

Estimated complexity: Medium

Vendor and Modified Framework Integration​

Purpose:

  • Supplies third-party frameworks and intentionally maintained Velox modifications to third-party/framework code.
  • Keeps vendor code separate from Velox-maintained modifications.

Main classes:

  • Modified VCL service manager code
  • Modified Indy code
  • Modified PascalScript code
  • Modified ReportBuilder code
  • Modified VCL code
  • Vendor OpenAPI-Delphi
  • Vendor Delphi Neon
  • Vendor Scalar assets

Dependencies:

  • Delphi RTL/VCL source
  • DevExpress VCL
  • Indy
  • PascalScript
  • ReportBuilder
  • OpenAPI-Delphi
  • Neon
  • Other vendor frameworks listed in project search paths

Important entry points:

  • Project search paths in .dproj files
  • Units resolved from Modified
  • Units resolved from Vendor
  • Initialization sections in third-party and modified code

Important configuration:

  • Delphi search path order
  • $(DXVCL)
  • Local Vendor and Modified folders
  • Modified units that shadow vendor/framework units

Related documentation:

  • ARCHITECTURE.md: Key Frameworks and Libraries, Solution and Project Structure

Estimated complexity: High

Installer and ProgramData Assets​

Purpose:

  • Defines the default files and folders installed under C:\ProgramData\Velox on first install.
  • Provides runtime files that are not part of the main source tree but are important to configuration and operation.

Main classes:

  • No Delphi classes directly. This is filesystem/install payload.

Dependencies:

  • Installer project outside this repository area
  • ProgramData path resolution in vxConfigPath
  • Connections.json
  • Schema files and default readme files

Important entry points:

  • First install process
  • ProgramData update scripts
  • Runtime path accessors in vxConfigPath

Important configuration:

  • C:\_GIT\Velox\Install\ProgramData\install-veloxprogramdata
  • C:\ProgramData\Velox
  • Config\Connections.json
  • Schema files, including UBL and XML schemas
  • Certificate, Custom Web Parts, Data, Files, Files_Test, Log, Resource, Script, Temp, Testing

Related documentation:

  • ARCHITECTURE.md: Configuration Loading

Estimated complexity: Medium