Transport Configuration

Summary

This page documents Velox transport configuration. TvxTransport provides shared host, authentication, OAuth, TLS, key, timeout, logging, and runtime state. Protocol descendants add FTP, SFTP, LAN, HTTP, IMAP, POP, SMTP, MSMQ, and IBM MQ settings. fptAS2 exists in the shared enum, but no AS2 transport class was found in Classes\Transports during this pass.

Related PKB Documents

• Configuration Reference Index
• Connection Configuration
• Flow Configuration
• General Setup Configuration
• Data Format Reference
• Module Library

Source Code Locations

• Classes\Transports\vxTransport.pas:42 - base TvxTransport.
• Classes\Transports\vxTransport.pas:476 - base transport defaults.
• Classes\Transports\vxTransportFTP.pas:23 - FTP base settings.
• Classes\Transports\vxTransportFTPIn.pas:22 - FTP inbound settings.
• Classes\Transports\vxTransportFTPOut.pas:22 - FTP outbound settings.
• Classes\Transports\vxTransportSFTP.pas:40 - SFTP base settings.
• Classes\Transports\vxTransportSFTPIn.pas:33 - SFTP inbound settings.
• Classes\Transports\vxTransportSFTPOut.pas:30 - SFTP outbound settings.
• Classes\Transports\vxTransportLAN.pas:23 - LAN base settings.
• Classes\Transports\vxTransportLANIn.pas:25 - LAN inbound settings.
• Classes\Transports\vxTransportLANOut.pas:20 - LAN outbound settings.
• Classes\Transports\vxTransportHTTP.pas:22 - HTTP base settings.
• Classes\Transports\vxTransportHTTPIn.pas:22 - HTTP inbound settings.
• Classes\Transports\vxTransportHTTPOut.pas:20 - HTTP outbound settings.
• Classes\Transports\vxTransportIMAP.pas:35 - IMAP inbound settings.
• Classes\Transports\vxTransportPOP.pas:35 - POP inbound settings.
• Classes\Transports\vxTransportSMTP.pas:35 - SMTP outbound settings.
• Classes\Transports\vxTransportMSMQ.pas:21 - MSMQ base settings.
• Classes\Transports\vxTransportMSMQIn.pas:20 - MSMQ inbound settings.
• Classes\Transports\vxTransportMSMQOut.pas:23 - MSMQ outbound settings.
• Classes\Transports\vxTransportIBMMQ.pas:21 - IBM MQ base settings.
• Classes\Transports\vxTransportIBMMQIn.pas:20 - IBM MQ inbound settings.
• Classes\Transports\vxTransportIBMMQOut.pas:20 - IBM MQ outbound settings.
• Forms\Transports\frmTransport*.pas - transport setup forms.

Important Classes

• TvxTransport
• TvxTransportLink
• TvxTransportFTP, TvxTransportFTPIn, TvxTransportFTPOut
• TvxTransportSFTP, TvxTransportSFTPIn, TvxTransportSFTPOut
• TvxTransportLAN, TvxTransportLANIn, TvxTransportLANOut
• TvxTransportHTTP, TvxTransportHTTPIn, TvxTransportHTTPOut
• TvxTransportIMAP, TvxTransportPOP, TvxTransportSMTP
• TvxTransportMSMQ, TvxTransportMSMQIn, TvxTransportMSMQOut
• TvxTransportIBMMQ, TvxTransportIBMMQIn, TvxTransportIBMMQOut

Important Forms

• TfrmTransportFTPIn, TfrmTransportFTPOut
• TfrmTransportSFTPIn, TfrmTransportSFTPOut
• TfrmTransportLANIn, TfrmTransportLANOut
• TfrmTransportHTTPIn, TfrmTransportHTTPOut
• TfrmTransportIMAP, TfrmTransportPOP, TfrmTransportSMTP
• TfrmTransportMSMQIn, TfrmTransportMSMQOut
• TfrmTransportIBMMQIn, TfrmTransportIBMMQOut
• TManageTransports, TManageTransportLogs
• TSSLSettings

Important Services

• VeloxService executes inbound/outbound transports and persists transport logs.
• VeloxAPIService can execute REST flows that use HTTP/API transport behaviour through flow configuration.

Related Configuration

• Database table: VX_TRANSPORT.
• Transport logs: VX_LOG_TRANSPORT and related link tables in TvxLogTransport.
• File connections and file definitions are assigned at runtime from flows/data definitions.
• Transport retry settings also depend on TvxSetup.TransportMaxAttempts and TvxSetup.TransportAttemptInterval.

Base Transport Identity

