Skip to main content

DATA_CustomerShip

DATA_CustomerShip: TvxClientDataSet

Example​

procedure ScriptEvent(var Value: variant);
begin
  CreateData(DATA_Consignor, ['Code,string,100', 'Name,string,100']);
  DATA_Consignor.Append;
  DATA_Consignor['Code'].AsString := 'CONSIGNOR-001';
  DATA_Consignor['Name'].AsString := 'Example Shipping Party';
  DATA_Consignor.Post;
  Value := DATA_CustomerShip.RecordCount;
end;

Usage​

DATA_CustomerShip provides a shipping-customer compatibility alias for the exact same live dataset object as DATA_Consignor.

Alias and conventional context

The shared object's current convention is consignor Party data and the Party_Consignor parent-specific code relationship. The alias name can be useful in older or role-oriented scripts, but it does not alter party type, select shipping-address columns or convert a customer into a consignor.

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

This is the most misleading alias in this slice: every query, close, filter, cursor movement and edit through DATA_CustomerShip affects DATA_Consignor. Code that also needs the customer object must use DATA_Customer, which is independent.

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_CustomerShip is a compatibility name bound to DATA_Consignor, not to DATA_Customer and not to a separate shipping-customer object. 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 binds DATA_CustomerShip and DATA_Consignor to the same TvxActionMan.FData16 instance. The object is constructed once with the diagnostic dataset name DATA_Consignor; errors or logs produced below the alias can therefore name DATA_Consignor.

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