Party_Consignee
Party_Consignee = 4
Example
procedure ScriptEvent(var Value: variant);
begin
Value := GetReferenceTableForPartyType(Party_Consignee); // 'Party_Consignee'
end;
Usage
Party_Consignee provides deprecated Consignee party-role alias value 4 used by legacy scripts, party tags and role helper functions.
Value
| Property | Value |
|---|---|
| Script type | LongInt |
| Numeric value | 4 |
| Preferred identifier | Type_Consignee |
| Canonical text | Type_Consignee_String = Consignee |
| Database domain | Party_Type.Num and Party.TypeNum |
| Reference-table helper result | Party_Consignee |
| Issue helper result | 1017 |
Additional Technical Info
Party_Consignee is a deprecated compatibility alias for the Consignee party role. Its fixed LongInt value is 4, identical to Type_Consignee. Prefer the Type_* identifier in new or revised scripts, while retaining this alias only where legacy compatibility or a helper's documented party-role input requires it.
Reading the alias identifies a role. It does not look up a party, create a role-table record, change Party.TypeNum or validate a transaction.
Implementation
Current native source places Party_Consignee in an explicitly deprecated block and registers it with PascalScript as 4. It also keeps this exact deprecated name in the numeric tag map, so <!Party_Consignee!> expands to 4; preferred Type_Consignee is registered separately with the same value.
GetReferenceTableForPartyType cases on Party_Consignee and returns Party_Consignee. GetIssueForPartyType cases on it and returns integer 1017. The text/number converters instead use preferred Type_Consignee and Type_Consignee_String.
A fresh VxData database seeds Party_Type value 4 as Consignee, and Party.TypeNum references that table. The role-specific reference table is Party_Consignee.
Behaviour
The alias and preferred identifier are numerically indistinguishable after evaluation. The reference-table helper returns a fixed table-name string; it does not open that table or return a dataset. The issue helper returns a fixed integer issue number; it does not create or persist an issue.
Edge cases and quirks
- There is no
Party_Consignee_Stringalias. UseType_Consignee_Stringfor canonical text and the preferred converters. - Despite deprecation, current product helpers and the tag map still refer to
Party_*names. Deprecation therefore means "prefer the replacement for authoring", not "currently unavailable". - The generated index lacks a deprecation flag even though native source marks the family deprecated.
- Party-role numbers overlap many other numeric families. PascalScript does not retain the domain after evaluation.
GetIssueForPartyTypereturns an integer such as1017, whereas the exposedIxxxxissue-code constants are strings. Do not substitute one representation without checking the receiving API.
Side effects
Reading Party_Consignee, comparing it or expanding its tag has no I/O or state-changing effect. The two helpers are fixed in-process case mappings and do not query the database.
Errors
Reading the alias does not raise an error. An unsupported party-role number makes GetReferenceTableForPartyType return Unknown and makes GetIssueForPartyType return its generic fallback 1029; this page's value uses the recognised branch.
Performance and concurrency
This is an immutable compiled value. Access, tag lookup and the fixed helper cases are constant-time for practical purposes and carry no shared mutable role state.
Remarks
The example is source-reviewed and non-destructive. Treat the returned table name as reference metadata; it does not authorise arbitrary SQL or prove that a matching row exists.
Related entries
Type_Consigneeis the preferred numeric identifier.Type_Consignee_Stringis the canonical role text.GetReferenceTableForPartyTypereturns a fixed role-table name.GetIssueForPartyTypereturns the role-specific issue number.GetPartyTypeNumandGetPartyTypeCodeuse preferred identifiers.