Skip to main content

Type_Agent_String

Type_Agent_String = 'Agent'

Example​

procedure ScriptEvent(var Value: variant);
begin
  Value := GetPartyTypeNum(Type_Agent_String); // 8
end;

Usage​

Type_Agent_String provides the canonical Agent party-role text paired with Type_Agent for Velox party conversion and configuration.

Value

PropertyValue
Script typeString
Text valueAgent
Paired numberType_Agent = 8
Deprecated numeric aliasParty_Agent = 8
Database domainParty_Type.Num; Party.TypeNum
Reference-table helper resultParty_Agent
Issue helper result1035

Additional Technical Info​

Type_Agent_String is the canonical script-visible String for the Agent party role. Its exact value is Agent, paired with Type_Agent value 8.

It identifies a party-role domain value. It does not find or create a party, add a Party_Agent reference row, validate a relationship or grant access to party data.

Implementation

Velox declares and registers exact text Agent. GetPartyTypeNum compares it with Delphi SameText and returns 8; GetPartyTypeCode performs the reverse mapping. The String name is not in the tag map.

Fresh-build VxData seeds Party_Type row 8 as Agent, and Party.TypeNum references that domain. The role-specific reference table is Party_Agent.

GetReferenceTableForPartyType returns fixed text Party_Agent. GetIssueForPartyType returns integer 1035. Their case statements use the numerically identical deprecated Party_Agent label, so this preferred value selects the same branch.

Behaviour

Text-to-number conversion is case-insensitive but non-trimming; unsupported text returns Null. Number-to-text conversion returns Null for a Null or unsupported number.

The reference-table helper returns a name only and does not open a table or dataset. The issue helper returns a number only and does not create, log or persist an issue.

Edge cases and quirks

  • Type_Agent and deprecated Party_Agent are numerically indistinguishable after evaluation. Use the preferred Type_* name in new or revised scripts.
  • Current helpers retain deprecated Party_* labels internally. This does not make the preferred identifier unsupported; the equal integer selects the branch.
  • Party-role values overlap many unrelated numeric families; PascalScript does not retain the role domain.
  • Text conversion accepts case differences but not leading/trailing whitespace.
  • The String identifier is not a tag-map entry.
  • GetIssueForPartyType returns an integer, whereas exposed Ixxxx issue-code constants are strings. Check the receiving API before substituting representations.
  • Unsupported role numbers make the table helper return Unknown and the issue helper return generic fallback 1029.

Side effects

Reading Type_Agent_String, comparing it or using the converters/helpers has no database or state-changing side effect.

Errors

Reading the constant does not raise an error. Converter misses return Null; helpers use their documented fallbacks. Persisting a role not present in Party_Type can fail a foreign key.

Performance and concurrency

This is immutable compiled metadata. Access and fixed-case conversion/helper lookup are constant-time for practical purposes and carry no shared mutable party state.

Remarks

The example is source-reviewed and non-destructive. A returned table name is metadata, not SQL authorisation or proof that a matching row exists.

Related entries

Created 2026-07-15