Configuration

Sommaire
  1. Pour commencer...
  2. Fichier "main.property "
  3. Fichier "advanced/server.xml"
  4. La commande scenariserver4.1-cfg

Pour commencer...⚓

La webApp SCENARIserver est fortement paramétrable en fonction du contexte d'utilisation et des fonctionnalités désirées.

Le paramétrage d'un SCENARIserver installé sous Debian / Ubuntu en DEB se trouve dans /etc/scenariserver4.1/.

Ce dossier contient :

  • un fichier init.xml contenant la configuration actuellement active ;
  • un dossier conf contenant les ressources nécessaires à la construction du fichier init.xml.

Attention

Ne pas éditer le fichier init.xml directement mais modifier les fichiers dans le dossier conf.

Une fois les modifications apportées, la commande scenariserver4.1-cfg permet de reconstruire le fichier init.xml.

Dans les parties suivantes, nous allons décrire une partie du paramétrage disponible dans le dossier /etc/scenariserver4.1/conf.

Fichier "main.property "⚓

Chemins d'accès⚓

[requis] server.work.path : Répertoire principal des données⚓

Cette variable définit le répertoire [pathData] utilisé dans le présent document à diverses reprises.

Exemple : server.work.path=E:/data/scserver41

[optionnel] server.temp.path : Répertoire de travail (backup inutile)⚓

Cette variable définit le répertoire [pathData] utilisé dans le présent document à diverses reprises.

Exemple : server.temp.path=E:/tmp/scserver41

[optionnel] server.gen.path : Répertoire racine de sortie des générateurs⚓

Cette variable définit le répertoire [pathData] utilisé dans le présent document à diverses reprises.

Exemple : server.gen.path=E:/data/scserver41/javaserver/gen

[optionnel] server.log.path : Répertoire des logs scenari⚓

Cette variable définit le fichier de log scenari.

Exemple : server.log.path=[pathLog]/[webAppName]/scenari_[date].log

Remarque : penser à retirer le caractère # de mise en commentaire de la variable server.log.path

Sécurité⚓

[optionnel] server.conf.enhancedSecurity : Activation de la sécurité avancée⚓

Cette variable permet d'activer un niveau de sécurité accru

Remarque : consommateur de ressources

Configuration du mode batch⚓

[optionnel] server.conf.batch : Activation du service de batch (scripting applicatif)⚓
  • Décommenter la ligne "# server.conf.batch=batch/server.xml" pour activer le service ;
  • Décommenter la ligne "# server.conf.batch.destPathRoot=${server.work.path}/batchGen" et spécifier le chemin ou seront créés les fichiers générés via SCENARIbatch 

liveCollab ⚓

[spécifique DB - optionnel] service liveCollab : module de collaboration entre auteurs⚓
  • Décommenter la ligne "# server.conf.liveCollab=collab/odb/liveCollab.xml" pour activer le service ;
  • Spécifier le port à utiliser : server.conf.liveCollab.port=8120 ;
  • Paramétrer l'URL d’accès au service à décommenter dans les environnements où liveCollab est lancé via un proxy : server.conf.liveCollab.connectUrl=https://[xxx.xxx.xxx.xxx]/scserver41/ws ;
  • Décommenter les ligne d’accès à l'outil node JS : server.conf.liveCollab.nodeJsExePath=${server.work.path}/nativlib/node.exe et server.conf.liveCollab.nodeJsLibPath=${server.work.path}/nodejslib ;
  • Paramétrer le path du fichier de log : server.conf.liveCollab.logPath=[logPath]/scserver41/scenari-liveCollab.log;

LDAP⚓

[optionnel] LDAP⚓

Pour activer le mode LDAP :

  • Déclarer le userMgr :

    • Sur FS : server.conf.usermgr=usermgr/fs/fsWithLdap.xml ;

    • Sur DB : server.conf.usermgr=usermgr/odb/odbWithLdap.xml;

  • Configurer la connexion LDAP dans les fichiers fsWithLdap.xml ou odbWithLdap.xml.

Remarques :

  • en environnement FS, les utilisateurs ne doivent pas être redéclarés dans scenari ;
  • en environnement FS, le rôle est commun à tous les utilisateurs LDAP ;
  • en environnement DB, les utilisateurs LDAP doivent être déclarés dans scenari afin de spécifier pour cet utilisateur le ou les rôles utiles.

Ateliers dérivés & brouillons⚓

[optionnel] server.db.drv : active la possibilité de créer des ateliers dérivés.⚓

Cette option n'existe que dans SCENARIserver (pas dnas SCENARIserverLite).

[optionnel] server.db.drf : active la possibilité de créer des ateliers calque de brouillon.⚓

Cette option n'existe que dans SCENARIserver (pas dnas SCENARIserverLite).

Fichier "advanced/server.xml"⚓

Ce fichier permet de définir des paramètres avancés du serveur

