Module Configuration

Summary

This page documents configurable Velox modules that are not covered by setup, connections, data definitions, flows, or transports: folders, definition-backed modules, maps, reports, SQL scripts, scriptlets, variable groups, variables, and API catalogs.

Related PKB Documents

• Configuration Reference Index
• Data Definition Configuration
• Flow Configuration
• Transport Configuration
• Module Library
• Feature Inventory

Source Code Locations

• Classes\vxModule.pas:83 - TvxModule base configuration properties.
• Classes\vxDefModule.pas:12 - TvxDefModule.
• Classes\vxFolder.pas:15 - TvxFolder.
• Classes\vxMap.pas:20 - map item classes.
• Classes\vxMap.pas:334 - TvxMap.
• Classes\vxReport.pas:21 - TvxReport.
• Classes\vxSQLScript.pas:11 - TvxSQLScript.
• Classes\vxScriptlet.pas:11 - TvxScriptlet.
• Classes\vxVariableGroup.pas:15 - TvxVariableGroup.
• Classes\vxVariables.pas:9 - TvxVariable.
• Classes\vxAPI.pas:14 - TvxAPIActionItem.
• Classes\vxAPI.pas:63 - TvxAPI.

Important Classes

• TvxModule, TvxModuleTemplate
• TvxDefModule
• TvxFolder
• TvxMap, TvxCustomMapItem, TvxViewMap, TvxFieldMap
• TvxReport
• TvxSQLScript
• TvxScriptlet
• TvxVariableGroup, TvxVariable
• TvxAPI, TvxAPIActionItem

Important Forms

• TSetupFolder
• TSetupMaps, TSetupMapDesign
• TSetupReports
• TSetupSQLScript
• TSetupScriptlet
• TSetupVariableGroup
• TSetupAPI

Important Services

• VeloxService loads maps, reports, SQL scripts, scriptlets, variables, and folders during flow execution.
• VeloxAPIService loads API catalogs and REST flow definitions.

Related Configuration

• Database tables: VX_FOLDER, VX_MAP, VX_REPORT, VX_SQLSCRIPT, VX_SCRIPTLET, VX_VARIABLE, VX_API.
• Component/module template streaming through TvxModuleTemplate.

Base Module Settings

Every TvxModule descendant inherits the following published properties.

Setting	Valid values	Default	Impact
FIDS	GUID string	New GUID created by module logic unless overridden	Persisted module identity.
FolderFIDS	GUID string	EmptyGuid unless assigned	Parent folder relationship.
ModuleName	String	Module-specific default such as New Map	User-visible name.
FolderName	String	'' by field default	Parent/display folder name.
Version	Double	Default not explicitly visible in inspected excerpt	Module version used by upgrade/load logic.
VxVersion	Double	Default not explicitly visible in inspected excerpt	Velox version marker.
ProdRevision	Integer	0 by field default	Production revision number.
TestRevision	Integer	0 by field default	Test revision number.
Active	Boolean	False by field default unless module-specific code changes it	Enables or disables module use.
CreatedDate	TDateTime	Set by create/save logic; exact default not fully traced here	Creation timestamp.
UpdatedDate	TDateTime	Set by save logic; exact default not fully traced here	Update timestamp.
ModuleNotes	TStringList inherited from TvxLogRelative	Empty list	Notes attached to a module or child object.

Definition-Backed Module Settings

TvxDefModule is the base for maps and reports.

Setting	Valid values	Default	Impact
SourceType	TvxDefinitionType	fstDatabase	Source definition type. Legacy fstJSON is migrated to fstFile during transfer.
SourceFIDS	GUID string	EmptyGuid	Source data definition reference.
DestType	TvxDefinitionType	fstDatabase	Destination definition type. Legacy fstJSON is migrated to fstFile during transfer.
DestFIDS	GUID string	EmptyGuid	Destination data definition reference.

Folder Settings

Setting	Valid values	Default	Impact
Table	Internal string	VX_FOLDER	Selects folder table.
ModuleDescription	Internal string	Folder	Display/module metadata.
ModuleName	String	New Folder	Folder name.
ModuleMask	TvxModuleTypeSet	[fmtFolder, fmtFileCon, fmtDBDef, fmtFileDef, fmtInboundTransport, fmtOutboundTransport, fmtReport, fmtSQLScript, fmtScriptlet, fmtMap, fmtFlow]	Controls module types allowed/displayed under the folder.

Map Settings

Map Module

Setting	Valid values	Default	Impact
Table	Internal string	VX_MAP	Selects map table.
ModuleDescription	Internal string	Map	Display/module metadata.
ModuleName	String	New Map	User-visible map name.
SourceType, SourceFIDS, DestType, DestFIDS	See definition-backed module settings	See definition-backed module settings	Links map source and destination data definitions.
Initialised	Boolean	False	Indicates map initialization status.
GlobalScript	TStringList	Empty list	Global map script.
SaveData	Boolean, public not published	True	Controls whether map saves destination data.
IgnoreEmptySourceData	Boolean, public not published	Not explicitly assigned in TvxMap.New; Delphi field default is False	Allows mapping even when source data is empty.
UseXSINilForNulls	Boolean, public not published	False	XML nil behaviour in mapping.

Map Event Item Settings

TvxCustomMapItem is the base for view and field map script events.

Setting	Valid values	Default	Impact
Description	String	'' by field default	Item description/name.
BeforeMapFormula	TStrings	Empty list	Script run before map event.
OnMapFormula	TStrings	Empty list	Main map script.
AfterMapFormula	TStrings	Empty list	Script run after map event.
LinkedDataFormula	TStrings	Empty list	Script for linked data event.
AfterDetailMapFormula	TStrings	Empty list	Script after detail map.
OnStartMapFormula	TStrings	Empty list	Script at map start.
OnEndMapFormula	TStrings	Empty list	Script at map end.
CompiledStatus	Integer	0	Compile status for map item scripts.
LastPosition	Integer	1	Last editor position.

