Skip to main content

Setup

Setup: TvxSetup

Example

procedure ScriptEvent(var Value: variant);
begin
Value := Setup.VeloxWebUrl;
end;

Usage

Setup provides the currently loaded General Setup values that Velox exposes to scripts.

Changing values

Changing a property changes the shared value immediately but does not save General Setup. The change can affect other flows in the same Velox process and can be lost when configuration is reloaded. Treat these properties as read-only in normal scripts and make durable changes through the governed General Setup process.

EmailBody is a live list. Changing its lines changes the value seen by other work using the same setup. Avoid editing it while other actions can be using it; assign a complete intended value through a governed configuration change instead.

Additional available members are documented under TvxSetup. Some can query, save, log or change configuration; use only the member needed for the documented flow.

Additional Technical Info

Setup is the current process-global TvxSetup General Setup module.

Velox always declares the variable, then binds it to gSetup only when that global is assigned. Normal successful compilation already assumes gSetup is available because constant registration unconditionally locks it; the conditional runtime binding mainly protects abnormal lifecycle/reference contexts. The instance is host-owned; never replace or free it.

Properties registered for scripts

PropertyScript accessMeaning
FromEmail, FromDisplayName, AdminEmail, NotifyEmailread/writeemail identity/recipients
EmailBodyread/write TStringListshared email body list
SMTPServerread/writeSMTP host text
VeloxAPIDomain, VeloxAPIPortread/writeAPI endpoint parts
VeloxAPIUrlread-onlycomputed http/https URL from Setup SSL/domain/port
VeloxWebDomain, VeloxWebPortread/writeWeb endpoint parts
VeloxWebUrlread-onlycomputed HTTPS URL with trailing slash
VeloxWebInstallPathunusableproduct property is string, compile import incorrectly declares integer, and runtime import registers no property helper
EnableLogUserReportingread/writelive reporting flag
DefaultFilePathread/writeshared default path; non-empty assignments gain a trailing delimiter

Do not access VeloxWebInstallPath from PascalScript until both the compile-time type and missing runtime registration are corrected in the product.

Created 2026-07-19