ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Tip
  • History of modifications
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
<Source>.HistoryModification (Function)
In french: <Source>.HistoriqueModification
HFSQL ClassicHFSQL Client/ServerAvailable only with these kinds of connection
Returns the modifications made to one or more items of a given record. The result can be displayed in a List Box or Table control to allow the user to view the modifications made to the specified data file.
Remarks:
  • This function is using the write-to-file log as well as all the archived logs.
  • WINDEV In a window linked to a data file, you have the ability to automatically display the history of the modifications performed on each item of the displayed record. To do so, the data file must be logged.
History of modifications
Example
// Allows viewing in a List Box control
// users who have changed the current customer's email address
// as well as the different values of the email over time
sHistory is string
sHistory = Customer.HistoryModification(CustomerID, Customer.CustomerID, "Email", 5)
sModification, sItem, sStatus, sUser are strings
sModification = sHistory.ExtractString(firstRank, CR)
WHILE sModification <> EOT
sItem = sModification.ExtractString(1, TAB)
sStatus = sModification.ExtractString(2, TAB)
sUser = sModification.ExtractString(5, TAB)
SWITCH sStatus
CASE "D"
LIST_ListModification.Add(StringBuild(...
"%1 has modified " + ...
"the Email item to give it the value %2", ...
sUser, sItem))
CASE "N"
LIST_ListModification.Add(StringBuild(...
"%1 has modified " + ...
"the Email item to make it NULL", sUser))
END
  sModification = sHistory.ExtractString(nextRank, CR)
END
Syntax

Modifications in a record identified by the value of a search key Hide the details

<Result> = <Source>.HistoryModification(<Search item> , <Sought value> , <List of items> [, <Number of modifications> [, <Separator of values> [, <Separator of modifications>]]])
<Result>: Character string
This result has the following format:
<Values> + <Separator of values> + <Information about modifications> +
<Separator of modifications>

Where:
  • <Values> has the following format:
    <Value of item 1> + <Separator of values> + <Status of item 1> +
    <Separator of values> + ... + <Separator of values> + <Value of item N>
    + <Separator of values> + <Status of item N>
    • <,Status of item> corresponds to:
      • "D": the item is defined.
      • "N": the item is NULL.
      • "I": the item does not exist in the archived log.
  • <Information about modifications> has the following format:
    <Modification date and time> + <Separator of values> +
    <Computer identifier (value of HComputer)> + <Separator of values> + <Login> +
    <Separator of values> + <Computer name> + <Separator of values> + <IP address> +
    <Separator of values> + <Application name> + <Separator of values> +
    <HInfoMsg> + <Separator of values> + <Function number>

HFSQL Classic Login always corresponds to an empty string ("").
<Source>: Type corresponding to the specified source
Name of the logged data file where the last modifications must be sought.
<Search item>: Character string
Name of the item used to select the record for which the last modifications are sought. The selected record corresponds to the record whose value is equal to <Sought value>.
We recommend that you use a search key to optimize the performance.
The second syntax enables you to perform a search on a record number.
<Sought value>: Type corresponding to the value
Value of the item that is sought in the data file. The list of modifications will be provided for the record for which the value of <Browse item> corresponds to <Sought value>.
<List of items>: Character string
List of items taken into account for the last modifications. In this list, the different items are separated by commas or by CR characters (Carriage Return).
If this parameter corresponds to "*", all the items found in the data file will be included.
<Number of modifications>: Optional integer
Maximum number of modifications returned (from the most recent one). All the modifications will be returned if this paramer is not specified.
<Separator of values>: Optional character string
Separator for the different values. This separator corresponds to TAB if this parameter is not specified.
<Separator of modifications>: Optional character string
Separator for the different modifications made to the specified record. This separator corresponds to CR if this parameter is not specified.

Modifications in a record identified by its record number Hide the details

<Result> = <Source>.HistoryModification(<Record number> , <List of items> [, <Number of modifications> [, <Separator of values> [, <Separator of modifications>]]])
<Result>: Character string
Values of the items of <List of items> separated by <Separator of values>. The following information is added after these values:
HFSQL Classic
<Separator of values> + <Modification date and time> + <Separator of values> +
<Computer identifier (value of HComputer)> + <Separator of values> + <Computer name> +
<Separator of values> + <IP address> + <Separator of values> +
<Application name> + <Separator of values> + <HInfoMsg> +
<Separator of modifications>
HFSQL Client/Server
<Separator of values> + <Modification date and time> + <Separator of values> +
<Computer identifier (value of HComputer)> + <Separator of values> + <Login> +
<Separator of values> + <Computer name> + <Separator of values> + <IP address> +
<Separator of values> + <Application name> + <Separator of values> +
<HInfoMsg> + <Separator of modifications>
<Source>: Type corresponding to the specified source
Name of the logged data file where the last modifications must be sought.
<Record number>: Integer
Number of the record where the modifications must be sought. The hRecNumCurrent constant can be used to handle the current record.
<List of items>: Character string
List of items taken into account for the last modifications. In this list, the different items are separated by commas or by CR characters (Carriage Return).
If this parameter is not specified or if it corresponds to "*", all the items found in the data file will be included.
<Number of modifications>: Optional integer
Maximum number of modifications returned (from the most recent one). All the modifications will be returned if this paramer is not specified.
<Separator of values>: Optional character string
Separator for the different values. This separator corresponds to TAB if this parameter is not specified.
<Separator of modifications>: Optional character string
Separator for the different modifications made to the specified record. This separator corresponds to CR if this parameter is not specified.
Remarks

Tip

We recommend that you use the first syntax by using as search key the automatic identifier of the data file or a unique key. Indeed, using the record number may cause some unexpected effects: the record number is re-used when deleting and adding a record.
For example, in a Customer data file, if a customer is deleted, the number of the deleted record will be reused when adding a new customer. The history of the modifications performed on this record number will take into account the modifications performed on the different customers associated with this record number.
WINDEV

History of modifications

In a window linked to a data file, you have the ability to automatically display the history of the modifications performed on each item of the displayed record. To do so, the data file must be logged.
History of modifications
To customize this window (or translate it),simply integrate it into the project.
To include the window for the history of modifications in your application:
  1. On the "Project" tab, in the "Project" group, expand "Import" and select "WINDEV elements and their dependencies".
  2. Select the subdirectory that contains the elements to import. The timer button configuration window is located in the "Programs\Data\Preset Windows\EN\ AAF " subdirectory of the WINDEV installation directory.
  3. WINDEV lists the elements of the directory. This directory contains the different elements corresponding to the customizable AAFs. The window to import is named "WINDEVAaf_HFLogWindow.wdw".
  4. Validate. The window is included in the project and it can be modified. This custom window will be automatically taken into account when running the application.
Remarks:
  • The window must not be renamed.
  • If this window is included in your application, you may not benefit from the improvements made to this window during the different updates. Don't forget to check whether this window has evolved.
  • Caution: To modify this window, the corresponding file must not be read-only. Modify the characteristics of the file in Windows if necessary.
Component: wd290hf.dll
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 07/05/2023

Send a report | Local help