Home

EBAD - Exécution des Batchs à Distance

EBAD est composé de 3 parties :

L'utilisation ou "fonction" : c'est ici que vous allez pouvoir lancer un batch, ajouter une tâche planifiée, récupérer ou déposer des fichiers
La gestion : Dans cette section vous pouvez ajouter des environnements (ou serveur), paramétrer des batchs, des dossiers et gérer les habilitations sur vos applications
L'administration : Elle permet de gérer l'ensemble des utilisateurs, normes, applications et actualités

1 Utilisation

Le rôle Utilisateur est requis pour ces actions.

1.1 Demander l'accès à une application

Pour pouvoir lancer un batch ou faire tout autre action, il vous faut être habiliter à une application. Pour cela, il vous suffit de vous rendre dans le menu "Accréditations" et cliquer sur le bouton "+ Nouvelle demande". Une boite de dialogue s'ouvre, commencez à taper les premiers caractères de l'applications pour vous la voir proposer, cliquez-dessus puis sélectionnez les types de droits que vous souhaitez :

Droit de gestion
Droit d'utilisation Cliquez sur le bouton "envoyer". Lorsque cela est fait, un administrateur EBAD ou un gestionnaire de l'application pourra valider votre demande.

1.2 Lancer un batch

Pour lancer un batch, il vous faut avant tout les accès à l'application voulue (voir 1.1 'Demander l'accès à une application')

Afin de lancer un batch, rendez-vous dans le menu Fonction > Batchs. Sélectionnez en haut à droite l'application désirée ainsi que l'environnement sur lequel vous souhaitez lancer le batch.

Une liste avec l'ensemble des batchs paramétrés (voir 2.x 'gestion des batchs' pour paramétrer les batchs) s'affiche. Vous avez la possibilité de :

Modifier la date présente dans le fichier de date (voir 3.x 'normes') en cliquant sur le calendrier en haut à droite
lancer un batch avec les paramètres par défaut en cliquant sur le bouton "Lancer"
lancer un batch avec des paramètres en cliquant sur le bouton "Lance avec paramètres"

Lorsque vous lancez un batch, une notification apparait pour vous indiquer si le batch est bien lancé et son éventuel retour. Vous pouvez consulter l'ensemble des lancements de batchs dans le menu Fonction > Traces (voir 1.6 'Consulter les traces')

1.3 Lancer une chaine

Pour lancer une chaine, il vous faut avant tout les accès à l'application voulue (voir 1.1 'Demander l'accès à une application')

Une chaine est une suite de lancements de batchs. Prenons l'exemple d'un batch A, d'un batch B et d'un batch C. Une chaine pourrait être le lancement du batch A puis du batch C ensuite le batch B et enfin encore le batch A (voir 2.x 'gestion des chaines').

Afin de lancer une chaine de batchs, rendez-vous dans le menu Fonction > Chaines. Sélectionnez en haut à droite l'application désirée ainsi que l'environnement sur lequel vous souhaitez lancer la chaine.

Une liste avec l'ensemble des chaines paramétrées (voir 2.x 'gestion des batchs' pour paramétrer les batchs) s'affiche. Vous avez la possibilité :

Modifier la date présente dans le fichier de date (voir 3.x 'normes') en cliquant sur le calendrier en haut à droite
lancer un batch avec les paramètres par défaut en cliquant sur le bouton "Lancer"

Lorsque vous lancez une chaine, une notification apparait pour vous indiquer si la chaine est bien lancée. Vous pouvez consulter l'ensemble des lancements des batchs composants la chaine dans le menu Fonction > Traces (voir 1.6 'Consulter les traces')

1.4 Planifier une tâche 🆕

Pour planifier une tâche, il vous faut avant tout les accès à l'application voulue (voir 1.1 'Demander l'accès à une application')

