hScheduling (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / Types of HFSQL variables

Properties specific to hScheduling variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

hScheduling (Variable type)

In french: hPlanification

Available only with this kind of connection

The hScheduling type is used to define and find out the characteristics of the scheduling that must be performed:

for a scheduled HFSQL Client/Server data file optimization task.
for a scheduled backup of HFSQL Client/Server data files.
for scheduled replication of HFSQL servers.

You can define and change the characteristics of this scheduling using different WLanguage properties.

This type of variable is used:

by the hScheduledOptimization type.
by the hBackupDescription type.
by the hRSConfig type.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Recalculate statistics of files in "MyDatabase", 
// every Saturday at 23:00
Optim is hScheduledOptimization
Optim.Description = "Recalculating the statistics for the files" + ...  
	"found in the MyDatabase database"

// Define the scheduling
MyScheduling is hScheduling
MyScheduling.Month = "*"
MyScheduling.DayOfWeek = "Saturday"
MyScheduling.Hour = "23"
MyScheduling.Minute = "0"

Optim.Scheduling = MyScheduling

// Define the files to process
Optim.File[1].Name = "MaBase"
Optim.File[1].Option = hOptStat

// Add the scheduled optimization
HAddScheduledOptimization(MyConnection, Optim)

Properties

Properties specific to hScheduling variables

The following properties can be used to handle a scheduling:

Property name	Type used	Effect

DayOfMonth	Character string	Number of the day for which the scheduled task must be run ("31" for example). This number is included between 0 and 31. This property can also correspond to: a comma-separated list of numbers: to specify several months. an interval. For example, "9-13" (the task is scheduled from the 9th to the 13th of the month). a star ("") to specify the entire range. an interval with a step, "/2" for example to perform the task on every odd day of the month.
DayOfMonthOrDayOfWeek	Boolean	Used to manage the execution of a scheduled task on the HFSQL Client/Server server by specifying the number of the day of the week or the number of the day of the month. Example: execution every Monday, 1st day of the month. This property can correspond to: True to run the scheduled task every Monday AND the first day of the month (cumulated conditions). False to run the task on Monday 1st (exclusive conditions).
DayOfWeek	Character string	Number of the day for which the scheduled task must be run ("2" for example). This number is included between 1 and 7 (1 = Monday, 2 = Tuesday, ...). This property can also correspond to: a comma-separated list of numbers: to specify several days. an interval. For example, "1-3" (the task is scheduled for Monday, Tuesday and Wednesday). a star ("") to specify the entire range. an interval with a step, "/2" for example to perform the task on every even day of the week. the day of the week in letters ("Monday", "Tuesday", "Wednesday", "Thursday", "Friday").
Minute	Character string	Minutes of the execution time of the scheduled task. If TimeUTC is set to True, this time will be in UTC. The possible values are: a digit included between 0 and 59. a comma-separated list of numbers: to specify several minutes. an interval. For example, "9-13". a star ("") to specify the entire range. an interval with a step, "/2" for example to perform the task at every even minute.
Month	Character string	Number of the execution month of scheduled task. The possible values are: a digit included between 1 and 12 a comma-separated list of numbers: to specify several months. an interval. For example, "9-11". a star ("") to specify the entire range. an interval with a step, "/2" for example to perform the task on every odd month.
Time	Character string	Execution time of scheduled task. If TimeUTC is set to True, this time will be in UTC. The possible values are: a digit included between 0 and 23. a comma-separated list of numbers: to specify several hours. an interval. For example, "9-13". a star ("") to specify the entire range. an interval with a step, "/2" for example to perform the task at every even hour.
TimeUTC	Boolean	True (default value) if the time is in UTC (Hour and Minute properties), False otherwise.