PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • Content of HFConf.Ini file
  • INIT section
  • MANAGER section
  • AUTOANALYSIS section
  • TELEMETRY section
  • ACTIVEDIRECTORY section
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
HFConf.Ini file
HFSQL Client/ServerAvailable only with this kind of connection
Overview
The HFConf.INI file is found at server root. This file is used to define several characteristics of HFSQL Client/Server server.
This file is also used to specify the characteristics of log files created on the server. The log files are text files whose items are separated by TAB characters. The first file line contains the definition of columns. The log files are created by HFLogger.exe (hflogger in Linux).
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Content of HFConf.Ini file
The HFConf.INI file contains several sections:
  • The INIT section that is used to perform different initializations.
  • The MANAGER section, used in Linux only.
  • Versions 18 and later
    The AUTOANALYSIS section that is used to configure the optimization of indexes in background task.
    New in version 18
    The AUTOANALYSIS section that is used to configure the optimization of indexes in background task.
    The AUTOANALYSIS section that is used to configure the optimization of indexes in background task.
  • Versions 22 and later
    The TELEMETRY section that is used to configure the transmission of data to PC SOFT in order to improve the product (telemetry).
    New in version 22
    The TELEMETRY section that is used to configure the transmission of data to PC SOFT in order to improve the product (telemetry).
    The TELEMETRY section that is used to configure the transmission of data to PC SOFT in order to improve the product (telemetry).
  • Versions 23 and later
    The ACTIVEDIRECTORY section that is used to configure the authentication via Active Directory.
    New in version 23
    The ACTIVEDIRECTORY section that is used to configure the authentication via Active Directory.
    The ACTIVEDIRECTORY section that is used to configure the authentication via Active Directory.

INIT section

The INIT section can contain the following keywords:
KeywordDescriptionDefault value
AccessPort Network port used.
The modification of this parameter is taken into account when restarting the server.
4900
ActivityStatisticMaxFileSizeMaximum size of the file for activity statistics (MB).
This value must be greater than or equal to 1 otherwise no modification is performed.
The statistics are saved and reinitialized.
The modification of this parameter is taken into account without having to restart the server.
ActivityStatisticPathPath of files for activity statistics. The path is created on the server if it does not exist.
The statistics are saved and reinitialized.
The modification of this parameter is taken into account without having to restart the server.
ActivityStatisticPeriodPeriod (in seconds) between each backup of values for the different activity counters.
This value must be greater than or equal to 1 otherwise no modification is performed.
The statistics are saved and reinitialized.
The modification of this parameter is taken into account without having to restart the server.
Versions 21 and later
CacheMaxUnusedFiles
New in version 21
CacheMaxUnusedFiles
CacheMaxUnusedFiles
Maximum number of unused HFSQL tables that are stored in cache (which means opened) on the server. When this number is reached, the less recent unused table is automatically deleted from the cache.
The modification of this parameter is taken into account without having to restart the server.
Versions 21 and later
CacheFilesPrefetch
New in version 21
CacheFilesPrefetch
CacheFilesPrefetch
Configures the automatic fill for the cache of tables.
The possible values are:
  • 1: Automatic fill enabled.
  • 0: Automatic fill disabled.
0, automatic fill of table caches disabled
The modification of this parameter is taken into account when restarting the server.
DBRootPathPath of directory containing all databases (which means the data files of different HFSQL Client/Server applications).
To specify the directory of Manta service, all you have to do is use "%%EXE%%".
The modification of this parameter is taken into account when restarting the server.
"%%EXE%%DB" ("DB" sub-directory of directory of Manta service)
DaemonUser
Linux only
User name that will be used by the server.
The modification of this parameter is taken into account when restarting the server.
"root"
JNLBackupRootPathPath of backup directory for the logs. This path is automatically created if it does not exist when restarting the server.
The modification of this parameter is taken into account when restarting the server.
"__JNLBackup" sub-directory of directory containing all the data files
JNLRootPathPath of the directory containing all the logs of different HFSQL Client/Server applications (history of write operations performed in the HFSQL files). All the logs will be found in the "__JNL" sub-directory of specified directory.
For example, if the specified directory is "C:\Mydir", the logs will be found in the "C:\MyDir\__JNL" directory.
We advise you to modify the default path of logs for security reasons. Indeed, if a technical problem occurs on the hard disk containing the data, you will be able to replay the log (saved on another disk) from a backup.
To specify the directory of Manta service, all you have to do is use "%%EXE%%".
The modification of this parameter is taken into account when restarting the server.
"__JNL" sub-directory of directory containing all data files
Versions 23 and later
KeepAliveInterval
New in version 23
KeepAliveInterval
KeepAliveInterval
Maximum time (in seconds) after which, if no communication is established between the server and the client, the server will check the presence of client.30 minutes
Versions 23 and later
KeepAliveTimeOut
New in version 23
KeepAliveTimeOut
KeepAliveTimeOut
Maximum time-out (in seconds) for the server when checking the presence of client. If the client is not found at the end of this time-out, the client is automatically disconnected.2 minutes
Versions 22 and later
KeySearch
New in version 22
KeySearch
KeySearch
Enable the search for keys.
The possible values are:
  • 0: Automatic search for inactive keys,
  • 1: Automatic search for active keys.