Depuis la version 2.4.0, EBAD permet d'ajouter des tâches planifiées. Une tâche planifiée est le lancement d'un batch standard avec une périodicité défini à l'aide de la syntaxe CRON (voir générateur de syntaxe cron en ligne).

1.4.1 Ajouter une tâche planifiée

Afin de créer une tâche planifiée, rendez-vous dans le menu Fonction > Planificateurs. Sélectionnez en haut à droite l'application désirée ainsi que l'environnement sur lequel vous souhaitez créer une tâche planifiée. Cliquez sur le bouton '+ Ajouter une tâche planifiée', une boite de dialogue s'affiche. Sélectionnez le batch souhaité, d'éventuels paramètres ainsi que l'expression cron. Une fois la tâche créée, elle sera exécuter automatiquement en tâche de fond sur EBAD, aucune notification n'est envoyé par EBAD. Vous pouvez consulter l'ensemble des lancements du batch dans le menu Fonction > Traces, l'utilisateur étant toujours 'ebad' (voir 1.6 'Consulter les traces')

1.4.2 Supprimer une tâche planifiée

Afin de supprimer une tâche planifiée, rendez-vous dans le menu Fonction > Planificateurs. Une liste avec l'ensemble des tâches planifiées déjà créée s'affiche, cliquez sur le bouton "supprimer" correspondant à la tâche planifiée à supprimer. Si la tâche est en cours, elle sera interrompue immédiatement.

1.5 Envoyer / Récupérer des fichiers

Pour envoyer et/ou récupérer un fichier, il vous faut avant tout les accès à l'application voulue (voir 1.1 'Demander l'accès à une application') Afin d'envoyer et/ou récupérer un fichier, rendez-vous dans le menu Fonction > Fichier. Sélectionnez en haut à droite l'application désirée ainsi que l'environnement et enfin le dossier dans lequel vous souhaitez envoyer et/ou récupérer un fichier.

L'affichage du contenu du dossier peut varier en fonction des droits accordé par le gestionnaire EBAD :

droit en lecture : Une liste de fichiers est affichée avec la taille en bits et la date de création, vous pouvez télécharger chaque fichier.
droit en écriture : elle se distingue en trois parties :
- la partie supérieur, vous permets de glisser/déposer des fichiers en vue des les envoyer sur le serveur distant
- la partie de gauche, vous permets de voir les fichiers précédemment glissés/déposés. Ils ne sont pas encore envoyer. Vous pouvez les renommer en cliquant sur le bouton 'renommer', les supprimer pour ne pas les envoyer en cliquant sur le bouton 'supprimer' ou tout envoyer en cliquant sur le bouton bleu 'Envoyer sur le serveur'
- la partie de droite, vous permet d'avoir les mêmes informations qu'avec le droit lecture.

Si le droit d'exploration est appliqué sur le dossier, vous pouvez naviguer dans les répertoires grâce au bouton 'Parcourir'.

1.6 Consulter les traces

Pour consulter les traces, il vous faut avant tout les accès à l'application voulue (voir 1.1 'Demander l'accès à une application') Afin de consulter les traces des batchs lancés, rendez-vous dans le menu Fonction > Traces. Sélectionnez en haut à droite l'application désirée ainsi que l'environnement dans lequel vous souhaitez consulter les traces.

Une liste de traces s'affiche, chaque élément de cette liste est un lancement de batch comportant les informations suivantes :

