|
|
|
|
|
|
|
|
|
|
- Propriétés spécifiques à la description des variables de type hTâchePlanifiée
- Comment manipuler les paramètres passés à la procédure stockée
- Fonctions utilisant les variables de type hTâchePlanifiée
- Compatibilité
hTâchePlanifiée (Type de variable) En anglais : hScheduledTask
  Disponible uniquement avec ces types de connexion
Le type hTâchePlanifiée permet de gérer une tâche planifiée HFSQL Client/Serveur par programmation. Les caractéristiques de cette tâche planifiée peuvent être définies et modifiées à l'aide de différentes propriétés WLangage. Remarque : Pour plus de détails sur la déclaration de ce type de variable et l'utilisation des propriétés WLangage, consultez Déclaration d'une variable.
MaTâche est une hTâchePlanifiée
MaTâche.Description = "Sauvegarde planifiée"
MaTâche.Mois = "*"
MaTâche.JourDeLaSemaine = "*"
MaTâche.JourDuMois = "*"
MonHeure est une Heure
MonHeure = SAI_Heure
MaTâche.Heure = MonHeure.Heure
MaTâche.Minute = MonHeure.Minute
MaTâche.NombreExécution = 1
MaTâche.Procédure = "HBackup"
Ajoute(MaTâche.Paramètre, NomBaseCS + "/LOG_TACHES.FIC")
Ajoute(MaTâche.Paramètre, NomBaseCS + ".SauvegardePlanifiée")
Ajoute(MaTâche.Paramètre, Vrai)
Ajoute(MaTâche.Paramètre, MaTâche.Description)
nID est un entier = HAjouteTâche(ConnexionCS, MaTâche)
Remarques Propriétés spécifiques à la description des variables de type hTâchePlanifiée Les propriétés suivantes peuvent être utilisées pour manipuler une variable de type hTâchePlanifiée : | | | | Nom de la propriété | Type manipulé | Effet |
|---|
| Activé | Booléen | - Vrai si la planification de la tâche est activée,
- Faux dans le cas contraire.
| | AuDémarrage | Constante de type Entier | Indique si la tâche doit être effectuée au démarrage du serveur HFSQL et son mode d'exécution : - hBloquant : La tâche est bloquante. Le serveur HFSQL sera inaccessible pendant l'exécution de la tâche.
- hTâcheDeFond : La tâche n'est pas bloquante. Le serveur HFSQL sera accessible pendant l'exécution de la tâche. La tâche est exécutée en tâche de fond.
- Non : La tâche ne doit pas être exécutée au démarrage du serveur (valeur par défaut).
| | Description (*) | Chaîne de caractères | Description associée à la tâche planifiée. Par défaut, la description de la tâche planifiée correspond à une chaîne vide.
Cette propriété est optionnelle. | | Heure | Chaîne de caractères | Heure d'exécution de la tâche planifiée. Si la propriété HeureUTC est à Vrai, cette heure est au format UTC (temps universel).Les valeurs possibles sont : - un chiffre compris entre 0 et 23.
- une liste de nombres séparés par des virgules : permet de spécifier plusieurs heures.
- un intervalle. Par exemple "9-13".
- une étoile "*" pour indiquer toute la plage.
- un intervalle avec un pas, par exemple "*/2" pour lancer la tâche à toutes les heures paires.
| | HeureUTC | Booléen | - Vrai (valeur par défaut) si l'heure est exprimée en heure UTC, c'est-à -dire en temps universel (propriétés Heure et Minute),
- Faux dans le cas contraire.
| | JourDeLaSemaine | Chaîne de caractères | Numéro du jour de la semaine pour lequel la tâche planifiée doit être exécutée (par exemple "2"). Ce nombre est compris entre 1 et 7 (1 = Lundi, 2 = Mardi, ...).
Ce paramètre peut également correspondre à :- une liste de nombres séparés par des virgules : permet de spécifier plusieurs jours.
- un intervalle. Par exemple "1-3" (la tâche est planifiée pour Lundi, Mardi et Mercredi).
- une étoile "*" pour indiquer toute la plage.
- un intervalle avec un pas, par exemple "*/2" pour lancer la tâche à tous les jours de la semaine pairs.
- le jour de la semaine en toutes lettres ("lundi", "mardi", "mercredi", "jeudi", "vendredi").
| | JourDuMois | Chaîne de caractères | Numéro du jour du mois pour lequel la tâche planifiée doit être exécutée (par exemple "31"). Ce nombre est compris entre 0 et 31.
Ce paramètre peut également correspondre à :- une liste de nombres séparés par des virgules : permet de spécifier plusieurs mois.
- un intervalle. Par exemple "9-13" (la tâche est planifiée du 9 au 13 du mois).
- une étoile "*" pour indiquer toute la plage.
- un intervalle avec un pas, par exemple "*/2" pour lancer la tâche à tous les jours du mois pairs.
| | JourDuMoisOuDeLaSemaine | Booléen | Permet de gérer l'exécution d'une tâche planifiée en précisant le numéro de jour de la semaine ou le numéro de jour du mois. Exemple : exécution tous les lundis 1er jour du mois.
Cette propriété peut correspondre à :- Vrai pour exécuter la tâche planifiée tous les lundis ET le premier jour du mois (conditions cumulées).
- Faux pour exécuter la tâche uniquement les lundis 1er (conditions exclusives).
| | Minute | Chaîne de caractères | Minutes de l'heure d'exécution de la tâche planifiée. Si la propriété HeureUTC est à Vrai, cette heure est au format UTC (temps universel). Les valeurs possibles sont : - un chiffre compris entre 0 et 59.
- une liste de nombres séparés par des virgules : permet de spécifier plusieurs minutes.
- un intervalle. Par exemple "9-13".
- une étoile "*" pour indiquer toute la plage.
- un intervalle avec un pas, par exemple "*/2" pour lancer la tâche à toutes les minutes paires.
| | Mois | Chaîne de caractères | Numéro du mois d'exécution de la tâche planifiée (par exemple "11"). Les valeurs possibles sont :- un chiffre compris entre 1 et 12.
- une liste de nombres séparés par des virgules : permet de spécifier plusieurs mois.
- un intervalle. Par exemple, "9-11".
- une étoile "*" pour indiquer toute la plage.
- un intervalle avec un pas, par exemple "*/2" pour lancer la tâche tous les mois pairs.
| | NombreExécution | Entier | Nombre de fois où la tâche doit être exécutée. Cette propriété peut également correspondre à la constante Infini. | | Paramètre | Tableau | Paramètres de la procédure stockée à exécuter par la tâche planifiée. Pour plus de détails, consultez le paragraphe "Comment manipuler les paramètres passés à la procédure stockée ?". | | Procédure | Chaîne de caractères | Nom de la procédure stockée à exécuter par la tâche planifiée.
Cette propriété est de la forme : <Nom de la base>:<Nom de la collection de procédures>.<Nom de la procédure stockée>.
Pour exécuter une sauvegarde, cette propriété doit correspondre à "HSauvegarde" ou "HBackup". | | Utilisateur | Chaîne de caractères | Utilisateur ayant créé la tâche planifiée.
Cette propriété est en lecture uniquement. |
Les propriétés suivies du caractère (*) sont optionnelles. Comment manipuler les paramètres passés à la procédure stockée La propriété Paramètre de la variable hTâchePlanifiée est un tableau de chaînes. Pour définir les paramètres d'une procédure stockée exécutée lors du déclenchement d'une tâche planifiée, utilisez la fonction Ajoute ou la fonction TableauAjoute. Exemple :
Ajoute(MaTâche.Paramètre, gsNomBaseCS + ".SauvegardePlanifiée")
Pour manipuler les paramètres, il est possible d'utiliser la syntaxe POUR TOUT permettant le parcours d'un tableau. Pour connaître le nombre d'éléments du tableau, il est possible d'utiliser : Fonctions utilisant les variables de type hTâchePlanifiée | | | Nom de la fonction | Effet |
|---|
| HAjouteTâche | Ajoute une tâche planifiée sur le serveur défini par la connexion. Cette tâche a été définie par une variable avancée de type hTâchePlanifiée. | | HInfoTâche | Renvoie les caractéristiques d'une tâche planifiée dans une variable avancée de type hTâchePlanifiée. | | HModifieTâche | Modifie une tâche planifiée sur le serveur défini par la connexion. Cette tâche est présente dans une variable avancée de type hTâchePlanifiée. |
Documentation également disponible pour…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|