Vous êtes sur la page 1sur 104

GUIDE UTILISATEUR

CARTHAGO ESB
MANUEL D’UTILISATION CARTHAGO

Résumé : Architecture du composant ‘Carthago ESB’.

Ref. MSESB/GU/01

Date de création 03/03/2014


Projet
Version 1.0
Date de mise à jour 27/03/2014

Guide Utilisateur Carthago ESB 1/104


TABLE DES MATIERES
Présentation de l’application _________________________________________________ 3
1. Configuration ____________________________________________________________ 4
1.1 Transformations Enrichissements et Contrôles _________________________________________ 4
1.2 Filtres ______________________________________________________________________ 28
1.3 Conteneur de messages (Endpoints ou BALS) : _______________________________________ 35
1.4 Traitement des Messages _______________________________________________________ 70
1.5 Performance : ________________________________________________________________ 82
2. Traitement : _____________________________________________________________ 85
2.1 Activation et désactivation des flux de messages :____________________________________ 85
2.2 Import : _____________________________________________________________________ 86
3. Piste d’audit : ___________________________________________________________ 87
3.1 PEC Messages : ______________________________________________________________ 87
3.2 PEC Fichiers : ________________________________________________________________ 94
3.3 Notifications : ________________________________________________________________ 97
4. Administration ESB : ______________________________________________________ 98
4.1 État des Endpoints : ___________________________________________________________ 98
4.2 Consultation pools JDBC : ______________________________________________________ 100
4.3 État des threads des bals : ____________________________________________________ 101
4.4 État des threads de la file d’attente :_____________________________________________ 102
4.5 Consultation Queue JMS : ______________________________________________________ 103
4.6 Consultation Pools LDAP : ______________________________________________________ 103

Guide Utilisateur Carthago ESB 2/104


PRESENTATION DE L’APPLICATION

Ce menu présente les éléments suivants :


 Configuration ;
 Traitement ;
 Piste d’audit ;
 Administration ESB.

Guide Utilisateur Carthago ESB 3/104


1. CONFIGURATION
C’est un dossier permettant le paramétrage des éléments suivants :
 Transformations Enrichissements et Contrôles
 Filtre
 Conteneurs de messages
 Traitement des messages
 Performance

1.1 Transformations Enrichissements et Contrôles

Ce menu permet la conversion, enrichissements, contrôles et transformation d’entités ou leurs


attributs en fournissant un ensemble de règles de transformations paramétrables.

1.1.1 PARAMETRAGE DES REGLES DE CONVERSION


L’entrée de menu pour les règles de conversion est accessible sous le chemin suivant :

1.1.1.1 Conversion Statiques

Guide Utilisateur Carthago ESB 4/104


Conversion de la valeur d’entrée en une valeur de sortie en utilisant une table de
correspondance.

La création : Pour paramétrer une nouvelle Conversion Statique, il faut cliquer sur le
bouton « Nouveau », le masque suivant s’affiche à l’écran :

Les éléments à saisir sont les suivants :


 Identifiant : sert à identifier le convertisseur crée.

 Expression valeur par défaut : cette valeur est renvoyée automatiquement une
fois (la/les) valeur(s) entrantes ne sont pas trouvée(s).

 Valeur Entrante : elle correspond à la valeur qu’on souhaite modifier.

 Valeur Sortante : elle correspond à la valeur cible après modification.

Guide Utilisateur Carthago ESB 5/104


1.1.1.2 Conversion Des Dates

Elle permet de convertir une chaîne de caractère vers une date ou une autre chaine de
caractère et réciproquement en utilisant une syntaxe spécifique.

La création : pour paramétrer un convertisseur de date, il faut cliquer sur le bouton


« Nouveau », le masque suivant s’affiche à l’écran :

Les attributs à saisir sont les suivants :


 Identifiant : qui sert à identifier le convertisseur crée.

 Format Source : Il contient le format source de la date à convertir. La date à


convertir étant une chaine de caractère ayant le format spécifié.

 Format Cible : Il contient le format cible de la date à convertir. La date à convertir


étant un objet date et le résultat obtenu sera une chaîne dont la forme sera celle
spécifiée.

Exemple :

Guide Utilisateur Carthago ESB 6/104


Dans cet exemple si notre source est une chaîne ‘20072011’, le format cible va permettre
d’obtenir un objet date dont la valeur est le 20 juillet 2011. Le format cible va
transformer l’objet date obtenu en une chaîne ’20-07-2011’.

1.1.1.3 Conversion Montant Chaîne

- Elle permet de convertir un montant vers une chaîne en utilisant une syntaxe
paramétrée.

La création : pour paramétrer un convertisseur montant chaîne, il faut cliquer sur le


bouton « Nouveau », le masque suivant s’affiche à l’écran :

Guide Utilisateur Carthago ESB 7/104


 Identifiant : identifie le convertisseur montant chaîne crée.

 Expression décimal : donne le chemin relatif au séparateur des décimaux.

 Expression de Symbole : donne le chemin relatif au symbole de la devise utilisée.

 Expression de groupe : donne le chemin relatif au séparateur des milliers.

 Séparateur de décimaux : précise le séparateur à utiliser pour les décimaux.

 Séparateur de milliers : précise le séparateur à utiliser pour les milliers.

 Séparateur décimal visible : c’est un Flag utilisé pour rendre le séparateur des
décimaux paramétré visible.

 Ajouter Symbole de devise : c’est un Flag utilisé pour rendre le symbole de


devise paramétré visible.

1.1.1.4 Conversion de nombres

- Elle permet de convertir une chaîne de caractère vers un nombre ou une chaîne de
caractère et réciproquement en utilisant une syntaxe spécifique.

Guide Utilisateur Carthago ESB 8/104


La création : Pour paramétrer un convertisseur nombre, il faut cliquer sur le bouton
« Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : identifie le convertisseur nombre crée.

 Pattern cible : indique le format du nombre que l’utilisateur désire utiliser.

 Séparateur de décimaux source : précise le séparateur de décimaux source du


convertisseur nombre.

 Séparateur de décimaux cible: précise le séparateur de décimaux que l’utilisateur


souhaite adopter.

 Séparateur de milliers source : précise le séparateur de milliers source du


convertisseur nombre.

 Séparateur de milliers cible : précise le séparateur de milliers que l’utilisateur


souhaite adopter.
 Séparateur de décimaux visible : c’est un Flag utilisé pour rendre le séparateur
des décimaux paramétré visible.

Guide Utilisateur Carthago ESB 9/104


1.1.1.5 Agrégation sur Collection

- Elle permet d’effectuer des opérations d’agrégation (somme, moyenne, minimum,


maximum, nombre) sur une liste d’objets

La création : Pour paramétrer un convertisseur agrégation sur collection, il faut cliquer


sur le bouton « Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : Identifie le convertisseur agrégation sur collection crée.

 Agrégation : Permet de choisir l’opérateur d’agrégation à utiliser par l’utilisateur


à savoir (Sommation, MIN, MAX, Moyenne ou un compteur).

 Expression Champ : Expression à évaluer qui permet de préciser le champ sur


lequel on va appliquer l’opération d’agrégation.
 Condition d’inclusion : Expression à évaluer qui représente une condition à
appliquer sur chaque objet de la liste afin de déterminer si l’objet en question doit
être inclus ou pas dans l’opération d’agrégation.

1.1.1.6 Conversion d’expressions

- Elle permet la conversion de la valeur d’entrée en valeur de sortie en utilisant une


expression paramétrée.

Guide Utilisateur Carthago ESB 10/104


La création : pour paramétrer un convertisseur d’expression, il faut cliquer sur le
bouton « Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : Identifie le convertisseur d’expression crée.

 Expression : Définir l’expression que l’utilisateur veut appliquer.

 Nom variable : elle sert à nommer l’objet courant sur lequel l’utilisateur va
appliquer l’expression définie.

Guide Utilisateur Carthago ESB 11/104


1.1.1.7 Conversion de text

La création : pour paramétrer un convertisseur de texte, il faut cliquer sur le bouton


« Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : Identifie le convertisseur de texte crée.

 Nombre de lignes : Définir le nombre de ligne.

 Nombre de caractères par ligne: Définir le nombre de caractère par ligne.


1.1.2 PARAMETRAGE D’ENRICHISSEMENT DES DONNEES

- L’enrichissement des données permet la conversion de la valeur d’entrée en


une valeur correspondante à partir de la base de données locale ou d’un
autre service interne ou externe.

L’entrée de menu pour les règles d’enrichissement des données est accessible sous le
chemin suivant :

Guide Utilisateur Carthago ESB 12/104


1.1.2.1 Enrichissement Local

- Il permet d’enrichir à partir d’une information de la base locale de l’ESB

La création : pour créer une nouvelle règle d’enrichissement, il faut cliquer sur le bouton
« Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : identifie la règle d’enrichissement crée.

 Nom Entité : l’utilisateur précise le nom de l’entité à partir de laquelle il va faire


la règle d’enrichissement.

 Champ Source : Il sert à préciser le champ de l’entité précisée auparavant et pour


lequel l’utilisateur va fournir une valeur, valeur qui sera utilisée pour identifier
l’entité correspondante dans la base de données locale.

 Champ Résultat : champ appartenant à l’entité identifiée auparavant grâce au


champ source et qui représentera la valeur de retour du convertisseur.

Guide Utilisateur Carthago ESB 13/104


1.1.2.2 Enrichissement ESB

- Il permet d’enrichir à partir d’un flux synchrone (Web Service, http JDBC…)
et ce en paramétrant un descripteur synchrone

La création : pour créer une nouvelle règle d’enrichissement ESB, il faut cliquer sur le
bouton « Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : identifie la règle d’enrichissement ESB crée.

 Descripteur ESB : précise le descripteur ESB synchrone à utiliser.

1.1.3. PARAMETRAGE DES REGLES DE CONTROLE

- La règle de contrôle permet de paramétrer des conditions à vérifier sur


l’entité courante en se basant sur le moteur d’expression.

Guide Utilisateur Carthago ESB 14/104


1.1.3.1 Contrôle d’entités

La création : pour créer une nouvelle règle de contrôle, il faut cliquer sur le bouton
« Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : identifie la règle de contrôle crée.

 Contrôler tout : si l’utilisateur coche ce flag alors le système teste toutes les
