Filtrer :

Démarrer la recherche

# Gérer les batchs

Un batch est un programme qui permet de réaliser un traitement automatique selon une fréquence paramétrée. Il peut également être lancé manuellement. Par exemple, certains batchs permettent d'éviter d'effectuer manuellement des tâches répétitives à faible valeur ajouté et d'autres permettent de lier des données d'Akuiteo à d'autres logiciels ou bases de données.

Créer un batch

| 1 | Allez dans Outils > Paramétrage > Batchs > Batch création et modification.

La liste des batchs déjà créés dans Akuiteo s'ouvre.

| 2 | Dans la barre d'action, cliquez sur .

| 3 | Dans l'écran Nouveau Batch, renseignez les champs suivants :

Champ | Description
--- | ---
Modèle de batch | Sélectionnez le modèle de batch depuis la liste déroulante. En fonction du modèle sélectionné, les paramètres affichés dans le tableau se mettent à jour.
Code | Attribuez un code au batch pour l'identifier. Le code de chaque batch doit être unique, toutes sociétés confondues.
Libellé | Renseignez un libellé pour nommer le batch.
Restreindre l'affichage au DMF | Renseignez un DMF si vous souhaitez restreindre l'affichage du batch à certains utilisateurs. Seuls les utilisateurs possédant le DMF en question pourront afficher le batch.
Restreindre la modification des paramètres au DMF | Renseignez un DMF si vous souhaitez restreindre la modification des paramètres à certains utilisateurs. Seuls les utilisateurs possédant le DMF en question pourront modifier les paramètres du batch.
Restreindre le lancement au DMF | Renseignez un DMF si vous souhaitez restreindre le lancement du batch à certains utilisateurs. Seuls les utilisateurs possédant le DMF en question pourront lancer le batch.
Paramètres | Le tableau affiche les différents paramètres disponibles en fonction du Modèle de batch sélectionné. Certains paramètres sont spécifiques à chaque modèle de batch mais d'autres paramètres sont communs et peuvent se retrouver dans la plupart des batchs. Ces paramètres communs remplissent toujours la même fonction quel que ce soit le batch mais leurs valeurs sont indépendantes à chaque batch. Double-cliquez sur chaque paramètre souhaité puis renseignez la valeur nécessaire. Tous les paramètres obligatoires doivent être renseignés. Référence Pour plus d'informations sur les paramètres de batch, voir Paramétrer un batch.

| 4 | Dans la barre d'action, cliquez sur .

Le batch est créé. Vous pouvez désormais le planifier et le lancer.

Modifier un batch

| 1 | Dans Outils > Paramétrage > Batchs > Batch création et modification, recherchez et ouvrez le batch.

| 2 | Dans la barre d'action, cliquez sur .

| 3 | Effectuez les modifications souhaitées.

Références

Pour modifier les paramètres du batch, voir Paramétrer un batch.

Pour planifier le batch, voir Planifier un batch.

| 4 | Dans la barre d'action, cliquez sur .

Le batch est modifié.

Paramétrer un batch

Les paramètres du batch sont rassemblés dans le tableau Paramètres de l'onglet Batch.

Certains paramètres sont spécifiques à chaque modèle de batch mais d'autres paramètres sont communs et peuvent se retrouver dans la plupart des batchs. Ces paramètres communs remplissent toujours la même fonction quel que ce soit le batch mais leurs valeurs sont indépendantes à chaque batch.

Lorsqu'un nouveau modèle est choisi, la liste des paramètres disponibles s'actualise.

Important

Lors de la sélection d'un nouveau modèle, aucune des valeurs renseignées dans les paramètres de l'ancien modèle n'est conservée.

Description des paramètres

Chaque paramètre contient les données suivantes :

- Le Code est l'identifiant unique du paramètre.
- La Description indique l'utilité du paramètre et peut préciser le type de valeur attendue.
- La Valeur indique la valeur utilisée pour le paramètre lors du traitement du batch. Les valeurs possibles dépendent du type du paramètre.
- Le Type indique le type du paramètre et les valeurs possibles pour ce paramètre. Le paramètre ne peut être que d'un seul type.
- La colonne Obligatoire ? indique si le paramètre doit obligatoirement être renseigné. Le batch ne pourra pas être lancé si aucune valeur n'est renseignée pour un paramètre obligatoire.

Gérer les paramètres d'un batch

| 1 | Ouvrez le batch souhaité et cliquez sur dans la barre d'action.

| 2 | Double-cliquez sur le paramètre à modifier.

La fenêtre de saisie du paramètre s'ouvre.

