Portail ZAPP exécute en arrière-plan des tâches planifiées (appelées « jobs » à l'écran) : envoi de la file des notifications, synchronisations d'annuaire, collectes des connecteurs, surveillance des délais, etc. Chaque tâche est fournie par un module ; l'écran Planificateur sert à choisir quand elles tournent, à les lancer à la main et à contrôler leur résultat.
L'écran Planificateur (menu Administration › Instance et exploitation › Planificateur) est réservé aux Administrateurs.
La liste des tâches
Chaque ligne donne le Nom de la tâche, sa Catégorie, sa Description, ses Déclencheurs (les plages horaires actives), son Statut (Actif, Désactivé ou En cours), la date de Dernière exécution et son Résultat.
On ne crée ni ne supprime une tâche depuis cet écran : les tâches apparaissent avec les modules qui les fournissent. Certaines sont livrées désactivées parce qu'elles demandent d'abord une configuration (par exemple une synchronisation d'annuaire) : activez-les une fois cette configuration faite.
Quand le module Grilles de données est installé, la liste est une grille : sélectionnez une ligne, puis utilisez les boutons Exécuter maintenant, Activer, Désactiver ou Détails de la barre d'outils. Sans grille, Détails ouvre la fiche de la tâche.
La fiche d'une tâche
La carte État rappelle la catégorie, le statut, la dernière exécution et son résultat, avec deux actions :
- Activer / Désactiver : une tâche désactivée ne se déclenche plus d'elle-même, quels que soient ses déclencheurs ;
- Déclencher maintenant : lance la tâche tout de suite, même si elle est désactivée. Le bouton est grisé (En cours) tant qu'une exécution n'est pas terminée : une même tâche ne tourne jamais deux fois en parallèle. L'exécution se fait en arrière-plan ; rechargez la page pour voir son résultat.
Certaines tâches génériques affichent aussi une carte Paramètres : un texte JSON transmis à la tâche à chaque exécution. Il est enregistré tel quel avec Enregistrer, sans contrôle de format : vérifiez-le avant d'enregistrer.
La tâche qui appelle une URL (paramètre url) joint une adresse publique ou une machine de votre réseau privé. Elle refuse les adresses réservées (lien local, adresse de métadonnées d'un hébergeur de nuage comme 169.254.169.254, multidiffusion) ainsi que localhost, sauf quand l'URL vise l'application elle-même : même adresse de base (protocole, nom et port), ou localhost sur un port où l'application écoute. Les autres services de la machine (localhost sur un autre port) restent refusés. Vers une autre adresse, une redirection est suivie et contrôlée de la même façon ; vers l'application elle-même, seules les redirections qui restent sur l'application sont suivies. Un appel refusé apparaît dans l'historique avec le message Appel refusé.
Les déclencheurs
Un déclencheur est une expression CRON qui dit quand la tâche part. Une tâche peut en avoir plusieurs ; elle part dès que l'un d'eux arrive à échéance.
- Pour en ajouter un, saisissez un Nom et une expression CRON, puis + Ajouter un déclencheur. Le bouton Assistant CRON (icône à droite du champ) compose l'expression pour vous ; Appliquer la recopie dans le champ.
- Modifier permet de changer le nom, l'expression et la case Actif d'un déclencheur ; Supprimer l'efface après confirmation.
Ce qu'il faut savoir :
- l'expression a six champs, le premier étant les secondes :
0 0/10 * * * *veut dire « toutes les 10 minutes »,0 30 2 * * *« chaque jour à 2 h 30 ». Une expression invalide est refusée et un message d'erreur s'affiche ; - les déclencheurs créés depuis cet écran suivent l'heure UTC, pas l'heure locale : tenez-en compte pour une tâche à heure fixe ;
- le planificateur vérifie les échéances une fois par minute : une tâche ne part donc jamais plus d'une fois par minute, et une échéance manquée pendant un arrêt de l'application n'est pas rattrapée (sauf pour les quelques tâches prévues pour se rattraper au démarrage).
L'historique d'exécution
Historique d'exécution liste les dernières exécutions, avec l'heure de début, la Durée, le Statut, des Statistiques fournies par la tâche (nombre d'éléments traités, par exemple) et l'Erreur éventuelle. Seules les 20 dernières exécutions de chaque tâche sont conservées.
Le statut s'affiche sous sa forme technique : Success (réussie), PartialSuccess (réussie en partie), Error (échec), Running (en cours) ou Skipped (non lancée : pendant une fenêtre de blackout, ou parce que le module de la tâche n'est pas disponible). Une échéance non lancée n'est pas rattrapée ensuite.
Une fenêtre de blackout est une période, ponctuelle ou récurrente (jours de la semaine et plage horaire), pendant laquelle aucune tâche planifiée ne se déclenche. Elle se gère par l'API du planificateur (GET et POST /api/v1/scheduler/blackout-windows, DELETE /api/v1/scheduler/blackout-windows/{id}) ; l'écran de santé de l'instance signale seulement celle qui est en cours.
Si l'application s'arrête pendant une exécution, la tâche est remise en état au redémarrage et repart à la prochaine échéance.
Quand une tâche échoue, la colonne Erreur explique la cause dans votre langue ; l'API et les exports reçoivent un code stable suivi d'une phrase en anglais. Le message technique (qui peut nommer un serveur, un fichier ou une requête) reste dans le journal du serveur. Causes communes à toutes les tâches :
| Code | Cause | Que faire |
|---|---|---|
DatabaseUnavailable |
La base de données n'a pas répondu ou a refusé la connexion (serveur arrêté, réseau, délai, trop de connexions) | Vérifier le serveur de base de données, puis relancer la tâche |
DatabaseError |
La base de données a refusé la requête | Consulter le journal du serveur |
Timeout |
Une opération de la tâche ne s'est pas terminée à temps | Relancer la tâche ; consulter le journal du serveur si cela se reproduit |
RemoteServiceUnreachable |
Un service distant n'a pas répondu ou a refusé la connexion (adresse, réseau, certificat) | Consulter le journal du serveur |
RemoteServiceError |
Un service distant a répondu par une erreur (statut HTTP affiché) | 401 ou 403 : compte refusé ; 404 : adresse fausse ; 5xx : service en panne. Consulter le journal du serveur |
Une tâche qui exécute une requête enregistrée indique, en cas d'échec, la requête en cause : la raison exacte est dans son journal d'exécution (module Requêtes).
Toute autre erreur imprévue s'affiche « Erreur inattendue » avec son type. Les causes propres à une tâche (connecteurs, scripts, synchronisations) sont décrites sur la page de son module.
Exporter et importer la planification
- Exporter la planification télécharge un fichier JSON avec, pour chaque tâche, son nom, son état (active ou non) et ses déclencheurs. Les paramètres JSON ne sont pas exportés.
- Importer la planification charge un tel fichier. Les tâches sont reconnues par leur nom ; une tâche absente de cette instance est ignorée, aucune n'est créée. Cochez Écraser la planification existante (déclencheurs remplacés) pour appliquer le fichier : l'état de chaque tâche reconnue est repris et ses déclencheurs sont remplacés par ceux du fichier. Sans cette case, l'import ne change rien.
C'est le moyen de reporter une planification réglée sur une instance de test vers une autre instance.
Voir aussi
- « Régler les droits » : qui peut ouvrir le Planificateur.
- Les pages des modules qui fournissent des tâches (synchronisations d'annuaire, connecteurs) décrivent ce que fait chacune.