Identifiant technique (id)
Nom fonctionnel du batch (batch)
La date de traitement (celle contenue dans le fichier de date)
Les paramètres éventuels effectif (paramètres)
L'identificant de l'utilisateur étant à l'origine du lancement du batch ou 'ebad' si c'est une tâche planifiée (utilisateur)
La date de lancement du batch (pour le moment, il s'agit de la date et heure de fin du batch)
Le temps d'exécution exprimé en millisecondes
Le code de retour du batch, sur UNIX le 0 correspond à un succès (code retour)

2 Gestion

Afin de permettre aux utilisateurs de pouvoir lancer un batch, récupérer un fichier ou encore planifier une tâche, il vous faut paramétrer différents éléments. Avant tout, assurez-vous d'être habiliter à l'application voulue en tant que gestionnaires et d'avoir le rôle utilisateur, ces applications sont paramétrées par les administrateurs EBAD.

Les notions de bases sont les suivantes :

Application : Les applications sont les plus fin périmètres de confidentialités. Ils contiennent des environnements
Environnement : Les environnements correspondent à des serveurs qui contiennent eux même des batchs, des répertoires, des chaines et des nommages
Batchs : Les batchs représentent un programme que vous souhaitez lancer
Chaines : Les chaines sont des suites de batchs ordonnancés
Répertoires : Les répertoires donnent accès à un répertoire sur un serveur avec des droits de lecture ou lecture/écriture
Nommages : Les nommages permettent de renommer facilement (d'après un pattern) un fichier lors de sont envoie sur un serveur
Identités : Les identités permettent de configurer des utilisateurs ssh

2.1 Gestion des accès

Afin de gérer les accès d'une application, rendez-vous dans le menu Gestion > Contrôle d'accès. Sélectionnez en haut à droite l'application désirée dans laquelle vous souhaitez gérer les accès.

Vous avez la liste complète des utilisateurs ayant accès à cette application, vous pouvez modifier les droits d'une personne habilitée. Si une personne n'a plus aucun droit, elle sera alors automatiquement supprimer des personnes habilitées à l'application. Il faudra alors qu'elle redemande une accréditation (voir 1.1 'Demander l'accès à une application').

2.2 Gestion des identités 🆕

Afin de gérer les identités SSH d'une application, rendez-vous dans le menu Gestion > identités. Sélectionnez en haut à droite l'application désirée dans laquelle vous souhaitez gérer les identités.

Vous avez la liste des identités disponible pour cette application (attention, celles-ci s'ajoutent aux identités globales configurées par un administrateur qui sont disponibles pour toutes les applications), vous pouvez ajouter, modifier ou supprimer une identité. Attention, toutes les informations des identités sont stockés en clair en base de données pour le moment, cela évoluera dans le future.

Pour créer une identité, il suffit, après avoir sélectionné une application, de cliquer sur le bouton '+ Nouvelle Identié'. Une boite de dialogue s'affiche :

Nom : champs libre et obligatoire, en général le nom fonctionnel (ex: user unix)
Login : champs libre et obligatoire, il s'agit du login permettant de se connecter en SSH à la machine
Mot de passe : champs libre et facultatif, il s'agit du mot de passe associé au login, cette méthode est déconseillée et ce mot de passe est stocké en clair dans Ebad pour le moment
Clé privée : champs libre et facultatif, il s'agit de la clé privée associée à votre login, la clé est stockée en claire dans Ebad pour le moment
Chemin de la clé privée : champs libre et facultatif, il s'agit du chemin vers la clé privée associée à votre login (méthode conseillée)
Passe de la clé privée : champs libre et facultatif, il s'agit du mot de passe associé à la clé privée, ce mot de passe est stocké en clair dans Ebad pour le moment

/!\ Lorsqu'un batch est lancé, Ebad utilise d'abord le Login avec le mot de passe, puis la clé privée par chemin et enfin la clé privée "textuelle"

2.3 Gestion des environnements

Afin de gérer les accès d'une application, rendez-vous dans le menu Gestion > Environnements. Sélectionnez en haut à droite l'application désirée dans laquelle vous souhaitez gérer les environnements.

Selon la configuration de EBAD effectuée par l'administrateur, il y a deux actions possibles :

'+ Nouvel Environnement' : lorsque vous cliquez sur ce bouton, une boite de dialogue s'ouvre avec différentes informations à fournir :
- Nom : champs libre, ce nom apparaitra dans toutes les listes déroulantes 'environnements'
- Serveur : adresse IP ou nom de la machine cible
- Identité: l'identité utilisée pour la connexion au serveur (voir 2.2 Gestion des identités et 3.6 Administration des identités)
- Répertoire Home : chemin absolu vers le répertoire contenant votre application (batchs, logs, fichier date, etc), ne pas terminer par un '/'
- Préfix : si le nommage de vos shell (.ksh, .sh, .bat, etc) est préfixé par une lettre selon l'environnement, alors elle doit être précisée ici, sinon laisser vide
- Norme : sélectionnez la norme voulue, celles-ci sont définies par l'administrateur EBAD
'+ Importer les environnements' : lorsque vous cliquez sur ce bouton, cela importe les environnements automatiquement selon le plugin utilisé (voir 4.x 'Les plugins')

Dans la liste des environnements, vous pouvez éditer ou supprimer un environnement. Si un batch se trouve sans environnement, il sera automatiquement supprimer, ainsi que toutes les traces, fichiers et tâches planifiées associées.

2.4 Gestion des batchs

Afin de gérer les batchs d'une application, rendez-vous dans le menu Gestion > Batchs. Sélectionnez en haut à droite l'application désirée dans laquelle vous souhaitez gérer les batchs.

Pour éviter de créer un même batch pour plusieurs environnements, vous avez la possibilité de créer un batch et de l'affecter à plusieurs environnements. Pour se faire cliquez sur le bouton '+ Nouveau Batch', une boite de dialogue s'ouvre :

Nom : champs libre, c'est le nom fonctionnel de votre batch
Shell : nom du programme à lancer, sans son éventuel préfix (ex: monbatch.sh)
Paramètres : se sont les paramètres par défaut du batchs, vous pouvez laisser vide (voir 1.2 'Lancer un batch')
Environnements : c'est ici que vous devez indiquer sur quel environnement ce batch est disponible

Un batch qui se retrouve sans environnement sera automatiquement supprimé.

2.5 Gestion des chaines

Afin de gérer les chaines d'une application, rendez-vous dans le menu Gestion > Chaines. Sélectionnez en haut à droite l'application et l'environnement désiré dans lequel vous souhaitez gérer les chaines. Contrairement à la gestion des batchs, les chaines ne sont pas partagées entre plusieurs environnements.

Une chaine est une suite de batchs sur un environnement (un batch pouvant y être plusieurs fois). Pour créer une chaine, il suffit, après avoir sélectionné un environnement, de cliquer sur le bouton '+ Nouvelle Chaine'. Une boite de dialogue s'affiche :

Nom : champs libre, en général le nom fonctionnel (ex: début de journée)
Description : champs libre
Batchs : sélectionnez les différents batchs précédemment paramétrés (voir 2.4 'Gestion des batchs'). Vous pouvez les supprimer et les réordonner en glisser/déposer.

2.6 Gestion des répertoires

Afin de gérer les répertoire d'une application, rendez-vous dans le menu Gestion > Répertoires. Sélectionnez en haut à droite l'application et l'environnement désiré dans lequel vous souhaitez gérer les répertoires.

Pour donner la possibilité de consulter, parcourir et envoyer des fichiers (voir 1.5 'Envoyer / Récupérer des fichiers'), il vous faut ajouter un nouveau répertoire dans EBAD en cliquant sur le bouton '+ Nouveau Répertoire'. Une boite de dialogue s'affiche :

Nom : champs libre, en général le nom du répertoire ou sa fonction
Chemin : le chemin relatif du répertoire en fonction du répertoire home de l'environnement (voir 2.3 'Gestion des environnements')
Droit en écriture : donne le droit d'envoyer des fichiers sur ce répertoire
Droit d'explorer : donne le droit de parcourir les répertoires enfants

2.6 Gestion des nommages

Les nommages permettent aux utilisateurs de ne pas connaitre les noms techniques des fichiers. Par exemple, si votre batch attends un fichier dans un répertoire avec le nommage MONFICHIER.TXT alors vous (gestionnaire) créez un nommage avec ce pattern qui aura le nom 'Fichier de travail'. L'utilisateur aura alors uniquement à sélectionner le nommage "Fichier de travail" lors de l'envoi du fichier (voir 1.5 'Envoyer / Récupérer des fichiers').

Afin de gérer les nommages d'une application, rendez-vous dans le menu Gestion > Nommages. Sélectionnez en haut à droite l'application désirée dans laquelle vous souhaitez gérer les nommages.

Pour créer un nouveau nommage, cliquez sur le bouton '+ Nouveau nommage', une boite de dialogue s'affiche :

Nom : champs libre, le nom fonctionnel du nommage (ex: 'Fichier de travail')
Pattern : champs libre, c'est le nommage final du fichier. la chaine de caractère '$1' sera remplacer par la date système avec le format JJMMAAAA_HHMM.

3 Administration

Le rôle d'administrateur est requis pour accéder à ces fonctionnalités.

3.1 Administration des utilisateurs

Afin d'administrer les utilisateurs de EBAD, rendez-vous dans le menu Administration > Utilisateurs.

3.1.1 Authentification JWT

Vous trouverez dans cette page la liste complète des utilisateurs, avec la possibilité :

Activer/Désactiver un utilisateur en cliquant sur le bouton correspondant ('activated', 'unactivated'). Si un utilisateur est désactivé il ne pourra alors pas se connecter.
Editer les rôles d'un utilisateurs en cliquant sur le bouton 'Roles' d'un utilisateur
- ROLE_ADMIN : donne accès à l'ensemble de l'administration EBAD
- ROLE_USER : donne accès aux fonction d'utilisation et de gestion de EBAD
Editer les informations d'un utilisateur en cliquant sur le bouton 'Edit' d'un utilisateur

Pour créer un nouvel utilisateur cliquer sur le bouton '+ New User'

3.1.2 Authentification OAUTH2

Vous trouverez dans cette page la liste complète des utilisateurs, avec la possibilité :

Activer/Désactiver un utilisateur en cliquant sur le bouton correspondant ('activated', 'unactivated'). Si un utilisateur est désactivé il ne pourra alors pas se connecter.
⚠️ L'édition de rôles en OAUTH2 n'est pas utiles, ces informations découlent de votre IDP et sera supprimée dans une version future.
⚠️ L'édition d'un utilisateur en OAUTH2 n'est pas utiles, ces informations découlent de votre IDP et sera supprimée dans une version future.

⚠️ La création d'un nouvel utilisateur en OAUTH2 n'est pas utiles, ces informations découlent de votre IDP et sera supprimée dans une version future.

3.2 Administration des normes

Les normes permettent à EBAD de fonctionner correctement. En effet, pour savoir où chercher les batchs, quel interpréteur de commande utiliser ou encore savoir où se trouve le fichier de date pour la Date de Traitement, il faut créer une norme.

Chaque environnement est lié à une norme (voir 2.3 'Gestion des environnements').

Afin d'administrer les normes de EBAD, rendez-vous dans le menu Administration > Normes. Pour créer une norme, il suffit de cliquer sur le bouton '+ Nouvelle Norme', une boite de dialogue s'affiche :

Nom : champs libre, nom fonctionnel de la norme (ex: "Norme standard")
Interpréteur de commande : permet d'utiliser un interpréteur différent. C'est un pattern, la chaine de caractère '$1' corresponds à la commande à exécuter. Vous pouvez mettre '$1' dans ce champs si vous souhaitez utiliser l'interpréteur par défaut. Vous pouvez indiquer par exemple '/bin/ksh $1' pour utiliser ksh ou encore 'PowerShell.exe -Command ". $1"' pour utiliser PowerShell sous Windows.
Dossier shell : chemin relatif au répertoire home des environnements contenant les scripts à exécuter (le champ 'shell' du batch). Ici c'est donc le chemin d'un répertoire.
Chemin du fichier date : chemin relatif au répertoire home des environnements. C'est donc le chemin du fichier date qui contiendra la date de traitement.

3.3 Administration des applications

Afin d'administrer les applications de EBAD, rendez-vous dans le menu Administration > Applications.

Selon la configuration de EBAD effectuée par l'administrateur, il y a deux actions possibles :

'+ Nouvelle Application' : lorsque vous cliquez sur ce bouton, une boite de dialogue s'ouvre avec différentes informations à fournir :
- Code : champs libre, un code représentant l'application sur 3 caractères
- Libellé: champs libre, ce nom apparaitra dans toutes les listes déroulantes 'environnements'
- Pattern date paramètre : il s'agit du pattern de date (ex: Générateur de pattern de date) permettant de remplacer les caractère '${DATE_TRAITEMENT}' par la date contenue dans le fichier de date (voir 3.2 'Administration des normes') sous le format indiqué
- Pattern date fichier: il s'agit du pattern de date (ex: Générateur de pattern de date) permettant de lire et écrire la date dans le fichier de date (voir 3.2 'Administration des normes') sous le format indiqué, via la fonction 'Modification date traitement '
'+ Importer des applications' : lorsque vous cliquez sur ce bouton, cela importe les application automatiquement selon le plugin utilisé (voir 4.1 'Les plugins')

3.4 Administration des actualités

Afin d'administrer les actualités de EBAD, rendez-vous dans le menu Administration > Actualités.

Sur la page d'accueil (lorsque l'on est connecté), vous avez la possibilité d'afficher des actualités ou autres contenus. Cela se fait via cette administration.

Pour créer une actualité, cliquer sur le bouton '+ Nouvelle actualité', une boite de dialogue s'affiche :

Titre : Champs libre
Contenu : Champs libre, vous pouvez utiliser le wysiwyg pour mettre en forme le contenu de votre actualité.
Brouillon? : Si votre actualité est en 'brouillon', elle ne sera alors pas visible sur la page d'accueil

Les actualités sont affichées par ordre décroissant selon la date de création de l'article.

3.5 Administration des paramètres de EBAD

Afin d'administrer les paramètres de EBAD, rendez-vous dans le menu Administration > Paramètres. Les paramètres globaux à EBAD sont disponible sur cet écran, il suffit de cliquer sur 'disable' pour les désactiver et 'enable' pour les activer :

APPLICATION_CREATE_ENABLED : permet à l'administrateur, si activé, de créer manuellement des applications dans EBAD (voir 3.3 'Administration des applications')
APPLICATION_IMPORT_ENABLED : permet à l'administrateur, si activé, d'importer des applications dans EBAD via les plugins (voir 3.3 'Administration des applications' et 4.1 'Les plugins')
ENVIRONMENT_CREATE_ENABLED : permet à un gestionnaire d'application, si activé, de créer manuellement des environnements dans EBAD (voir 3.3 'Gestion des environnements')
ENVIRONMENT_IMPORT_ENABLED : permet à un gestionnaire d'application, si activé, d'importer des environnements dans EBAD via les plugins (voir 3.3 'Gestion des environnements')

Une rafraichissement du navigateur peut être nécessaire après modification de ces paramètres.

3.6 Administration des identités

Afin de gérer les identités SSH globales à toutes les applications disponible dans EBAD, rendez-vous dans le menu Administration > identités.

Vous avez la liste des identités disponible dans EBAD (attention, celles-ci s'ajoutent aux identités de chaque application configurées par un gestionnaire), vous pouvez ajouter, modifier ou supprimer une identité. Attention, toutes les informations des identités sont stockés en clair en base de données pour le moment, cela évoluera dans le future.