| 3 | Si besoin, modifiez la Description.

| 4 | Renseignez la valeur souhaitée en fonction du type du paramètre :

- Chaîne : Renseignez une chaîne de caractères. Par exemple : RESP_COM_AFF ou support@akuiteo.com.
- Date.
- Nombre.
- Booléen : Sélectionnez Vrai ou Faux depuis la liste déroulante.
- Liste de valeurs.
- Requête SQL.

Important

Une requête SQL doit être renseignée uniquement sur indication de la société Akuiteo.

| 5 | Cliquez sur Valider.

| 6 | Dans la barre d'action, cliquez sur .

Le paramètre est modifié et le batch est enregistré.

Note

Après une mise à jour d'Akuiteo, un paramètre pourrait être manquant. Dans ce cas, il est possible d'ajouter un paramètre en cliquant sur en haut à droite du tableau. Cet ajout doit être effectué uniquement sur indication de la société Akuiteo.

Il est également possible de supprimer un paramètre en cliquant dessus, puis en cliquant sur en haut à droite du tableau. Cette suppression doit être effectuée uniquement sur indication de la société Akuiteo.

Configurer les paramètres communs

Les paramètres dans le tableau suivant sont communs et peuvent se retrouver dans la plupart des batchs. Ces paramètres remplissent toujours la même fonction quel que ce soit le batch mais leurs valeurs sont indépendantes à chaque batch :

Code | Description | Type | Obligatoire
--- | --- | --- | ---
`BATCH_DEBUG_PARAMS` | Lorsque le paramètre est Vrai, les paramètres du batch s'affichent dans les logs. Note Le log est un fichier texte d'extension .log qui se génère à chaque exécution du batch. Il contient l'historique de toutes les opérations effectuées durant l'exécution du batch. On peut l'ouvrir grâce à un éditeur de texte. | Booléen | Non
`BATCH_LOG_CONSOLE` | Lorsque le paramètre est Vrai, les logs s'affichent à la fois dans la console et dans le fichier de log. La console est une fenêtre utilisée par les développeurs qui indique l'activité d'Akuiteo. | Booléen | Non
`BATCH_LOG_FILE` | Répertoire du serveur de l'instance dans lequel le fichier de log s'enregistre. | Chaîne Ex : C:\AKUITEO\logs_batch | Non
`BATCH_LOG_ID` | Identifiant (nom) du fichier de log. Il est conseillé d'éviter les accents et les espaces. | Chaîne Ex : RelancesAutomatiques.log | Non
`BATCH_LOG_LEVEL` | Niveau de log. Il est possible de choisir un niveau de log parmi les suivants : `ERROR` : Seules les erreurs sont présentes dans les logs. `WARN` : Les erreurs et les warnings sont présents dans les logs. `INFO` : Les erreurs, les warnings et les messages d’information sont présents dans les logs. `DEBUG` : Les messages pour "débugger" Akuiteo, les erreurs, les warnings et les messages d’information sont présents dans les logs. Important La modification de ce paramètre doit être effectuée uniquement sur indication de la société Akuiteo car des fichiers volumineux peuvent se créer et saturer le disque. | Chaîne Ex : WARN | Non
`BATCH_MAIL` | Adresse mail du destinataire des logs en cas d'erreur. | Chaîne Ex : support@akuiteo.com | Oui
`BATCH_MAIL_CC` | Adresse mail du destinataire en copie des logs en cas d'erreur. | Chaîne Ex : support@akuiteo.com | Non
`BATCH_MAIL_CCI` | Adresse mail du destinataire en copie cachée des logs en cas d'erreur. | Chaîne Ex : support@akuiteo.com | Non
`BATCH_MAIL_FROM` | Adresse mail de l'expéditeur des logs en cas d'erreur. | Chaîne Ex : support@akuiteo.com | Non
`BATCH_MAIL_REPLY_TO` | Adresse mail du destinataire de la réponse au mail reçu en cas d'erreur et contenant les logs. | Chaîne Ex : support@akuiteo.com | Non
`BATCH_PWD` | Mot de passe de l'utilisateur lançant le batch. Ce mot de passe doit être associé au `BATCH_USER` renseigné. Dans le tableau, des * s'affichent à la place du mot de passe. | Chaîne Ex : aHFG45*F | Oui
`BATCH_USER` | Identifiant de l'utilisateur lançant le batch. L'utilisateur doit se trouver sur la société sur laquelle est lancé le batch. Si le batch est paramétré sur la société *****, l'utilisateur doit également être de la société *****. | Chaîne Ex : TECH | Oui

Planifier un batch

