Skip to main content

Source_API_String

Source_API_String = 'API'

Example​

procedure ScriptEvent(var Value: variant);
begin
  Value := GetSourceNum(Source_API_String); // 4
end;

Usage​

Source_API_String provides the exact API source-origin text paired with Source_API for Velox transaction provenance fields.

Value

PropertyValue
Script typeString
Text valueAPI
Paired numberSource_API = 4
Database domainSource.Num / Source.Description
Security helper treatmenttreated as a partner source by current helper logic

Additional Technical Info​

Source_API_String is the canonical script-visible String for the API transaction-source category. Its exact value is API, paired with Source_API value 4.

Source_API_String identifies provenance metadata. It does not prove how a request arrived, authenticate a caller, stamp a transaction record or authorise partner/internal processing.

Implementation

Velox declares and registers the exact text API. GetSourceNum compares source text with Delphi SameText and returns 4; GetSourceCode performs the reverse mapping. The String name is not added to the Velox tag map.

Fresh-build VxData seeds Source row 4 with Description API. Numerous transaction headers and operational records expose nullable SourceNum foreign keys to this table.

Behaviour

Text-to-number conversion is fixed in product code and does not query VxData. Text matching is case-insensitive but non-trimming; unsupported text or numbers and a Null number return Null.

IsSourceInternal returns true only for value 1 (App). IsSourcePartner returns the direct negation, so this value is partner-treated. Those helpers choose a security-treatment branch; they do not verify provenance.

Edge cases and quirks

  • IsSourcePartner returns true for every integer other than 1, including unsupported values such as 0 or 99. Validate or convert source input before using that helper as a policy branch.
  • Source_API, Source_Web and Source_EDI are all partner-treated. The category name does not imply a particular authentication strength.
  • The database column is named Description, not Code, even though its seeded text is used as the canonical converter token.
  • PascalScript retains no source-domain type information after an integer or string is evaluated. Values overlap many other constant families.
  • The text converter accepts case differences but not leading/trailing whitespace; an empty or padded token returns Null.
  • The String identifier is not a tag-map entry. Use the paired numeric tag only when an integer expansion is required.
  • A source constant records a category only. It does not inspect transport headers, API credentials, files, user sessions or database provenance.

Side effects

Reading Source_API_String, comparing it or using the fixed converters/helpers has no I/O or state-changing effect. The caller owns any field assignment and validation.

Errors

Reading the constant does not raise an error. Converter misses return Null. Persisting an unsupported source number can fail a SourceNum foreign key; this page's seeded value is valid in a fresh database.

Performance and concurrency

This is an immutable compiled value. Access and fixed-case helper/converter checks are constant-time for practical purposes and carry no shared mutable source state.

Remarks

The example is source-reviewed and non-destructive. It converts a fixed identifier only and does not create or classify a live transaction.

Related entries

Created 2026-07-15