[optionnel] Propriété "sOoLoadWaitFactor"⚓
  • Décommenter la ligne !-- <properties type="Alone" code="com.scenari.s.co.transform.oo.HTransformerOo.sOoLoadWaitFactor" level="2000">8</properties>-- pour contourner des problèmes de génération de LibreOffice (chargement faussement synchrone du fichier LibreOffice).
  • La valeur "8" peut être ajustée en fonction du volume des documents générés et de la puissance du serveur.
[optionnel] Tags "ooConnectionPool"⚓

Ces directives permettent de paramétrer le mode de communication de Scenari avec LibreOffice, et notamment de définir un pool de connexions permettant un usage parallèle de LibreOffice (plusieurs requêtes simultanées) améliorant les performances de générations multiples simultanées.

Attention

Le mode headless ne fonctionne pas correctement sous Windows (OO3.3) : le process OO peut se figer dans certains cas.

ExempleExemple de paramétrage sous Linux :⚓
1
<declareTag tagName="ooConnectionPool" classParser="com.scenari.s.co.transform.oo.OoConnectionPoolLoader"/>
2
<ooConnectionPool>
3
	<ooConnection pipeMode="true" autoLaunch="true" headless="true" profilePath="file:///tmp/LO1"/>
4
	<ooConnection pipeMode="true" autoLaunch="true" headless="true" profilePath="file:///tmp/LO2"/>
5
</ooConnectionPool>

La commande scenariserver4.1-cfg⚓

Les version DEBs de SCENARIserver sont fournies avec un script de maintenance : scenariserver4.1-cfg.

Celui-ci permet de reconfigurer ou de réinitialiser la configuration et d'effectuer une sauvegarde simple de SCENARIserver [DB]

ProcédureAppliquer des modifications de configuration (reconfig)⚓

Une fois la configuration de SCENARIserver modifiée il faut re-générer le fichier /etc/scenariserver4.1/init.xml puis relancer le serveur d'application pour que les modifications soient prises en compte.

  1. Générer le fichier de configuration /etc/scenariserver4.1/init.xml.

    user@computer:~$ sudo scenariserver4.1-cfg reconfig

    1. Cette commande sauvegarde le fichier /etc/scenariserver4.1/init.xml actuel en /etc/scenariserver4.1/init.xml.bkp puis l'écrase avec une nouvelle version construite à partir des éléments dans /etc/scenariserver4.1/conf.

  2. Relancer le serveur d'application.

    ExemplePour Tomcat 6 :⚓

    user@computer:~$ sudo service tomcat6 restart

ProcédureRéinitialiser la configuration (reset)⚓

À tout moment, il est possible de supprimer toute modification de la configuration de SCENARIserver et de revenir au paramétrage par défaut.

Attention

Cette procédure ne peut être annulée et effacera toute modification apportée à la configuration de SCENARIserver.

  1. Réinitialiser la configuration dans /etc/scenariserver4.1/.

    user@computer:~$ sudo scenariserver4.1-cfg reset

    1. Cette commande écrase le dossier /etc/scenariserver4.1/conf avec les fichiers originaux.

      scenariserver4.1-cfg propose ensuite de lancer la reconstruction du fichier /etc/scenariserver4.1/init.xml

  2. Relancer le serveur d'application.

    ExemplePour Tomcat 6 :⚓

    user@computer:~$ sudo service tomcat6 restart

ProcédureSauvegarder les données (backup) [DB]⚓

scenariserver4.1-cfg propose une fonction simple de sauvegarde de la base de données de SCENARIserver.

Attention

Cette commande dépend de la bonne configuration de scenariserver4.1-cfg qui s'effectue dans le fichier : /etc/scenariserver4.1/cfg.conf :

1
# scenariserver4.1-cfg script config file
2
webappUrl=http://localhost:8080/scenariserver4.1
3
webappUser=admin
4
webappPasswd=admin
5
dataFolder=/var/lib/scenariserver4.1/javaserver
6
backupFolder=/var/lib/scenariserver4.1/backup
  • webappUrl : url dans la webapp SCENARIserver telle que vue depuis le serveur
  • webappUser, webappPasswd : identifiant et mot de passe permettant de se connecter à SCENARIserver
  • dataFolder : dossier source contenant la base de données
  • backupFolder : dossier de destination de la sauvegarde

IMPORTANT : ne pas oublier d'adapter ces valeurs en fonction de votre paramétrage de SCENARIserver.

Remarque

Cette sauvegarde s'effectue forcément à chaud.

  • S'assurer que le serveur d'application est bien lancé et que SCENARIserver est bien accessible.

  • Lancer la commande de sauvegarde :

    user@computer:~$ sudo scenariserver4.1-cfg backup

Une copie de la base de données est maintenant disponible dans le dossier backupFolder (par défaut /var/lib/scenariserver4.1/backup).

Truc & astuce

Vous pouvez incorporer cette procédure dans votre stratégie de sauvegarde de vos serveurs. Le contenu de backupFolder peut alors être récupéré par un système tiers tel que backuppc ou backula etc.