La planification d'un batch permet de faire en sorte que le batch se lance automatiquement aux instants souhaités selon les paramètres de planification définis.

| 1 | Ouvrez le batch souhaité et cliquez sur dans la barre d'action.

| 2 | Depuis l'onglet Planification, sélectionnez un mode de planification parmi les cinq proposés :

- Inactif : Permet de désactiver la planification. Dans ce cas, le batch ne peut s'exécuter que par un lancement manuel.
- Mode Simple : Permet d'activer la planification simple.
- Ordonnancement : Permet de lancer le batch avant ou après le traitement d'un autre batch.
- Mode calendrier : Permet de lancer le batch à des dates précises sans que cela ne corresponde à une fréquence définie.
- Mode Avancé : Permet de définir des options de planification avancées.

Note

Il est impossible de sélectionner plusieurs modes de planification à la fois. Par exemple, il est impossible de sélectionner le Mode Simple tout en utilisant le Mode calendrier pour en plus planifier des dates avec le calendrier.

| 3 | Paramétrez la planification selon le mode sélectionné.

Note

Pour plus d'informations sur le paramétrage de la planification, consultez la sous-partie qui correspond au mode de planification sélectionné.

| 4 | Dans la barre d'action, cliquez sur .

Le batch est planifié.

Inactif

Par défaut lors de sa création, un batch est réglé sur Inactif.

Cochez Inactif pour désactiver la planification du batch. Dans ce mode, le batch peut uniquement se lancer de manière manuelle (voir Lancer un batch manuellement).

Mode Simple

Cochez Mode Simple pour activer la planification simple du batch.

Ce mode permet de planifier une exécution du batch ou de définir une certaine récurrence pour le lancement du batch.

Exemples

Je souhaite lancer le traitement d'un batch tous les dimanches à 23:59 :

1. Dans la liste déroulante Récurrence, je sélectionne Semaine.
2. Parmi les jours de la semaine, je coche Dimanche.
3. Dans le champ Heure, je renseigne 23.
4. Dans le champ Minute, je renseigne 59.

Je souhaite lancer le traitement d'un batch tous les ans, le 31 décembre à 00:00 :

1. Dans la liste déroulante Récurrence, je sélectionne Année.
2. Dans le champ Jour, je renseigne 31.
3. Dans la liste déroulante Mois, je sélectionne Décembre.
4. Dans le champ Heure, je renseigne 0.
5. Dans le champ Minute,je renseigne 0.

Important

Il est nécessaire de ne pas exécuter deux batchs de même modèle en même temps, par exemple deux batchs RelancesAutomatiques planifiés aux mêmes jours et à la même heure. En effet, des dysfonctionnements se présenteront.

De la même manière, il est nécessaire de ne pas définir une fréquence plus courte que le temps nécessaire pour l'exécution du batch. Par exemple, si un batch a une durée de traitement de deux heures, il ne faut pas programmer son exécution toutes les heures.

Champ | Valeurs possibles
--- | ---
Récurrence | Sélectionnez le rythme de la récurrence depuis la liste déroulante : Jamais (désactivé) : La récurrence est désactivée. Le batch ne peut se lancer que de manière manuelle. Une seule fois : Le batch n'est lancé qu'une seule fois à la date renseignée. Semaine : Le batch est lancé toutes les semaines, au jour de la semaine et à l'heure renseignés. Mois : Le batch est lancé tous les mois, au jour du mois et à l'heure renseignés. Année : Le batch est lancé tous les ans, à la date et à l'heure renseignés.
Lundi, Mardi, Mercredi, Jeudi, Vendredi, Samedi et Dimanche. | Seulement disponible pour la récurrence Semaine. Cochez un ou plusieurs jours de la semaine pendant le(s)quel(s) le batch se lance.
Jour | Seulement disponible pour les récurrences Une seule fois, Semaine, Mois, et Année. Renseignez le numéro du jour du mois pendant lequel le batch se lance, de 1 à 31. Important Si vous renseignez un numéro du jour plus grand que le nombre de jours dans le mois, le batch ne se lancera pas pour ce mois-là. Par exemple, si vous renseignez 31 et que le mois comporte 30 jours au moins, le batch ne se lancera pas pour ce mois-là.
Mois | Seulement disponible pour les récurrences Une seule fois, Semaine et Année. Sélectionnez le mois pendant lequel le batch se lance.
Année | Seulement disponible pour les récurrences Une seule fois, Semaine et Année. Sélectionnez l'année pendant laquelle le batch se lance.
Heure et Minute | Disponible pour les récurrences Une seule fois, Semaine, Mois et Année. Sélectionnez l'heure et la minute auxquelles le batch se lance.