Setting	Valid values	Default	Impact
Table	Internal string	VX_TRANSPORT	Selects transport table.
ModuleDescription	Protocol-specific	Set by descendant, for example FTP In	Display/module metadata.
ModuleName	String	New {ModuleDescription} by descendant	User-visible transport name.

Base Transport Connection and Auth Settings

Setting	Valid values	Default	Impact
Host	String with tags processed at runtime	''	Host, URL, or server depending on protocol.
Port	Integer	0; protocol descendants override (21, 22, 110, etc.)	Network port.
AuthType	TvxAuthType	fatNone	Authentication mode.
InProcessAuth	Boolean	False	Indicates auth should occur in process. Exact call sites are protocol-specific.
Username	String with tags processed at runtime	''	User/login name.
Password	Encrypted persisted string; runtime getter decrypts and tags are processed	''	Password/token/secret depending on auth type.
ClientId	String	Not explicitly assigned in TvxTransport.New; Delphi string default is ''	OAuth client id.
Tenant	String	Not explicitly assigned in TvxTransport.New; Delphi string default is ''	OAuth tenant.
Scope	String	Not explicitly assigned in TvxTransport.New; Delphi string default is ''	OAuth scope.
AuthURL	String	Not explicitly assigned in TvxTransport.New; Delphi string default is ''	OAuth authorization URL.
TokenURL	String	Not explicitly assigned in TvxTransport.New; Delphi string default is ''	OAuth token URL.
Direction	TvxDirectionType	tdInbound; descendants override getter where needed	Inbound/outbound classification used by import, UI, service, and log descriptions.

Base Transport SSL, TLS, and Key Settings

Setting	Valid values	Default	Impact
SSLRootCertificate	File path/string	''	Root certificate file/reference.
SSLClientCertFile	File path/string	''	Client certificate file.
SSLClientKeyFile	File path/string	''	Client key file.
SSLClientKeyPassword	Encrypted persisted string; runtime getter decrypts	''	Client key password.
SSLClientType	TvxSSLClientType	fstAuto; FTP overrides to fstNoSSL	SSL/TLS version. Old aliases migrate during transfer.
SSLCertDepth	Integer	3	Certificate verification depth.
SSLVerifyPeer	Boolean	True	Enables peer certificate verification.
SSLFailNoPeer	Boolean	True	Fails when no peer certificate is supplied where required.
SSLVerifyOnce	Boolean	True	Verifies peer once per connection/session.
SSLTLSType	TvxTLSType	fttImplicitTLS	TLS mode.
PrivateKey	String	''	Private key content/reference used by SFTP/OAuth/key auth paths.
PrivateKeyType	TScAsymmetricAlgorithm, public runtime setting	aaEC	Private key generation algorithm. Not published in TvxTransport.
PrivateKeySize	Integer, public runtime setting	2048	Private key generation size. Not published.
ECName	TScECName, public runtime setting	x25519	Elliptic curve name for key generation. Not published.
PublicKeyFile, PublicKeyFile2, PrivateKeyFile, PrivateKeyFile2	File names, public runtime settings	Derived from generated key name	Public/private key file names in app data certificate folders.

Base Transport Timeout Settings

Setting	Valid values	Default	Impact
ConnectTimeOut	Integer	15	Connect timeout. HTTP code passes it to TvxHTTP.ConnectTimeout; property setter there multiplies by 1000.
ReadTimeOut	Integer	0; MSMQ inbound overrides to 1	Read timeout. Protocol-specific units depend on target library.

Base Transport Runtime Settings

These are public runtime settings, not all persisted as transport module properties.

Setting	Valid values	Default/reset	Impact
FileDef	TvxFileDef reference	Assigned by flow/runtime	File definition used by transport.
FileCon	TvxFileCon reference	Created/assigned by runtime	File connection used for file read/write locations.
Locals	TvxThreadList	Assigned by flow/runtime	Runtime variables/tags.
TagData	TStringList	Created in constructor	Data/local tags saved into transport log for later outbound sends.
CurrentFilename	String	'' on reset	Current file being transported.
LogTransport, LogFile	Log object references	Assigned by runtime	Transport and file log linkage.
ActionFID, ActionName	Flow reference values	Assigned by flow/runtime	Links logs and notifications to the flow.
AdminEmail, NotifyEmail	Strings	Assigned from flow/runtime	Notification recipients.
SaveLogStatuses, SendLogStatuses	TvxLogStatusTypeSet	Assigned from flow/runtime	Controls log save/send behaviour.
LogHTTPComms, LogTransportComms	Boolean	Assigned from flow/runtime	Controls comms logging.
Intercept	TvxIntercept	Created lazily	Captures protocol traffic where supported.

