DATA_RemittanceLine
DATA_RemittanceLine: TvxClientDataSet
Example
procedure ScriptEvent(var Value: variant);
begin
CreateData(DATA_RemittanceLine, ['RemittanceHdrNum,integer', 'LineNo,integer', 'InvoiceNo,string,50', 'TranTotal,double']);
DATA_RemittanceLine.Append;
DATA_RemittanceLine['RemittanceHdrNum'].AsInteger := 1001;
DATA_RemittanceLine['LineNo'].AsInteger := 1;
DATA_RemittanceLine['InvoiceNo'].AsString := 'EXAMPLE-INV-001';
DATA_RemittanceLine['TranTotal'].AsFloat := 100;
DATA_RemittanceLine.Post;
Value := DATA_RemittanceLine.RecordCount;
end;
Usage
DATA_RemittanceLine provides the friendly dataset conventionally used for remittance-line working data.
Conventional VxData context
The current Remittance_Line table requires RemittanceHdrNum, can reference an invoice, and records line/code, invoice/order identifiers, high-precision subtotal/tax/total, status, hash and audit fields. The header and invoice relationships apply only when the explicit schema and persistence path use that table.
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.
Postupdates 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 object is independent from both remittance header and invoice datasets. Reconcile keys, currency, signs and totals explicitly; current cursor positions do not establish a relationship.
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_RemittanceLine is the friendly dataset conventionally used for remittance allocation lines. 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_RemittanceLine to TvxActionMan.FData30. Its diagnostic dataset name is DATA_RemittanceLine.
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
Datasetsexplains cursor, field, edit and ownership rules.CreateDatacreates an explicit in-memory schema.GetDataandGetDataFromDBexplicitly populate a dataset.TvxClientDataSetis the exposed class.DATA_Remittanceis the independent header dataset.
External references
- Embarcadero DocWiki:
TClientDataSetdocuments the inherited Delphi in-memory dataset. - Embarcadero DocWiki:
TDataSetdocuments the inherited cursor and edit model. - Free Pascal:
TDataSetprovides compatibility context; Velox uses Delphi and its own descendant.