Astuce

Lorsque vous enregistrez le batch, la planification paramétrée est visible également dans la partie Mode avancé. Cela peut être utile pour vérifier les modifications que vous avez effectuées.

Ordonnancement

Cochez Ordonnancement pour que le batch se lance avant ou après le traitement d'un autre batch.

Option | Description
--- | ---
Batch suivant | Sélectionnez un batch depuis la liste déroulante. Cette liste comporte tous les batchs créés dans Akuiteo. Après le traitement du batch actuel, le batch sélectionné dans la liste se lance automatiquement.
Lancement le batch suivant même si le batch en cours est en statut FAILED | Si la case est cochée, le batch suivant se lance même si le batch en cours est en statut FAILED. Si la case n'est pas cochée, le batch suivant ne se lance pas si le batch actuel est en statut FAILED.
Batch précédent | Sélectionnez un batch depuis la liste déroulante. Cette liste comporte tous les batchs créés dans Akuiteo. Après le traitement du batch sélectionné dans la liste, le batch actuel se lance automatiquement.
Lancer ce batch même si le batch précédent est en statut FAILED | Si la case est cochée, le batch actuel se lance même si le batch précédent est en statut FAILED. Si la case n'est pas cochée, le batch actuel ne sera pas exécuté si le batch précédent est en statut FAILED.

Mode calendrier

Cochez Mode calendrier pour planifier le lancement du batch à des dates fixes. Les dates sont définies dans l'onglet Calendrier de la page du batch. Elles peuvent également être ajoutées par un API.

| 1 | Cliquez sur l'onglet Calendrier.

| 2 | En haut du tableau Planification Batch, cliquez sur .

| 3 | Dans le champ de saisie, cliquez sur .

Un calendrier s'ouvre.

| 4 | Sélectionnez la date et l'heure souhaitée.

Important

Il est impossible de renseigner une date inférieure à la date de dernière exécution du batch.

La date et l'heure s'affichent dans le champ.

| 5 | Dans la barre d'action, cliquez sur .

Le batch est planifié aux dates fixées. Le tableau suivant résume la signification des icônes :

Icône | Description
--- | ---
Aucune icône | Le batch s'exécutera à cette date mais au moins une autre date antérieure est programmée.
| Le batch s'exécutera la prochaine fois à cette date.
| Le batch s'est exécuté à cette date.

Note

Si le mode calendrier est désactivé et que des dates sont programmées dans l'onglet Planification Batch, le batch ne se lancera pas aux dates programmées.

Si le batch est déjà en exécution lorsque l'on atteint une date et une heure programmées, le batch ne se lancera pas une nouvelle fois.

Mode Avancé

Cochez Mode Avancé pour définir des options de planification avancées. Le mode avancé utilise la syntaxe des expressions cron d'Unix.

Important

Il est nécessaire de ne pas exécuter deux batchs de même modèle en même temps, par exemple deux batchs RelancesAutomatiques planifiés aux mêmes jours et à la même heure. En effet, des dysfonctionnements se présenteront.

De la même manière, il est nécessaire de ne pas définir une fréquence plus courte que le temps nécessaire pour l'exécution du batch. Par exemple, si un batch a une durée de traitement de deux heures, il ne faut pas programmer son exécution toutes les heures.

Les champs doivent être remplis des manières suivantes :

Champ | Valeurs possibles
--- | ---
Seconde | [0-59] , - / *
Minute | [0-59] , - / *
Heure | [0-23] , - / *
Jour du mois | [1-31] , - / * ? L W
Mois | [0-11] {JAN,MAY,.} , - / *
Jour de la semaine | [1-7] {MON,WED,.} , - / * ? L Dièse Le 1 correspond au dimanche, le 2 au lundi, etc.
Année | Vide [1970-2099] , - / *

Les caractères spéciaux sont utilisés des manières suivantes :