Field Map Settings

Setting	Valid values	Default	Impact
FieldName	String	Derived from data field when created; otherwise '' by field default	Destination/source field mapped by this item.
VxFieldType	TvxFieldType	Derived from RTTI/default enum value during construction	Field type metadata.

TvxViewMap has no additional published settings in the inspected source; it owns field map children and runtime view/link state.

Report Settings

Setting	Valid values	Default	Impact
Table	Internal string	VX_REPORT	Selects report table.
ModuleDescription	Internal string	Report	Display/module metadata.
ModuleName	String	New Report	User-visible report name.
SourceType, SourceFIDS	See definition-backed module settings	fstDatabase, EmptyGuid	Links report source data definition.
NoDataPrint	Boolean	True	Allows printing/output with no source data.
SplitReport	Boolean	False	Splits report output. Exact split mechanism is in report execution code.
IgnoreReportErrors	Boolean	False	Allows report errors to be ignored.
EmbedFontsPDF	Boolean	False	When enabled, code sets ReportBuilder PDF embed font options to all/subset.

SafeReportProcessing is copied from gSetup.SafeReportProcessing into runtime report state and is not a published report property.

SQL Script Settings

Setting	Valid values	Default	Impact
Table	Internal string	VX_SQLSCRIPT	Selects SQL script table.
ModuleDescription	Internal string	SQL Script	Display/module metadata.
ModuleName	String	New SQL Script	User-visible script name.
Script	TStringList	Empty list	SQL script text.
DBConFIDS	GUID string	EmptyGuid	Database connection used by the SQL script.
LastPosition	Integer	1	Last editor position.

Default SQL scripts may be created with names _Site Settings and _Override; _Site Settings points to _Data by assigning DefaultModuleGuid.

Scriptlet Settings

Setting	Valid values	Default	Impact
Table	Internal string	VX_SCRIPTLET	Selects scriptlet table.
ModuleDescription	Internal string	Scriptlet	Display/module metadata.
ModuleName	String	New Scriptlet	User-visible scriptlet name.
Script	TStringList	Empty list	Scriptlet code.
LastPosition	Integer	1	Last editor position.

Default scriptlets may be created with names _Common and _Override.

Variable Group and Variable Settings

Variable Group

Setting	Valid values	Default	Impact
Table	Internal string	VX_VARIABLE	Selects variable table.
ModuleDescription	Internal string	Variable Group	Display/module metadata.
ModuleName	String	New Variable Group	User-visible variable group name.

TvxVariableGroup stores variables as child objects. It has no additional published properties in the inspected source beyond inherited module properties.

Variable

Setting	Valid values	Default	Impact
Code	String	''	Variable code/key.
Value	Variant; encrypted when Encrypted=True for strings	null	Variable value. Getter decrypts encrypted string values.
ItemName	String	''	Display name.
OperatorString	String	=	Operator used for parameter/filter contexts.
ParamType	TFieldType	ftString	Data type for value validation/conversion.
Encrypted	Boolean	False	Encrypts string values when set through the property.

ValidateValue is public runtime behaviour, not published. It defaults True except for variable lists whose owner is TvxVariableList, where comments say globals/locals cannot validate because param type may not be set.

API Catalog Settings

API Module

Setting	Valid values	Default	Impact
Table	Internal string	VX_API	Selects API table.
ModuleDescription	Internal string	API	Display/module metadata.
ModuleName	String	New API	User-visible API name.
Version	String	v1.0	API version placed into generated OpenAPI document.
APIDescription	TStrings	Empty list	API-level description.
GroupDescription	TStrings	Empty list	Group description text.
ProdURL	String	''	Production server URL for OpenAPI/catalog.
ProdURLDescription	String	Production URL	Production URL description.
TestURL	String	''	Test/development server URL for OpenAPI/catalog.
TestURLDescription	String	Development URL	Test/development URL description.
Groups	String	''	API grouping/category text.
Terms	String	''	Terms of service text/URL.
ContactName	String	''	API contact name.
ContactUrl	String	''	API contact URL.
ContactEmail	String	''	API contact email.
LicenseName	String	''	API license name.
LicenseUrl	String	''	API license URL.
DocumentationUrl	String	''	External documentation URL.
OpenAPISchema	TStrings	Empty list	OpenAPI schema text/cache.

API Action Item

Setting	Valid values	Default	Impact
APIFIDS	GUID string	EmptyGuid	Parent API reference.
ActionFIDS	GUID string	EmptyGuid	Flow/action reference exposed by API.
ActionName	String	'' by field default	Display name for linked action.
Active	Boolean	True	Enables API action item.
CreatedDate	TDateTime	Now at constructor	Creation timestamp.
UpdatedDate	TDateTime	Not explicitly assigned in constructor; Delphi date/time default is 0 until updated	Update timestamp.

Persistence Notes

• TvxDefModule saves source/destination relationships as module relations.
• TvxMap.BeforeAddModuleEvent/BeforeSaveModuleEvent persist source/destination FIDs and types into auxiliary columns.
• TvxVariable.Value encrypts only string values when Encrypted is true.
• TvxAPI constructs an OpenAPI document using TOpenAPIDocument version v304.

Unclear Areas

• Full semantics of map CompiledStatus and all script status integer values are not defined by an enum in the inspected source.
• TvxVariableGroup itself has no published properties beyond inherited module metadata; variables are persisted as children, but the exact database child serialization layout is handled by module streaming.