Transport Link Settings

TvxTransportLink links inbound transports to flows.

Setting	Valid values	Default	Impact
TransportFIDS	GUID string	EmptyGuid	Linked transport module.
TransportName	String	''	Display name of linked transport.
TransportClass	Registered class name	''	Transport class used to instantiate the linked transport.

FTP Settings

FTP Base

Setting	Valid values	Default	Impact
Port	Integer	21	FTP/FTPS port.
SSLClientType	TvxSSLClientType	fstNoSSL	FTP defaults to no SSL.
Path	Remote path string	''	Remote directory; normalized with web path delimiter before save.
TransferType	TIdFTPTransferType: ftASCII, ftBinary	ftBinary	FTP transfer mode.
ProtectDataPort	Boolean	True	FTPS data port protection.
UseCCC	Boolean	False	Clear Command Channel option for FTPS.
UsePassive	Boolean	True	Passive FTP mode.
MoveToFolderName	Remote path string	''	Destination for move-after-receive/send operations; normalized before save.
ControlTimeOut	Integer	15	FTP control timeout.
TransferTimeOut	Integer	0	FTP transfer timeout.

FTP In

Setting	Valid values	Default	Impact
AfterReceiving	TvxFTPAfterReceivingType	barDelete	Deletes, leaves, or moves remote file after download.
UseLIST	Boolean	False	Uses FTP LIST behaviour for file listing where implemented.

FTP Out

Setting	Valid values	Default	Impact
AfterSendingMove	Boolean	False	Moves remote file after send when enabled.
AfterSendingIndicator	Boolean	False	Creates/sends indicator file after upload.
IndicatorFileName	String	''	Indicator file name; tags may be processed in send logic.
UseTemporaryFileName	Boolean	False	Sends using temporary file name before final name.

SFTP Settings

SFTP Base

Setting	Valid values	Default	Impact
Port	Integer	22	SFTP/SSH port.
Path	Remote path string	''	Remote directory; normalized with web path delimiter before save.
MoveToFolderName	Remote path string	''	Destination for move-after-receive/send operations.
SFTPVersion	TScSFTPVersion; display strings include Auto and SFTP v1-v6	vSFTP0 (Auto)	SFTP protocol version negotiation preference.
SFTPAuthType	TvxSFTPAuthType	fsaPassword	Password vs private key auth.
ControlTimeOut	Integer	15	SFTP/SSH control timeout.
TransferTimeOut	Integer	0	SFTP transfer timeout.

SFTP In

Setting	Valid values	Default	Impact
AfterReceiving	TvxSFTPAfterReceivingType	basfDelete	Deletes, leaves, or moves remote file after download.

SFTP Out

Setting	Valid values	Default	Impact
AfterSendingMove	Boolean	False	Moves remote file after send when enabled.
AfterSendingIndicator	Boolean	False	Creates/sends indicator file after upload.
IndicatorFileName	String	''	Indicator file name.
UseTemporaryFileName	Boolean	False	Sends using temporary file name before final name.

LAN Settings

LAN Base

Setting	Valid values	Default	Impact
UNCPath	Folder/UNC path with <DEFAULTDIR> and tags supported	Not explicitly assigned in TvxTransportLAN.New; Delphi string default is ''	Local/network folder used by LAN transport. Normalized before save.

LAN In

Setting	Valid values	Default	Impact
AfterReceiving	TvxLANAfterReceivingType	balaDelete	Deletes or leaves file in folder after copy/download.
WaitFor	Integer	0	Wait setting used by LAN inbound file handling. Exact unit is not explicit in this class.

LAN Out

TvxTransportLANOut adds no published settings beyond LAN base and TvxTransport.

HTTP Settings

HTTP Base

Setting	Valid values	Default	Impact
Headers	TStrings; code treats names as header names and values/content metadata depending on path	Empty list	Custom HTTP headers; values are tag-processed before send/receive.
FollowLocation	Boolean	True	Comment says "not currently used"; InitialiseHTTP has assignment commented out.
HandleRedirects	Boolean	True	Controls redirect handling in HTTP client where supported.
ProtocolVersion	TIdHTTPProtocolVersion: pv1_0, pv1_1	pv1_1	HTTP protocol version.

HTTP In

Setting	Valid values	Default	Impact
AfterReceiving	TvxHTTPAfterReceivingType	bahtNothing	HTTP inbound post-receive behaviour; enum currently only has bahtNothing.
ReceiveMethod	TvxHTTPReceiveMethodType	brmGet	HTTP method used to receive/download.

HTTP Out

