Comment planifier des Tâches API

La planification d'une Tâche API vous permet de lancer des automatisations indépendantes de l'infrastructure Bot Runner (utilisateurs et périphériques). Étant donné que les Tâches API fonctionnent sur le cloud, aucune licence utilisateur individuelle n'est nécessaire, ce qui permet de réduire les coûts et de simplifier la gestion de l'automatisation.

Vous pouvez planifier l'exécution des Tâches API disponibles à des heures précises. Par exemple, le traitement d'un lot de factures dans un fichier .csv à exécuter tous les mercredis à 17 h 00.
Remarque : La planification des Tâches API dans la Control Room nécessite de disposer d'une licence Plateforme Enterprise. Reportez-vous à la rubrique Plateforme Enterprise.

Prérequis

Assurez-vous d'être connecté à la Control Room en tant qu'administrateur ou en tant qu'utilisateur disposant des autorisations suivantes :

Procédure

  1. Connectez-vous à Control Room.
  2. Pour créer une planification, sélectionnez l'une des méthodes suivantes dans le panneau de gauche :
    • Cliquez sur Automatisation.

      Cliquez sur le menu Actions (trois points verticaux) en regard de la Tâche API que vous souhaitez planifier, puis cliquez sur Planifier la tâche API.

    • Cliquez sur Gestion > Planifiée > Créer une planification.
    L'écran Automatisation et dépendances s'affiche. Vous pouvez également cliquer sur l'option Choisir pour rechercher une Tâche API spécifique.
  3. Sélectionnez la Tâche API que vous souhaitez planifier, puis cliquez sur Choisir.
    L'écran Créer un calendrier s'affiche ; il comporte plusieurs onglets.
  4. Utilisez l'onglet Automatisation et dépendances pour examiner et mettre à jour les champs suivants :
    • Fichier d'automatisation : Affiche la Tâche API sélectionnée.

      Si vous souhaitez sélectionner une autre Tâche API, cliquez sur Choisir.

    • Exécuter l'automatisation et les dépendances en utilisant : sélectionnez l'une des versions suivantes de la Tâche API à exécuter :
      • Dernière version : planifie la Tâche API sélectionnée et les dépendances en utilisant la version la plus récente.
      • Étiquette de production : planifie la Tâche API sélectionnée et les dépendances en utilisant la version de production.

      Par défaut, la dernière version du Tâche API est sélectionnée.

    • Dépendances : Liste des dépendances de la Tâche API sélectionnée.
  5. Cliquez sur Suivant.
  6. Ajoutez les détails de planification de la Tâche API.
    Dans le champ Planifier, sélectionnez l'une des options suivantes :
    • Exécuter une fois : exécute une fois la Tâche API au jour et à l'heure spécifiés.

      Les options suivantes permettent de configurer le paramètre Exécuter une fois :

      • Date de début : La valeur par défaut est le jour actuel.
      • Heure de début : la valeur par défaut est arrondie à la demi-heure suivante.
      • Fuseau horaire : Fuseau horaire du système sur votre périphérique local.
        Remarque : Les fuseaux horaires EST, HST ou MST sont obsolètes. Reportez-vous à la rubrique Prochaines obsolescences de fonctionnalités.
    • Exécuter de façon répétée : utilisez cette option pour planifier votre Tâche API de sorte qu'elle s'exécute à l'heure spécifiée un jour donné.

      Les options suivantes permettent de configurer le paramètre Exécuter de façon répétée :

      • Date de début : Saisissez la date à laquelle vous souhaitez que la planification commence à exécuter le Tâche API.

        Saisissez la date manuellement au format AAAA/MM/JJ ou en utilisant le calendrier contextuel. La valeur par défaut du champ Date de début est définie sur le jour actuel de votre périphérique local.

      • Date de fin : Saisissez la date à laquelle vous souhaitez que la planification prenne fin.

        La Date de fin n'est pas définie par défaut.

      • Heure de début : Définissez le champ Heure de début à l'aide de la liste déroulante pour définir la valeur de l'heure à laquelle vous souhaitez que votre planification commence.

        La liste contient des valeurs d'heure prédéfinies au format 12 heures à intervalles de 15 minutes. Vous pouvez également définir manuellement la valeur d'heure au format 12 heures.

      • Fuseau horaire : définissez le fuseau horaire avec l'heure de début et l'heure de fin.

        La valeur par défaut est définie sur l'emplacement actuel de votre système. Une planification est exécutée en fonction du fuseau horaire sélectionné lors de sa création ou de sa modification.

      • Répéter chaque : Sélectionnez cette option pour répéter la planification.
    • Fréquence : sélectionnez l'une des options suivantes comme fréquence d'exécution de la planification :
      • Tous les jours : sélectionnez le nombre de jours pendant lesquels vous souhaitez que la planification s'exécute.
      • Toutes les semaines : sélectionnez les semaines et les jours de la semaine où vous souhaitez que la planification s'exécute.

        Par exemple, si vous souhaitez que la planification s'exécute toutes les 2 semaines, le lundi et le jeudi, définissez l'option Chaque sur 2 et cochez les cases Lundi et Jeudi.

      • Tous les mois : Sélectionnez l'une des options suivantes :
        • Jour : sélectionnez le jour des mois où vous souhaitez que la planification s'exécute.
        • Le : sélectionnez une occurrence particulière du jour des mois où vous souhaitez que la planification s'exécute.

          Par exemple, si vous souhaitez que la planification s'exécute le deuxième jeudi des mois de janvier, mai et septembre, sélectionnez Deuxième, Jeudi et Janvier, Mai et Septembre parmi les options proposées.

        Remarque : Lorsque l'heure d'été est activée et que la Date de début est planifiée, la date s'affiche dans le fuseau horaire auquel elle appartient (et non dans le fuseau horaire actuel de l'utilisateur). Cependant, la Prochaine occurrence s'affiche dans le fuseau horaire (fuseau horaire du système de l'utilisateur) selon l'heure d'été.

        Par exemple, pour une planification créée le 15 mars dans le fuseau horaire GMT, la Date de début est indiquée comme étant le 15 mars, conformément au fuseau horaire GMT. Ultérieurement, lorsque l'heure d'été est activée et que vous modifiez ou affichez cette planification au mois d'août dans le fuseau horaire CET, la prochaine occurrence est indiquée en août, conformément au fuseau horaire CET.

        Si vous planifiez l'exécution de la tâche du 23/11/2023 à 9 h 00 au 30/11/2023 à 9 h 00 avec la fréquence définie sur Tous les jours, la tâche s'exécute quotidiennement à partir du 23/11/2023 à 9 h 00, et la dernière tâche est exécutée le 30/11/2023 à 9 h 00.

    • Dans la section Paramètre de planification manquée, cochez la case Redéployer la planification pour redéployer une planification manquée à la suite d'un arrêt de la Control Room.

      Lorsque l'option Redéployer la planification est sélectionnée, les planifications manquées à la suite d'un arrêt de la Control Room sont automatiquement redéployées après le redémarrage de la Control Room. Une entrée dans le journal d'audit est également ajoutée, indiquant le Type d'événement comme étant Schedule misfired.

      Remarque : Pour garantir un déploiement réussi lors de l'utilisation de l'option Redéployer à nouveau le planning, vous devez démarrer le service de compilation avant de redémarrer les services de Control Room.
  7. Cliquez sur Suivant.
  8. Utilisez l'onglet Utilisateurs Exécuter en tant que pour effectuer les opérations suivantes :
    • Sélectionnez les utilisateurs dans la liste du champ Exécutions en tant qu'utilisateurs disponibles et cliquez sur la flèche vers le bas pour ajouter votre sélection.

      Les utilisateurs que vous avez sélectionnés sont répertoriés dans le tableau sélectionné. Vous pouvez utiliser la flèche vers le haut pour supprimer l'un des utilisateurs sélectionnés.

      Remarque : Le système génère un utilisateur appelé apitaskrunner qui est associé au rôle AAE_API Task Runner pour établir le contexte de l'utilisateur Exécuter en tant que pour les Tâches API.
    • Dans le champ Définir le nombre d'utilisateurs Exécuter en tant que à utiliser, choisissez l'une des options suivantes :
      • Tous les utilisateurs Exécuter en tant que : sélectionnez cette option pour spécifier tous les utilisateurs disponibles dans le tableau sélectionné comme utilisateurs Exécuter en tant que, lors de l'exécution de la Tâche API.
      • Nombre personnalisé d'utilisateurs Exécuter en tant que : sélectionnez cette option pour fournir un certain nombre d'utilisateurs du tableau sélectionné que vous souhaitez utiliser comme utilisateurs Exécuter en tant que.

        Par exemple, si vous avez 5 utilisateurs dans le tableau sélectionné et que vous souhaitez en utiliser seulement 3 comme utilisateurs Exécuter en tant que, saisissez 3. Les 3 utilisateurs répertoriés en haut du tableau sont utilisés comme utilisateurs Exécuter en tant que lors de l'exécution de la Tâche API.

  9. Cliquez sur Suivant.
  10. Facultatif : L'onglet Général permet de modifier les paramètres par défaut des options suivantes :
    • Nom de l'activité : modifiez ou renommez le Tâche API.
    • Priorité d'automatisation : cliquez sur le menu déroulant pour définir la priorité d'automatisation.

      Bien que la priorité d'automatisation soit par défaut définie sur Moyen, vous pouvez la modifier afin de traiter les automatisations pour le déploiement en conséquence.

  11. Cliquez sur Créer une planification.
    La Tâche API est planifiée. Vous pouvez consulter l'état des Tâches API planifiées sur la page Gérer > Planifiée.