expressions à évaluer.

 Expression à évaluer : l’utilisateur énonce l’expression à évaluer lors du contrôle.

 Code erreur : permet à l’utilisateur d’écrire le code d’erreur souhaité si la condition


n’est pas vérifiée.

La règle de contrôle permet également de paramétrer des règles de contrôle sur les
objets fils de l’entité courante (composition)

Guide Utilisateur Carthago ESB 15/104


 Chemin Association N: permet de spécifier le nom de l’attribut appartenant à
l’entité courante et qui contient les objets fils. Ce champ est généralement de type
liste d’entités.

Il est aussi possible de calculer des variables sur la liste des objets fils de la manière
du convertisseur Agrégation sur collection, variables qui peuvent être utilisées pour le
calcul des règles de contrôle sur l’objet parent.

 Expression : permet de préciser par expression le champ sur lequel on va


appliquer l’opération d’agrégation.

Guide Utilisateur Carthago ESB 16/104


 Opérateur : permet de choisir l’opérateur d’agrégation à utiliser à savoir
(Sommation, MIN, MAX, Moyenne ou un compteur).

 Alias Résultat : nom de la variable qui va stocker le résultat de ce calcul.

 Condition: permet d’écrire une condition à appliquer sur chaque objet de la liste
afin de déterminer si l’objet en question doit être inclus ou pas dans l’opération de
calcul.

On peut aussi saisir des règles de contrôle sur les objets fils en réitérant les étapes
décrites auparavant.

1.1.4. PARAMETRAGE DES REGLES DE TRANSFORMATION

- Les Règles de Transformation permettent de transformer une entité vers une


autre entité.

Guide Utilisateur Carthago ESB 17/104


1.1.4.1Transformation d’entités

1.1.4.1.1 REGLES DE TRANSFORMATIONS SIMPLES


- Permet la correspondance des attributs champs à champs avec la possibilité
d’utiliser des expressions.

 Identifiant : identifie la transformation d’entité crée.

 Source : précise le nom de l’entité à partir de laquelle on va appliquer la