0, automatic search for keys is disabled.
The modification of this parameter is taken into account when restarting the server.
LoadCoeffCallGlobal coefficient for the number of client calls.
This value (included between -100 and 100) increases or reduces the coefficient applied to the counter for the client calls to the server.
The coefficients are used to modify the importance of each counter in the formula for calculating the load generated by a user on the server.
A value equal to 1, 0 or -1 does not modify the coefficient.
A value greater than 100 is equivalent to 100.
A value less than -100 is equivalent to -100.
The modification of this parameter is taken into account without having to restart the server.
LoadCoeffDiskGlobal coefficient for the number of bytes read or written on disk.
This value (included between -100 and 100) increases or reduces the coefficient applied to the counter for the bytes read or written on disk by the server.
The coefficients are used to modify the importance of each counter in the formula for calculating the load generated by a user on the server.
A value equal to 1, 0 or -1 does not modify the coefficient.
A value greater than 100 is equivalent to 100.
A value less than -100 is equivalent to -100.
The modification of this parameter is taken into account without having to restart the server.
LoadCoeffDiskAccessGlobal coefficient for the number of accesses to the disk.
This value (included between -100 and 100) increases or reduces the coefficient applied to the counter for the number of accesses to the disk.
The coefficients are used to modify the importance of each counter in the formula for calculating the load generated by a user on the server.
A value equal to 1, 0 or -1 does not modify the coefficient.
A value greater than 100 is equivalent to 100.
A value less than -100 is equivalent to -100.
The modification of this parameter is taken into account without having to restart the server.
LoadCoeffRecvGlobal coefficient for the number of bytes received on the network.
This value (included between -100 and 100) increases or reduces the coefficient applied to the counter for the bytes received by the server.
The coefficients are used to modify the importance of each counter in the formula for calculating the load generated by a user on the server.
A value equal to 1, 0 or -1 does not modify the coefficient.
A value greater than 100 is equivalent to 100.
A value less than -100 is equivalent to -100.
The modification of this parameter is taken into account without having to restart the server.
LoadCoeffSendGlobal coefficient for the number of bytes sent over the network.
This value (included between -100 and 100) increases or reduces the coefficient applied to the counter for the bytes sent by the server.
The coefficients are used to modify the importance of each counter in the formula for calculating the load generated by a user on the server.
A value equal to 1, 0 or -1 does not modify the coefficient.
A value greater than 100 is equivalent to 100.
A value less than -100 is equivalent to -100.
The modification of this parameter is taken into account without having to restart the server.
LoadEnableIndicates whether the load balancing is enabled (True) or not (False).
The modification of this parameter is taken into account without having to restart the server.
LoadMaxWaitMaximum time (in ms) during which a request to the server can be temporarily stopped by the system for load balancing before it is processed.
The modification of this parameter is taken into account without having to restart the server.
LogConnectionUsed to add information to the system log files whenever a client connects to the server.
This keyword can be set to 0 (no addition) or 1 (addition allowed).
0 (no addition)
MoreThan2GBIndicates whether the system files support more than 2 GB.
This keyword can be set to 0 (No) or 1 (Yes).
The modification of this parameter is taken into account when restarting the server.
0 (no)
NdxCacheSizeSize of the index cache (MB).
This size must be greater than 1.
The modification of this parameter is taken into account without having to restart the server.
Note: on a 32-bit server, this parameter cannot exceed 1 GB.
ServerLogLevelsDefines the elements that must be found in the log file.
The possible parameters are "WL" and "PARAM", separated by a comma:
  • "WL": the calls to the server will be included in the log file.
  • "PARAM": the parameters of the calls will be included in the log file.
