Planning API Tasks

Planifier un API Task vous permet de lancer des automatisations indépendantes de l\'infrastructure Bot Runner (utilisateurs et appareils). Comme API Tasks fonctionne sur Cloud, cela élimine le besoin de licences utilisateur individuelles, ce qui permet de réduire les coûts et de simplifier la gestion de l\'automatisation.

Remarque : La planification des API Tasks dans la Control Room nécessite de disposer d\'une Enterprise Platform licence. Pour plus d\'informations sur la version prise en charge par cette fonctionnalité, consultez Enterprise Platform.
Vous pouvez programmer les API Tasks disponibles pour s\'exécuter à des heures spécifiées. Par exemple, traiter un lot de factures dans un fichier .csv pour l\'exécuter tous les mercredis à 17h.

Prérequis

Assurez-vous d\'être connecté à la Control Room en tant qu\'administrateur ou en tant qu\'utilisateur disposant des autorisations suivantes :
  • Planifiez mes robots pour qu\'ils s\'exécutent
  • Gérer TOUTE l\'activité planifiée à partir de mes Dossiers autorisation au niveau du dossier pour des API Task spécifiques et toutes les dépendances
  • Exécuter en tant qu\'utilisateur API Tasks.

    Pour plus d\'informations, consultez Utilisateur Exécuter en tant que pour API Task (apitaskrunner).

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 des actions (trois points verticaux) à droite de API Task pour lequel vous souhaitez créer un planning, puis cliquez sur Planifier 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 API Task spécifique.
  3. Sélectionnez les API Task que vous souhaitez planifier et 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 le API Task sélectionné.

      Si vous souhaitez sélectionner une autre API Task, cliquez sur Choisir.

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

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

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

      Utilisez les options suivantes pour configurer le paramètre Run once :

      • 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. Voir Upcoming feature deprecations.
    • Exécuter de façon répétée: Utilisez cette option pour planifier votre API Task de sorte qu\'il s\'exécute à l\'heure spécifiée un jour donné.

      Utilisez les options suivantes pour configurer le paramètre Exécuter de manière répétée :

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

        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 : Sélectionnez le fuseau horaire pour 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 pour l\'exécution du programme :
      • 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.

      • Mensuel : 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 soit exécutée le deuxième jeudi 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 BST, la prochaine occurrence est indiquée en août, conformément au fuseau horaire BST.

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

    • Dans la section Paramètre de planification manquée, cochez la case Redéployer la planification pour redéployer une planification manquée à cause de toute fermeture de Control Room.

      Lorsque l\'option Redéployer la planification est sélectionnée, les planifications manquées à cause de tout 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 Exécuter en tant qu\'utilisateurs pour effectuer les opérations suivantes :
    • Sélectionnez les utilisateurs dans la liste du tableau 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 API Tasks.
    • Dans le champ Définir le nombre d\'exécutions en tant qu\'utilisateurs à utiliser, choisissez l\'une des options suivantes :
      • Toutes les exécutions en tant qu\'utilisateurs : 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 API Task.
      • Nombre personnalisé d\'exécutions en tant qu\'utilisateurs : 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 API Task.

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

      Moyen est la priorité d\'automatisation par défaut, mais vous pouvez la modifier afin de traiter les automatisations pour le déploiement en conséquence.

  11. Cliquez sur Créer une planification.
    Le API Task est prévu. Vous pouvez consulter le statut de la API Tasks planifiée sur la page Gérer > Planifiée.