Planifier une tâche de notebook

Depuis la version 10.8.1, vous pouvez créer des tâches pour planifier l’exécution automatique d’un notebook. Chaque fois que le notebook est exécuté selon la planification définie, le site ouvre un nouveau conteneur et exécute le notebook sans intervention de l’utilisateur.

Dans la fenêtre Tasks (Tâches) de l’éditeur de notebooks, vous pouvez créer une ou plusieurs tâches planifiées pour l’exécution du notebook. Vous pouvez planifier une exécution unique ou récurrente, d’une par minute à une tous les cinq mois.

Si vous préparez un notebook en vue de l’exécution automatisée, par exemple de manière récurrente, vous devez garder plusieurs éléments à l’esprit.

Préparer le notebook

L’éditeur de notebooks propose une fonctionnalité Parameters (Paramètres) qui vous permet de configurer les paramètres en entrée et en sortie d’un notebook. Les paramètres en entrée correspondent aux variables en entrée d’un notebook à externaliser pour une tâche planifiée ou un outil Web. Lors de l’exécution d’une tâche planifiée, les paramètres en entrée sont insérés dans la partie supérieure du notebook, à l’instar des variables globales. Cela permet de créer des notebooks génériques et de modifier les valeurs des variables en entrée au moment de l’exécution.

Lors de la création d’un notebook, externalisez et configurez les variables à l’aide de Parameters (Paramètres). Pour obtenir des informations sur la configuration des paramètres en entrée d’un notebook, reportez-vous à la section Configurer les paramètres en entrée de la rubrique Publier un notebook sous forme d’outil Web.

Les paramètres de tâche sont intégrés par défaut dans une cellule au début du notebook. Vous pouvez également utiliser l’option de cellule Tags (Balises) de la barre d’outils pour créer et gérer les balises de chaque cellule de l’espace de travail du notebook, afin de créer une balise pour une cellule nommée injected-parameters. Les paramètres de tâche sont intégrés dans la cellule qui suit la balise injected-parameters. Pour activer les balises, vous pouvez modifier les options de la barre d’outils de la cellule en cliquant sur View (Afficher), sur Cell Toolbar (Barre d’outils de la cellule), puis sur Tags (Balises).

Considérations relatives au contenu

En dehors de l’insertion de la cellule des paramètres, la planification d’un notebook ne prend en charge aucune interaction de l’utilisateur avec les notebooks. Évitez d’ajouter du contenu qui nécessite une interaction de l’utilisateur pendant l’exécution du notebook, par exemple, cliquer sur un point sur la carte.

Les identifiants de connexion et nouvelles variables à ajouter lors d’une exécution automatisée doivent être insérés dans la cellule des paramètres, comme indiqué ci-avant. Assurez-vous que le notebook ne renferme pas de contenu empêchant son exécution complète.

Remarque :

Lors de la création de notebooks, utilisez les chemins d’accès complets vers les répertoires et fichiers du répertoire de l’espace de travail.

Par exemple, utilisez /arcgis/home/test.gdb au lieu de home/test.gdb.

Créer une tâche

Lorsque le notebook est prêt, vous pouvez créer une tâche pour planifier son exécution. Dans le panneau Tasks (Tâches) de l’éditeur de notebooks, vous pouvez créer une ou plusieurs tâches pour automatiser l’exécution du notebook et spécifier la planification de la tâche.

1. Si vous ne l’avez pas déjà fait, enregistrez le notebook et donnez-lui un titre.

   Le bouton Tasks (Tâches) devient accessible sur le ruban supérieur de l’éditeur de notebooks.

2. Cliquez sur Create Task (Créer une tâche) pour ouvrir la boîte de dialogue.

   Remarque :

   Vous pouvez également créer des tâches dans l’onglet Tasks (Tâches) de la page des détails des éléments du notebook.

3. Fournissez un titre dans la zone de texte Title (Titre) pour décrire la planification de la tâche, par exemple Nettoyage hebdomadaire des données.
4. Si vous n’avez pas encore configuré de paramètres et que vous souhaitez en ajouter dans le notebook lors de son exécution par la tâche, indiquez-les dans la section Parameters (Paramètres). Indiquez une clé pour le champ Key (Clé) et sa valeur associée dans le champ Value (Valeur) pour chaque paramètre, puis cliquez sur Add (Ajouter) pour enregistrer le paramètre.

   Si vous avez déjà configuré des paramètres en entrée à l’aide de l’option Parameters (Paramètres), ils sont automatiquement renseignés pour la tâche. Vous pouvez ajouter, supprimer ou mettre à jour des paramètres spécifiques à cette tâche. Les paramètres par défaut du notebook configuré ne changeront pas si vous utilisez l’option de paramètres.