The modification of this parameter is taken into account without having to restart the server.
No log file will be created
ServerLogPathLocation of the audit log files of the server (set of operations requested by the client computers to the server).
The path is created on the server if it does not exist.
The modification of this parameter is taken into account without having to restart the server.
"%%EXE%%\Logs" ("Logs" sub-directory of directory of Manta service)
ServerLogMaxSizeMaximum size of a log file (in MB).
This size must be greater than 1.
The modification of this parameter is taken into account without having to restart the server.
20 MB
Versions 17 and later
TmpPath
New in version 17
TmpPath
TmpPath
Path of temporary directory. This directory can be used to create temporary files when reindexing large data files for example.
Versions 19 and later
WindowsFileCacheSize
New in version 19
WindowsFileCacheSize
WindowsFileCacheSize
Configures the management of Windows disk caches.
The possible values are:
  • -1 for a size that is automatically calculated,
  • 0 for an unlimited cache size,
  • a positive value is used to define a custom cache size.
Note: The standard management of Windows disk caches in 64-bit mode (independently from HFSQL) can create memory saturation. This option is used to customize the management of memory caches.
-1
WLDebugPortPort used to debug the stored procedures and the Client/Server triggers.
The modification of this parameter is taken into account when restarting the server.
27281
Versions 16 and later
Note: In the directory paths, you have the ability to use %%COMMONAPPDATA%%:
  • In Windows, the directory corresponds to the one returned by SysDir (syntax: SysDir(srCommonAppData)).
  • In Linux, the directory is "/var/lib/".
New in version 16
Note: In the directory paths, you have the ability to use %%COMMONAPPDATA%%:
  • In Windows, the directory corresponds to the one returned by SysDir (syntax: SysDir(srCommonAppData)).
  • In Linux, the directory is "/var/lib/".
Note: In the directory paths, you have the ability to use %%COMMONAPPDATA%%:
  • In Windows, the directory corresponds to the one returned by SysDir (syntax: SysDir(srCommonAppData)).
  • In Linux, the directory is "/var/lib/".
WINDEVWEBDEV - Server codeLinux

MANAGER section

The MANAGER section is used in Linux only. This section can contain the following keywords:
  • RestartOnFailed: Restarts the server when a fatal error occurs. This keyword can be set to 0 (no activation) or 1 (activation). By default, this keyword is set to 1 (activation).
  • CheckPeriod: Period (in seconds) after which MantaManager checks whether the server was stopped properly. 600 by default (which means every 10 minutes).
Versions 18 and later

AUTOANALYSIS section

The AUTOANALYSIS section that is used to configure the optimization of indexes in background task. This section can contain the following keyword:
Enabled: Enables the optimization of indexes in background task. This keyword can be set to 0 (no activation) or 1 (activation). By default, this keyword is set to 1 (activation).
If the optimization of indexes in background task is enabled, the indexes of the data files are automatically optimized if the following conditions are fulfilled:
  • the statistics have not been calculated for the data file since at least 7 days.
  • the data file was created since at least 1 day.
  • the number of write operations since the last statistical calculation is greater than 10000 (plus 10% of the number of file records).
If the optimization of indexes is enabled, this operation is not a locking operation.
New in version 18

AUTOANALYSIS section

The AUTOANALYSIS section that is used to configure the optimization of indexes in background task. This section can contain the following keyword:
Enabled: Enables the optimization of indexes in background task. This keyword can be set to 0 (no activation) or 1 (activation). By default, this keyword is set to 1 (activation).
If the optimization of indexes in background task is enabled, the indexes of the data files are automatically optimized if the following conditions are fulfilled:
  • the statistics have not been calculated for the data file since at least 7 days.
  • the data file was created since at least 1 day.
  • the number of write operations since the last statistical calculation is greater than 10000 (plus 10% of the number of file records).