Setting	Valid values	Default	Impact
SendMethod	TvxHTTPSendMethodType	bsmPost	HTTP method used to upload/send.
FormEncoding	TvxHTTPFormEncodingType	feNone	Controls body/form encoding.
ContentFieldName	String	file	Multipart/form file field name; code falls back to file if blank.

Email and Mailbox Transport Settings

IMAP In

Setting	Valid values	Default	Impact
Port	Integer	Not explicitly assigned in TvxTransportIMAP.New; base default 0 remains unless UI/runtime sets it	IMAP server port.
Mailbox	String	''	IMAP mailbox/folder.
AfterReceiving	TvxIMAPAfterReceivingType	baimDelete	Marks read, moves, deletes, or does nothing after download.
MoveToMailBox	String	''	Mailbox used when AfterReceiving = baimMove.
UseSASL	Boolean	False	Enables SASL auth path.
FromEmail	String	Not explicitly assigned in New; Delphi default is ''	Email sender filter.
ToEmail	String	Not explicitly assigned in New; Delphi default is ''	Email recipient filter.

POP In

Setting	Valid values	Default	Impact
Port	Integer	110	POP server port.
AfterReceiving	TvxPOPAfterReceivingType	bapoDelete	Deletes or leaves mail on server after download.
UseSASL	Boolean	False	Enables SASL auth path.

SMTP Out

Setting	Valid values	Default	Impact
ToEmail	String with tags	''	Message recipients.
CcEmail	String with tags	''	CC recipients.
BccEmail	String with tags	''	BCC recipients.
Subject	String with tags	''	Message subject.
ReadReceipt	Boolean	False	Requests read receipt.
LoadAttachmentToBody	Boolean	False	Loads attachment content into text body.
LoadAttachmentToHTMLBody	Boolean	False	Loads attachment content into HTML body.
BodyText	String	''	Text body.
BodyHTML	String	''	HTML body.

MSMQ Settings

MSMQ Base

Setting	Valid values	Default	Impact
Visibility	TvxMSMQVisibilityType	fqvPrivate	Private vs public queue format.
QueueName	String	''	Queue name.
DeliveryType	TvxMSMQDeliveryType	fdtExpress	MSMQ delivery mode.
UseTransaction	Boolean	False	Uses MSMQ transactions.
UseDirectFormatName	Boolean	False	Uses direct format names.
DirectFormatType	TvxMSMQDirectFormatType	fdfOS	Direct format type.
Authenticate	Boolean	False	MSMQ authentication flag.

MSMQ In

Setting	Valid values	Default	Impact
AfterReceiving	TvxMSMQAfterReceivingType	bamsNothing	Post-receive behaviour; enum currently only has bamsNothing.
ReadTimeOut	Integer	1	Receive timeout. Code comment says future 0 may mean unlimited and allow monitor trigger behaviour.

MSMQ Out

TvxTransportMSMQOut adds no published settings beyond MSMQ base and TvxTransport.

IBM MQ Settings

IBM MQ Base

Setting	Valid values	Default	Impact
ConnectionManager	String	''	IBM MQ connection manager.
QueueName	String	''	Queue name.
ChannelName	String	''	Channel name.

IBM MQ In

Setting	Valid values	Default	Impact
AfterReceiving	TvxIBMMQAfterReceivingType	baibNothing	Post-receive behaviour; enum currently only has baibNothing.
ReceiveBufferLength	Integer	32768	Buffer size for receiving message data.

IBM MQ Out

TvxTransportIBMMQOut adds no published settings beyond IBM MQ base and TvxTransport.

AS2 Status

TvxTransportType includes fptAS2, and display strings include AS2. No vxTransportAS2*.pas class was found under Classes\Transports during this pass, and no AS2 setup form was found under Forms\Transports. Behaviour and settings are therefore unclear from the current inspected source.

Persistence Notes

• TvxTransport.BeforeAddModuleEvent and BeforeSaveModuleEvent persist derived DIRECTION and DESCRIPTION columns.
• FTP and SFTP path fields are normalized before save rather than in setters so the Designer edit controls do not change while the user is editing.
• Password and SSL client key password are encrypted on assignment outside component loading.
• OAuth configuration calls FOAuthAuthenticator.Configure with auth type, tenant, client id, password/private key/scope, auth URL, token URL, and protocol scope.

Unclear Areas

• Some timeout units depend on third-party protocol libraries and are not explicitly documented in the inspected classes.
• FollowLocation is a published HTTP setting, but source comments and commented-out assignment indicate it is not currently implemented.
• InProcessAuth is persisted on all transports, but exact protocol-specific behaviour was not fully traced in this pass.