Flow Configuration

Summary

This page documents configuration for Velox flows (TvxActionMan) and flow action items. Flows define scheduling, monitoring, REST endpoints, retry behaviour, logging, notification routing, and ordered execution steps such as maps, reports, outbound transports, SQL, shell commands, sub-flows, file routing, and custom scripts.

Related PKB Documents

• Configuration Reference Index
• Data Definition Configuration
• Transport Configuration
• Module Configuration
• Architecture
• Domain Model

Source Code Locations

• Classes\vxActionMan.pas:22 - TvxActionItem base class.
• Classes\vxActionMan.pas:299 - TvxActionMan.
• Classes\vxActionMan.pas:1494 - TvxActionMan.New defaults.
• Classes\vxActionMan.pas:793 - TvxActionReport.
• Classes\vxActionMan.pas:3230 - TvxActionShellExecute.
• Classes\vxActionMan.pas:3404 - TvxActionTransport.
• Classes\vxActionMan.pas:3599 - TvxActionSQL.
• Classes\vxActionMan.pas:3678 - TvxActionFileRouter.
• Classes\vxActionMan.pas:3821 - TvxActionSubAction.
• Classes\vxActionMan.pas:3921 - TvxActionCustomScript.
• Classes\vxActionMan.pas:4061 - TvxActionAPI source-visible subclass. No current class registration or main flow setup creation path was confirmed.
• Classes\vxRouteItem.pas:8 - file route item.
• Classes\vxScriptItem.pas:9 - script item.
• Forms\frmSetupActions.pas:25 - flow setup form.

Important Classes

• TvxActionMan
• TvxActionItem
• TvxActionMap, TvxActionReport, TvxActionTransport, TvxActionShellExecute, TvxActionSQL, TvxActionFileRouter, TvxActionSubAction, TvxActionCustomScript
• TvxActionAPI as a source-visible transport-derived subclass whose active product availability was not confirmed
• TvxRouteItem
• TvxScriptItem
• TvxTransportLink

Important Forms

• TSetupActions
• TManageActions
• TViewProcesses
• TSetupMapDesign
• TScriptEditor

Important Services

• VeloxService executes scheduled, monitored, manual, linked, and transport-related flows.
• VeloxAPIService executes REST flows and API-linked flows.

Related Configuration

• Database table: VX_ACTION.
• Child objects: TvxActionItem, TvxDefManager, TvxTransportLink, TvxScriptItem, TvxRouteItem.
• Shared enum values: TvxExecutionType, TvxSchedulePeriod, TvxRepeatOccurrence, TvxActionType, TvxHTTPMethod, TvxLogStatusTypeSet.

Flow Module Identity

Setting	Valid values	Default	Impact
Table	Internal string	VX_ACTION	Selects flow database table.
ModuleDescription	Internal string	Flow	Display/module metadata.
ModuleName	String	New Flow	User-visible flow name.

Schedule and Execution Settings

Setting	Valid values	Default	Impact
ScheduleType	TvxExecutionType	fstNone	Determines manual, scheduled, monitor, REST, or linked flow execution mode.
SchedulePeriod	TvxSchedulePeriod	fspDaily	Daily/weekly/monthly schedule grouping.
RunOnceImmediately	Boolean	False	Runs once immediately when schedule starts.
RepeatInterval	Integer	10	Interval amount for recurring execution. Source comment says "number of seconds etc"; effective unit depends on RepeatPeriod.
RepeatPeriod	TvxRepeatOccurrence	frtMinutes	Unit for repeat interval.
DayInterval	Integer	1	Day interval for daily schedules.
MonthDay	Integer	1	Day of month for monthly schedules.
EnableReoccurring	Boolean	False	Enables repeat/recurring execution.
StartTime	TDateTime time value	12:01:00 AM	Schedule start time.
EndTime	TDateTime	Not explicitly assigned in New; Delphi date/time default is 0	Schedule end time.
WeekDays	TvxDays set	Monday through Friday	Days used by weekly schedules.
FileMonitor	TvxDefItem child reference	nil	Definition/file source monitored for incoming files.
IgnoreCancel	Boolean	False	Allows execution to ignore cancellation in relevant paths.
ReprocessUntilError	Boolean	False	Reprocesses until error condition. Exact loop enforcement is in execution code.
MaxThreadsPerAction	Integer	1	Maximum concurrent threads per flow.
LinkedActionFIDS	GUID string	EmptyGuid	Linked flow reference.
LinkedActionOrder	Integer	1	Execution order for linked flows.