Caractère | Description | Exemple
--- | --- | ---
, | Permet de saisir plusieurs valeurs. | Je souhaite lancer le batch le 1er et le 15 de chaque mois : Dans le champ Jour du mois, je renseigne 1,15.
- | Permet de saisir l'intervalle entre deux valeurs (De X à X). | Je souhaite lancer le batch tous les mois de janvier à juin : Dans le champ Mois, je renseigne : 1-6 qui correspond aux valeurs 1, 2, 3, 4, 5, 6.
/ | Permet d'incrémenter à partir d'une valeur de départ. | Je souhaite lancer le batch toutes les 15 minutes : Dans le champ Minute, je renseigne 0/15 qui correspond aux valeurs 0, 15, 30, 45. Je souhaite lancer le batch toutes les 10 minutes : Dans le champ Minute, je renseigne 0/10 qui correspond aux valeurs 0, 10, 20, 30, 40, 50. Je souhaite lancer le batch toutes les 20 minutes à partir de la minute 3 : Dans le champ Minute, je renseigne 3/20 qui correspond aux valeurs 3, 23, 43.
* | Permet de sélectionner toutes les valeurs possibles du champ. | Je souhaite lancer le batch tous les mois : Dans le champ Mois, je renseigne * qui correspond aux valeurs de 1 à 12.
? | Permet de sélectionner soit le jour du mois soit le jour de la semaine : Si on sélectionne le ou les jours du mois, on écrit ? dans le champ Jour de la semaine. Inversement, si on sélectionne le ou les jours de la semaine, on écrit ? dans le champ Jour du mois. | Je souhaite lancer le batch le premier jour de chaque mois : Dans le champ Jour du mois, je renseigne 1. Dans le champ Jour de la semaine, je renseigne ?.
L | Signifie la dernière valeur possible du champ : S'il est renseigné seul dans le champ Jour du mois, cela sélectionne le dernier jour du ou des mois. S'il est renseigné seul dans le champ Jour de la semaine, cela sélectionne le dernier jour de la semaine (soit 7 ou samedi). S'il est renseigné juste après une valeur, cela permet de sélectionner la dernière de cette valeur. | Je souhaite lancer le batch le dernier jour du mois : Dans le champ Jour du mois, je renseigne L. Dans le champ Jour de la semaine, je renseigne ?. Je souhaite lancer le batch le dernier vendredi du mois : Dans le champ Jour de la semaine, je renseigne 6L. Dans le champ Jour du mois, je renseigne ?.
W | Permet de sélectionner le plus proche jour de la semaine hors week-ends. | Je souhaite lancer le batch à partir du dixième jour de chaque mois. Cependant, le batch ne doit pas être lancé pendant le week-end : Dans le champ Jour du mois, je renseigne 10W. Ainsi, si le 10 est un samedi ou un dimanche, le batch sera lancé le lundi.
# | Permet de sélectionner l'énième jour de la semaine dans le mois. | Je souhaite lancer le batch le troisième mercredi du mois : Dans le champ Jour de la semaine, je renseigne WED#3.

Astuce

Dans l'onglet Planification, on retrouve en haut à droite deux liens : Aide et Documentation. Ces liens renvoient vers des ressources (en anglais) pour mieux comprendre la syntaxe.

Gérer le traitement d'un bach
Lancer un batch manuellement

Il est possible de lancer un batch à n'importe quel moment, par exemple lorsque vous n'avez pas besoin que le batch soit planifié ou lorsque vous souhaitez tester le batch pour savoir s'il fonctionne correctement. Le lancement manuel peut également s'effectuer en complément d'une autre planification.

| 1 | Allez dans Outils > Paramétrage > Batchs > Batch (CR d'exécutions).

La liste des batchs préalablement créés et paramétrés s'ouvre.

| 2 | Faites un clic droit sur la ligne du batch souhaité.

| 3 | Cliquez sur Lancer le traitement.

Le traitement s'effectue en arrière-plan.

À la fin du traitement, la colonne Statut affiche :

- COMPLETED si le traitement du batch s'est déroulé sans erreur.
- FAILED si le traitement a échoué.

Arrêter le traitement d'un batch

Lorsqu'un batch est en cours de traitement, vous pouvez l'interrompre à tout moment, par exemple si vous vous rendez compte que le batch n'a pas bien été paramétré.

| 1 | Allez dans Outils > Paramétrage > Batchs > Batch (CR d'exécutions).

La liste des batchs préalablement créés et paramétrés s'ouvre.

| 2 | Faites un clic droit sur la ligne du batch à arrêter.

| 3 | Cliquez sur Arrêter le traitement.

Le traitement s'arrête.

Consulter le compte rendu d'un traitement

| 1 | Allez dans Outils > Paramétrage > Batchs > Batch (CR d'exécutions).

| 2 | Dans le tableau Batchs, double-cliquez sur le batch souhaité.

La liste des comptes rendus des traitements du batch sélectionné s'affiche.

| 3 | Double-cliquez sur la ligne d'un traitement.

Le compte rendu du traitement du batch s'affiche.

Supprimer un batch

Important

La suppression d'un batch est définitive.

Depuis l'écran du batch, cliquez sur dans la barre d'action et confirmez la suppression.