Connection Configuration

Summary

This page documents database connections, file connections, database links, and system connection JSON. These settings control how Velox connects to configuration/data/log databases and how it reads, writes, audits, transports, and names files.

Related PKB Documents

• Configuration Reference Index
• System and Runtime Configuration
• Data Definition Configuration
• Transport Configuration
• Domain Model

Source Code Locations

• Classes\vxDBCon.pas:17 - TvxDBCon.
• Classes\vxDBCon.pas:190 - TvxDBCon.New defaults.
• Classes\vxDBCon.pas:558 - database connection parameter application.
• Classes\vxFileCon.pas:17 - TvxFileCon.
• Classes\vxFileCon.pas:159 - TvxFileCon.New defaults.
• Classes\vxFileCon.pas:193 - TvxFileCon.Reset runtime file state.
• Classes\vxCon.pas:160 - Connections.json parsing.
• Classes\vxDBParams.pas - system database parameter object.
• Forms\frmSetupDBCon.pas:21 - TSetupDBCon.
• Forms\frmSetupFileCon.pas:21 - TSetupFileCon.

Important Classes

• TvxDBCon
• TvxDBLink
• TvxFileCon
• TvxConnection
• TvxDBParams

Important Forms

• TSetupDBCon
• TSetupFileCon
• TDatabaseExplorer
• TViewDBCons
• TViewSysCons

Important Services

• VeloxService uses connection modules during flow execution.
• VeloxAPIService uses connection modules for API/runtime execution.

Related Configuration

• Connections.json in AppDataConfigPath.
• Database tables: VX_DBCON, VX_FILECON.
• Additional file connection columns: MAINFILEPATH, ERRORFILEPATH, ISSUEFILEPATH, DUPFILEPATH.

Database Connection Module Identity

Setting	Valid values	Default	Impact
Table	Internal string	VX_DBCON	Selects database connection table.
ModuleDescription	Internal string	DB Con	Display/module metadata.
ModuleName	String	New DB Con	User-visible module name.

Database Connection Settings

Setting	Valid values	Default	Impact
ConnectionType	TRegConType	ctMSSQL	Selects database engine and ReportBuilder database type.
DisconnectAfterUse	Boolean	False	Indicates whether to disconnect after use. Exact call sites not fully traced here.
msoledbsql	Boolean	True	Legacy/compatibility flag for MSOLEDBSQL use. Transfer code maps this to SQLDriverType when older configs have no driver type.
SQLDriverType	TvxSQLDriverType	fdtNotSet	SQL Server driver selection; code comments indicate fdtNotSet lets legacy logic infer MSOLEDBSQL or SNAC11.
Hostname	String, tags processed at connect time	''	Database server/host.
Database	String, tags processed at connect time	''	Database/catalog name.
SQLAuthType	TvxSQLAuthType	atWindows	Authentication type.
Username	String, tags processed at connect time	''	Database login user.
Password	Encrypted persisted string; runtime getter decrypts and tags are processed at connect time	''	Database login secret.
ProviderName	String	''	Provider name for ADO/ODBC or database driver paths.
SearchADO	Boolean	False	Enables ADO search behaviour in UI/runtime where used.
SearchODBC	Boolean	False	Enables ODBC search behaviour in UI/runtime where used.
SQLDialect	Integer	1	SQL dialect parameter passed into database configuration.
OtherParams	TStringList of key/value style parameters	Empty list	Additional database driver parameters; values are tag-processed before connection.
SQLType	TppSQLType	sqSQL2	ReportBuilder SQL type. For non-ODBC, getter returns type from ConTypeSQLTypeArray; for ODBC, stored value is used.
SingleQuoteDates	Boolean	True	SQL date formatting behaviour.
UseASAlias	Boolean	False	SQL alias generation behaviour.
ForceAlias	Boolean	False	SQL alias forcing behaviour.
UseSingleBackQuote	Boolean	False	SQL identifier quoting behaviour.
MySQLVersion	TvxMySQLVerType	fmtClient	MySQL driver mode. Old values are migrated during transfer.
SSLKey	File path/string	''	Database SSL key.
SSLCert	File path/string	''	Database SSL certificate.
IsPersistant	Boolean	False	Persistent connection/pool behaviour flag. Name is misspelled in code and persisted API.
MinConnections	Integer	0	Minimum pool connection count.
MaxConnections	Integer	0	Maximum pool connection count.
MaxTranPerUpdate	Integer	0	Maximum transactions per update. Exact enforcement not fully traced here.
DisableTransactions	Boolean	False	Prevents vxStartTransaction, vxCommitTran, and vxRollbackTran from calling SQL transaction methods.
TrustCertificate	Boolean	False	Passed to database parameter configuration; used for SQL certificate trust behaviour.
UseCCE	Boolean	True	Passed to SetMainParams and SetSubParams; exact meaning is not expanded in this unit.
TransIsolationForWriting	TvxTransIsolationLevel	ftilREADCOMMITTED	Transaction isolation for writes.
TransIsolationForReading	TvxTransIsolationLevel	ftilREADCOMMITTED	Transaction isolation for reads.

