PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

  • Propriétés spécifiques à la description des variables de type serveurAppliTâchePlanifiée
  • Liste des fonctions manipulant le type serveurAppliTâchePlanifiée
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget iOSApple WatchCatalystUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
serveurAppliTâchePlanifiée (Type de variable)
En anglais : appServerScheduledTask
Le type serveurAppliTâchePlanifiée permet de gérer par programmation une tâche planifiée du serveur d'application WEBDEV (pour un site ou un webservice).
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.
Exemple
// Programme la tâche pour s’exécuter toutes les heures
MaTâchePlanifiée est un serveurAppliTâchePlanifiée
MaTâchePlanifiée.Nom = "MaTache"
MaTâchePlanifiée.Procédure = MaProc
MaTâchePlanifiée.Mois = "*"
MaTâchePlanifiée.JourDuMois = "*"
MaTâchePlanifiée.JourDeLaSemaine = "*"
MaTâchePlanifiée.Heure = "*"
MaTâchePlanifiée.Minute = "0"
 
SI PAS ServeurAppliAjouteTâchePlanifiée(MaTâchePlanifiée) ALORS
// Cas d'erreur (par exemple si une tâche de même nom existe déjà)
FIN
Remarques

Propriétés spécifiques à la description des variables de type serveurAppliTâchePlanifiée

Les propriétés suivantes peuvent être utilisées pour manipuler une Tâche planifiée :
Nom de la propriétéType manipuléEffet
ActivéBooléenIndique si la tâche est active ou non :
  • Vrai si la planification de la tâche est active.
  • Faux dans le cas contraire.
EnExécutionBooléenIndique si la tâche est en cours d'exécution :
  • Vrai si la tâche est en cours d'exécution.
  • Faux dans le cas contraire.
Cette propriété est disponible en lecture seulement.
Cette propriété est mise à jour uniquement par les fonctions ServeurAppliInfoTâchePlanifiée et ServeurAppliListeTâchePlanifiée. La valeur lue reflète l'état au moment de l'appel de ces fonctions et non pas l'état au moment de la lecture de la propriété.
HeureChaîne de caractèresHeure 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.
HeureUTCBoolé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.
JourDeLaSemaineChaîne de caractèresNumé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, ...).
Cette propriété 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").
JourDuMoisChaîne de caractèresNumé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.
Cette propriété 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 impairs du mois.
JourDuMoisOuDeLaSemaineBooléenPermet 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).
MinuteChaîne de caractèresMinutes 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.
MoisChaîne de caractèresNumé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 impairs.
MotDePasseChaîne de caractèresMot de passe de l'utilisateur.
NomChaîne de caractèresNom de la tâche.
Ce nom permet de différencier les tâches associées à une même procédure.
Si cette propriété n'est pas renseignée, le nom de la tâche correspondra au nom complet de la procédure (par exemple : MaColletion.NomDeLaProcédure).
NomProcédureChaîne de caractèresNom de la procédure à exécuter.
Cette propriété est en lecture seule et permet de récupérer le nom de la procédure associée à la tâche (pour l'afficher dans un écran spécifique par exemple).
ParamètreTableauParamètres à transmettre à la tâche planifiée lors de son exécution. Chacun des paramètres doit pouvoir être transformé par la fonction Sérialise (la sérialisation utilisée est une sérialisation binaire).
ProcédureNom de la procédureProcédure à exécuter par la tâche planifiée. Ce nom est de la forme :
  • pour une procédure présente dans une collection de procédures : <Nom de la collection de procédures>.<Nom de la procédure>.
  • pour une procédure présente dans un composant : <Nom du composant>.<Nom de la collection de procédures>.<Nom de la procédure>.
Cette propriété n'accepte pas :
  • Les procédures locales. Une procédure locale existe uniquement dans le contexte de l'appel de sa procédure parente. Ce contexte n'existera plus lors de l'appel de la tâche planifiée.
  • Une variable de type Procédure (sauf si celle-ci ne désigne une procédure appartenant à une collection de procédures).
UtilisateurChaîne de caractèresIndique l'utilisateur du système d'exploitation qui exécutera la tâche. Si cette valeur n'est pas remplie, l'utilisateur utilisé est l'utilisateur par défaut de l'application (site ou webservice).

Liste des fonctions manipulant le type serveurAppliTâchePlanifiée

Versions 22 et supérieures
ServeurAppliAjouteTâchePlanifiée
ServeurAppliAjouteTâchePlanifiée
Ajoute une nouvelle tâche planifiée à l'application (site ou webservice).
Versions 22 et supérieures
ServeurAppliExécuteTâchePlanifiée
ServeurAppliExécuteTâchePlanifiée
Lance immédiatement l'exécution d'une tâche planifiée sur un Serveur d'Application WEBDEV.
Versions 22 et supérieures
ServeurAppliInfoTâchePlanifiée
ServeurAppliInfoTâchePlanifiée
Lit la description d'une tâche planifiée.
Versions 22 et supérieures
ServeurAppliModifieTâchePlanifiée
ServeurAppliModifieTâchePlanifiée
Modifie une tâche planifiée existante.
Versions 22 et supérieures
ServeurAppliSupprimeTâchePlanifiée
ServeurAppliSupprimeTâchePlanifiée
Supprime une tâche planifiée associée à l'application (site ou Webservice).
Version minimum requise
  • Version 22
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire