Skip to main content

Environment properties and paths

Velox reads C:\ProgramData\Velox\Config\Connections.json to select a named system connection and its production/test database roles. Treat the file as controlled configuration: it can contain encrypted credential values and a wrong role mapping can direct work to the wrong environment.

Connection fields

JSON fieldRequirement and meaningValidation/runtime effect
KeyUnique name used by Designer/service selection and service -c parameterMust identify the intended profile; missing service key prevents normal startup
DisplayNameNon-empty user-facing nameA blank display name makes the connection invalid
ConfigNumNon-zero configuration numberZero makes the connection invalid
ProdLabel, TestLabelLabels shown for the two contextsMake the environment explicit; do not use a label as proof of database identity
Config, ConfigTestDatabase keys for VxConfig production/testEach must resolve to a Databases entry
Log, LogTestLogical log database keysParsed and retained; reviewed core VX_LOG* persistence currently follows the active configuration connection, so verify the deployed implementation/schema
Data, DataTestVxData database keysEach must resolve to the correct business-data environment

Database profile fields

JSON fieldType/defaultEffect
Keystring / empty before loadLookup key referenced by connection roles
HostTypeDB type / Microsoft SQL Server enum first valueSelects the database engine/provider branch
Host, Databasestring / emptyServer and database/catalog
AuthTypeSQL auth enum / Windows authenticationChooses authentication mode
Username, Passwordstring / empty; password stored encrypted by Velox toolingCredentials for modes that require them; never place plaintext in documentation
Driverstring / empty, uppercased on loadDriver/provider selection input
TrustCertificateBoolean / falseRelaxes certificate trust for applicable SQL connections; use only under an approved security decision

Safe change procedure

  1. Back up the file with access controls that match its sensitivity.
  2. Validate JSON syntax and confirm every referenced database key exists.
  3. Compare actual host/database values, not only ProdLabel and TestLabel.
  4. Test under the interactive and service identities.
  5. Restart processes that loaded the old file and verify the selected key/context before any write or Flow run.

See environment validation before promotion or service start.