Manuel d'exploitation de BlueCourrier¶
A propos de ce document¶
Contexte¶
Ce document a été produit dans le cadre du projet de dématérialisation des courriers du Grand Port Maritime du Havre.
Objectif du document¶
Ce document a pour objectif de fournir aux équipes technique du Grand Port Maritime du Havre les éléments relatif à l'exploitation de la solution mise en place dans le cadre du projet de dématérialisation du courrier.
Sources et références¶
| Nom | Auteur | Référence | Version | | ------------- |:-------------:| -----:| -----: | -----: | | Guide de l'administrateur Abbyy FlexiCapture11 | Abbyy| FCAdminGuider3.pdf | | | Manuel d'Installation | BlueXML | ManuelInstallationClient-1.0 | 1.0 |
(Ré)installation¶
Installation¶
L'installation et l'initialisation de BlueCourrier sont détaillées dans le manuel d'installation de la solution de dématérialisation du courrier.
Mise à jour¶
Solution tar.gz¶
La mise à jour de BlueCourrier s'effectue grâce à la procédure suivante :
- Récupérer le(s) livrable(s) BlueCourrier fournis par BlueXML
- Déposer les livrable dans le dossier /tmp de la machine hébergeant BlueCourrier
- Stopper le serveur tomcat hébergeant BlueCourrier
- Effectuer un backup du dossier webapps du serveur tomcat
- Positionner le shell dans le répertoire tomcat hébergeant BlueCourrier
- Extraire les fichiers à l'aide de la commande tar (par exemple : tar xvzf /tmp/
) - Relancer le serveur tomcat
Solution AMP¶
Les mises à jour BlueCourrier sont livrées sous-forme de fichier AMP pour l'application Alfresco et sous forme de jar pour l'application Share. Ces fichiers correspondent à des module Alfresco.
L'installation d'une nouvelle version de BlueCourrier se fait de la manière suivante :
- Récupérer le(s) livrable(s) BlueCourrier fourni par BlueXML
- Déposer les livrable dans le dossier /tmp de la machine hébergeant BlueCourrier
- Stopper le serveur tomcat hébergeant BlueCourrier
- Effectuer un backup du dossier webapps du serveur tomcat
- Appliquer les différents AMP sur les applications Alfresco
- Déposer les fichiers jar dans le dossier WEB-INF/lib de l'application Share
- Extraire les fichiers à l'aide de la commande tar (par exemple : tar xvzf /tmp/
) - Relancer le serveur tomcat
La commande pour appliquer un AMP est la suivante :
java -jar
DESTINATION peut être soit un fichier .war ou le dossier de l'application déployé. Les fichiers AMP doivent être appliqué dans l'ordre suivante :
- Alfresco :
- alfresco-extensions-1.0-alf4.2.amp
- bluecourrier-repo-2.1-alf4.2.amp
- client-bluecourrier-repo-2.1-alf4.2.amp
- client-bluecourrier-demat-repo-2.1-alf4.2.amp
Retour arrière¶
En cas de problème suite à la mise à jour un retour arrière est possible. Pour cela, suiver la procédure suivante :
- Récupérer la sauvegarde réalisée avant la mise à jour
- Stopper le serveur tomcat hébergeant BlueCourrier
- Remplacer le dossier webapps du serveur tomcat par celui de la sauvegarde
- Relancer le serveur tomcat
Sauvegarde¶
Aucune procédure particulière n'est à réaliser pour Blue Courrier.
Restauration¶
Aucune procédure particulière n'est à réaliser pour Blue Courrier.
Supervision¶
Aucune procédure particulière n'est à réaliser pour superviser Blue Courrier.
Annexes¶
Les manuels d'exploitations proposés en annexes sont des exemples réalisées sur un projet BlueCourrier.
Abbyy FlexiCapture11¶
Installation / Initialisation¶
L'installation et l'initialisation d'Abbyy FlexiCapture sont détaillées dans le manuel d'installation de la solution de dématérialisation du courrier du Grand Port Maritime du Havre.
Sauvegarde¶
Sauvegarde du projet Abbyy FlexiCapture11¶
Le projet mis en oeuvre dans le cadre du projet de dématérialisation du courrier peut être sauvegardé en suivant la procédure suivante :
- Se connecter à la machine "vm-courrier-index"
- Lancer la Station de configuraiton de projet
- Sélectionner le projet sur le serveur
- Exporter le projet à l’aide du menu « Project > Exporter un projet »
- Sauvegarder le projet sur le bureau.
- Sauvegarder le dossier qui est apparut sur le bureau de la machine "vm-courrier-index"
Sauvegarde complètre¶
La solution Abbyy FlexiCapture11 est installée sur une machine virtuelle. Une sauvegarde peut être effectuée à l'aide des outils liés à l'hyperviseur employé. La sauvegarde de la machine doit être accompagnée d'une sauvegarde de la base Oracle utilisée par la solution AFC.
Restauration¶
Restauration du projet Abbyy FlexiCapture11¶
Pour la restauration d'un projet Abbyy, procédez comme suit :
- Récupéré une copie des fichiers du projet ayant été sauvegardé au préalable
- Copier ces fichiers sur le bureau de la machine "vm-courrier-index"
- Lancer le programme de configuration des projets.
- A l’aide de l’explorateur, sélectionner le projet issue de la sauvegarde
- Publier le projet sur le serveur à l’aide du menu « File > Télécharger le projet sur le serveur »
Restauration complète¶
Afin de restaurer la solution AFC, il est possible de repartir d'une sauvegarde de la machine virtuelle. Il est alors important de restaurer un dump de la base Oracle associé à la sauvegarde de la machine.
Supervision¶
Les informations présentées dans ce paragraphe sont extraites du document ABBYY FlexiCapture Guide de l'administrateur système. Pour plus d'informations vous pouvez vous référer à ce document.
Compteur FlexiCapture¶
Pour surveiller l'état de FlexiCapture et rechercher les goulots d'étranglement, l'utilitaire du moniteur de performances doit être utilisé. Des compteurs propres à FlexiCapture se trouvent dans la catégorie FlexiCapture.
Les valeurs des compteurs sont enregistrées par le serveur de traitement, les compteurs sont donc disponibles sur l'ordinateur sur lequel ce serveur est installé. Étant donné que le serveur de traitement est une application 32 bits, l'utilitaire Moniteur de performances doit fonctionner en mode 32 bits lorsqu'il est utilisé sur les ordinateurs 64 bits. Pour cela, saisissez la commande suivante sur la ligne de commande (cmd.exe) : mmc /32 perfmon.msc
Par défaut ces compteurs sont désactivés. Ils doivent être activés. La procédure est décrite dans le document ABBYY FlexiCapture Guide de l'administrateur système.
- Compteur ASCT – nombre de threads de communication du serveur d'application;
- Latence ASCT – latence de threads de communication du serveur d'application (ms);
- Latence de thread primaire – un retard de réponse du serveur de traitement mesuré en millisecondes;
- Compteur de coeurs – le nombre de coeurs de tous les postes de traitement (dans l'état Démarré) démarrés de FlexiCapture;
- Coeurs libres – le nombre de coeurs libres de tous les postes de traitement (dans l'état Démarré ) démarrés de FlexiCapture;
- Tâches en attente – le nombre de tâches prises en charges par le traitement du serveur de traitement;
- Tâches en cours d'exécution – le nombre total de tâches actuellement en cours d'exécution sur le serveur de traitement;
- Compteur d'exportations, compteur d'importations, compteur de reconnaissances, autre compteur de tâches – le nombre de tâches correspondantes (exportation, importation, reconnaissance et autres) au cours des 5 dernières minutes;
- Durée d'exportation, durée d'importation, durée de reconnaissance, autres durées de tâches – le temps d'exécution moyen des tâches correspondantes ( exportation, importation, reconnaissance et autres) au cours des 5 dernières minutes;
- Compteur de verrouillages de serveur de modification – le nombre de documents étant verrouillés pour les exécuteurs. Ce compteur s'applique uniquement au poste de traitement;
NB : Une description plus complète des différents compteurs est disponible dans le document ABBYY FlexiCapture Guide de l'administrateur système.
Supervision des services windows.¶
Les composants serveur d'Abbyy FlexiCapture repose sur plusieurs service. La supervision de ces services permet de suivre l'état de la solution :
- ABBYY.ProcServer.FlexiCapture11.0
- ABBYY.Licensing.FlexiCapture.Standard.11.0
- ABBYY.ProcStation.FlexiCapture11.0
Blue Stats¶
Installation / Initialisation¶
L'installation et l'initialisation de Blue Stats (Stack ELK) sont détaillé dans le manuel d'installation de la solution de dématérialisation du courrier du Grand Port Maritime du Havre.
Sauvegarde¶
Elasticsearch¶
La sauvegarde des index d’ELK se fait de la manière suivante :
- Stopper Elasticsearch (service windows)
- Effectuer une sauvegarde du dossier contenant les index (T:/applis/stats/elasticsearch-1.7.1 par défaut)
- Relancer Elasticsearch
Note : Durant l’arrêt d’Elasticsearch, il est possible que des données soient perdues. Il est préférable d’effectuer cette opération de sauvegarde durant des heures de faible fréquentation.
Kibana¶
La sauvegarde des éléments de configuration de Kibana s’effectue au travers de l’écran « Settings » de Kibana. Pour effectuer une sauvegarde suivre les étapes ci-dessous :
- Se rendre sur Kibana
- Naviguer jusqu’à l’écran « Settings »
- Se rendre sur l’onglet « Objects »
- Cliquer sur le bouton « Export »
- Sauvegarder le fichier JSON.
Restauration¶
Elasticsearch¶
La restauration des index d’ELK se fait de la manière suivante :
- Stopper Elasticsearch (service windows)
- Restaurer le dossier contenant les index (T:/applis/stats/elasticsearch-1.7.1 par défaut) à partir d’une sauvegarde
- Relancer Elasticsearch
Note : Durant l’arrêt d’Elasticsearch, il est possible que des données soient perdues. Il est préférable d’effectuer cette opération de sauvegarde durant des heures de faible fréquentation.
Kibana¶
La sauvegarde des éléments de configuration de Kibana s’effectue au travers de l’écran « Settings » de Kibana. Pour effectuer une sauvegarde suivre les étapes ci-dessous :
- Se rendre sur Kibana
- Naviguer jusqu’à l’écran « Settings »
- Se rendre sur l’onglet « Objects »
- Cliquer sur le bouton « Import »
- Sélectionner le fichier JSON issue de la sauvegarde à restaurer.
Procédure¶
Arrêt des services¶
L'arrêt de la suite Blue Stats se fait en arrêtant les services Windows associés à Kibana et Elasticsearch. Les services doivent être arrêtés dans l'ordre suivant :
- Kibana ()
- Elasticsearch (elasticsearch-service-x64)
Démarrages des services¶
Le démarrage de la suite Blue Stats se fait en démarrant les services Windows associés à Kibana et Elasticsearch Les services doivent être démarrés dans l'ordre suivant :
- Elasticsearch (elasticsearch-service-x64)
- Kibana ()
Supervision¶
Elasticsearch¶
Elasticsearch est installé sous forme de service windows. La supervision de ce composant se base sur la supervision du service Windows. La supervision du service doit être complétée par une supervision du répertoire accueillant les index (par défaut : T:/applis/stats/elasticsearch-1.7.1/data).
Kibana¶
Kibana est installé sous forme de service windows. La supervision de ce composant se base sur la supervision du service Windows. Kibana ne nécessite pas de surveiller d'autre élément du système hébergeant le composant.