Retry Settings

Setting	Valid values	Default	Impact
AutoRetry	Boolean	False	Enables automatic retry.
AutoRetryCount	Integer	3	Number of retry attempts.
AutoRetryWaitSeconds	Integer	5	Wait between retries in seconds, per property name.

REST/API Settings

Setting	Valid values	Default	Impact
RESTMethod	TvxHTTPMethod	hmGet	HTTP method for REST-triggered flow.
RESTEndpoint	String; setter prepends / when missing	''; BeforeAdd can set /api/{FID}	REST route endpoint.
RESTGroups	String	''	API group tags/categories.
RESTSummary	String	''	OpenAPI/API summary.
RESTDescription	TStrings	Empty list	REST/OpenAPI description.
RESTDocumentation	String	''	Documentation text/reference.
RESTParams	TStrings	Empty list	REST parameter metadata.
RESTSuccessResult	Integer HTTP status	200	HTTP status for successful response.
RESTClientErrorResult	Integer HTTP status	400	HTTP status for client errors.
RESTServerErrorResult	Integer HTTP status	500	HTTP status for server errors.
RESTAllowAnonymous	Boolean	False	Allows anonymous REST execution.
RequestDef	TvxDefItem child reference	nil	Request data definition.
ResponseDef	TvxDefItem child reference	nil	Response data definition.

Logging and Notification Settings

Setting	Valid values	Default	Impact
SaveLogStatuses	TvxLogStatusTypeSet	[flsOK, flsWarning, flsIssue, flsDuplicate, flsError]	Log statuses saved for flow results.
SendLogStatuses	TvxLogStatusTypeSet	[flsWarning, flsIssue, flsDuplicate, flsError]	Log statuses that send notifications.
UseDefaultEmail	Boolean	True	Uses default setup email recipients when flow-specific recipients are blank.
AdminEmail	String; getter falls back to setup admin email when blank	''	Flow-specific admin notification target.
NotifyEmail	String; getter falls back to setup notify email when blank	''	Flow-specific notify target.
LogSQL	Boolean	True	Logs SQL.
LogHTTPComms	Boolean	True	Logs HTTP communication details.
LogFileData	Boolean	False	Controls whether file data is stored in logs.
LogTransportComms	Boolean	True	Logs transport communication details.

Flow Runtime Flags

These are public properties used by execution/script/API runtime. Some are persisted through published properties, others are runtime only.

Setting	Valid values	Default	Impact
REST	Boolean	False	Indicates execution through REST call. Not reset in New if caller already assigned it.
SubAction	Boolean	False	Indicates loaded as sub-action.
SendEvent, SendIssueEvent, NotifyCompanyEvent, NotifyCompanyIssueEvent, NotifyPartnerEvent, TypeNum, StatusNum, SourceNum, UserNum	Integer flags	-1	Script/API event/status/source/user references.
IsChanged	Boolean	False	Script-set flag indicating the transaction changed.

Action Item Base Settings

Setting	Valid values	Default	Impact
IgnoreEmptySourceData	Boolean	False	Allows action execution when source data is empty.
ActionName	String	New Action; subclasses override	Display name of action step.
ActionType	TvxActionType	fatMap; subclasses override	Step type.
ActionFIDS	GUID string	EmptyGuid	Linked module/flow/transport/action reference.
ItemActive	Boolean	True	Enables/disables the step.
Source	TvxDefItem child object	nil	Source data item.
Dest	TvxDefItem child object	nil	Destination data item.