If the optimization of indexes is enabled, this operation is not a locking operation.

AUTOANALYSIS section

The AUTOANALYSIS section that is used to configure the optimization of indexes in background task. This section can contain the following keyword:
Enabled: Enables the optimization of indexes in background task. This keyword can be set to 0 (no activation) or 1 (activation). By default, this keyword is set to 1 (activation).
If the optimization of indexes in background task is enabled, the indexes of the data files are automatically optimized if the following conditions are fulfilled:
  • the statistics have not been calculated for the data file since at least 7 days.
  • the data file was created since at least 1 day.
  • the number of write operations since the last statistical calculation is greater than 10000 (plus 10% of the number of file records).
If the optimization of indexes is enabled, this operation is not a locking operation.
Versions 22 and later

TELEMETRY section

The TELEMETRY section is used to configure the implementation of data transmission for the HFSQL server (telemetry). You can help us improve the product installed by allowing us to collect information regarding the use of product. This optional and anonymous collect allows PC SOFT to improve the product features.
This section contains the following keyword:
Active: Enables the transmission of data regarding the use of HFSQL server. The value of this keyword can be:
  • 1 if the transmission of data (telemetry) was enabled when installing the HFSQL server,
  • 0 if the transmission of data (telemetry) was refused when installing the HFSQL server.
  • another value if no choice was made during the setup regarding the use of telemetry. The question will be asked again during the next setup of HFSQL server.
Note: If the "TELEMETRY" section does not exist in the HFConf.ini file, the transmission of data regarding the use of product is not enabled for the HFSQL server.
New in version 22

TELEMETRY section

The TELEMETRY section is used to configure the implementation of data transmission for the HFSQL server (telemetry). You can help us improve the product installed by allowing us to collect information regarding the use of product. This optional and anonymous collect allows PC SOFT to improve the product features.
This section contains the following keyword:
Active: Enables the transmission of data regarding the use of HFSQL server. The value of this keyword can be:
  • 1 if the transmission of data (telemetry) was enabled when installing the HFSQL server,
  • 0 if the transmission of data (telemetry) was refused when installing the HFSQL server.
  • another value if no choice was made during the setup regarding the use of telemetry. The question will be asked again during the next setup of HFSQL server.
Note: If the "TELEMETRY" section does not exist in the HFConf.ini file, the transmission of data regarding the use of product is not enabled for the HFSQL server.

TELEMETRY section

The TELEMETRY section is used to configure the implementation of data transmission for the HFSQL server (telemetry). You can help us improve the product installed by allowing us to collect information regarding the use of product. This optional and anonymous collect allows PC SOFT to improve the product features.
This section contains the following keyword:
Active: Enables the transmission of data regarding the use of HFSQL server. The value of this keyword can be:
  • 1 if the transmission of data (telemetry) was enabled when installing the HFSQL server,
  • 0 if the transmission of data (telemetry) was refused when installing the HFSQL server.
  • another value if no choice was made during the setup regarding the use of telemetry. The question will be asked again during the next setup of HFSQL server.
Note: If the "TELEMETRY" section does not exist in the HFConf.ini file, the transmission of data regarding the use of product is not enabled for the HFSQL server.
Versions 23 and later

ACTIVEDIRECTORY section

The ACTIVEDIRECTORY section is used to configure the authentication via Active Directory.
This section can contain the following keywords:
  • Enabled: Enables the authentication via Active Directory. This keyword can be set to 0 (no activation) or 1 (activation).
  • KerberosKeyFile (used in Linux only): Path to "keytab".
New in version 23

ACTIVEDIRECTORY section

The ACTIVEDIRECTORY section is used to configure the authentication via Active Directory.
This section can contain the following keywords:
  • Enabled: Enables the authentication via Active Directory. This keyword can be set to 0 (no activation) or 1 (activation).
  • KerberosKeyFile (used in Linux only): Path to "keytab".

ACTIVEDIRECTORY section

The ACTIVEDIRECTORY section is used to configure the authentication via Active Directory.
This section can contain the following keywords:
  • Enabled: Enables the authentication via Active Directory. This keyword can be set to 0 (no activation) or 1 (activation).
  • KerberosKeyFile (used in Linux only): Path to "keytab".
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment