Serveur d’édition SAFE X3 - Guide de présentation et d’exploitation

Installation / Désinstallation

Pré-requis

Avant de commencer l’installation d’un serveur d’édition sur une machine, veuillez consulter la liste des pré-requis qui se trouve dans la documentation d’installation présente sur le DVD-ROM d’installation.

Installation

Un programme d’installation permet de déposer dans le répertoire de votre choix les exécutables, librairies et autres ressources nécessaires au bon fonctionnement du serveur d’édition. 
Suite à ce dépôt initial, l’arborescence suivante est créée sous le répertoire d’installation :

• Le répertoire racine contient l’ensemble des binaires du serveur.
• Le répertoire « Config » contient un ensemble de fichiers au format XML qui sont utilisés :
  ==> lors du démarrage du serveur (paramètres de démarrage), 
  ==> lors de la création automatique des sources de données ODBC (description externe des pilotes ODBC), 
  ==> lors du cycle normal d’exécution (paramètres de description des solutions SAFE X3 rattachées au serveur).
  Il est très important de noter que les fichiers présents dans ce répertoire ne doivent jamais être mis à jour manuellement. Ils sont en effet mis à jour et maintenus automatiquement  par le biais du composant d’administration interne du serveur (répertoire « Tools\AdxAdmin ») lui même piloté par une console d’administration SAFE X3.
• Le répertoire « Data » contient l’ensemble des fichiers du cache interne au serveur. Entre autres, sont stockés dans le cache du serveur les états Crystal Report issus des applications en technologie SAFE X3 rattachées au serveur.
• Le répertoire « log» contient 
  ==> le journal d’activité et le journal des exceptions («*.log »),
  ==>les fichiers de récupération suite à un arrêt brutal du serveur  («*.bin »), 
  ==> le rapport d’arrêt du serveur («*_AdxSrvShutdown_Inf.htm»).
• Le répertoire « Lan» contient les fichiers de localisation. Si besoin, ces fichiers sont mis à jour lors de l'installation de patchs.
• Le répertoire « Temp » est destiné à recueillir les fichiers temporaires.  En fonction de sa volumétrie, il doit être purgé régulièrement (attention, la purge doit être effectuée serveur arrêté).
• Le répertoire « Tools » contient le composant d’administration du serveur (piloté par la console d’administration SAFE X3) ainsi que ses utilitaires associés.

Dé-installation

Avant de désinstaller un serveur d’impression par « Ajout/Suppression de programmes » du panneau de configuration de votre machine, il faut d’abord veiller à dé-publier via la console d’administration SAFE X3 les solutions SAFE X3 rattachées au serveur d’impression.

Configuration

Comme les autres composants « Serveur » d’une solution SAFE X3, le serveur d’édition se configure via la console d’administration SAFE X3. Il est formellement déconseillé de modifier manuellement les fichiers de configuration produits et mis à jour par la console d’administration.
Sans entrer dans le détail (pour cela, se reporter à la documentation de la console d’administration), les grandes lignes concernant la configuration d’un serveur d’édition sont présentées ci-dessous.

Paramètrage de démarrage

Ces paramètres permettent de configurer l’environnement technique d’exécution du serveur d’édition. Ils sont stockés dans le fichier « adxeditionserverconfig.xml »  du sous-répertoire « Config ». 
On trouve parmi ces paramètres :

• Le code langue d’exploitation :
  C’est dans cette langue que le serveur affichera les messages qu’il sera amené à émettre.
  Indépendamment de ce code langue, le serveur d’édition est bien sûr capable d’éditer des rapports multi-langues.
• Le numéro de port d’écoute TCP/IP :
  Ce paramètre  permet de fixer le numéro de port sur lequel on souhaite que le serveur d’édition soit à l’écoute des connexions entrantes.
• Taille de la pile des demandes d’impression :
  Ce paramètre permet de fixer le nombre maximum de demandes que pourra empiler le serveur d’édition. Ce paramètre doit être ajusté en fonction de la charge ponctuelle maximum du serveur d’ édition.
• Nombre de processus maximum :
  Ce paramètre permet de fixer le nombre maximum de processus d’impression que le serveur d’édition sera autorisé à lancer en parallèle. Ce paramètre doit être ajusté en fonction du nombre moyen de demandes à soumettre et de la disponibilité globale souhaitée pour le système.
  Quand le nombre maximum de processus est atteint, le serveur empile les nouvelles demandes d’impression dans la pile des demandes en attente. Ces demandes sont ensuite dépilées lorsque l’un des processus d’impression se trouve  à nouveau à l’état « disponible ».
• Les caractéristiques du journal d'activité et des exceptions du serveur :
  Correspond à une série de paramètres destinés à activer et, le cas échéant, dimensionner le journal d’activité et le journal des exceptions du serveur.
  Le dimensionnement consiste à fixer le nombre de volumes archive du journal et la taille limite maximum (nombres d’octets) de ces volumes.Chaque volume est physiquement associé à un fichier stocké dans le sous-répertoire « Log » du serveur. Lorsque le volume courant a atteint la taille limite (ou lors du démarrage du serveur), les volumes archives sont permutés afin de libérer un volume pour archiver le volume courant.
  A noter que le journal d'activité consigne les événements "d'enregistrement", de "soumission", de "terminaison", et de "suppression" d'une demande d'édition.Le journal des exceptions consigne l'ensemble des erreurs ou anomalies détectées par le serveur.
• Le paramètrage du mode "Récupération" :
  Permet de fixer la politique de gestion par défaut du mode "Récupération" en cas d'arrêt inopiné du serveur.
  Pour plus de détails sur le mode "Récupération", consulter le paragraphe "Les options de démarrage du serveur" - option "Recovery:status".
• Taille de la mémoire partagée :
  On verra dans la suite de ce document que le serveur d’édition utilise des segments de mémoire partagée afin de pouvoir échanger des données avec ses processus d’impression. Comme les segments de mémoire partagée ne peuvent pas être étendus dynamiquement, la taille maximale de ces segments  doit être fixée lors du  démarrage du serveur.
  Au cas où la taille allouée au démarrage (via ce paramètre) se révèlerait être insuffisante dans le contexte courant d’utilisation, le serveur d’édition provoque une erreur identifiée par le code 266. Suite à l’émission de ce code erreur,  il faut arrêter le serveur, modifier via la console d’administration Sage X3 la valeur de ce paramètre ( VPALLOC ), puis redémarrer le serveur.
  En principe la valeur par défaut affectée à ce paramètre (soit « 40 » , ce qui correspond en fait à un coefficient multiplicatif par rapport à un ratio basé sur la taille maximum de la pile des demandes) est suffisamment large pour qu’une telle erreur ne se produise jamais dans des conditions normales d’utilisations.
  

Paramètres de description des solutions SAFE X3 rattachées

Les paramètres de description des solutions SAFE X3 rattachées au serveur d’édition sont stockés dans le fichier « adxeditionserversolutions.xml» du sous-répertoire « Config ». Ce fichier de description XML est mis à jour par la console d’administration SAFE X3 suite à la publication d’une solution.
Seule une demande d’impression en provenance d’une application en technologie SAFE X3 appartenant à une solution publiée pourra être  prise en charge par le serveur d’édition.
Le fichier de description des solutions a une structure arborescente qui permet de décrire :