5. Cliquez sur Next (Suivant) pour passer à la page Set task schedule details (Détailler la planification de la tâche).

   C’est sur cette page que vous pouvez définir la planification précise de cette tâche.

   Conseil :

   Lorsque vous modifiez la valeur du champ Repeat type (Type de répétition), les options ci-dessous changent pour s’adapter à cette dénomination. Par exemple, si vous sélectionnez le type de répétition Week (Semaine), des cases à cocher apparaissent pour chaque jour de la semaine.

6. Vous pouvez également déveopper la section Advanced (Avancé) pour indiquer la durée maximale en minutes de l’exécution de la tâche.
7. Dans la section Advanced (Avancé), un bouton bascule Save parameters to notebook (Enregistrer les paramètres dans le notebook) apparaît si vous avez ajouté des paramètres. Vous pouvez également activer cette option pour enregistrer les cellules insérées avec les nouveaux paramètres dans le notebook lorsqu’il est exécuté.
8. Dans la section Advanced (Avancé), activez le bouton bascule Update notebook on completion (Mettre à jour le notebook à la fin du processus) si vous souhaitez mettre à jour le notebook avec les résultats de chaque exécution.
9. Lorsque vous êtes satisfait du titre, les paramètres facultatifs et de la planification de la tâche, cliquez sur Create Task (Créer une tâche).

   La tâche est active et exécute le notebook conformément à la planification que vous avez définie.

Si vous avez besoin de plusieurs planifications, éventuellement avec des paramètres insérés différents, vous pouvez créer d’autres tâches pour le notebook en suivant le même processus.

Utiliser des tâche existantes

Après avoir créé une tâche pour un notebook, vous pouvez consulter ses détails, la mettre à jour ou la supprimer à tout moment. Vous pouvez modifier les tâches dans la fenêtre Tasks (Tâches) de l’éditeur de notebooks ou dans l’onglet Tasks (Tâches) de la page des détails des éléments du notebook. Aux deux endroits, vous pouvez consulter toutes les tâches du notebook avec la date et l’heure de création de chaque tâche, quand elle a été modifié pour la dernière fois et son état actuel.

1. Dans le ruban supérieur de l’éditeur de notebooks, cliquez sur Tasks (Tâches).
2. Dans la section Scheduled Tasks (Tâches planifiées), recherchez la tâche que vous voulez utiliser.
3. Cliquez sur Actions en regard de la tâche et procédez de l’une des façons suivantes :
   • Cliquez sur Details (Détails) pour examiner les résultats de chaque exécution de la tâche. Un aperçu du notebook est stocké avec les détails de chaque exécution de la tâche.

     Remarque :

     Cet aperçu n’inclut pas les widgets cartographiques du notebook. Les widgets cartographiques ne sont affichés que dans le notebook ; ils ne le sont pas dans l’aperçu statique inclus avec le résultat d’une tâche planifiée.

   • Cliquez sur Edit (Mise à jour) pour modifier le titre, les paramètres ou la planification de la tâche.
   • Cliquez sur Pause (Interrompre) pour interrompre une tâche active. Une fois la tâche interrompue, cliquez sur Resume (Reprendre) pour la reprendre.
   • Cliquez sur Delete (Supprimer) pour supprimer la tâche.

     Remarque :

     Lorsqu’une tâche est supprimée, l’historique de ses exécutions l’est également. Pour conserver l’historique d’une tâche active, vous pouvez interrompre la tâche afin d’empêcher toute exécution ultérieure.

Le changement de propriété d’un notebook change également la propriété de ses tâches. Les tâches sont transférées au nouvel utilisateur dans un état inactif. Le nouveau propriétaire peut activer les tâches depuis la fenêtre Tasks (Tâches) de l’éditeur de notebooks ou dans l’onglet Tasks (Tâches) de la page des détails des éléments du notebook.