Database Link Settings

TvxDBLink is embedded by definitions and scripts to reference a database connection module.

Setting	Valid values	Default	Impact
DBConFIDS	GUID string	EmptyGuid	Persisted database connection reference.
DBConName	String	''	Display name for the linked DB connection. Loaded resets default module names _Data and _Config for default GUIDs.

Default Database Connections

TvxDBCon.CreateDefaultDBConnection creates two special connections if absent:

Module	FID	Purpose	Source
_Data	DefaultModuleGuid	Points to active data database from Connections.json.	TvxDBCon.LoadDefaultConfig
_Config	DefaultModuleGuid2	Points to active configuration database from Connections.json.	TvxDBCon.LoadDefaultConfig

File Connection Module Identity

Setting	Valid values	Default	Impact
Table	Internal string	VX_FILECON	Selects file connection table.
ModuleDescription	Internal string	File Con	Display/module metadata.
ModuleName	String	New File Con	User-visible module name.

File Connection Settings

Setting	Valid values	Default	Impact
FileName	String with tags supported at runtime	''	Output file naming template. <FILENO> and <COUNTER> are supported in ProcessFileName; data and runtime tags are also processed.
FilePattern	File search/pattern string with tags supported	*	Input search pattern and output save-name basis for transports.
FileDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\	Main file directory. Setter updates related default subfolders and enforces trailing delimiter.
AuditDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\AUDIT\	Destination for audited files.
TransportDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\TRANSPORT\	Destination for files awaiting outbound transport.
ErrorDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\ERROR\	Destination for errored files.
IssueDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\ISSUE\	Destination for issue files.
DuplicateDir	Folder path with <DEFAULTDIR> and tags supported	<DefaultDir>\DUPLICATE\	Destination for duplicate files.
TempDir	Folder path with <DEFAULTDIR> and tags supported	Set by SetFileDir to FileDir + TEMP\; not explicitly set in New before setter calls	Temporary file directory.
EnableCounter	Boolean	False	Enables database-backed counter increment for <COUNTER> naming.
UniqueFileName	Boolean	True	Ensures output/moved/copied file names are made unique rather than overwritten.
EnsureSafeFileName	Boolean	True	Applies MakeSafeFilename after tag processing for file names.
WaitFor	Integer seconds	30	Wait time for file lock release when reading files.
InboundFileNaming	TvxInboundFileNaming	ffnUseIncoming	Controls how inbound transport downloads choose saved file names.

File Connection Runtime State

The following settings are not published module configuration, but they are important runtime configuration/state.

Setting	Valid values	Default/reset	Impact
CurrentFileName	File path string	'' on reset	Tracks current file being processed.
NewFileName	File name string	'' on reset	One-use override for destination name. Getter clears it.
FilePath	File path string	'' on reset	Explicit file path used by service monitor processing. Getter clears it after use.
FileNo	Integer	1 on reset	Per-run increment used by <FILENO>.
DoMoveToAudit	Boolean	False on reset	Controls post-processing audit move.
DoMoveToTransport	Boolean	False on reset	Controls move to transport folder and disables audit move when set.
DoMoveToError	Boolean	True on reset	Controls move to error folder. Defaults true so errors can move the file.
FileEvent	TvxFileEventType	fetNone on reset	Tracks file event for logs.
DataViewRecordNo	Cardinal	0 on reset	Used when processing data tags into file names.

Default File Connection

TvxFileCon.CreateDefaultFileConnection creates _Default with DefaultModuleGuid when missing. It appends Temp\ to the default FileDir before saving.

System Connection JSON

The system connection JSON schema is documented in System and Runtime Configuration. It maps named configuration keys to active config/log/data database parameter objects.

Persistence Notes

• TvxDBCon.Password stores encrypted values unless loading/reading component data.
• TvxFileCon.BeforeAddModuleEvent and BeforeSaveModuleEvent persist processed folder paths to auxiliary columns.
• TvxFileCon.CheckDirectories creates main, audit, issue, error, duplicate, and temp directories; it intentionally does not create transport folder by default.

Unclear Areas

• UseCCE, MaxTranPerUpdate, and some SQL alias/formatting flags are passed into lower-level database helpers; the exact database-driver-specific effects were not fully traced in this pass.
• SearchADO and SearchODBC appear to be UI/search aids; exact runtime impact is not fully traced here.