Velox Configuration Reference

Summary

This folder is the internal Product Knowledge Base reference for Velox configuration. It describes configurable values discovered from the current Velox source code. The source code is authoritative; where the inspected code does not reveal a default, valid range, or runtime effect, this reference says so explicitly.

Most product configuration is persisted as Velox module data through TvxModule and its descendants. The primary signal for persisted module configuration is Delphi published properties. Runtime files, service command line arguments, registry values, JSON connection files, UI settings INI files, and database metadata are documented separately.

Related PKB Documents

• Architecture
• Domain Model
• Developer Guide
• Feature Inventory
• Module Library
• Data Format Reference

Configuration Reference Pages

• System and Runtime Configuration
• General Setup Configuration
• Connection Configuration
• Data Definition Configuration
• Flow Configuration
• Module Configuration
• Transport Configuration

Source Code Locations

• Classes\vxModule.pas - base module persistence, module template export/import, log classes, module metadata.
• Classes\Tools\vxTypes.pas - shared configuration enum values and display strings.
• Classes\Tools\vxConstant.pas - runtime folder, file name, service name, and INI constants.
• Classes\Tools\vxConfigPath.pas - app data and user data folder resolution.
• Classes\vxCon.pas and Classes\vxDBParams.pas - Connections.json loading and database parameter objects.
• Forms\frmSetup*.pas and Forms\Transports\frmTransport*.pas - Designer configuration forms.

Important Classes

• TvxModule - base configurable module.
• TvxModuleTemplate - module serialization layer.
• TvxSetup - global setup module.
• TvxDBCon, TvxFileCon - connection modules.
• TvxDataDef, TvxDBDef, TvxFileDef - data definition modules.
• TvxActionMan and TvxActionItem descendants - flow and flow step configuration.
• TvxTransport and transport descendants - inbound and outbound transport configuration.

Important Forms

• TSetupGeneral - General Setup.
• TSetupDBCon, TSetupFileCon - connection setup.
• TSetupDBDef, TSetupFileDefFlat, TSetupFileDefXML, TSetupFileDefEDI, TSetupFileDefExcel, TSetupFileDefJSON - data definition setup.
• TSetupActions - flow setup.
• TSetupMaps, TSetupMapDesign, TSetupReports, TSetupScriptlet, TSetupSQLScript, TSetupVariableGroup, TSetupAPI, TSetupFolder - module setup forms.
• TfrmTransportFTPIn, TfrmTransportFTPOut, TfrmTransportSFTPIn, TfrmTransportSFTPOut, TfrmTransportLANIn, TfrmTransportLANOut, TfrmTransportHTTPIn, TfrmTransportHTTPOut, TfrmTransportIMAP, TfrmTransportPOP, TfrmTransportSMTP, TfrmTransportMSMQIn, TfrmTransportMSMQOut, TfrmTransportIBMMQIn, TfrmTransportIBMMQOut - transport setup forms.

Important Services

• VeloxService - executes flows, schedules, monitors, and transports.
• VeloxAPIService - exposes REST/API runtime behaviour and loads setup/API/flow configuration.
• Designer executable Velox - edits configuration modules and saves module data.

Related Configuration

• Connections.json in AppDataConfigPath.
• Module data in Velox configuration database tables such as VX_SETUP, VX_DBCON, VX_FILECON, VX_DBDEF, VX_FILEDEF, VX_ACTION, VX_TRANSPORT, VX_REPORT, VX_MAP, VX_SQLSCRIPT, VX_SCRIPTLET, VX_API, VX_VARIABLE, and VX_FOLDER.
• UI setting INI file names declared in vxConstant.pas.
• Trial registry keys under HKEY_CURRENT_USER\SOFTWARE\Velox\License when compiled with VELOXTRIAL.

Default and Valid Value Rules

Unless a page says otherwise:

• String settings accept strings and default to ''.
• Boolean settings accept True or False.
• Integer/Cardinal settings accept Delphi numeric values of that type; the inspected code often does not enforce a narrower range.
• GUID settings are stored as strings via GUIDToString/StringToGuid; defaults are usually EmptyGuid.
• Secret settings such as passwords are stored encrypted when set outside component loading and decrypted by property getters at runtime.
• Defaults are taken from the relevant New constructor method when present. If no assignment is visible in New or the constructor, the page says the default is not explicitly assigned in inspected code.

Shared Enum Values

Module Types

TvxModuleType: fmtModule, fmtSetup, fmtFolder, fmtDBCon, fmtFileCon, fmtDBDef, fmtFileDef, fmtInboundTransport, fmtOutboundTransport, fmtReport, fmtSQLScript, fmtScriptlet, fmtMap, fmtFlow, fmtAPI, fmtVariableGroup.

Service State

TvxServiceState: vssEnabled, vssDisabled.

Database Types

TRegConType: ctMSSQL, ctOracle, ctMySQL, ctPostgreSQL, ctDB2, ctADO, ctODBC.

TvxSQLAuthType: atWindows, atSQLServer, atEntraMFA, atEntraPassword, atEntraIntegrated, atEntraServicePrincipal, atEntraManagedIdentity.

