Planifier une tâche de notebook

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 que vous ayez besoin de l’ouvrir. Vous pouvez avoir un maximum de cinq tâches actives sur tous vos notebooks.

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 (de toutes les 15 minutes à tous les six mois).

Si vous préparez un notebook en vue de l’exécution automatisée, par exemple de manière récurrente, tenez compte des éléments suivants :

• La fréquence maximale à laquelle une tâche planifiée peut être exécutée est de 15 minutes.
• Vous ne pouvez créer des tâches que pour les éléments de notebook que vous possédez. Cela s’applique à tous les types d’utilisateurs, y compris les administrateurs.
• Les administrateurs peuvent afficher et modifier des tâches pour tous les éléments de notebook de l’organisation.
• Si un notebook comportant des tâches planifiées est supprimé ou envoyé dans la corbeille, les tâches sont supprimées définitivement et ne peuvent pas être restaurées.

Préparer le notebook

Vous pouvez 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. 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, s’apparentant aux 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.

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. Vérifiez que vous êtes connecté et que vous disposez des privilèges appropriés pour créer et planifier des notebooks.
2. 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.

3. Sur le ruban supérieur de l’éditeur de notebooks, cliquez sur Tasks (Tâches).
4. 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 de l’élément du notebook.

5. 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.
6. 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.
7. Cliquez sur Next (Suivant).
8. Sur la page Set task schedule details (Détailler la planification de la tâche), spécifiez la planification de la 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 Week (Semaine), des cases à cocher s’affichent pour chaque jour de la semaine.

9. Si le notebook à planifier lit ou crée des fichiers dans le répertoire de l’espace de travail (/arcgis/home), activez le bouton bascule Use workspace (Utiliser l’espace de travail) pour monter le répertoire pour chaque tâche exécutée. Si le notebook ne nécessite pas d’accès au répertoire de l’espace de travail, désactivez le bouton bascule.

   Remarque :

   Avec le bouton bascule Use workspace (Utiliser l’espace de travail) désactivé pour une tâche de notebook, vous pouvez toujours écrire des fichiers pendant l’exécution d’une tâche. Néanmoins, les fichiers écrits seront uniquement conservés à un emplacement temporaire pendant la durée de l’exécution de la tâche, puis seront supprimés une fois l’exécution de la tâche terminée.

10. 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.
11. 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é.
12. 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.
13. 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, vous pouvez créer d’autres tâches pour le notebook à l’aide du même processus. Vous pouvez avoir un maximum de cinq tâches actives sur tous vos notebooks. Interrompez ou supprimez des tâches actives si vous avez déjà cinq tâches actives et souhaitez en planifier d’autres.

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 apporter des modifications aux 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 é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. Vérifiez que vous êtes connecté et que vous disposez des privilèges appropriés pour créer des notebooks.
2. Dans le ruban supérieur de l’éditeur de notebooks, cliquez sur Tasks (Tâches).
3. Dans la section Scheduled Tasks (Tâches planifiées), recherchez la tâche que vous voulez utiliser.
4. 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 voir les détails et l’état de chaque exécution de la tâche. Pour consulter les résultats d’exécution, cliquez sur le bouton Results (Résultats) . Le statut d’une tâche peut être l’un des suivants :
     • Terminée : la tâche s’est terminée avec succès.
     • En cours d’exécution : la tâche est actuellement en cours d’exécution.
     • Échec : la tâche n’est pas parvenue à s’exécuter correctement. Si une tâche échoue cinq fois, elle est complètement arrêtée.
     • Ignorée - La tâche a été ignorée, car une exécution précédente était toujours en cours.
   • 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 éléments du notebook.