Skip to main content

DATA_Consignee

DATA_Consignee: TvxClientDataSet

Example​

procedure ScriptEvent(var Value: variant);
begin
  CreateData(DATA_Consignee, ['Code,string,100', 'Name,string,100', 'TypeNum,integer']);
  DATA_Consignee.Append;
  DATA_Consignee['Code'].AsString := 'CONSIGNEE-001';
  DATA_Consignee['Name'].AsString := 'Example Consignee';
  DATA_Consignee['TypeNum'].AsInteger := 4;
  DATA_Consignee.Post;
  Value := DATA_Consignee.RecordCount;
end;

Usage​

DATA_Consignee provides the friendly dataset conventionally used for consignee Party master and parent-specific code mapping data.

Conventional VxData context

Current helper functions load Party master rows for party type 4. Party_Consignee separately relates a parent customer or supplier (ParentNum) and a consignee PartyNum to TheirCode; its uniqueness is parent/party/code specific. The variable can hold either shape only when an explicit query or schema creates it.

That convention is guidance for choosing queries and field names, not a guarantee. A configured source/destination or customer extension may expose a different subset or additional columns. Use FindField for optional columns and never assume a named field merely because this page describes the current base schema.

Behaviour, lifecycle and side effects

  • Velox loads all returned rows into memory and preserves fetched string whitespace. Large results can use substantial memory.
  • Field access, navigation, filtering, indexing, inserts, edits, posts and deletes mutate this shared object. Closing or recreating it invalidates retained fields and record positions.
  • Post updates the client dataset; it is not proof of an external database write or transaction commit. SQL or file effects belong to the function used to populate or persist it.
  • Data helper functions generally catch and log SQL or creation failures, potentially leaving the object inactive or reset. Direct invalid field, conversion or dataset-state operations can raise.
  • Action cleanup closes every friendly dataset. Velox owns the object; never free it or depend on records surviving another action execution.
  • The mutable dataset and cursor are not thread-safe. Do not hand the reference to asynchronous work or let nested code reposition it without an explicit contract.

Alias and naming cautions

A consignee code is not globally unique by this convention. Keep the parent party context when resolving TheirCode, and do not confuse a cross-reference row with the related Party master.

The friendly suffix never validates record type, authenticates a party or application, enforces foreign keys or prevents the dataset being reused for unrelated data.

Additional Technical Info​

DATA_Consignee is the friendly dataset conventionally used while resolving or mapping a consignee party. It is a live TvxClientDataSet reference; its name does not load data, choose a connection, execute SQL or impose a field layout.

Runtime binding and identity

Velox constructs the object with the action and binds DATA_Consignee to TvxActionMan.FData17. Its diagnostic dataset name is DATA_Consignee.

The dataset begins inactive and without fields. CreateData, the Data query helpers and load methods can each replace its current schema and records. Every script using this action sees the same live cursor, filters, indexes and edits until the dataset is closed or repopulated.

Related entries

External references

Created 2026-07-15