TvxSQLDriverType: fdtNotSet, fdtMSOLEDBSQL, fdtSNAC11, fdtSNAC10, fdtSQLOLEDB.

TvxTransIsolationLevel: ftilREADCOMMITTED, ftilREPEATABLEREAD, ftilDIRTYREAD.

TvxMySQLVerType: fmtClient, fmtDirect, fmtEmbedded, fvtServer, fvtServerSSL, fvtEmbedded, fvtEmbeddedSSL; the last four are marked old in display strings and migrated to current values in code.

File and Data Types

TvxDataType: fdtDB, fdtFlatFile, fdtXMLFile, fdtEDIFile, fdtExcelFile, fdtJSONFile. These values back Designer data-view labels such as DB Dataview, File Dataview, XML Dataview, EDI Dataview, Excel Dataview, and JSON Dataview.

TvxFileType: fftFlatFile, fftXMLFile, fftEDIFile, fftExcelFile, fftJSONFile, fftExcel where fftExcel is displayed as old.

TvxFileEncoding: feASCII, feANSI, feUTF8, feUTF16, feUTF16BE.

TvxLineBreakType: flbSegment, flbLF, flbCRLF, flbCustom.

TvxExcelFormat: fefXLS, fefXLSX.

TvxInboundFileNaming: ffnUseIncoming, ffnAppendId, ffnRename.

TvxJSONRootType: vrtNotSet, vrtObject, vrtArray, vrtSimpleArray.

TvxDefinitionType: fstDatabase, fstFile, fstWeb, fstNoData, fstJSON; fstJSON is displayed as old.

Flow Types

TvxExecutionType: fstNone, fstSchedule, fstMonitor, fstREST, fstLinkedAction, fstWebResult.

TvxSchedulePeriod: fspDaily, fspWeekly, fspMonthly.

TvxRepeatOccurrence: frtMilliseconds, frtSeconds, frtMinutes, frtHours.

TvxActionType: fatMap, fatReport, fatShell, fatTransport, fatSQL, fatPlugin, fatCommit, fatDisconnect, fatFileRouter, fatCallAction, fatWaitFile, fatCustomScript, fatInboundTransport.

TvxOutputDestType: fdtViewer, fdtPrinter, fdtFile, fdtEmail.

TvxOutputType: fotPDF, fotHTML, fotPNG, fotJPEG, fotBMP, fotExcel, fotExcelXls, fotRTF, fotXHTML.

Transport Types

TvxTransportType: fptFTP, fptSFTP, fptLAN, fptHTTP, fptMSMQ, fptIBMMQ, fptIMAP, fptPOP, fptSMTP, fptAS2. fptAS2 exists in the enum; no AS2 transport class was found in Classes\Transports during this pass.

TvxDirectionType: tdInbound, tdOutbound, tdBoth.

TvxAuthType: fatNone, fatBasic, fatBearer, fatMicrosoftOAuth, fatGoogleOAuth, fatNetsuiteOAuth, fatCustomOAuth, fatWindows, fatNTLM.

TvxGrantType: gtAuto, gtAuthCode, gtClientCredentials, gtPassword.

TvxTLSType: fttNoTLSSupport, fttImplicitTLS, fttUseRequireTLS, fttUseExplicitTLS.

TvxSSLClientType: fstNoSSL, fstAuto, fstTLS13, fstTLS12, fstTLS11, fstTLS1, fstSSL3, fstTLS1_2, fstTLS1_1; the last two are old aliases migrated by transfer code.

TvxSFTPAuthType: fsaPassword, fsaPrivateKey.

TvxHTTPMethod: hmAny, hmGet, hmPut, hmPost, hmPatch, hmDelete, hmOptions, hmHead, hmTrace, hmCustom.

TvxHTTPReceiveMethodType: brmGet, brmPut, brmPost, brmPatch, brmDelete.

TvxHTTPSendMethodType: bsmPut, bsmPost, bsmPatch, bsmDelete.

TvxHTTPFormEncodingType: feNone, feURLEncode, feMultipartForm.

TvxFTPAfterReceivingType: barDelete, barLeave, barMove.

TvxSFTPAfterReceivingType: basfDelete, basfLeave, basfMove.

TvxLANAfterReceivingType: balaDelete, balaLeave.

TvxHTTPAfterReceivingType: bahtNothing.

TvxIMAPAfterReceivingType: baimNothing, baimRead, baimMove, baimDelete.

TvxPOPAfterReceivingType: bapoDelete, bapoLeave.

TvxMSMQAfterReceivingType: bamsNothing.

TvxIBMMQAfterReceivingType: baibNothing.

TvxMSMQVisibilityType: fqvPrivate, fqvPublic.

TvxMSMQDeliveryType: fdtExpress, fdtRecoverable.

TvxMSMQDirectFormatType: fdfOS, fdfTCP, fdfIPX.

Unclear Areas

• The exact database storage schema for every serialized property is distributed through module template streaming and database table columns. The source code shows table names and many auxiliary columns, but not every column definition in these units.
• Some UI-only INI files are declared as constants, but the inspected pass did not trace every key written into those files. Those are listed in the system reference as declared UI settings files rather than fully enumerated key/value schemas.