transformation (si on veut appliquer la Transformation d’entité sur un BlockObject
alors on choisit le package.

 Cible : précise le nom de l’entité cible.

 Action à faire : précise l’action à faire


o Création : création d’une nouvelle entité.
o MAJ : un champ « critères » s’affiche, afin de saisir un ensemble de critères
pour identifier l’entité à mettre à jour. Une exception est levée si l’entité en
question n’a pas été trouvée.
o Création ou MAJ : si l’entité cible n’a pas été trouvé à partir du champ
critères alors une nouvelle entité est créé.
o Exécuter Expression: exécute une expression pour construire l’objet cible.

Guide Utilisateur Carthago ESB 18/104


 Expression source : Précise l’expression de l’attribut ou de l’objet source qu’on
souhaite transformer.

 Clé Cible : Précise l’expression de l’attribut.

 Condition : Expression à évaluer qui permet d’indiquer s’il faut ou pas appliquer
cette transformation.

 Sous Transformation : Précise la transformation d’entité à appliquer sur l’objet


source. Cette transformation est utilisée pour transformer une entité ou liste d’entité
vers une entité ou liste d’entité.

On peut également définir un ensemble de paramètres. Ces paramètres serviront plus


tard dans les expressions utilisées pour le calcul des valeurs des éléments.

Guide Utilisateur Carthago ESB 19/104


 Clé : précise le nom de la variable.

 Valeur : C’est une expression à évaluer pour déterminer la valeur de la variable.

1.1.4.1.2 REGLES DE TRANSFORMATIONS CONDITIONNEES

- Possibilité de paramétrer des conditions en utilisant des expressions pour


choisir quelle transformation simple ou conditionnée à appliquer.

 Identifiant : identifie la transformation conditionnée crée.

 Source : précise le nom de l’entité qui va subir la transformation

 Appliquer tout : Si ce flag est coché, alors toutes les transformations dont les
conditions sont vérifiées par l’objet source sont appliqués (avec comme point d’entrée
de chaque transformation le résultat de celle qui la procède) sinon seul la première
transformation dont la condition est vérifiée est appliquée et la valeur résultat est
retourné. Les transformations sont saisies dans une liste ordonnée afin que l’exécution
des transformations suive cet ordre.

Guide Utilisateur Carthago ESB 20/104


 Transformation : permet à l’utilisateur de choisir une transformation simple ou aussi
conditionnée parmi celles qui sont déjà paramétrées.

 Condition : expression à évaluer pour déterminer si la règle de transformation doit


être appliquée ou pas.

1.1.4.2. Transformation Statique

Quatre types de transformations statiques:


- XML : Format propriétaire du Module Carthago qui permet l’export et l’import de
données sous format XML.
- EXCEL : Format propriétaire du Module Carthago qui permet l’export et l’import de
données sous format EXCEL.
- PDF : Format propriétaire du Module Carthago qui permet l’export et l’import de
données sous format PDF.
- HTML : Format propriétaire du Module Carthago qui permet l’export et l’import de
données sous format HTML.
- GZIP : Possibilité de compresser ou de décompresser de ou vers un fichier ou un objet.
- MML: Format propriétaire du Module Carthago qui permet l’export et l’import de
données sous format XML.

Guide Utilisateur Carthago ESB 21/104


1.1.4.3. Fichier Plat
Permet de spécifier la syntaxe pour la lecture d’un fichier de type plat :

 Direction : Lecture, écriture ou lecture écriture.

 Type de bloc :
o Position fixe : chaque attribut dans le fichier a une position et une longueur
prédéfini au préalable.
o Séparateur : chaque attribut est séparé des autres attributs par un
séparateur spécifique.

 Syntaxe retour à la ligne : Type de syntaxe de retour à la ligne :


o LF : généralement pour les systèmes Unix Linux
o CRLF : généralement pour les systèmes DOS Windows.

 Séparateur de Champs : Dans le cas où le type de bloc est Séparateur, cet


attribut sert à spécifier le séparateur.

 Référence dans Bloc Object : Indique la référence dans le BlockObject parent s’il
s’agit d’un FlatFileBlock fils.

 Bloc de Référence : indique la référence dans le BlockObject parent s’il s’agit d’un
FlatFileBlock fils et que l’attribut Référence dans BlockObject n’est pas spécifié.
Dans le cas aussi d’un sous bloc, représente un ensemble de valeurs séparés par
« ; » des valeurs que devra avoir le « champ de référence » du sous bloc pour
être associé à tel configuration et ce selon l’opérateur spécifié (Egal : champ de
référence doit avoir une de ces valeurs, Différent : champ de référence ne doit pas
avoir une de ces valeurs).

 Champ de référence : Indique le nom du champ de référence dans le cas d’un bloc
fils. Champ qui permet de déterminer la référence du fils.

 Opérateur : Possède les valeurs Egal ou Différent. Utilisé lorsqu’il s’agit d’un sous
bloc et qu’aucune fréquence n’a été défini pour lui.

 Ignorer Entête : Indique s’il faut ignorer la première ligne du fichier. Ignoré dans le
cas des sous blocs.

 Ignorer dernière Ligne : Indique s’il faut ignorer la première ligne du fichier.

Guide Utilisateur Carthago ESB 22/104


 Type de fichier : indique le type de fichier.

Onglet « Sous Blocs »


Permet de référencer les sous blocs.

 Fréquence : permet de spécifier le nombre d’instance de ce sous blocs qui se


trouvent sous son bloc parent.

 Attribut Fréquence Sous Bloc : attribut dans le BlockObject parent qui permet de
spécifier la fréquence de ce sous bloc.

 Sous Bloc : permet de sélectionner la structure FlatFileBlock du sous bloc.


 Est Optionnel : indique que le sous bloc est optionnel. Si le sous bloc n’est pas
optionnel et si une instance parente donnée ne possède pas de sous bloc alors une
exception est levée.

 Code Erreur : code d’erreur à lever si le bloc n’est pas optionnel et aucune
instance n’a été trouvée.

Onglet « Attributs » :

Permet de lire une ligne dans un fichier et de déterminer ses attributs.

 Type de bloc : Séparateur

Guide Utilisateur Carthago ESB 23/104


o Nom: nom de l’attribut.
o Index : numéro de l’attribut par rapport aux autres attributs. Le premier
attribut ayant le numéro 1.

 Type de bloc : Position fixe

o Nom: nom de l’attribut.


o Position début : position de début de l’attribut dans la ligne. La première
position aura le numéro 1.
o Longueur : la longueur de l’espace alloué à l’attribut dans la ligne en
nombre de caractères.

Guide Utilisateur Carthago ESB 24/104


1.1.4.4. Transformation Etat

- La transformation état permet la génération d’un état à partir d’un


paramétrage saisi au préalable et des données de l’objet courant.

La création : pour créer une nouvelle transformation état, il faut cliquer sur le bouton
« Nouveau », le masque suivant s’affiche à l’écran :

 Identifiant : Permet d’identifier la transformation.

 Nom état : une liste qui permet à l’utilisateur de choisir un état déjà paramétré au
niveau du menu en sélectionnant son nom.

Il reste alors à saisir les variables d’entrée du report :

Guide Utilisateur Carthago ESB 25/104


 Nom : le nom du critère utilisé pour la génération du report.

 Expression Valeur : expression à évaluer de la valeur du critère. Expression qui


sera évalué sur l’objet courant.

1.1.5. LISTE FICHIERS ATTENDUS :

La configuration des fichiers attendus offre la possibilité de paramétrer des


structures de fichiers de manière dynamique (journalier, mensuels, trimestriels …). Ces
fichiers seront utilisés plus tard pour filtrer les fichiers qui seront acceptées par l’ESB.

Guide Utilisateur Carthago ESB 26/104


 Identifiant : identifie la configuration de fichier crée.

 Date Début : date de début de validité de la configuration.

 Date Fin : date de fin de validité de la configuration.

 Expression nom fichier par défaut : expression à évaluer pour déterminer le nom du
fichier si le nom est constitué d’un seul bloc.

 Condition : condition à évaluer pour déterminer si le fichier doit être généré ou non.
Par exemple indiquer qu’un fichier doit être généré à la fin du mois.

 Mail de notification : indique les mails des personnes (séparés par des « ; » ) à
informer dans le cas de non réception du fichier spécifique le jour prévu.

 Fragments : si le fichier est constitué de plusieurs fragments, les spécifier dans l’ordre
prévu.

 Identifiant : identifie le fragment.

 Expression valeur par défaut : expression à évaluer pour déterminer la valeur du


fragment.

 Mail de notification : indique les mails des personnes à informer pour ce fragment.

 Valeurs : liste des valeurs distinctes si le fragment peut contenir plusieurs valeurs.

Guide Utilisateur Carthago ESB 27/104


 Expression valeur: expression à évaluer pour déterminer la valeur.

 Condition : condition à évaluer pour déterminer si cette valeur doit faire partir de la
liste des valeurs.

 Mail de notification : indique les mails des personnes à informer pour cette valeur.

1.2 Filtres

- Les filtres offrent la possibilité de filtrage des messages que ce soit lors de la
réception ou lors de l’envoie et même lors de traitement par l’ESB.

Guide Utilisateur Carthago ESB 28/104


1.2.1 FILTRE FICHIER :
Le filtre fichier Permet d’effectuer des opérations de filtrage sur un fichier et plus
précisément sur son nom. Il existe deux types de filtres fichiers :
 Filtrage par nom de fichier
 Filtre expression régulière

Les filtres fichiers sont accessibles sous le chemin suivant :

1.2.1.1 Filtrage par nom Fichier :

- Ce filtre effectue un filtrage en utilisant des "*", par exemple "*. txt" permet de filtrer
tous les fichiers ayant pour extension .txt. Ce filtre accepte une liste délimitée par des
virgules, donc plus d'un filtrage peuvent être combinées par exemple: "*. txt, *. xml".

Guide Utilisateur Carthago ESB 29/104


 Identifiant : c’est un champ obligatoire qui permet d’identifier le filtre crée et il doit
être unique.

 Modèle : Dans ce champ l’utilisateur doit définir l’expression qui sera appliqué sur les
messages à filtrer.

 Respecter la case :
- Si cette case est cochée : le système va respecter la casse lors de l’évaluation
de l’expression sur le nom du fichier (différencie entre majuscules et
minuscules).
- Sinon : pas de respect de la casse.

1.2.1.2 Filtre expression régulière :

- Ce filtre effectue un filtrage en utilisant des expressions régulières.

La création : pour créer un filtre par expression régulière il suffit de cliquer sur le
bouton « Nouveau » et un autre écran s’affiche.

 Identifiant : c’est un champ obligatoire qui permet d’identifier le filtre crée et il doit
être unique.

 Modèle : Dans ce champ l’utilisateur doit définir l’expression qui sera appliqué sur les
messages à filtrer.

 Respecter la case : précise s’il faut respecter ou pas la casse lors de l’évaluation de
l’expression sur le nom du fichier.

Guide Utilisateur Carthago ESB 30/104


1.2.2 FILTRE JMS :
- Ce type de filtre permet le filtrage d’un message d’une destination JMS à
partir des attributs de l’entête de ce message.

1.2.2.1 Filtre JMS type de message :

- Le filtre JMS permet de sélectionner uniquement les messages ayant comme


type celui défini dans le filtre.

 Identifiant : Ce champ permet d’identifier le filtre crée et il doit être unique.

 Type message : type du message (JMSType).

1.2.2.2 Filtre JMS expression :

Ce filtre permet de sélectionner uniquement les messages dont les attributs d’entête
vérifient l’expression saisie.

 Identifiant : C’est un champ obligatoire qui sert à identifier le filtre crée, cet
identifiant doit être unique.
 Expression : saisie des valeurs des attributs d’entête requis pour le message.
(ex :JMSType = ’type1’ and sender=’Engagement’)

Guide Utilisateur Carthago ESB 31/104


1.2.3 FILTRE LOGIQUES :

- Les filtres logiques représentent des filtres génériques qui permettent de créer à partir
des autres filtres existants des nouveaux types de filtres.

1.2.3.1 Filtre NON :

- Le message n’est accepté que si le filtre paramétré dans le filtre a décliné le message.

 Identifiant : c’est un champ obligatoire permettant d’identifier le filtre crée.

 Filtre : permet à l’utilisateur de choisir un filtre parmi ceux qui ont été déjà
paramétrés.

1.2.3.2 Filtre OU :

- Ce filtre permet de réunir deux filtres déjà paramétré par une relation logique de type
« OU », le message ne sera accepté que si au moins un des deux filtres a accepté le
message.

Guide Utilisateur Carthago ESB 32/104


 Identifiant : ce champ permet d’identifier le filtre crée.

 Filtre de droite, Filtre de gauche : ces combos affichent les différents types de filtres
qui ont été paramétré, L’utilisateur doit choisir un filtre à gauche et un à droite.

1.2.3.3 Filtre ET :

- Ce filtre permet de réunir deux filtres déjà paramétrés par une relation logique de type
« ET », le message ne sera accepté que si les deux filtres acceptent le message.

 Identifiant : permet d’identifier le filtre crée.

Guide Utilisateur Carthago ESB 33/104


 Filtre de droite, Filtre de gauche : ces combos affichent les différents types de
filtres qui ont été paramétrés, L’utilisateur doit choisir un filtre à gauche et un à
droite.

1.2.4 FILTRE TYPE DU MESSAGE :

- Le filtre type de message permet de filtrer un message en se basant sur sa classe au


sens java. Ce filtre est accessible sous le chemin suivant.

 Identifiant : C’est un champ obligatoire permettant d’identifier le filtre crée.

 Type attendu : type du message, le message ne sera accepté que si son type
correspond au type paramétré.

1.2.5 FILTRE EXPRESSION:

- Le filtre expression permet le filtrage des messages en évaluant une expression sur le
message à traiter, le message ne sera alors accepté que si cette expression est vérifiée.

Ce filtre est accessible sous le chemin suivant.

Guide Utilisateur Carthago ESB 34/104


 Identifiant : c’est un champ obligatoire qui permet d’identifier le filtre crée.

 Expression : ce champ permet à l’utilisateur de définir l’expression relative au


filtre.

1.3 Conteneur de messages (Endpoints ou BALS) :

Un conteneur de message ou endpoint est une représentation d’une boîte aux lettres
(bal), il peut être de deux types :

 Entrant : il représente un bal à partir duquel l’ESB va lire les messages.

 Sortant : il représente un bal vers lequel l’ESB va envoyer des messages.

Un endpoint, entrant ou sortant, possède un ensemble d’attributs communs :

 Transformations : liste des transformations à appliquer au message après sa


lecture ou avant son envoi. Les transformations sont représentées sous la
forme d’une liste afin que leur exécution suive son ordre. Chaque
transformation contient les attributs suivants :
o Transformation : transformation à appliquer.
o Sauv. msg transformé : indique s’il faut sauvegarder le message
transformé.
o Condition : expression optionnelle à évaluer pour indiquer si la règle
de transformation doit être appliquée ou pas au message.

 Filtre : filtre à appliquer au message : traiter le message ou pas dans le cas


d’un endpoint Entrant et envoyer le message ou pas dans le cas d’un endpoint
Sortant.

 Sauvegarder message d’origine : Un booléen pour indiquer si le message


reçu par l’endpoint doit être sauvegardé ou pas dans la piste d’audit.

 Sauvegarder message transformé : Un booléen pour indiquer si le message


transformé doit être sauvegardé ou pas.

Chaque endpoint entrant possède en plus les attributs suivants:

Guide Utilisateur Carthago ESB 35/104


 Identifiant : un identifiant unique par rapport aux autres endpoints entrants.

 Politique de traçage : Ce combo permet à l’utilisateur de spécifier la


politique de traçage adapté. Il existe trois politiques :
 Ne pas tracer : la trace du message ne sera pas sauvegardée au
niveau de la piste d’audit.
 Tracer en cas d’échec : la trace du message ne sera sauvegardée que
si une erreur s’est produite durant son traitement.
 Tracer tout le temps : la trace sera toujours sauvegardé edans la piste
d’audit.

 Expression Id message: expression qui permet d’extraire un identifiant du


message pour la piste d’audit. Une valeur par défaut est assignée au
message reçu si cette expression n’est pas spécifiée.

 Expression id de corrélation: expression pour extraire du message son


identifiant dans l’application qui a l’a envoyé. Cet id sert lors de l’envoi d’une
notification afin d’identifier dans l’application émettrice le message dans la
piste d’audit.

 Expression expéditeur: expression pour identifier l’expéditeur du message.

Chaque endpoint sortant possède également en commun les attributs suivants:

 Identifiant : un identifiant unique par rapport aux autres endpoints sortants.

 Id message envoyé: expression pour extraire l’id du message à envoyer.

 Expression expéditeur message: expression pour évaluer l’application


émettrice du message.

Les endpoints sont aussi soit de nature synchrones soit asynchrones :

 Endpoint synchrone :
o Entrant : permet la réception d’un message, son traitement et le renvoi
d’une réponse. Pour cela il possède un ensemble de transformations
sortantes pour la transformation de la réponse.
o Sortant : permet l’envoi d’un message et la réception d’une réponse
du destinataire. Possède entre autres les attributs suivants:
 Retourner réponse : indique si la réponse reçue doit être
retourné à l’endpoint entrant ou pas.
 Expression utilisateur : expression pour déterminer le login.
 Expression mot de passe : expression pour déterminer le mot
de passe.

 Endpoint asynchrone :
o Entrant : permet la réception d’un message, son traitement sans renvoi
d’une réponse. Possède entre autres les attributs suivants:

Guide Utilisateur Carthago ESB 36/104



Appel asynchrone : si vrai alors l’endpoint se contente de
placer le message sur une queue pour que son traitement se
face ultérieurement.
 Priorité async : permet de spécifier la priorité du message
dans la queue si le flag appel asynchrone est coché.
o Sortant : permet l’envoi du message vers le destinataire sans attendre
une réponse. Possède les attributs suivants :
 Attendre notification : si vrai signale que le message ne peut
être considéré comme envoyé que lorsque l’application
destinatrice enverra une notification de bonne réception de
manière asynchrone.
 Statut d'acquittement : le statut que la notification devra
indiquer pour considérer que le message est acquitté.

Une structure générique sera également utilisée par plusieurs endpoints : cette structure est
la structure BlockObject :

La structure BlockObject est une structure générique qui permet de représenter n’importe
quelle entité en représentant le nom de ses attributs et leurs valeurs selon leurs types. La
relation bloc permet de représenter les relations de composition et d’agrégation.

Le menu relatif aux endpoints est accessible sous le chemin suivant :

Guide Utilisateur Carthago ESB 37/104


1.3.1. BOITE AUX LETTRES FICHIERS :

- Ce type de bal gère les messages de type fichier situés dans un répertoire
local au serveur d’application.

1.3.1.1. Entrant :

- Cet endpoint entrant asynchrone permet la lecture des fichiers situés dans un répertoire
local.

LA CREATION : Pour créer ce type de boite aux lettres il suffit cliquer sur le bouton
« Nouveau » et l’écran suivant s’affiche.

Guide Utilisateur Carthago ESB 38/104


 Fréquence : fréquence en secondes à laquelle l’ESB va lire les fichiers à, partir du
répertoire local (60 secondes par défaut).

 Bal locale : nom du répertoire à partir duquel les fichiers vont être lus.

 Bal temporaire : nom du répertoire dans lequel le fichier sera déplacé durant son
traitement par l’ESB.

 Bal backup : nom du répertoire dans lequel le fichier sera sauvegardé à la fin de
son traitement.

 Utiliser file d’attente : si vrai les fichiers seront placés sur une file d’attente pour
paralléliser leur traitement.

 Priorité : la priorité du message dans la file d’attente par rapport aux autres
fichiers collectés par d’autres endpoints.

 Option de tri : ce combo permet de trier les fichiers selon leurs noms ou leur date
de création.

 ASC : indique si le tri des fichiers doit être ascendant ou descendant.

 Inclure sous fichiers : indique s’il faut ou pas inclure les fichiers placés dans les
sous répertoires du bal local.

1.3.1.2. Sortant :

- La boite aux lettres fichierssortant est un endpoint sortant asynchrone qui

Guide Utilisateur Carthago ESB 39/104


gère l’envoi de messages de type fichier vers un répertoire local.

 Expression nom répertoire : expression pour évaluer le nom du répertoire dans


lequel le fichier sera sauvegardé.

 Expression nom fichier : définit le nom de fichier en évaluant l’expression saisie.

 Concaténer : si le fichier existe déjà, indique s’il faut concaténer le nouveau


contenu à l’ancien ou tout simplement écraser l’ancien contenu.

 Inclure dans transaction : indique si l’écriture du fichier doit être transactionnelle.


Le fichier est d’abord écrit dans un répertoire temporaire, puis déplacé dans le
répertoire final à la fin du traitement ESB.

1.3.2. BOITE AUX LETTRES SFTP :

- SFTP : Secure File Transfert protocole


- Cette boite aux lettres gère aussi les messages de type fichier situés sur un
serveur SFTP.

1.3.2.1. Hôte SFTP :


Tout d’abord il faut configurer l’emplacement du serveur SFTP, pour cela il faut créer une
hôte SFTP :

Guide Utilisateur Carthago ESB 40/104


 Hôte : adresse du serveur

 Port : port du serveur SFTP

 Utilisateur : identifiant de l’utilisateur sur le serveur SFTP

 Mot de passe : mot de passe de l’utilisateur

Un bouton « tester connexion » permet de tester la validité de la connexion.

1.3.2.2. Entrant

- Cette boite aux lettres de type endpoint entrant asynchrone permet la lecture
des fichiers à partir d’un répertoire situé sous un serveur SFTP.

 Configuration : permet de choisir une hôte parmi celles qui ont été créé
auparavant.

 Répertoire : indique le répertoire sous le serveur SFTP ou les fichiers sont situés.

Guide Utilisateur Carthago ESB 41/104


 Fréquence : fréquence en secondes à laquelle l’ESB va lire les messages contenus
dans l’endpoint (60 secondes par défaut).

 Bal locale : nom du répertoire local dans lequel les fichiers du serveur SFTP seront
rapatriés.

 Bal temporaire : nom de répertoire dans lequel le fichier sera transféré durant
son traitement.

 Bal backup : nom de répertoire dans lequel le fichier sera sauvegardé à la fin du
traitement.

 Utiliser file d’attente : Si vrai les fichiers seront placés sur une file d’attente pour
paralléliser leur traitement.

 Priorité : la priorité du message dans la file d’attente par rapport aux autres
fichiers collectés par d’autres endpoints.

 Option de backup :
o Renommer : le fichier sera renommé dans le serveur distant pour indiquer
qu’il a été déjà traité. Dans ce cas il faut indiquer l’extension que devra
porter le fichier et un filtre au niveau de l’endpoint pour ne pas retraiter le
fichier.
o Supprimer : suppression du fichier du serveur SFTP.
1.3.2.3. Sortant :

- Cette boite aux lettres de type endpoint sortant asynchrone gère l’envoi des
messages de type fichier vers un serveur SFTP.

 Configuration d’hôte : hôte SFTP.

 Expression nom de fichier : expression qui sera évalué pour spécifier le nom de
fichier

 Répertoire : ce champ indique le répertoire dans lequel le fichier sera


sauvegardé sous le serveur SFTP.

Guide Utilisateur Carthago ESB 42/104


1.3.3. BOITE AUX LETTRES JMS :

- Gestion des messages vers une file d’attente JMS (Java Message Service).

La boite aux lettres JMS est accessible sous le chemin suivant :

1.3.3.1. Destination JMS

Configuration pour établir une connexion avec le fournisseur JMS, l’utilisateur doit
paramétrer les informations relatives à cette connexion dans l’écran suivant :

 Identifiant : pour identifier la connexion crée

 Fabrique de connexions : nom de la fabrique de connexions JMS.

 Context Facteur Initial : nom de la classe de la fabrique pour se connecter.

 Fournisseur URL : adresse du fournisseur JMS.

 Destination : adresse jndi de la file d’attente ou du topic

 Topic : indique s’il s’agit d’une file d’attente.

 Supports XA : support ou pas du Protocol XA.

Guide Utilisateur Carthago ESB 43/104


 Utilisateur : nom utilisateur.

 Mot de passe : mot de passe de l’utilisateur.

1.3.3.2. Entrant

- Ce bal de type endpoint entrant asynchrone gère les messages de type JMS (lecture à
partir d’une queue ou un topic).

 Destination : contient les informations nécessaires pour se connecter au fournisseur


JMS.

 Filtre JMS : indique le filtre JMS à utiliser pour filtrer les messages à traiter.

1.3.3.3. Sortant

- L’endpoint JMS est un endpoint sortant synchrone qui gère l’envoi des
messages vers une queue ou un topic JMS.

 Destination : contient les informations nécessaires pour se connecter au fournisseur


JMS.

 Type message : type du message JMS.

Guide Utilisateur Carthago ESB 44/104


 Priorité : la priorité du message dans la destination JMS.

 Timeout réponse : dans le cas où l’endpoint doit attendre une réponse, indique la
durée d’attente de la réponse en millisecondes.

1.3.3.4. Entrant Ecouteur


Il s’agit d’un endpoint entrant synchrone. Cet endpoint est associé à la file d’attente crée
par défaut pour l’ESB pour chaque module Carthago, il est donc toujours actif.

 Identifiant : seul les messages ayant comme type (JMSType) cet identifiant seront
traités par cet endpoint.

1.3.4. BOITE AUX LETTRES HTTP :


- Traitement des messages de type requêtes HTTP.

1.3.4.1. Entrant
- Boîte aux lettres de type endpoint entrant synchrone qui permet la réception de
requêtes http et de renvoyer une réponse.

Guide Utilisateur Carthago ESB 45/104


 Type de contenu : pour spécifier le type de contenu de la réponse (texte, html,
XML).

 Encodage : encodage de la réponse (UTF-8,…).

 Identification requise : indique si l’expéditeur du message doit être authentifié.


Dans ce cas le message reçu doit avoir dans son entête les attributs suivants
(user,password) pour l’identification de l’utilisateur.

1.3.4.2. Sortant

- L’endpoint http sortant est un endpoint sortant synchrone qui permet d’envoyer une
requête http et de recevoir une réponse.

Onglet « Général » :

 Adresse : URL du service http cible.

 Méthode : méthode d’envoi de la requête http (POST ou GET).

 Version http : version du protocole http utilisé.

 Temps de réponse : timeout pour la réception d’une réponse.

Guide Utilisateur Carthago ESB 46/104


 Encodage : encodage du texte du message.

 Nb max. d’essais : nombre d’essai avant de considérer que l’appel a échoué.

Onglet « Paramètres » :

Liste les paramètres de la requête http :

 Nom : nom du paramètre.

 Valeur : expression de la valeur du paramètre.

1.3.5. BOITE AUX LETTRES WEB SERVICE :


- Permet l’invocation de service web distants en utilisant le protocole SOAP.

Cette boite aux lettres est accessible sous le chemin suivant :

1.3.5.1 Entrant :

- Endpoint de type entrant synchrone qui permet la réception de messages et


le renvoi d’une réponse en utilisant le protocole SOAP.

Guide Utilisateur Carthago ESB 47/104


Chaque application Carthago possède un service web par défaut. Prenons par exemple
l’application Dave dont l’url est la suivante : http://localhost:9082/CarthagoDave, pour
accéder au fichier WSDL du service web de l’application Dave, il faut rajouter l’extension
« WS/MassinissaWebService ?wsdl ». Donc le service web de Dave aura pour adresse :
http://localhost:9082/CarthagoDaveWS/MassinissaWebService?wsdl

Ce service web est un service générique, c.à.d. que toutes les requêtes WSDL destinés au
module Carthago doivent transiter par ce service tout en précisant le nom de l’endpoint
web service entrant dans le paramètre service de la requête afin de différencier le
traitement du message.

 Identifiant : nom du service, doit être spécifié dans le message SOAP reçu selon
le modèle du fichier WSDL.

 Encoder réponse : indique si la réponse doit être encodée sous format XML.

 Identification requise : indique si l’expéditeur du message doit être authentifié ou


pas selon le modèle du schéma WSDL.

1.3.5.2 Sortant :
- Endpoint sortant synchrone qui permet l’envoi de messages de type SOAP
et la réception de la réponsevers tous les modules Carthago.

-Onglet « Général » :

 Emplacement wsdl : URL du fichier wsdl de l’application Carthago cible.

Guide Utilisateur Carthago ESB 48/104


 Service : identifiant de l’endpoint web service entrant de l’application cible.

 Décoder réponse : décoder la réponse du format XML au format objet java.


L’onglet paramètres permet de spécifier les paramètres en précisant leurs noms et
l’expression de leurs valeurs.

1.3.6. BOITE AUX LETTRES JDBC :


- Cette boite aux lettres permet la connexion avec une base de données externe pour
exécuter des requêtes, les résultats de ces requêtes seront convertis en liste de
« BlockObject ».

1.3.6.1. Configuration base externe


Onglet « Général » :

 Identifiant : identifiant de la connexion.

 Nom utilisateur : nom utilisateur pour se connecter à la base de données.

 Nom Driver : nom du driver JDBC.

 Url : adresse de la base de données.

Un bouton « Tester connexion » permet de tester la validité de la connexion.

Guide Utilisateur Carthago ESB 49/104


Onglet « Configuration de Pool JDBC »

Permet de créer un pool de connexion pour la connexion JDBC. Ce pool sera géré au
niveau de l’ESB et non du serveur d’application.

1.3.6.2. Configuration base via jndi :

Permet de se connecter à une source de données paramétrée dans le serveur


d’application :

 Nom utilisateur : nom utilisateur pour se connecter à la base de données

 Nom JNDI : nomjndi de la source de donnée.

Un bouton « Tester connexion » permet de tester la validité de la connexion.

1.3.6.3. Entrant

- Cet endpoint de type entrant asynchrone permet l’exécution des requêtes SQL de type
« select » sur une base de données et la récupération du résultat sous format
« BlockObject ».

Guide Utilisateur Carthago ESB 50/104


Onglet « Général » :

 Config base de données : permet de choisir la base sur laquelle la requête sera
exécutée.

 Fréquence : fréquence d’exécution de la requête en secondes.

 Requête : requête de type « select » qu’on souhaite exécuter sur la base.

 Temps de réponse : le temps nécessaire pour que la requête soit exécuté.

 Traiter messages individuellement : si la requête retourne une liste d’objet alors


réitérer dans la liste en envoyant chaque objet au traitement de façon
individuelle.

 Réitérer requête : indique s’il faut réitérer la requête durant son exécution tant
que celle-ci renvoie des résultats.

 Requête màj. : requête de type update pour permettre de mettre à jour le


résultat du select pour que les éléments déjà sélectionnés ne soit pas repris dans
la prochaine exécution de la requête.

Onglet « Paramètres requête » :

Permet de saisir les paramètres de la requête « select ». Si par exemple la requête est
du type : select fullName, rating from Client where groupCode= ?1, alors le paramètre
aura comme type String (chaîne de caractère) et comme expression ‘admin’. Dans ce cas
cette requête va renvoyer tous les clients appartenant au groupe admin.
Les paramètres sont représentés sous forme de liste pour suivre l’ordre des paramètres de
la requête (1,2, …)

Guide Utilisateur Carthago ESB 51/104


 Type : type du paramètre au sens SQL (String Date, Long, ...).

 Expression : expression de la valeur du paramètre.

Onglet « Paramètres requête màj » :

Si une requête maj. a été paramétrée alors cet onglet sera visible et il permettra de saisir
ses paramètres de manière identique que celle de la requête « select ».

Onglet « Colonnes résultats » :

Permet de sélectionner le nom et le type des colonnes des résultats de la requête. Par
exemple pour l’exemple précédant, on pourra avoir comme colonne résultat la colonne
fullName (type String) et la colonne rating (type String).

Guide Utilisateur Carthago ESB 52/104


 Nom colonne : nom de la colonne.

 Type : Ce champ permet de préciser le type de la colonne au sens java.

1.3.6.4 Sortant

- La boite aux lettres JDBC sortante est un endpoint de type sortant synchrone
qui permet la connexion à une base externe et l’exécution des requêtes SQL.

L’endpoint JDBC sortant aura un comportement selon le type de la requête qu’il devra
exécuter. Dans le cas d’une colonne de type select, son comportement sera celui d’un
endpoint synchrone et la réponse de la requête pourra être retournée dans une liste de
BlockObject.
Par contre dans le cas de requête de type update ou delete son comportement sera celui
d’un endpoint asynchrone et aucune réponse ne sera retourné de l’exécution de la
requête.

Onglet « Général » :

Guide Utilisateur Carthago ESB 53/104


 Configuration BD : ce combo permet de choisir la base de données vers laquelle
la requête va être exécutée.

 Requête : requête SQL.

 Temps de réponse Requête : timeout pour attendre la fin d’exécution de la


requête.

 Exécuter Mise à jour : indique s’il s’agit d’une requête de type update.

Onglet « Paramètres requête» :

 Expression : expression de la valeur du paramètre.

 Type : type du paramètre


Onglet « Colonnes de Résultat» :

Visible dans le cas d’une requête de type select

Guide Utilisateur Carthago ESB 54/104


 Nom colonne : nom de la colonne SQL

 Type : type de la colonne


1.3.7. BOITE AUX LETTRES VIRTUELLE :

- La boite aux lettres virtuelles représente un endpoint entrant virtuel qui n’a
pas d’existence physique. Il sert essentiellement à définir un endpoint sur
lequel l’application peut envoyer des messages pour être traités par l’ESB.

Cette boite aux lettres est accessible sous le chemin suivant :

Il existe deux types d’endpoints virtuels l’un synchrone qui permet de retourner une
réponse et le second est asynchrone qui permet un traitement asynchrone du message reçu
de l’application.
1.3.8. BOITE AUX LETTRES JPQL :

- La boîte aux lettres JPQL permet d’effectuer des requêtes sur la base de
données locale en exécutant des requêtes de type JPQL défini dans la
spécification JPA.

La boite aux lettres JPQL est accessible sous le chemin suivant :

1.3.8.1 Entrant :

- L’endpoint JPQL est un endoint de type entrant asynchrone qui permet l’exécution de
requêtes de type « select » sur la base locale en utilisant une syntaxe SQL simplifiée :

Onglet « Général » :

Guide Utilisateur Carthago ESB 55/104


 Entité : Ce combo permet à l’utilisateur de choisir l’entité sur laquelle la requête
va être exécutée.

 Alias : alias de l’entité dans la requête.

 Expression requête : critères de la requête (expression criteria).

 Premier résultat : indique le numéro du premier résultat de la requête

 Nbre max de résultats : nombre maximal de résultat de la requête

 Type de projection : map, entity,…

 Résultat unique : indique si la requête doit renvoyer un résultat unique et nom


une liste d’objets.

 Traiter messages individuellement : indique si la requête a renvoyé une liste


d’objets, les objets seront envoyés au traitement individuellement ou en lot.

 Réitérer requête : indique s’il faut réitérer la requête durant son exécution tant
que celle-ci renvoie des résultats.

 Requête maj. : requête de type update pour permettre de mettre à jour le


résultat du select pour que les éléments déjà sélectionnés ne soit pas repris dans
la prochaine exécution de la requête.

Onglet « Projections » :

Indique le nom des champs qui seront sélectionnées sur l’entité sélectionné auparavant.

Guide Utilisateur Carthago ESB 56/104


 Type : indique s’il s’agit d’une simple projection ou d’une relation d’agrégation sur
le champ (max, min, avg,…)

 Champ : nom du champ.

 Alias : alias du champ dans la requête


Onglet « Paramètres » :
Permet de saisir le nom des paramètres de la requête.

 Nom : nom du paramètre.

 Valeur : expression de la valeur du paramètre.

1.3.8.2 Sortant :

L’endpoint JPQL sortant est un endpoint de type synchrone sortant. Il permet d’effectuer
une requête JPQL sur la base de données et de renvoyer la réponse.

Guide Utilisateur Carthago ESB 57/104


Onglet « Général » :

Le paramétrage de tous les paramètres est identique à celui de l’endpoint JPQL entrant.

1.3.9. BOITE AUX LETTRES EMAIL :

- La boite aux lettre Email gère l’envoie des mails en utilisant le Protocol SMTP
avec possibilité d’ajouter des pièces jointes.

La boite aux lettres E-Mail est accessible sous le chemin suivant :

1.3.9.1 Serveur mail externe :


Permet de se connecter à un serveur mail externe :

Onglet « Général »

 Hôte : hôte du serveur mail.

Guide Utilisateur Carthago ESB 58/104


 Port : port du serveur mail.

 Utilisateur : nom de l’utilisateur pour pouvoir s’authentifier auprès du serveur mail.

Onglet « Propriétés» :

Permet la saisie de couples clé/valeur qui est propres à certains serveurs mail.

 Clé : nom de la clé.

 Valeur : valeur de la clé.

1.3.9.2 Serveur mail interne :


Permet de se connecter à un serveur mail paramétré dans le serveur d’application.

 Identifiant : identifiant de la connexion

 Nom JNDI : nom jndi de la connexion

Guide Utilisateur Carthago ESB 59/104


1.3.9.3 Mail Sortant
Onglet « Général »

 Adresse expéditeur : permet de préciser l’adresse de l’expéditeur

 Nom expéditeur : permet de définir le nom de l’expéditeur

 Répondre à : adresse à laquelle le récepteur du message peut répondre.

 Expression objet mail : expression pour obtenir l’objet du mail

 Contenu : texte contenu dans le corps du mail

 Configuration serveur mail : ce combo permet de choisir un serveur mail parmi


ceux qui ont été créé.

 Type contenu : Ce combo permet de choisir le type de contenu (texte ou html)

Onglet « Destinataires »

Guide Utilisateur Carthago ESB 60/104


 Expression adresse destinataire : expression adresse destinataire

 Expression nom destinataire : expression adresse destinataire

 Type : type de destinataire (destinataire, en copie, en copie cachée)

 Condition : expression à évaluer si le mail en question doit être envoyé ou pas à


ce destinataire.

Onglet « Propriétés contenu »

Le contenu du mail est décrit en utilisant le moteur d’expression Velocity afin de pouvoir
générer un Template de la manière suivante :

Les paramètres du Template (nom, rib, adresse,…) doivent être saisies entre ‘$’ et
paramétrés dans l’onglet Propriétés du contenu :

 Nom : nom du paramètre.

Guide Utilisateur Carthago ESB 61/104


 Expression : expression de la valeur du paramètre.

Onglet « Pièces jointes »

Des pièces jointes peuvent être rajoutées au mail à envoyer. Il existe deux types de pièces
jointes :

1. Pièce jointe flux de données : le contenu de la pièce jointe est contenu dans le
message traité par l’ESB.

 Nom fichier mail : nom de la pièce jointe dans le mail.

 Identifiant : id de la pièce.

 Expression données : expression du tableau de byte des données.

 Type MIME : type des données (PDF, Postscript, Excel, Html, Texte, XML).

2. Pièce jointe fichier : La pièce jointe est un fichier situé sur le disque local du
serveur :

Guide Utilisateur Carthago ESB 62/104


 Nom fichier mail : nom de la pièce jointe dans le mail.

 Identifiant : id de la pièce.

 Expression nom du fichier : expression du nom et du chemin du fichier qui sera


rajouté comme pièce jointe.

Reprenons l’exemple ci-dessus, on peut rajouter une image qui se trouve sous
l’emplacement « C:/banque.bmp » comme pièce jointe en lui attribuant comme identifiant
« banque » et qui représente le logo de la banque. Ce logo sera alors rajouté au contenu
du message en le référençant comme suit : <imgalign="top"src="cid:banque">

1.3.10. BOITE AUX LETTRES LDAP :

- La boite aux lettres LDAP gère les connexions avec le serveur LDAP.

La boite aux lettres LDAP est accessible sous le chemin suivant :

Guide Utilisateur Carthago ESB 63/104


1.3.10.1 Configuration serveur LDAP :
Permet de se connecter à un serveur LDAP :

Onglet « Général »

 Identifiant : identifiant de la connexion.

 Hôte : adresse du serveur

 Port : port du serveur LDAP

 Utilisateur : nom utilisateur pour se connecter au serveur LDAP.

 Timeout connexion

 Timeout réponse : dans le cas où l’endpoint doit attendre une réponse, indique la
durée d’attente de la réponse en millisecondes.

Onglet « Configuration Pool »

Permet de créer un pool de connexion pour la connexion avec un serveur LDAP. Ce pool
sera géré au niveau de l’ESB et non du serveur d’application.

Guide Utilisateur Carthago ESB 64/104


1.3.10.2 Sortant :

Onglet « Général »

 Identifiant : identifiant de la connexion LDAP

 Configuration Serveur : ce combo permet de choisir un serveur LDAP parmi ceux


qui ont été crées.

 Portée Requête LDAP :

Onglet « Paramètres »

Guide Utilisateur Carthago ESB 65/104


 Nom : nom du paramètre.

 Valeur : expression de la valeur du paramètre.

 Type : type du paramètre.

1.3.11. BOITE AUX LETTRES EJB :

La boite aux lettres EJB est accessible sous le chemin suivant :

1.3.11.1 Configuration EJB :

Guide Utilisateur Carthago ESB 66/104


 Identifiant : identifiant de la connexion EJB

 Nom JNDI: nom de la connexion

 Login : nom utilisateur pour se connecter.

 Mot de passe : mot de passe de la connexion

1.3.11.2 Façade Sortante :

Onglet « Général »

 Identifiant : identifiant de l’endpoint EJB

 Configuration EJB : ce combo permet de choisir l’EJB parmi ceux qui ont été
crées.

 Contrôleur : nom du contrôleur à utiliser

 Méthode: nom de la méthode à utiliser

 Scope : le scope de la transaction

Onglet « Paramèters »

Guide Utilisateur Carthago ESB 67/104


 Nom : nom du paramètre.

 Valeur : expression de la valeur du paramètre.

 Type : type du paramètre.

1.3.12. IMPRIMANTE :

- Cet endpoint de type sortant asynchrone gère l’envoi de message vers une
imprimante.

 Sauvegarder : indique si le fichier doit être sauvegardé sur le disque et lorsque


cette case est cochée le champ suivant s’affiche.

Guide Utilisateur Carthago ESB 68/104


 Expression nom du fichier : dans le cas où la case « sauvegarder » est cochée, il
faut indiquer l’expression à évaluer pour le nom du fichier dans ce champ. Cette
option est surtout utilisée dans la phase de test non en production.

 Imprimer : indique si le fichier doit être imprimé dans ce cas le champ suivant
s’affiche et il faut renseigner le nom de l’imprimante à utiliser.

1.3.13. ENDPOINT DIFFERE :

L’endpoint différé est un endpoint sortant asynchrone qui permet d’envoyer un message
de manière différé.

Le message est tout d’abord sauvegardé dans la base locale pour être ensuite envoyé
ultérieurement. Pour envoyer le message au moment opportun, il faut paramétrer un
second descripteur qui aura comme endpoint entrant un endpoint JPQL qui aura comme
tache de récupérer le message de l’entité
(com.massinissa.esb.endpoint.deffered.DeferredOutEndpoint, attribut=message.value) et
comme endpoint sortant un endpoint pour lequel le message est destiné.

Guide Utilisateur Carthago ESB 69/104


1.4 Traitement des Messages

- Ce menu permet la configuration des flux de messages à travers le


paramétrage du descripteur, des routeurs (Entrant/Sortant) et le choix des
endpoints déjà paramétrés.

1.4.1. CONFIGURATION DES FLUX DE MESSAGES

- Elle permet de définir les flux de messages en définissant le lien entre les endpoints, les
routeurs, le traitement et les endpoints de notifications.
- Possibilité de lancer la consommation des messages par un job paramétrable.

1.4.1.1 Onglet Général

 Date début : date de début de validité du descripteur

 Date fin : date de fin de validité du descripteur

 Identifiant : l’identifiant du descripteur

Guide Utilisateur Carthago ESB 70/104


 Utilisateur : utilisateur dont les droits seront utilisés pour l’exécution du traitement.
Si l’utilisateur n’est pas spécifié alors le traitement sera exécuté avec les droits de
l’administrateur.

 Statut :(non saisissable), indique le statut du descripteur : Démarré (les endpoints


entrants sont démarrés), Arrêté, Démarré partiellement (certains endpoints entrants
sont démarrés tandis que d’autres sont à l’arrêt.

 Action à faire : l’action à effectuer sur le message reçu (création, mise à jour,
exécution d’une expression,…).

 Expression d’action : si l’action à faire est « Exécuter expression d’action » alors


il faut spécifier cette expression qui sera alors évalué lors du traitement du
message.

 Statut notification : spécifie le statut du message pour lequel il faut envoyer une
notification.

 Envoi notif.si échec : indique s’il faut envoyer une notification en cas d’échec.

Les endpoints de notification sont saisissables sous l’anglet « endpoints de notifications ».

1.4.1.2 Onglet « Endpoints de notifications » :

Guide Utilisateur Carthago ESB 71/104


 Endpoint sortant : endpoint vers lequel la notification sera envoyée.

 Condition : expression qui permet de déterminer si une notification doit être


envoyée vers cet endpoint. L’expression sera évaluée sur l’objet du message ainsi
que sur les variables suivantes :
o Sender : spécifie l’expéditeur du message, déterminé grâce à l’expression
du destinataire de l’endpoint entrant.
o correlationID : id de corrélation du message
o NotifError : indique le message d’erreur s’il s’agit d’un envoi de
notification en cas d’échec. Permet de différencier si l’endpointen question
doit envoyer une notif d’erreur (expression : NotifError !=null)

1.4.1.3 Onglet « Routeurs entrants » :

- Le routeur entrant s’occupe du routage des messages entrant. Il peut inclure un certain
nombre de filtres et ou effectuer un certain nombre de traitements.
- rôle du routeur entrant intervient après la réception et la transformation du message par
l’endpoint entrant et avant l’exécution du traitement.

Onglet « Général »

Guide Utilisateur Carthago ESB 72/104


 Appliquer tout : si l’attribut a la valeur vrai alors le message sera dispatché vers
tous les routeurs paramétrés dans l’onglet « Routeurs » sinon il ne sera traité
qu’uniquement par le premier routeur qui acceptera le message (filtre du routeur
non spécifié ou le filtre du routeur a accepté le message).

 Statut de Notification : spécifie le statut du message lors de son traitement par le


routeur pour lequel il faut envoyer une notification. Le paramétrage des endpoints
de notification se fera de la même manière que celle spécifié pour les endpoints
de notification du traitement décrite auparavant.

Onglet « Routeurs »

Il existe deux types de routeurs entrant :


 Routeur filtrant.

 Routeur de regroupement

 Routeur filtrant :

Permet de spécifier un filtre au niveau du routeur pour filtrer les messages à traiter.
Seul les messages acceptés par le filtre pourront poursuivre leur traitement et seront
transmis au traitement (Action à faire). Si le filtre n’est pas spécifié alors tous les
messages seront transmis.

Guide Utilisateur Carthago ESB 73/104


 Identifiant : permet d'identifier le routeur filtrant entrant.

 Filtre : filtre à appliquer.

 Routeur de regroupement :
Permet de regrouper les messages reçus afin de les traiter simultanément. Les
messages seront tout d’abord sauvegardés dans la base de données et à la réception
d’un message de type spécifique qui sera accepté par le filtre de regroupement, les
messages seront regroupés et leur traitement se poursuivra de manière normale.
L’opération de regroupement aura pour but de regrouper des entités en spécifiant des
critères de regroupement ainsi que fonctions d’agrégation (Sum, Avg, Max, Min) sur
des nombre (par exemple des montants).

Guide Utilisateur Carthago ESB 74/104


 Entité : représente la classe du message à regrouper au sens java.

Onglet « champs montants » :

Liste des champs de type nombre qui seront agrégés :

 Expression Source : expression du champ

 Destination : alias du champ

Guide Utilisateur Carthago ESB 75/104


 Opération : représente l’opération de regroupement à effectuer (Somme,
moyenne, max, min).

Onglet « champs de regroupement » :

Cette liste représente les critères de regroupement.

 Expression Source : expression du champ.


 Destination : alias du champ.

Il est à noter que les données regroupées seront placés dans des structures de type
BlockObject avec les alias spécifiés.

Onglet « Endpoints »

Cet onglet permet de choisir des endpoints entrants parmi ceux qui ont été créés
auparavant. Chaque endpoint de la liste recevant un message le transmettra aux routeurs
entrants suivant les règles défini auparavant.

Guide Utilisateur Carthago ESB 76/104


1.4.1.4 Onglet « Routeurs sortants » :

- Après traitement du message (Action à faire), celui-ci est remis au routeur sortant qui
aura pour tâche de router le message.

 Appliquer tout : si l’attribut a la valeur vrai alors le message sera dispatché vers
tous les routeurs paramétrés dans l’onglet « Routeurs » sinon il ne sera traité
qu’uniquement par le premier routeur qui acceptera le message (filtre du routeur
non spécifié ou le filtre du routeur a accepté le message).

 Routeur filtrant :

Guide Utilisateur Carthago ESB 77/104


Permet de spécifier un filtre au niveau du routeur pour filtrer les messages.Seuls les
messages acceptés par le filtre seront transmis aux endpoints sortants. Si le filtre n’est
pas spécifié alors tous les messages seront transmis.

Onglet « Général » :

 Identifiant : identifiant du routeur.

 Statut de notification : La gestion des notifications au niveau du routeur sortant


est comparable à celle du routeur entrant.

 Filtre : filtre des messages reçus par le filtre.

Onglet « Endpoints » :

Cet onglet permet de spécifier liste les endpoints vers lesquels le router va envoyer les
messages.

Guide Utilisateur Carthago ESB 78/104


 Endpoint : endpoint sortant.

 Condition : expression à évaluer pour savoir si le message doit être transmis à


l’endpoint ou pas.

1.4.1.5 Onglet « Routeurs de réponse » :


Lors de la réception d’une notification, le routeur réponse aura pour tâche de lire la
notification et d’acquitter le message envoyé auparavant par ce descripteur (grâce à l’id
du message porté par la notification).

Guide Utilisateur Carthago ESB 79/104


 Endpoint : endpoint entrant qui aura pour tâche la lecture des notifications reçues.

 Identifiant : identifiant du routeur.

1.4.2. MESSAGE DE L’APPLICATION

Afin de pouvoir envoyer des messages par les modules métiers Carthago, il faut
paramétrer des événements client. Ces évènements auront pour tâche de définir les
descripteurs et les endpoints virtuels entrant qui auront pour tâche l’envoi des messages.

Guide Utilisateur Carthago ESB 80/104


 Type message : nom de l’événement.

 Descripteur : Ce lien permet de choisir un descripteur parmi ceux qui ont été déjà
crées.

 Endpoint virtuel : permet de choisir l’endpoint virtuel (appartenant évidement au


descripteur sélectionné)

1.1.4.3. CONFIGURATION DES FLUX SYNCHRONES

Le descripteur synchrone a pour but d’associer un endpoint entrant synchrone, une


expression optionnelle et un endpoint sortant synchrone optionnel afin de récupérer une
information requise par l’application de manière synchrone.

Guide Utilisateur Carthago ESB 81/104


A la réception d’une requête de l’endpoint entrant, celle-ci est transmise au traitement
(représenté ici par l’expression), le résultat de l’évaluation de l’expression (message
d’origine si expression non défini) est alors transmis à l’endpoint sortant qui renverra la
réponse. La réponse est alors renvoyée par le descripteur.

 Endpoint Sortant : endpoint sortant synchrone.

 Endpoint Entrant : endpoint entrant synchrone.

 Expression : expression du traitement.


1.5
1.6 Performance :

- Ce menu permet à l’utilisateur de paramétrer les processus (threads) qui


seront utilisés par le moteur de messagerie ESB.

Guide Utilisateur Carthago ESB 82/104


1.5.1 GESTION DES PROCESSUS

1.5.1.1 Nombre de processus des bals :


Lorsqu’unendpoint entrant asynchrone s’exécute, il est exécuté dans un processus (thread).
Ces processus sont gérés par un pool de threads dont la configuration est la suivante :

 Nombre minimal de processus : le nombre minimal de processus du pool.

 Nombre maximal de processus : le nombre maximal de processus du pool.

A un instant t il ne peut y avoir un nombre d’endpoints entrants asynchrone en cours


d’exécution plus que le nombre maximal des processus du pool.

1.5.1.2 Nombre de processus de la file d’attente :


Pool de processus utilisé par la file d’attente pour paralléliser le traitement des fichiers
reçus par un endpoint fichier entrant (flag utiliser file d’attente coché).

Guide Utilisateur Carthago ESB 83/104


 Nombre de processus : nombre de thread de la file.

 Taille de la file : nombre maximal de fichiers qui pourront être rajoutés à la file.
Si ce nombre est atteint alors le rajout de fichier sera bloqué jusqu'à ce qu’un des
fichiers ait été traité et supprimé de la file. Si ce nombre n’est pas spécifié alors
la file peut accepter un nombre infini de messages. Ce paramètre a pour but de
ne pas encombrer la mémoire.

Guide Utilisateur Carthago ESB 84/104


2. TRAITEMENT :

2.1 Activation et désactivation des flux de


messages :

- Permet l’activation ou la désactivation manuelle des flux de messages


existants.

1. L’utilisateur doit tout d’abord cliquer sur le bouton « chercher »


pour que les flux de messages s’affichent.

2. L’utilisateur doit sélectionner un flux de message et cliquer sur le


bouton « Activer ». le statut du descripteur sera alors Démarré.

3. Pour arrêter le descripteur de nouveau, l’utilisateur doit cliquer


sur le bouton « Désactiver ».

Guide Utilisateur Carthago ESB 85/104


2.2 Import :

Permet l’import de fichier de données dans la base locale.

 Fichier : Permet de préciser le fichier à importer

 Action à faire : Permet de préciser l’action à effectuer sur le fichier à importer


(créer, maj., exécuter expression,..)

 Transformation I/O: Règle de transformation qui permettra la lecture du fichier


(MML, Flat File, XML, EXCEL, GZIP).

 Transformations : Permet de spécifier les transformations à effectuer sur le


message lu avant d’exécuter l’action à faire.

Guide Utilisateur Carthago ESB 86/104


3. PISTE D’AUDIT :

Massinissa ESB possède un mécanisme qui permet le traçage des messages traités
afin de pouvoir identifier les messages ayant rencontrés des problèmes et ainsi
pouvoir effectuer des reprises dessus.

3.1 PEC Messages :


3.1.1 MESSAGE REÇU :
Onglet « Général» :

 Id message : identifiant du message.

Guide Utilisateur Carthago ESB 87/104


 Erreur : si le traitement ne s’est pas terminé avec succès ce champ indique l’erreur
qui s’est produite

 Date : La date de réception de message.

 Id message d’origine : id du message dans l’application expéditrice.

 Expéditeur : identifie l’application à l’origine de ce message.

 Historique statut : historique des statuts du message reçu.

 Statut : indique la bonne réception du message,c.à.d. si l’ESB a réussi à lire le


message, le transformer et le faire suivre totalement ou partiellement au reste du
traitement défini dans le descripteur :
o Echec transformation : la transformation du message a échoué.
o Traité partiellement : le message a été traité avec succès par un certain nombre
de routeur entrants et a échoué dans au moins un d’eux.
o Traité : message traité avec succès par l’endpoint entrant et transmis aux
routeurs entrants.
o Echec traitement : échec du traitement du message par les routeurs entrants.
o Ignoré : Le message n’a été accepté par aucun des routeurs entrants ou il n’y a
pas de routeurs entrant paramétré.

 Endpoint : endpoint qui a reçu le message.

 Configuration de traitement : descripteur utilisé


 Message d’origine : contient le message d’origine (sauvegardé si le flag
sauvegarder message d’origine a été coché).

 Message transformé : contient le message transformé (sauvegardé si le flag


sauvegarder message transformé a été coché).

Onglet « Messages transformés» :

Permet de sauvegarder une trace des messages transformés pour une règle de
transformation. La trace est sauvegardé si lors de la sélection de la règle le flag Sauv.
msg transformé est coché.

Guide Utilisateur Carthago ESB 88/104


 Donnée : trace du message transformé.

 Transformateur : règle de transformation

Onglet « Notifications envoyées» :


Cet onglet permet de consulter l’ensemble des notifications envoyées pour la réception du
message, sa transformation et son traitement par les routeurs entrants.

 Statut notification : statut du message lors de l’envoi de la notification.

 Erreur : permet de décrire l’erreur levée si une erreur se produit lors de l’envi de la
notification.

 Statut : statut de la notification :


o Ignoré : si la notification n’a pas été accepté par le filtre de l’endpoint
sortant.
o Echec transformation : échec de la transformation de la notification par
l’endpoint sortant.
o Echec envoi : échec de l’envoi de la notification.
o Envoyé avec succès : la notification a été envoyée avec succès.

 Date : Date d’envoi de la notification

 Id message : id du message pour lequel la notification a été envoyée.

Onglet « Messages» :

Chaque message reçu est dispatché sur les routeurs entrants. Chaque message reçu par un
routeur entrant est tracé en créant une instance de Message routeur entrant.

Guide Utilisateur Carthago ESB 89/104


- Onglet « Général» :

 Statut : trace le traitement du message par le router.


 A grouper : le message a été sauvegardé par le routeur
regroupement en attendant d’être regroupé.
 Echec traitement : échec du traitement du message par le routeur.
 Ignoré : le message n’a pas été accepté par le filtre du routeur
entrant.
 Regroupé : le message a été regroupé avec succès par le routeur
regroupement.
 Traité : le message a été traité avec succès par le routeur entrant.

 Routeur : Le routeur qui a routé le message

 Erreur : Si le traitement ne s’est pas terminé avec succès ce champ indique l’erreur
qui s’est produite

- Onglet « Données à grouper» :

Sert à stocker les données pour être regroupés plus tard et ce dans le cas d’un routeur de
regroupement

Il est à noter qu’un bouton de reprise permet de reprendre au message reçu échoués.

Guide Utilisateur Carthago ESB 90/104


3.1.2 MESSAGE ESB :

- Après traitement du message par le routeur entrant, une instance de


« Message ESB »est crée qui trace l’exécution du traitement (attribut Action à
faire défini dans le descripteur) ainsi que le traitement du message par les
routeurs sortants et son envoi par les endpoints sortants.

Onglet « Général » :

 Statut : trace l’exécution du message :


o Echec traitement : échec d’exécution de l’action à faire.
o Attente notification : au moins un des endpoints sortants attend une notification
pour l’envoi du message.
o Exécuté partiellement : certains endpoints sortant n’ont pas réussi à envoyer
leurs messages.
o Exécuté avec succès : le message a été envoyé avec succès par tous les
endpoints sortants.
o Traité : le traitement (Action à faire) a été exécuté avec succès. Le traitement du
message s’est alors interrompu ici, car il n’y a pas d’endpoints sortants
paramétrés.
o Traité partiellement : le traitement (Action à faire) a été effectué avec succès
puis la suite du traitement a été interrompue brusquement.

 Erreur : description de l’erreur qui s’est produite si le message n’a pas été traite
avec succès.

 Configuration de traitements : le descripteur.

 Historique statut : historique des statuts du message ESB.

Onglet « Notification envoyé» :

Cet onglet permet de consulter l’ensemble des notifications envoyées pour l’exécution du
traitement (Action à faire), les routeurs sortants.

Guide Utilisateur Carthago ESB 91/104


Onglet « Messages envoyés» :

Trace l’état de l’envoi des messages par les endpoints sortants.

 Statut : indique l’état de l’envoi du message :


o Envoyé : message envoyé avec succès.
o Ignoré : le message a été ignoré par le filtre de l’endpoint.
o Attente notification : le message a été envoyé et est en attente d’acquittement.
o Echec transformation : la transformation du message a échoué.
o Echec envoi : l’endpoint n’a pas réussi à envoyer le message.

 Id message : l’id du message à envoyer.

 Erreur : indique l’erreur qui s’est produite si l’envoi n’a pas réussi

 Routeur : Le routeur qui a routé le message

 Endpoint : L’endpoint qui a émis le message.

Onglet « Message Entrant» :

Décrit les messages du routeur entrant qui sont à l’origine de ce message. Dans le cas d’un
routeur entrant filtrant, un message reçu par le routeur crée un message ESB. Dans le cas
d’un routeur regroupement, plusieurs messages entrants peuvent créer, après
regroupement, un seul message ESB.

Guide Utilisateur Carthago ESB 92/104


Onglet « Entités crées» :

Lors du traitement du message (Action à faire), des entités peuvent être créées. Cet onglet
décrit les entités qui ont étés crées par leur classe, code et pk.

Onglet « Messages recyclés» :

Pour chaque reprise sur un message ESB dont le déroulement ne s’est pas déroulé de la
manière souhaitée (échec), une instance de message recyclé est créée et rajouté à cet
onglet.

Il est à noter qu’un bouton de reprise permet de reprendre les messages ESB échoués.

Guide Utilisateur Carthago ESB 93/104


3.2 PEC Fichiers :

Lorsque le message reçu est de type fichier une deuxième structure est également utilisée
pour tracer le traitement du fichier en totalité ou des différents blocs du fichier.

Que ce soit pour le traitement d’un fichier local ou le traitement d’un fichier SFTP situé sous
un serveur SFTP, la prise en charge des messages de type fichiers est accessible sous le
chemin suivant.

Un bouton de reprise permet de reprendre les PEC fichiers échoués.


L’utilisateur doit sélectionner un fichier parmi la liste des fichiers traités affichés et clique
sur le bouton de consultation afin de tracer le traitement de ce fichier, l’écran suivant
s’affiche.

 Nom fichier : le nom du fichier comprenant son chemin absolu.

 Date réception : la date de la lecture du fichier.

 Erreur : permet de décrire l’erreur levée si une erreur se produit lors de la lecture
du fichier.

 Statut : état de la lecture et traitement du fichier :


o En cours de traitement : le fichier est en cours de traitement dans le cas ou
sa lecture se fait par bloc.
o Rejeté en totalité : aucun bloc du fichier n’a pu être lu.

Guide Utilisateur Carthago ESB 94/104


o Rejeté partiellement : la lecture des blocs du fichier a été interrompu car un
bloc n’a pas pu être lu.
o Traité en totalité : le fichier a été lu en totalité avec succès.
o Interrompu : la lecture du fichier a été interrompu (arrêt du serveur,…).

 Historique statut : historique des statuts du traitement du fichier.

 Dernier Bloc traité : lors du traitement indique le dernier bloc lu et traité.

 Endpoint : l’endpoint qui a lu le fichier.

 Descripteur : le nom de descripteur auquel l’endpoint est associé

Onglet « Blocs traités» :

- Permet le traçage des blocs du fichier

 A échoué : indique si la lecture du bloc a réussi ou pas

Guide Utilisateur Carthago ESB 95/104


 Erreur : permet de décrire l’erreur levée Si une erreur se produit lors de la lecture
du bloc.

 Numéro du bloc : le numéro du bloc par rapport au fichier

 Message reçu : Indique le message reçu que le bloc a produit

L’écran de consultation des fichiers attendus, permet de consulter la liste des


fichiers attendus pour chaque journée. Cette liste est générée à partir de la
configuration des fichiers attendus en respectant les conditions de générations
(périodicité,…)

 Non fichier : le nom du fichier attendu.

 Date prévu de réception : jour pour lequel le fichier est attendu

 Statut : indique le statut de la réception du fichier :

o Non reçu : le fichier n’est pas encore reçu


o Echec traitement : le fichier a été reçu mais son traitement n’a pas abouti.
Dans ce cas consulter la piste d’audit (message ESB, …).

Guide Utilisateur Carthago ESB 96/104


Le bouton fichiers reçus permet de consulter les fichiers attendus déjà reçus et
éventuellement de déplacer un fichier reçu dans la liste des attendus avec le bouton
Restaurer.

3.3 Notifications :

Les notifications envoyé ou reçus possèdent une autre structure pour pouvoir les tracer.

3.3.1 NOTIFICATION REÇUE :

 Statut : l’état du traitement de la notification.

 Réponse routeur : le router qui a traité la notification.

3.3.2 NOTIFICATION ENVOYE:

Guide Utilisateur Carthago ESB 97/104


 Statut : l’état du traitement de la notification.

 Erreur : permet de décrire l’erreur levée si une erreur se produit.


 Date : la date d’envoi de notification.
 Statut notification : l’état du traitement de la notification.

Il est à noter qu’un bouton de reprise permet de reprendre les notifications échouées.

4. ADMINISTRATION ESB :
- Le moteur de messagerie permet l’administration des différents composants
de l’ESB afin de pouvoir optimiser l’utilisation des services et l’état de leur
exécution.

4.1 État des Endpoints :

- Il permet de faire un suivi en temps réel en affichant les états des endpoints
entrant asynchrones en cours d’exécution pour détecter d’éventuels problèmes
(Pb connexion réseau, Pb connexion SFTP ou BD, …). Affiche aussi les erreurs
rencontrées par les endpoints sortants lors de l’envoi des messages.

Guide Utilisateur Carthago ESB 98/104


Après avoir activé (le/les) descripteur(s), l’utilisateur peut suivre l’état de tout le flux à
partir de cette écran.

 Màj états : ce bouton permet de rafraichir les champs pour mettre à jour les
données relatifs au flux.

 Réinitialiser : ce bouton permet de réinitialiser tous les champs.

L’utilisateur peut visualiser l’état de l’endpoint.

 Endpoint : le nom de l’endpoint en cours d’exécution.

Guide Utilisateur Carthago ESB 99/104


 Descripteur : le nom de descripteur auquel l’endpoint est associé

 Direction : affiche le type de l’endpoint (Entrant/Sortant).

 Erreur : affiche le message de l’erreur de la dernière exécution de l’endpoint.

 Date Erreur : date de l’erreur.

 Unités à traiter : précise le nombre d’unités non encore traité.

 Unités traitées : précise le nombre d’unités traité à ce moment.

4.2 Consultation pools JDBC :

- Elle permet la consultation des pools de connexion de bases externes


lorsque ceux ci sont gérés par l’application ESB et non par le serveur
d’application. Elle offre la possibilité de les stopper à tout moment.

Guide Utilisateur Carthago ESB 100/104


 Nom : affiche le nom de la connexion paramétrée au niveau de la boite à lettre
base de données externe.

 Nb connexions : affiche le nombre des connexions paramétrées au niveau de la


boite à lettre base de données.

 Taille cache requête : affiche la taille du cache allouée pour l’exécution de la


requête.

4.3 État des threads des bals :

- Elle permet la consultation des threads que le module ESB utilise pour la
lecture des messages par les endpoints entrants.

 Nombre de threads du Pool : le nombre de processus qui sont alloués à l’ESB.

 Nombre de threads actifs : le nombre de processus activés.

 Nombres de tâches en attente : affiche le nombre de tâche en attente.

Guide Utilisateur Carthago ESB 101/104


4.4 État des threads de la file d’attente :

- Elle permet la consultation des threads que le moteur ESB utilise pour le traitement des
fichiers de manière parallèle.

 Nombre de threads du pool : le nombre minimal de processus qui seront alloués à


l’ESB.

 Nombre de threads actif : le nombre de processus activés.

 Nombres de tâches en attente : affiche le nombre de tâche en attente dans la file


d’attente.

Guide Utilisateur Carthago ESB 102/104


4.5 Consultation Queue JMS :

Permet de consulter les messages contenus dans une Queue JMS, consulter leurs contenus
et offre la possibilité d’en supprimer quelques-uns ou de vider la queue totalement.

 Queue JMS : permet de sélectionner la destination JMS pour se connecter à la file


d’attente.

 Filtre JMS : filtre pour n’afficher que les messages vérifiés par le filtre.

 Expression description : expression à évaluer pour afficher une description de


l’objet du message.

 Afficher objet : indique s’il faut afficher le contenu du message (objet envoyé)

 Propriétés entête : contient une liste de propriétés séparés par des virgules, des
entêtes contenus dans le message et qui devront être affichés.

 Transformations objet : liste de transformations à appliquer au message si le flag


Afficher objet est coché pour afficher l’objet du message dans le format souhaité.

4.6 Consultation Pools LDAP :

Permet de consulter les connexions LDAP. Elle offre la possibilité de les stopper à tout
moment.

Guide Utilisateur Carthago ESB 103/104


 Nom : affiche le nom de la connexion paramétrée au niveau de la boite à lettre
LDAP.

 Nombre de connexions disponibles : affiche le nombre des connexions


paramétrées au niveau de la boite à lettre LDAP.

 Nombre maximum de connexions : affiche le nombre des connexions maximum


possible.

Guide Utilisateur Carthago ESB 104/104

Vous aimerez peut-être aussi