• Un profil solution. Cette notion est réservée pour un usage futur. Actuellement seul le code profil « ADMIN » est exploité.
• Pour chaque profil, une à N solutions associées
• Pour chaque solution on retrouve la description :
  - des applications associées à la solution 
  - des paramètres de connexion au serveur de fichier SADFSQ de la solution  (avec notamment le mode d'authentification à employer)
  - des paramètres de connexion au serveur de base de données de la solution

Démarrage/Arrêt du serveur

Un serveur d’édition peut-être démarré en mode « Console » ou en mode « Service Windows».  Le fonctionnement propre du serveur est strictement identique dans les 2 cas, la seule différence réside dans le fait qu’en mode « Console » l’activité du serveur est affichée en direct dans la fenêtre Windows présente sur le bureau.
Lors de la première configuration du serveur d’édition à partir de la console d’administration SAFE X3, celle-ci crée automatiquement un « Service Windows » par défaut associé au serveur.  Il est ensuite possible de démarrer et d’arrêter ce service via la console d’administration. Rien n’empêche pour autant d’utiliser les outils standard de votre  système Windows pour administrer et contrôler le service ainsi créé.
Les options de démarrage du serveur d’édition sont décrites ci-dessous (à noter qu’elles sont disponibles aussi bien en mode « Console » qu’en mode « Service Windows»).  

Les options de démarrage du serveur d’édition sont les suivantes :

• Lancement du serveur en mode Récupération : "/recovery:status" :
  En cas d’arrêt involontaire d’un serveur d’édition en cours de traitement (par exemple arrêt des services Windows sur procédure d’arrêt immédiate d’une station de travail), la pile des demandes d’impression en attentes ou en cours d’exécution est sérialisée dans un fichier binaire (le contenu de ce fichier peut-être consulté par le truchement du rapport d’arrêt stocké dans le sous-répertoire « log » (fichier « *_AdxSrvShutdown_Inf.htm »).
  Le mode « Récupération » permet d’indiquer au serveur de commencer par charger  la pile des demandes précédemment sauvegardée avant de démarrer le service d’écoute. Ainsi les   demandes d’impression qui n’auraient pas abouties lors de l’arrêt involontaire sont automatiquement ré-enregistrées et soumises au système d’édition.  
  Quand cette option est activée, les demandes récupérées sont consignées dans le journal d’activité du serveur (qu’il ait été par ailleurs activé ou pas).
  Il est important de noter que cette option permet de forcer la politique de "Récupération" défini au niveau de la console d'administration :
   - pour forcer l'activation du mode "Récupération", valoriser status à 1
   - pour forcer la désactivation du mode "Récupération", valoriser status à 0
• Activation de la trace : « /d »
  Cette option permet de produire un fichier qui trace l’activité du serveur d’édition et des processus d’impressions qu’il est amené à lancer.  Le fichier produit se nomme « AdxSrvImp_Trace.log »; il est stocké dans le répertoire temporaire du serveur d'édition. 
  Cette option doit être utilisée en cas de problème dans le but de faciliter l’analyse et la correction d’incidents soumis à la hot-line Sage.
• Lancement en mode console : «/noservice »
• Démarrage  en désactivant le contrôle et la configuration des sources ODBC : «/noodbc»
  Lorsqu’il est lancé avec cette option, le serveur d’édition ne prend pas en charge la création, le contrôle et la configuration des sources ODBC qu’il sera amené à utiliser pour se connecter aux serveurs de données des solutions SAFE X3 qui lui sont rattachées.
  Dans ce cas, c’est à l’exploitant de prendre l’initiative de créer et configurer correctement les sources de données ODBC, et ceci sur la base des caractéristiques des différentes Solutions SAFE X3 rattachées au serveur.
• Lancement en utilisant un profil de configuration différent de celui défini par défaut : «/cfg :cdprofil»
  Réservé pour une utilisation future.
• Suppression d’un service Windows préalablement créé : «/rmsvc:cdservice» 
  Après avoir supprimé le service demandé, le serveur d’édition s’arrête automatiquement.
• Affichage de la version du serveur d’édition : «/v» 
  Disponible uniquement en mode console.
  

Surveillance

Même si le serveur n’a pas été démarré avec l’option trace « /d », il est néanmoins possible de suivre son activité en consultant le journal d'activité, l’observateur d’évènements Windows et en accédant d’autre  part à la fonction « Surveillance impressions » disponible sur chaque dossier de la solution SAFE X3.

Fenêtre de surveillance

Pour afficher cette fenêtre, il faut se connecter avec un client lourd ou un navigateur Internet à un dossier de la solution, et ouvrir la fonction «Impressions/Surveillance Impressions». Une fois dans cette fonction, il suffit de renseigner le nom réseau du serveur d’édition qu’on souhaite surveiller (serveur:port), et les données relatives à ce serveur s’affichent automatiquement dans la fenêtre.

Depuis cette fenêtre il est possible :

• de visualiser les paramètres de démarrage du serveur (bloc Configuration)
• de visualiser les sessions TCP/IP courantes (bloc Clients connectés)
• de visualiser et éventuellement modifier les paramètres associés aux demandes empilées ou en cours d’exécution (bloc Tâche).
  

Journal d'activité et journal des exceptions

• Le journal d’activité consigne les événements « d’enregistrement » , de « soumission », de « terminaison » et de « suppression » d’une demande d’édition.
• Le journal des exceptions consigne l’ensemble des erreurs ou anomalies détectées par le serveur.
• L’activation et le paramétrage de ces journaux s’effectue via la console d’administration du serveur (Cf. le chapitre «-Configuration» - le journal des exceptions hérite automatiquement du paramétrage du journal d’activité).
• Un journal est organisé en volume, chaque volume est physiquement associé à un fichier stocké dans le sous-répertoire « Log » du serveur.
  Lorsque le volume courant a atteint la taille limite (ou lors du démarrage du serveur), les volumes archives sont permutés afin de libérer un volume pour archiver le volume courant.

Observateur d’évènements Windows

L’ensemble des messages d’information, d’avertissement ou d’erreur émis par le serveur d’édition ou un ses processus d’impression sont consignés dans l’observateur d ‘évènements Windows.
En cas d’incidents il est vivement conseillé de consulter l’observateur d’évènements afin d’établir un diagnostic précis (sources AdxSrvImp et AdxImp).

Architecture technique

La figure ci-dessous représente l’architecture technique simplifiée du serveur d’édition.

Principes

Comme indiqué par ailleurs, le serveur d’édition est un serveur  « multi-processus ». A ce titre il maintient et contrôle un « pool » de processus spécialisés qui ont pour seule fonction de produire des états Crystal Report. Ce qui veut dire que c’est le serveur lui même qui se charge de préparer et de mettre en forme l’ensemble des informations nécessaires au bon déroulement de la production finale des états, et donc de l’exécution des processus d’impression.
Les principales briques logicielles du serveur sont décrites ci-dessous :

• Le service d’écoute TCP/IP :  
  A chaque fois qu’un client établit une connexion TCP/IP avec le service d’écoute du serveur d’édition, celui-ci crée un « Thread Client » qui est dédié  à la prise en charge de la demande émanant de ce client. A un instant donné, on a donc autant de « Thread Client » que de clients connectés.
• Les services technologiques:  
  Ces services assurent l’intégrité du serveur et contrôlent principalement l’accès aux ressources partagées (Cf. ci-dessous).
  Ajouté à cela, un service technologique spécialisé prend en charge la création, la configuration ainsi que le contrôle des sources de données ODBC (Oracle ou SQLServer) nécessaires aux processus d’impression pour l’accès aux serveurs de base de données des solutions SAFE X3 rattachées. En ce qui concerne les sources de données Oracle, le serveur d’édition supporte les versions 9, 10 et 11 du client Oracle*Net ainsi que les drivers ODBC Oracle de type « Wire Protocol ». Pour mémoire, le compte utilisateur sous lequel est démarré le serveur d’édition doit disposer des droits et privilèges suffisants pour pouvoir créer des sources de données ODBC Systèmes et, le cas échéant, des alias Oracle*Net. L’exploitant, si il le souhaite, a la possibilité de créer manuellement les sources de données ODBC en utilisant l’option de démarrage « /noodbc » (Cf. § Les options de démarrage du serveur d’édition).
• Les services de base :  
  Le serveur d’édition traite en direct un certain nombre de services fonctionnels de base. Ci-dessous, la liste des principaux services fonctionnels :
  - Enregistrement et mise en forme des paramètres associés à une demande d’édition
  - Sélection d’imprimantes
  - Configuration d’imprimantes
  - Surveillance des demandes en cours
  
• Les transferts de fichiers :
  La prise en charge d’une demande d’édition en provenance d’une application en technologie SAFE X3 nécessite le plus souvent de télécharger des fichiers stockés sur cette application (le fichier état « .rpt » par exemple). Le serveur d’édition s’adresse pour cela à des serveurs de fichiers SAFE X3 (SADFSQ). Il est donc amené à contacter ces serveurs de fichiers en  établissant une session TCP/IP avec les serveurs d’application correspondants qui lui sont  associés.
  Il est possible de paramétrer via la console d’administration le mode d’authentification souhaité pour l’établissement de cette session, à savoir :   
  ==> connexion non sécurisée : par défaut le compte d’administration de la plate-forme est alors utilisé,    
  ==>connexion sécurisé : le compte plate-forme spécifié via la console d’administration est alors utilisé.

• Les processus d’impression :  
  Une fois que le serveur d’édition a terminé de préparer une demande d’impression (c’est à dire enregistrement des paramètres, transfert des fichiers nécessaires à l’impression…), et en fonction de la disponibilité du système, il lance un processus d’impression qui a pour vocation de prendre en charge la production finale de l’état. La tâche principale de ce processus d’impression est d’initialiser et de solliciter le moteur d’impression Crystal Report. C’est ce dernier qui in-fine produit l’état demandé.
  Après avoir terminé la production de l’état, un processus d’impression accède à la mémoire partagée du serveur d’ édition afin de déterminer si le serveur a des demandes d’impression en attente. Si c’est le cas, le processus traite la première demandes éligible. Si il n’y en a pas, ou quand il n’y a plus de demande en attente, le processus d’impression se termine naturellement.
  Le nombre maximum de processus d’impression concurrents pour un serveur d’édition donné se paramètre à l’aide de la console d’administration SAFE X3 (Cf. § Paramètres de démarrage).
• La mémoire partagée :  
  Comme indiqué ci-dessus, le serveur d’édition publie plusieurs segments de mémoire partagée afin de pouvoir échanger de l’information avec les processus d’impression qu’il est amené à créer (Inter-processes shared memory). L’accès à ces segments est effectué de manière « exclusive » en se basant sur des objets de synchronisation inter-processus de type « Mutex ».
  

Gestion des imprimantes

Les règles suivantes devront être respectées afin que le serveur d’édition soit en mesure d’imprimer correctement :

• Dans le cas où  le serveur d’édition est démarré en mode  « Service Windows », il faut absolument indiquer un compte de démarrage différent du compte « Système local » afin que le serveur d’édition puisse adresser une des imprimantes de votre organisation. Par nature, aucune imprimante n’est rattachée au compte Windows « Système local ».
• Le compte utilisateur sous lequel a été démarré le serveur d’édition (en mode « Console » ou en mode « Service Windows ») devra au moins avoir une imprimante de paramétrée.
• Le serveur d’édition ne pourra adresser que les imprimantes « visibles » et « accessibles » par le compte utilisateur sous lequel a été démarré le serveur (que ce soit en mode « Console » ou en mode « Service Windows »)
• Dans le cas d’une impression avec génération d’un document au format PDF, les paramètres relatifs à la taille du document seront hérités de la taille papier de l’imprimante par défaut associé au compte utilisateur sous lequel a été démarré le serveur d’édition (que ce soit en mode « Console » ou en mode « Service Windows »).

Codes erreurs et messages

Les codes erreurs générés par le serveur d’édition sont référencés ci-dessous. Ils sont classés par  catégories.  
Le message formaté associé au code erreur fait le plus souvent référence :

• Au code erreur lui même,
• Au type de message (64 : information -  48 : avertissement – 16 : erreur,
• A la fonction qui a levée l’erreur,
• Au contexte, avec une chaîne donnant des informations de détail.

Codes erreurs du serveur d’édition

 Codes erreurs du module de gestion du cache

 Codes erreurs du module de gestion des services Windows

 Codes erreurs du module de gestion des Solutions SAFE X3

 Codes erreurs du module de gestion ODBC