Action-Specific Settings

Action class	Setting	Valid values	Default	Impact
TvxActionMap	No additional published settings	Uses base settings	ActionName = New Map Action, ActionType = fatMap	Loads and executes a map module.
TvxActionReport	OutputDest	TvxOutputDestType	Not explicitly assigned; enum field default is fdtViewer	Output target: viewer, printer, file, or email.
TvxActionReport	OutputType	TvxOutputType	Not explicitly assigned; enum field default is fotPDF	Report output format/content type.
TvxActionReport	OutputDetails	String with tags	'' by field default	Printer/file/email target depending on OutputDest.
TvxActionReport	FileDetails	String with tags	'' by field default	File-related output detail. Exact format not fully traced here.
TvxActionReport	Attachment	String	'' by field default	Attachment setting.
TvxActionReport	Miscellaneous	String	'' by field default	Miscellaneous report options. Exact semantics not fully traced here.
TvxActionReport	BCCEmail	String	'' by field default	BCC recipients for email output.
TvxActionTransport	TransportClass	Registered transport class name	''; source-visible TvxActionAPI sets TvxTransportHTTPOut if created	Selects outbound transport class for outbound transport action steps.
TvxActionShellExecute	CommandLine	String with tags	'' by field default	Command to run.
TvxActionShellExecute	Username	String	'' by field default	Optional run-as username.
TvxActionShellExecute	Userpass	Encrypted persisted string; runtime getter decrypts	'' by field default	Optional run-as password.
TvxActionShellExecute	Domain	String	'' by field default	Optional run-as domain.
TvxActionShellExecute	Params	String with tags	'' by field default	Command parameters.
TvxActionShellExecute	Delay	Cardinal seconds	0 by field default	Sleeps after command execution when greater than zero.
TvxActionShellExecute	UseShellExecute	Boolean	False by field default	Chooses shell execution path.
TvxActionShellExecute	WaitforProcess	Boolean	False by field default	Waits for process completion.
TvxActionSQL	SQLCommand	String with tags	'' by field default	SQL executed by the action. Blank command is detected and skipped/error-handled in execution code.
TvxActionFileRouter	No direct published settings	Child route items	ActionName = New File Router Action, ActionType = fatFileRouter	Routes files through TvxRouteItem children.
TvxActionSubAction	No additional published settings	Uses base ActionFIDS	ActionName = New Sub Action, ActionType = fatCallAction	Calls another flow.
TvxActionCustomScript	Child TvxScriptItem objects	See script item settings	ActionName = New Custom Script Action, ActionType = fatCustomScript	Executes custom script steps.

Script Item Settings

Setting	Valid values	Default	Impact
ItemName	String	New Script Item	Display name of script item.
Formula	TStrings	Empty list until CreateFormula copies template	Script/formula text.
CompiledStatus	Integer	0	Compile status: code sets 1 compiled, 2 error, and returns 4/5/6 from checks. Full status display mapping is not defined in this unit.

File Route Item Settings

Setting	Valid values	Default	Impact
FileConFIDS	GUID string	EmptyGuid	File connection target for route.
FileConName	String	''	Display name for route file connection.
ItemName	String inherited from TvxScriptItem	<New Route Item>	Route item display name.
Formula	TStrings inherited from TvxScriptItem	Route script template assigned in constructor	Route condition/action script.

Transport Link Settings

Inbound transports linked to a flow use TvxTransportLink; see Transport Configuration.

Persistence Notes

• Flow child actions are component children of TvxActionMan and are persisted through module template streaming.
• Shell action passwords are encrypted on assignment outside component loading.
• RESTEndpoint setter prepends / when a value does not start with /.

Unclear Areas

• Some report action string fields (FileDetails, Attachment, Miscellaneous) are persisted and transferred, but their complete value schema is not fully evident from the inspected source.
• CompiledStatus integer display semantics are partially inferred from code paths; no complete enum was found.