Manuel d'exploitation sM-Client
←
→
Transcription du contenu de la page
Si votre navigateur ne rend pas la page correctement, lisez s'il vous plaît le contenu de la page ci-dessous
Manuel d'exploitation sM-Client CSI / OFAS eAVS/AI Version: R6.0 Date de publication Feb 28, 2019
Manuel d'exploitation sM-Client
Publié le : Feb 28, 2019 Protégé par la Loi 2 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
SOMMAIRE
1 OBJET DU MANUEL D'EXPLOITATION .................................................... 8
2 APERÇU GÉNÉRAL DE SM-CLIENT .......................................................... 9
2.1 ARCHITECTURE DU SYSTÈME ET INTERFACES ................................................................... 9
2.1.1 Architecture du système ........................................................................... 9
2.1.2 Interfaces ............................................................................................. 10
2.2 INSTALLATION ET CONFIGURATION REQUISE – SERVEUR ................................................... 13
2.2.1 Recommandation concernant la configuration mémoire .............................. 14
2.3 TUNING ............................................................................................................ 16
2.3.1 Polling Intervall ..................................................................................... 16
2.3.2 sM-Client Queue .................................................................................... 16
2.4 INSTALLATION ET CONFIGURATION REQUISE – CLIENT ..................................................... 17
2.5 APERÇU DES ENVIRONNEMENTS DÉVELOPPEMENT, TEST ET PRODUCTION INSTALLÉS .................. 17
3 EXPLOITATION.................................................................................... 18
3.1 DÉMARRAGE ET ARRÊT DE L’EXPLOITATION ................................................................... 18
3.1.1 Conditions pour le démarrage ou le redémarrage de l’exploitation ............... 18
3.1.2 Première démarrage de l’exploitation ....................................................... 18
3.1.3 Démarrage et arrêt normal ..................................................................... 18
3.1.4 Interruption d’exploitation planifiée (arrêt et redémarrage) ......................... 18
3.1.5 Interruption d’exploitation non planifiée (panne du système) ...................... 18
3.1.6 Traitement postérieur et travaux de clôture: ............................................. 19
3.2 EXÉCUTION ET SURVEILLANCE DE L’EXPLOITATION (MONITORING) ....................................... 19
3.2.1 Monitoring centralisé .............................................................................. 19
3.2.2 Server Monitoring .................................................................................. 20
3.2.3 Vérification du traitement correct des messages ........................................ 20
3.2.4 Backup et Recovery ............................................................................... 21
3.2.5 Détenteurs, responsables et contacts ....................................................... 24
3.2.6 Heures de service .................................................................................. 24
3.3 INDICATEURS DE PERFORMANCE (KPI) ....................................................................... 24
3.4 RESTRICTIONS CONNUES ........................................................................................ 24
3.5 ARCHIVAGE ET SUPPRESSION DE DONNÉES ................................................................... 24
3.6 NOUVELLES VERSIONS ET MISES À JOUR ...................................................................... 25
3.6.1 Nouvelles versions du sM-Client .............................................................. 25
3.6.2 Mise à jour du repository ........................................................................ 26
3.6.3 Mise à jour des plug-ins ......................................................................... 26
Publié le : Feb 28, 2019 Protégé par la Loi 3 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
3.7 PLUSIEURS SM-CLIENT SUR UN ADAPTATEUR SEDEX........................................................ 26
3.7.1 Explication pour l’usage des règles .......................................................... 27
3.7.2 Exemple règles adaptateur ..................................................................... 28
3.8 PLUG-INS .......................................................................................................... 29
4 CONSIGNES DE SÉCURITÉ ................................................................... 30
4.1 SAUVEGARDE DES DONNÉES .................................................................................... 30
4.2 PROTECTION DE LA BANQUE DE DONNÉES .................................................................... 30
4.3 PROTECTION DES MESSAGES DE SM-CLIENT QUEUE ........................................................ 30
4.4 PROTECTION DES RÉPERTOIRES ................................................................................ 30
4.5 PROTECTION DE L’INTERFACE UTILISATEUR ................................................................... 31
4.6 PROTECTION DU BACKUP ........................................................................................ 31
5 ANNEXES DU MANUEL D'EXPLOITATION ............................................. 32
5.1 LISTE DES MESSAGES LOG ...................................................................................... 32
5.1.1 Message Handler ................................................................................... 33
5.1.2 Case postale ......................................................................................... 34
5.1.3 Service formulaire ................................................................................. 34
5.1.4 Général ................................................................................................ 35
5.2 LISTE DES CODES DE STATUT ................................................................................... 37
5.2.1 Deutsch................................................................................................ 37
5.2.2 Français ............................................................................................... 40
5.2.3 Italiano ................................................................................................ 43
5.3 ENVOI D’EMAIL EN CAS D’ERREUR .............................................................................. 46
5.4 REQUÊTE DE L'ÉTAT DE LA DLQ VIA REST ................................................................... 47
Publié le : Feb 28, 2019 Protégé par la Loi 4 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
TABLEAU DES ILLUSTRATIONS
Figure 1 Architecture de référence .............................................................................. 9
Figure 2 Interfaces vers l’adaptateur ......................................................................... 10
Figure 3 Interfaces vers les applications métiers ......................................................... 11
Figure 4 Exemple d’interfaces externes ..................................................................... 12
Figure 5 Mandants multiples .................................................................................... 13
Figure 6 Plusieurs sM-Client ..................................................................................... 27
Publié le : Feb 28, 2019 Protégé par la Loi 5 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
GESTION DES DOCUMENTS
Historique
Version Modifé Description Date Validé
01 Martin Elaboration, chapitrage et première version 14.08.2009 SM
Liebrich
02 Martin Compléments suivant le retour d'information 24.08.2009 SM
Liebrich
03 Stefan Malär Adaptations et chapitrage du manuel de 31.08.2009 ML
l'utilisateur/manuel d'exploitation
10 Stefan Malär Version finale 31.08.2009 ML
11 Sylvain Mandants multiples, Backup et Recovery 17.03.2010 CW
Berthouzoz
12 Sylvain Recommandation au sujet de la mémoire 19.01.2011 SM
Berthouzoz requise
13 Sylvain Détails au sujet de la mémoire 03.02.2011 SM
Berthouzoz
14 Sylvain Liste des codes de statut 07.06.2011 CW
Berthouzoz
15 Sylvain Installations Serveur, mesure de sécurité, 11.01.2012 CW
Berthouzoz envoi d'email en cas d'erreur
16 A. Rapanaro 3.6.3 Mise à jour des plug-ins 18.01.2012 CW
3.8 Plug-ins
17 S. Berthouzoz 3.2.2 Limitations des backups 22.02.2012 CW
18 S. Berthouzoz 3.2.1 monitoring platform 26.09.2012 CW
19 S. Berthouzoz Input AWK 29.09.2012 CW
20 Andreas Neue JMS-Extension Zustände und Log 16.01.2013 OW
Dejung Informationen hinzugeführt
50 Andreas Informationen für Release 5.0 hinzugefügt 15.04.2013 OW
Dejung
5.0.1 S Berthouzoz Feedback von RC2/RC3 24.07.2013 CW
5.0.7 Fei Guo Informationen für Release 5.0.7 hinzugefügt 20.03.2014 CW
(2.2, 2.3.3)
Publié le : Feb 28, 2019 Protégé par la Loi 6 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
5.0.8 Fei Guo Informationen für Release 5.0.8 hinzugefügt 08.05.2014
(2.2, 2.3.3)
Sylvain Kapitel 3.2.3 Überprüfung des korrekten 17.10.2014
Berthouzoz Verarbeitung, Infos für Anmeldung an der
Monitoring Platform im Kap. 3.2.1, Log
(3.2.2)
6.0.0 Sylvain Anpassungen für Release 6.0.0 24.01.2017
Berthouzoz
6.0.4 Sylvain Informations sur la supression des donnés 28.02.2019
Berthouzoz de la BD (chap. 3.5 Archivage et
suppression de données)
Références
Nom Version Document
Design technique 6.0.0 Technisches_Design_sM-Client.pdf
Manuel d’installation 6.0.0 Installations-Handbuch_sM-Client.pdf
Load Tests Resultats 1.0 Load Tests Resultate.pdf
Publié le : Feb 28, 2019 Protégé par la Loi 7 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
1 OBJET DU MANUEL D'EXPLOITATION
Ce manuel d’exploitation sert de document de base pour les manuels d'exploitations des
participants. Il comprend les informations techniques usuelles nécessaires à l’exploitation
ainsi que des „best practices“.
Ce manuel est importante source d’information pour appuyer l’exploitation quotidienne par
des descriptions détaillées et l’explication de toutes les étapes active et proactives pour
maintenir le système en marche et pour éviter des arrêts (pannes) non prévus. Il décrit des
cas d’exploitation particuliers comme p.ex. la reprise de l’exploitation après des arrêts
prévus ou non prévus, la préparation d'arrêts planifiés dans des fenêtres de maintenance,
la recherche de pannes et la correction de pannes de toutes les étapes de travail actives et
proactives (p.ex. extension de Hardware / Software et de licences) pour assurer les
performances nécessaires malgré l’agrandissement et l’utilisation accrue du système.
Publié le : Feb 28, 2019 Protégé par la Loi 8 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
2 APERÇU GÉNÉRAL DE SM-CLIENT
Décrit les relations techniques générales du système et offre un aperçu général à
l’exploitant.
2.1 Architecture du système et interfaces
2.1.1 Architecture du système
Le diagramme suivant montre l’architecture de référence du sM-Client.
Figure 1 Architecture de référence
Suivant l’installation, JBoss EAP doit être remplacé par un autre serveur d’application (par
exemple Apache TomEE), et MySQL par d’autres banques de données. Il est également
possible d’utiliser en plus un LDAP ou AD.
Le code du sM-Client tourne sur le serveur d'application.
Publié le : Feb 28, 2019 Protégé par la Loi 9 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Messaging est l’implémentation JMS utilisée par le sM-Client, aussi nommée sM-Client
Queue dans le présent document
Les données de base nécessaires à l’exploitation du client sM sont stockées dans la
banque de données. Les données de traitement pour les messages sont également
stockées dans la banque de données (voir au chapitre Archivage et suppression des
données ).
Le disque local ou le NAS est utilisé pour la sauvegarde temporaire des messages lors de
leur passage dans le système. Les messages JMS de la Queue sont aussi sauvegardés par
l'implémentation JMS sur le disque local ou le NAS. Un éventuel Backup est également
enregistré ici.
Si un LDAP / AD est utilisé, celui-ci contient les données utilisateur et de login. Sinon,
elles sont stockées dans la banque de données.
Autres informations sur l’architecture du système dans le chapitre 2 du document "Design
technique".
2.1.2 Interfaces
Un aperçu général peut être tiré des diagrammes suivants.
Figure 2 Interfaces vers l’adaptateur
Publié le : Feb 28, 2019 Protégé par la Loi 10 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Figure 3 Interfaces vers les applications métiers
Les répertoires doivent être adaptés aux besoins individuels de l’exploitant. En principe il
est prévu de créer un répertoire par application métier ou triage externe. Un exemple est
montré ci-dessous
Publié le : Feb 28, 2019 Protégé par la Loi 11 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Figure 4 Exemple d’interfaces externes
Les interfaces sont décrites en détail dans le chapitre 4 du document "Design technique
client sM".
A partir de la version 2.0.x, il est possible d’installer plusieurs mandants avec un seul
serveur d’application, cela signifie que l’on peut exécuter plusieurs instances du client sM
sur le même serveur. Reportez-vous au manuel d’installation pour l’activation et la
configuration des mandants. Le diagramme suivant illustre ce principe :
Publié le : Feb 28, 2019 Protégé par la Loi 12 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Figure 5 Mandants multiples
Chaque mandant dispose de sa propre configuration et de sa propre structure de
répertoire.
2.2 Installation et configuration requise –
Serveur
Les conditions requises pour installer et exploiter le client sM sont les suivantes :
JBoss (voir plateforme de référence), TomEE ou Oracle WebLogic
MySQL (voir plateforme de référence), Oracle ou MS SQL
JDK
Publié le : Feb 28, 2019 Protégé par la Loi 13 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
1 Go de libre sur le disque dur pour l'application
Installation minimale locale pour une utilisation simple utilisateur (Desktop, seulement
pour les tests) :
o 2Go de Mémoire (1.25Go libre pour l'application)
Configuration JVM pour sM-Client (JBoss) : -Xms512m -Xmx1024m
Installation minimale Installation pour l'exploitation:
o 4Go de Mémoire (3Go libre pour l'application)
Configuration JVM pour sM-Client (JBoss) : -Xms512m -Xmx2816m
Pour Windows il est recommandé d’utiliser les même valeurs pour MinHeapSize et
MaxHeapSize pour éviter le swapping de mémoire, par exemple : set
JAVA_OPTS=%JAVA_OPTS% -Xms1024m -Xmx1024m
Le disque dur et la mémoire sont les conditions minimales pour l’exploitation d’un
ordinateur individuel exécutant un seul mandant. Pour l’exploitation d’un centre de calcul il
est nécessaire de prévoir des conditions requises plus importantes, en particulier la
mémoire.
De plus, les interfaces de répertoires nécessitent de la place de stockage sur un support
adéquat (disque dur, NAS) suivant la taille et le volume des messages.
L’installation et la configuration sont décrites dans le document "Manuel d’installation client
sM".
Des mesures de sécurité supplémentaires pour un serveur accessible sur internet sont
contenues dans le document suivant
http://community.jboss.org/wiki/SecureTheJmxConsole
(http://community.jboss.org/wiki/SecureTheJmxConsole).
Une vue d’ensemble des tests de montée en charge se trouve dans le document "Load
Tests Resultats" [03].
2.2.1 Recommandation concernant la configuration
mémoire
Différents facteurs influencent la quantité de mémoire employée. Les facteurs sont le
nombre de mandants, la taille des messages à traiter, la taille des messages à imprimer
ainsi que l'utilisation ou non du service de formulaire
Les recommandations minimales suivantes (3 Go libre pour l'application) permettent
l'exploitation dans les conditions suivantes :
Un seul mandant actif
Message dont la taille au format XML fait moins de 100Mo (Beaucoup de ces grands
messages à traiter en même temps peuvent par contre causer un ralentissement du
traitement des messages)
Messages dont le fichier XML fait moins de 2Mo peuvent être imprimés, ou exportés
comme PDF.
Publié le : Feb 28, 2019 Protégé par la Loi 14 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Le service de formulaire peut être employé
2.2.1.1 Plusieurs mandants
Lors de l’exploitation de plusieurs mandants, les recommandations suivantes doivent être
prises en compte. Ces recommandations supposent que les mandants ne sont pas tous
employés à pleine charge au même moment.
Pour les deux premiers mandants supplémentaires, ajouter 1Go (0.5Go sans service de
formulaire) par mandant
Pour les mandants suivants, ajouter 0.5Go (256Mo sans service de formulaire) par
mandant
Exemple de configuration pour 10 mandants sans service de formulaire :
3Go + 2 x 0.5Go + 7 x 256Mo = 5.75Go
-Xms1024m –Xmx5888m -XX:MaxPermSize=1024m
Cela signifie aussi que pour un système à plusieurs mandants, un système d'exploitation
64bit est nécessaire.
La configuration du sM-Client Queue ne dépend pas du nombre de mandants.
2.2.1.2 Messages plus grands
En principe, il est possible d’envoyer de plus grands messages avec plus de mémoire. Ainsi
on peut envoyer des messages deux fois plus grands avec deux fois plus de mémoire.
Les valeurs données correspondent à une marge de sécurité, il est en théorie possible de
traiter des messages de n’importe quelle taille, mais il n’est pas garanti que cela fonctionne
sans problème. Il faut aussi tenir compte du fait que des messages de plusieurs centaines
de Mo peuvent occasionner des problèmes au niveau de la vitesse d’accès au disque.
La configuration de sM-Client Queue est indépendante du nombre de message.
2.2.1.3 Impression de messages et génération de PDF
Avec plus de mémoire, il est aussi possible d’imprimer et de générer un PDF pour de plus
grands messages. Avec 3.5Go des messages jusqu'à 4Mo XML peuvent être imprimés le
fichier PDF peut être généré
Exemple de configuration :
-Xms1024m -Xmx3584m
La limite pour l’impression et la génération de PDF sont configurés dans le fichier
config.properties
Par défaut : print.message.smaller=2048 dans config.properties.
Publié le : Feb 28, 2019 Protégé par la Loi 15 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Attention au fait que des messages de 4Mo génèrent environ 700 pages, ce qui peut
poser problème lors de l’impression.
2.3 Tuning
2.3.1 Polling Intervall
2.3.1.1 config.properties
filechange.listener.interval: Temps entre chaque lecture des dossiers Inbox, receipts
et Outbox
o o La valeur par défaut est de 15 secondes
message.batch.pickup.size: Nombre de messages traités par dossier en un passage.
o Valeur par défaut est de 50 (soit 50 fichiers depuis Inbox, 50 de Receipts, 50 de
Outbox)
Idéalement tous les fichiers devraient être traités durant un passage, soit durant
[filechange.listener.interval] secondes. Par exemple: avec message.batch.pickup.size=10,
soit 10 messages dans Outbox, 10 quittances Sedex, 10 messages dans Sedex Inbox)
2.3.1.2 Exemple:
filechange.listener.interval=120
Le traitement d’un message dure entre 3 et 5 secondes
30 x 3 = 90 secondes jusqu'à 30 x 5 = 150 secondes
Ainsi le traitement peut rester dans l’intervalle de 120 secondes et les messages suivants
seront lu à la fin du traitement ou après filechange.listener.interval=120 secondes.
2.3.2 sM-Client Queue
Les paramètres suivants de message-handler-[domain].properties peuvent être utilisés
pour définir le type de queue employé pour le traitement des messages (voir aussi [02] →
Installation du sM-Client sur JBoss EAP7 → JMS Settings):
max.num.msg
max.num.msg.pdf
Messages groupés avec plus de messages internes que max.num.msg seront traités dans
la queue standard, les autres dans la queue priority (pour la validation).
max.num.msg.pdf a la même signification pour la génération du PDF.
max.size
Publié le : Feb 28, 2019 Protégé par la Loi 16 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
max.size.pdf
Messages ou la taille des messages XML dépasse max.size seront traités dans la queue
standard, les autres dans la queue priority (pour la validation).
max.size.pdf a la même signification pour la génération du PDF.
Pour décider du traitement dans la queue standard, le sM-Client vérifie d’abord le nombre
de messages, puis la taille de ces derniers.
Le sM-Client peut traiter un message par queue en même temps.
2.4 Installation et configuration requise – Client
Le sM-Client est conçu comme une application basée sur le Web. Pour le client on utilise
donc un navigateur Web (Internet Explorer 10+, Firefox 47+). On suppose qu’un tel
programme navigateur est déjà installé sur l’ordinateur client.
L’interface Web du client sM n'impose pas de conditions particulières au navigateur ni à la
capacité de performance de l'ordinateur. Comme pour le service formulaire on utilise AJAX,
on recommande d’utiliser Firefox 47+, IE10 dans le mode compatibilité. Un ordinateur
ordinaire du marché doit être suffisant pour utiliser le GUI.
2.5 Aperçu des environnements développement,
test et production installés
A compléter par l'exploitant.
Publié le : Feb 28, 2019 Protégé par la Loi 17 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
3 EXPLOITATION
3.1 Démarrage et arrêt de l’exploitation
3.1.1 Conditions pour le démarrage ou le redémarrage
de l’exploitation
L’installation et la configuration sont décrites dans le document "Manuel d'installation sM-
Client".
3.1.2 Première démarrage de l’exploitation
Avant le premier démarrage de l’exploitation, il est nécessaire de s’assurer que toutes les
configurations aient été faites comme décrit dans le "Manuel d'installation sM-Client".
3.1.3 Démarrage et arrêt normal
Si le sM-Client a été installé avec Start-Script, une procédure de démarrage et d’arrêt est à
disposition (répertoire $INSTALL_PATH/scripts/windows|linux – start_smclient.bat|.sh
resp. stop_smclient.bat|sh).
Si le sM-Client a été installé comme service, le service respectif peut être démarré ou
arrêté.
3.1.4 Interruption d’exploitation planifiée (arrêt et
redémarrage)
Les mêmes possibilités d’arrêt et de démarrage sont possibles pour les interruptions
d'exploitation planifiées que celles décrites plus haut.
3.1.5 Interruption d’exploitation non planifiée (panne
du système)
Après une panne il faut s’assurer que les processus du serveur JBoss et de la banque de
données MySQL ne tournent plus. Ils doivent être éventuellement terminés avec les outils
adéquats.
Publié le : Feb 28, 2019 Protégé par la Loi 18 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Si la fonction Backup était activée avant l’arrêt, il est possible d’effectuer une restauration
comme décrite dans le chapitre "Nouvelle installation avec Backup complet" du document
"Manuel d’installation sM-Client".
3.1.6 Traitement postérieur et travaux de clôture:
Si des travaux de clôture sont nécessaires après arrêt de l’exploitation, ils doivent être
indiqués ici. Ceci peut par exemple concerner le traitement des supports de données.
3.2 Exécution et surveillance de l’exploitation
(monitoring)
Décrit les mesures pour le bon fonctionnement et la surveillance de l’exploitation.
3.2.1 Monitoring centralisé
Dès le 01.01.2013 (Date exacte indéterminée) la plateforme smc-monitoring.ctp-
consulting.com (http://smc-monitoring.ctp-consulting.com) sera mise en place et enverra
chaque jour à tous les participants inscrits un message de monitoring. L'exploitant pourra
donc voir sur cette plateforme si son adaptateur sedex et/ou son sM-Client est atteignable.
La disponibilité des autres participants inscrits peut aussi être consultée sur la plateforme
via un tableau de bord.
De façon à ce que ces messages de monitoring ne perturbent pas l'exploitation courante, il
est nécessaire de définir une règle de triage pour placer ces messages de monitoring dans
un dossier spécifique. (Voir le manuel d'installation au chapitre 4.2.3 pour les détails
techniques de configuration)
Si ces messages ne sont pas placés dans un dossier spécifique, il convient de les ignorer.
Les messages de monitoring sont de types :
Type de message 2991 pour les participants BSV
Type de message 3991 pour les participants SSK
Si malgré la règle de triage un message de monitoring aboutit dans un dossier standard du
sM-Client, ce message doit être ignoré. Cela peut arriver dans le cas d'une quittance de
protocole d'un message de monitoring intransmissible et qui serait dans le dossier
failed_to_transmit.
La plateforme de monitoring envoie un email à chaque participant, lorsque son adaptateur
Sedex et/ou sM-Client n'est pas atteignable, ce n'est qu'à ce moment qu'il est nécessaire
de contrôler le déroulement des messages de monitoring sur le serveur local (soit le
serveur de l'exploitant).
Publié le : Feb 28, 2019 Protégé par la Loi 19 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
L’accès à la plateforme de Monitoring n’est possible qu’après inscription auprès de support-
sm-client.consulting@atos.net (mailto:support-sm-client.consulting@atos.net) avec
mention de votre sedexId ainsi que d’une adresse email, laquelle recevra les notifications
de la plateforme de Monitoring.
3.2.2 Server Monitoring
Le sM-Client enregistre toutes les données intéressantes pour le monitoring dans le fichier
Log. La configuration du Log est décrite dans le manuel d’installation au chapitre 4.2.4.1.1
« Log ». Il est recommandé de conserver les fichiers de Logs pour une période minimale de
6 mois. Les différents messages sont décrits en annexe 6.1 de ce document.
Le sM-Client donne périodiquement un message de fonctionnement (message i-0500) pour
chaque mandant. L'exploitant peut vérifier à l’aide de ce message si le sM-Client
fonctionne.
Il est possible d'envoyer un Email dans le cas d'un message d'erreur, voir l'annexe Envoi
d’email en cas d’erreur.
La vérification de ce Log doit être décrite par l’exploitant.
Le sM-Client enregistre chaque étape de processus pour les messages dans la table
Message. Les différents codes et messages sont décrits en annexe "Liste des codes de
statut" de ce document.
3.2.3 Vérification du traitement correct des messages
Pour vérifier le traitement correct d‘un message, vous disposez des possibilités suivantes :
Vérification du statut dans le suivi d‘audit:
Les statuts suivant représentent un traitement réussi d‘un message (il y a un statut
général et un par domaine).Les messages, qui restent pendant plusieurs jours en cours
de traitement ont un statut différent et doivent être vérifiés plus en détail.
o Statuts "Traitement terminé avec succès (Réception)":
message-handler-ech0058v4 receive ended
message-handler-receive process ended
message-handler-moved message
message-handler-end elm receive
o Statuts "Traitement terminé avec succès (Envoi)":
message-handler-end elm send
message-handler-send process ended
message-handler-moved to sent
message-handler-ech0058v4 send ended
Publié le : Feb 28, 2019 Protégé par la Loi 20 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Pour être sûr qu’aucun message n’est en cours de traitement, il faut aussi vérifier les
dossiers suivants :
o Failed_to_transmit, Failed_to_send, Failed (voir Architecture du système et
interfaces. ainsi que le manuel d’installation au chap. 4.2.1 „Configuration des
dossiers des interfaces“ et 4.2.2.3 „message-handler.properties“): Les messages
se trouvant dans ces dossiers représentes ont subi une erreur de traitement et
doivent être examinés plus en détails (p.ex. au moyen du suivi d’audit, des
fichiers de Logs et des fichiers d’erreurs éventuels contenus dans le message).
Le dossier temporaire ne devrait pas contenir de fichiers vieux de plus de 30 jours (sedex-
Timeout): Par défaut, le dossier temporaire est celui du système d’exploitation
(C:\Users\'username'\AppData\Local\Temp sous Windows7 et /tmp sous Linux). Ce dossier
peut aussi être configuré ailleurs, comme décrit dans le manuel d’installation.
3.2.4 Backup et Recovery
3.2.4.1 Limitations lors de la sauvegarde
La fonction de backup intégré du sM-Client n’est prévue que pour des petites quantités de
messages (< 10000 entrées dans la table Message) autrement il est recommandé d’utiliser
une solution de backup externe (par exemple mysql dump)
3.2.4.2 Limitations lors de la sauvegarde avec plusieurs
mandants
Il est possible de faire une sauvegarde simple de la base de données (BD sans les
processus, avec les fichiers) ainsi qu’une sauvegarde complète de la base (BD avec les
processus). La restauration de la sauvegarde peut se faire par l’administrateur
correspondant au mandant. Pour une utilisation du sM-Client avec un seul mandant,
aucun changement n’est donc à signaler
Si plusieurs mandants sont configurés, il faut tenir compte des points suivants :
o La sauvegarde simple peut être configuré par mandant et restauré par
l’administrateur du mandant
o La sauvegarde complète fonctionne pour la base de données dans son ensemble,
soit pour tous les mandants gérés par le sM-Client. C’est pourquoi il ne faut
activer la sauvegarde complète que pour un seul mandant ET ce mandant ne doit
pas exécuter la sauvegarde au même moment que les autres. (= il faut une
valeur différente pour time.of.day.for.backup) ni dans le même répertoire. Après
une restauration complète de la base de données (qui a lieu en dehors de
l’application sM-Client), tous les administrateurs doivent restaurer les fichiers
depuis l’interface. Cela pour autant que ces mandant aient activés la sauvegarde
simple (sinon aucun fichier ne peut être restaurés). Le sM-Client ne fait aucune
vérification à ce sujet.
Publié le : Feb 28, 2019 Protégé par la Loi 21 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
3.2.4.3 Backup pour sM-Client Queue
Le système sM-Client Queue utilise un stockage persistant pour la gestion des Queues. Les
informations sont stockées dans le système de fichier. sM-Client Core peut renvoyer les
messages JMS en attente, de telle façon que le traitement puisse reprendre sans qu’un
backup des messages JMS ne soit nécessaire. Un backup des messages JMS aurait de plus
aucun sens au vue de la faible durée de vie des messages JMS ; un backup devrait être fait
après chaque traitement d’un message JMS, ce qui arrive toutes les quelques minutes.
3.2.4.4 Backup
Le mécanisme du backup permet de sécuriser les données suivantes :
backup.enabled : Messages (fichiers et table message, inclus les audits), configurations
et référentiels (système fichier)
backup.fullDB.enabled : Informations de traitement, Audit Trail, éventuellement les
utilisateurs (entrées banque de données)
Le mécanisme du backup prévoit que les données soient déplacées en paquet, à un
moment et dans un répertoire définis (à configurer dans config.properties). Il est judicieux
de ne pas placer le répertoire sur la même machine. Localement, il est de la responsabilité
de l’exploitant de sécuriser et de mettre à jour le backup.
Le backup peut être configuré avec config.properties. Les possibilités de configuration
suivantes sont disponibles :
backup.enabled – active ou désactive le backup
backupDirectory – répertoire dans lequel le backup est enregistré
time.of.day.for.backup – heure à laquelle le backup est effectué
backup.fullDB.enabled – backup complet (MySQL DB-Dump) activé ou désactivé.
L’emplacement du backup complet peut être configuré dans le script backupBatch (par
exemple MySQLSmClientBackup.bat)
Le sM-Client effectue ensuite lui-même le backup en fonction de la configuration. La
logique du backup doit être simple, car sinon il est possible que des données soient
perdues entre le backup et la panne. Si le backup est enregistré sur le même support que
le Filesystem et la banque de données, il est possible qu’un backup soit complètement
perdu. Il est donc fortement recommandé d’enregistrer le backup sur un autre disque
physique.
Si une conservation ou un visionnement des backups individuels est souhaité, c'est à
l'exploitant de s'en assurer.
Un enregistrement redondant des données est recommandé pour augmenter la sécurité
(banque de données et répertoires).
Publié le : Feb 28, 2019 Protégé par la Loi 22 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
3.2.4.5 Restore (restauration)
Le backup peut être restauré par l'administrateur technique, sous l’entrée de menu Backup
de l’interface utilisateur.
Il faut également noter que lors de la restauration de la banque de données, les données
existantes sont supprimées.
Le Restore peut être fait individuellement pour le système fichier et pour les entrées de la
banque de données. Pour éviter une incohérence (la banque de données et le système
fichier ne correspondent pas), le Restore devrait toujours être fait complètement. Les
incohérences sont signalées par des messages d’erreur dans le journal ou par l’affichage du
message dans la case postale, comme par exemple "Le message a été supprimé et n’est
plus disponible" ou "Une erreur est survenue lors de la suppression".
Si une incohérence est permanente, elle doit être corrigée par l’administrateur :
Le message correspondant peut être cherché dans Audit Trail à l’aide des attributs
connus (p.ex. messageId, type, expéditeur). Le lieu de stockage prévu et le nom y sont
indiqués.
Les messages d’erreur correspondant peuvent également être trouvés dans le Log.
Sur le système fichier il est possible de vérifier si le message n’est vraiment plus
disponible.
Si c’est le cas, l’administrateur peut chercher le fichier avec le nom et, s'il existe, le
copier dans le dossier adéquat.
Si le message n’existe plus, il est éventuellement possible de vérifier dans le backup si
le fichier s’y trouve encore.
Si l’incohérence ne peut être corrigée de cette manière, il est nécessaire de placer
l’entrée dans le tableau message de la banque de données, sur currentStateMsg
"mailbox permanently deleted".
Si des fichiers sont trouvés dans le système fichier et ne sont plus affichés sur l’interface, il
est également possible de les rechercher dans Audit Trail. La correction est analogique, le
fichier devrait être déplacé à l’endroit adéquat ou supprimé manuellement de la banque de
données.
Pour trouver des incohérences après restauration, l’exploitant peut effectuer les
vérifications suivantes :
Lors d’une restauration des données uniquement, il est possible de trouver dans Audit Trail
toutes les données qui ont été modifiées après le moment de la restauration du backup ; et
si elles ne sont plus cohérentes avec le système fichier, l’incohérence peut être corrigée
selon description ci-dessus.
Publié le : Feb 28, 2019 Protégé par la Loi 23 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Lors d’une restauration de la banque de données uniquement, il est possible de trouver
dans le système fichier toutes les données qui ont été modifiées après le moment de la
restauration du backup ; et si elles ne sont plus cohérentes avec la banque de données,
l’incohérence peut être corrigée selon description ci-dessus.
Restauration d'un backup complet
Le backup complet ne peut être restauré que depuis l'invite de commande:
Windows: > MySQLSmClientBackup.bat restore
Linux: > bash MySQLSmClientBackup.sh restore
3.2.5 Détenteurs, responsables et contacts
Un support est disponible pendant la phase pilote à l’adresse suivante : https://jira.ctp.com
(https://jira.ctp.com)
Vous pouvez demander un compte à l'adresse suivante : support-sm-
client.consulting@atos.net (mailto:support-sm-client.consulting@atos.net)
Les autres contacts, responsabilités et déroulements doivent être décrits par le PL ou
l'exploitant respectif.
3.2.6 Heures de service
A compléter par l’exploitant.
3.3 Indicateurs de performance (KPI)
Indicateurs de performance relatifs à l’utilisation – serveurs qui doivent être gérés par
l’exploitant.
3.4 Restrictions connues
Il n’y a pas de restrictions fonctionnelles.
Il n’y a pas de restrictions techniques.
Il n’y a pas de restrictions concernant la capacité.
3.5 Archivage et suppression de données
Comme le sM-Client est une interface, ou Middleware, il n’offre pas de fonctions pour
l’archivage ou la suppression de données.
Publié le : Feb 28, 2019 Protégé par la Loi 24 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Les données ne doivent pas s'accumuler dans les répertoires interfaces en exploitation
normale, car celles-ci sont chaque fois récupérées et traitées par un système. Ceci doit être
vérifié périodiquement. Une grande accumulation de données peut indiquer un problème du
système général.
Le sM-Client utilise des répertoires internes pour les fichiers temporaires. Ces fichiers sont
supprimés par le sM-Client lui-même. Ceci doit également être vérifié périodiquement. Une
grande accumulation de données indique un problème avec le sM-Client.
Les répertoires pour les messages échoués (failed resp. failed_to_send, failed_to_transmit)
doivent être vérifiés régulièrement. Failed_to_send et failed_to_transmit contiennent des
messages qui ont échoués lors du processus d’envoi. Ces messages peuvent être vérifiés
sur la case postale, mais doivent être supprimés manuellement du répertoire. Les
messages qui ont échoués lors du processus de réception sont déposés dans failed. Ce
répertoire n’est pas affiché dans la case postale et doit être traité hors du sM-Client
(manuellement ou par une autre application).
Dans la banque de données, il faut s’attendre à une forte augmentation du volume de
données dans les tables Message et smAudit. Ces données peuvent être supprimées ou
archivées après traitement (statut „Permanently Deleted“ ou „Message Sent“ dans le
tableau Message). Il faut alors s’assurer que les messages soient supprimés ou archivés de
manière cohérente dans les deux tables. Vous pouvez utiliser pour cela les scripts
DB_cleanup.zip (http://sm-client.ch.atosconsulting.com/downloads/DB_cleanup.zip)
(p.ex.: message_cleanup_mysql.zip). Ce fichier ZIP contient également les instructions
d'utilisation du script ainsi qu'un script (p.ex.: camunda_hist_cleanup_mssql.sql) pour
nettoyer les tables du moteur de processus (Tables ACT_*).
Les tables smUser, smRole, smUser_smRole, smMandant et configuration contiennent des
données de base. La croissance ici devrait être minime.
Fichiers Log et fichiers erreurs
Gestion de capacité
Enregistrement de la capacité et surveillance
Révision régulière de l’utilisation de la capacité
Intervention corrective pour éliminer l’usage incorrect
Planification de la capacité
3.6 Nouvelles versions et mises à jour
3.6.1 Nouvelles versions du sM-Client
En cas d’une nouvelle version du sM-Client celui doit être réinstallé. Les directives
respectives sont livrées avec la nouvelle version.
Publié le : Feb 28, 2019 Protégé par la Loi 25 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Pour installer une nouvelle version le sM-Client doit être arrêté, c.-à-d. la banque de
données et le serveur d’application doivent être arrêtés selon la procédure. L’installation
peut alors s'effectuer selon les indications données.
Il est recommandé de sauvegarder la banque de données et les répertoires afin de ne pas
les écraser pas mégarde
3.6.2 Mise à jour du repository
Les mises à jour du stockage sont publiées sur le site du sM-Client (http://sm-
client.ch.atosconsulting.com/).
L'installation, resp. la mise à jour, s'effectue de la manière suivante :
1. Arrêter le sM-Client
2. Effacer le contenu du répertoire \interface\repository
3. Extraire le fichier ZIP dans le dossier \interface\repository
4. Vérifier les droits du sM-Client pour la lecture et l'écriture sur les 4 dossiers.
5. Démarrer le sM-Client
3.6.3 Mise à jour des plug-ins
Normalement les plug-ins sont livrés avec un nouveau repository et ils se trouvent dans le
répertoire "plugins/". Par default ce répertoire est scanné au fin de contrôler si des plug-ins
ont été installés ou mis à jour, mais il est possible d'en configurer un autre (cf. Manuel
d'installation au chapitre "repository.properties"). Les plug-ins peuvent être installés ou mis
à jour pendant le fonctionnement du sM-Client, mais pour les effacer il est nécessaire de
redémarrer l'application.
3.7 Plusieurs sM-Client sur un adaptateur sedex
Si plusieurs clients sM (ou plusieurs mandants) ou différentes communications accèdent sur
le même adaptateur sedex, il faut s’assurer que chaque client ne puisse accéder qu’à ses
propres données dans l’interface de l’adaptateur.
Publié le : Feb 28, 2019 Protégé par la Loi 26 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Figure 6 Plusieurs sM-Client
Le sM-Client peut être configuré en conséquent par Triage dans le fichier rule.xml. Cela
permet aussi de s’assurer qu’aucun message d’un autre type de communication ne soit
accédé.
A noter qu’un message envoyé simultanément aux deux clients sM n’est traité qu’une fois
par un adaptateur. Après 5 jours le deuxième message est également traité si l’autre sM-
Client est inactif pendant toute cette durée. Dans ces cas il est recommandé que les
messages pour le sM-Client, qui hors service sont sauvegardés provisoirement ailleurs, lui
soient remis dès que celui-ci est à nouveau en service.
3.7.1 Explication pour l’usage des règles
L’élément comprend un nombre au choix d’éléments . Les règles sont
traitées à la suite, dans lesquelles elles apparaissent. Les règles spécifiques doivent donc
être tout en haut.
Pour cette configuration on utilise le Use Case "adapter".
contient dans Use Case "adapter"
- critères de la règle qui sont analysées
- adapter
peut vérifier les valeurs suivantes dans "adapter"
Publié le : Feb 28, 2019 Protégé par la Loi 27 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
o
o
:
aucune -> règle par défaut (n’est justement pas utilisée dans ce cas)
et
3.7.2 Exemple règles adaptateur
Voici quelques exemples d’application des règles adaptateur, si plusieurs clients sM ou
applications sont connectés à un adaptateur.
Cette règle permet de saisir tous les messages de type 3001 envoyés au destinataire T6-
900014-2 :
T6-900014-2
3001
adapter
Cette règle permet de traiter tous les messages de type 3002 :
3002
adapter
Cette règle permet de traiter tous les messages envoyés au destinataire T6-900014-1 :
T6-900014-1
adapter
Publié le : Feb 28, 2019 Protégé par la Loi 28 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
Avec deux adaptateurs, un utiliserait p.ex. la règle adaptateur avec recipientId est T6-
900014-1 et l’autre la règle adaptateur avec recipientId est T6-90014-2. Chaque
adaptateur ne traite ainsi que les messages qui lui sont destinés.
3.8 Plug-ins
Les plug-ins se trouvent par default dans le répertoire "plugins/". Dans le cas d'une
installation de plusieurs mandants et repository ceci n'est pas optimal, car plusieurs
répertoires devraient être scannés pour des mises à jour des plug-ins qui, souvent,
contiennent les mêmes fichiers. Il est donc possible de spécifier un chemin absolu, qui
serait en commun entre les différents mandants.
plugins.dir=/path/to/plugin/directory
Une autre raison qui justifierait l'emploi d'un répertoire commun dans le cas de mandants
multiples est d'avoir un endroit centralisé pour le stockage des plug-ins, ce qui permettrait
de garantir une meilleure consistance. Tous les mandants pourraient donc utiliser les
mêmes versions des plugins en cas de mises à jour.
Publié le : Feb 28, 2019 Protégé par la Loi 29 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
4 CONSIGNES DE SÉCURITÉ
Décrit les consignes et mesures pour garantir la sécurité nécessaire. Ceci comprend
l’infrastructure, l’organisation et le personnel ainsi que les prévoyances en cas de
catastrophe et les assurances.
4.1 Sauvegarde des données
Le sM-Client n’effectue pas de sauvegarde à long terme des messages. Seules les données
sur les messages sont enregistrées dans la banque de données, mais pas les messages
mêmes. Des mesures de sécurité particulières pour une sauvegarde à long terme de
données sensibles ne sont donc pas nécessaires.
4.2 Protection de la banque de données
L’accès direct à la banque de données doit être limité aux administrateurs, afin que l’état
du sM-Client ne soit pas corrompu ou rendu incohérent par des modifications non
intentionnelles ou délibérées dans la banque de données.
4.3 Protection des messages de sM-Client Queue
sM-Client Queue contient uniquement des références sur les messages sM-Client en cours
de traitement, mais pas de messages Sedex en tant que tel. Pour cette raison, il n’est pas
nécessaire de prendre des mesures de sécurité particulières pour un enregistrement de
données sensible.
4.4 Protection des répertoires
Le sM-Client utilise des interfaces de répertoires pour la communication avec l’adaptateur
sedex et les applications métier. Ces interfaces doivent également être protégées d’un
accès externe, afin de ne pas corrompre par inadvertance ou intentionnellement l’état du
sM-Client. Il faut toutefois s’assurer que le sM-Client ainsi que l’adaptateur sedex ou
l’application métier respective possèdent les droits d’accès nécessaires.
Le sM-Client utilise également un répertoire interne temporaire. Seuls le sM-Client et les
administrateurs doivent avoir accès à ces répertoires.
Publié le : Feb 28, 2019 Protégé par la Loi 30 / 48
Atos Consulting AG © 2019Manuel d'exploitation sM-Client
sM-Client Queue utilise des fichiers au format binaire pour le stockage des messages JMS.
Le répertoire des messages JMS doit aussi être protégé de toutes modifications
accidentelles ou indésirables. Par défaut ce répertoire est /apache-tomee-
plus-7.0.3/activemq-data/local_broker.
4.5 Protection de l’interface utilisateur
L’interface utilisateur (Web-GUI) est protégée par un login avec nom d’utilisateur et mot de
passe. La communication s’effectue via SSL L’exploitant ne doit pas prendre de mesures de
protection particulières.
4.6 Protection du backup
Si un backup est réalisé par le sM-Client, le répertoire respectif, dans lequel le sM-Client
est enregistrés, doit être protégé de manière adéquate au niveau du répertoire.
Publié le : Feb 28, 2019 Protégé par la Loi 31 / 48
Atos Consulting AG © 2019Vous pouvez aussi lire
