Skip to main content

DATA_Agent

DATA_Agent: TvxClientDataSet

Example​

procedure ScriptEvent(var Value: variant);
begin
  CreateData(DATA_Agent, ['TheirCode,string,255', 'PartyNum,integer']);
  DATA_Agent.Append;
  DATA_Agent['TheirCode'].AsString := 'AGENT-001';
  DATA_Agent['PartyNum'].AsInteger := 101;
  DATA_Agent.Post;
  Value := DATA_Agent.RecordCount;
end;

Usage​

DATA_Agent provides the friendly dataset conventionally used for agent party-role code working data.

Conventional VxData context

The current VxData role table Party_Agent maps a PartnerNum and TheirCode to a PartyNum; it is not the full Party master record. A script that needs party name, address or other master attributes must explicitly select/join them and cannot infer their presence from DATA_Agent.

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/file effects belong to the function used to populate or persist it.
  • Data helper functions generally catch and log SQL/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

The friendly suffix communicates intended use only. It does not validate record type, authenticate a party/application, enforce foreign keys or protect the dataset from being reused for unrelated data.

Additional Technical Info​

DATA_Agent is the friendly dataset conventionally used for agent party-role or code-mapping data. It is a live TvxClientDataSet reference; the friendly 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_Agent to TvxActionMan.FData57. Its diagnostic dataset name is DATA_Agent.

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

Related entries

External references

Created 2026-07-15