Skip to content

Flow documentation · legacy product

Dataset.RecordPKValue ​

Declaration ​

property RecordPKValue : boolean;

Example ​

pascal
procedure OnMapEvent(var Value:Variant);
begin
  DATASET.RecordPKValue := False;
end;

Description ​

By default RecordPKValue is True. Each time the dataset is moved to a new record it is reset to True. Set RecordPKValue to False to stop the script engine from recording the Primary Keys of this record.

Primary Keys are recorded for use in features such as the Transaction ID update (Refer DB Definitions). You may not want this record to be included in the transaction ID update therefore set RecordPKValue to False while processing that record in the map.

This is commonly used on the Dataset BeforeMap event of a dataset, in conjunction with setting the BeforeMap Value parameter to False (to have it skip the record). Since you are skipping the record you may want to skip the update of its transaction ID once processing has finished.