Procédure d'Installation
Les étapes d'une installation standard d'un serveur Efalia Process sont les suivantes :
Préparation de l'installation
Installation des fichiers
Configuration du serveur
Préparation de l'installation
Avant d'entamer l'installation du serveur, assurez-vous des points suivants :
Être en possession de votre fichier de licence :
workey-license.xmlAvoir installé Tomcat. Les étapes suivantes amènent à placer, dans l'arborescence de Tomcat, les différents fichiers du serveur.
Disposer d'un compte LDAP pour votre/vos annuaire(s) d'authentification et/ou d'entreprise (nom d'utilisateur et mot de passe associé). Ce compte est utilisé par le serveur pour parcourir l'arborescence des utilisateurs.
Disposer d'un compte SMTP (nom d'utilisateur et mot de passe associé), utilisé par le serveur pour envoyer des emails aux acteurs des processus.
Créer une base de données dans votre Système de Gestion de Base de Données (SGBD) — voir Annexes Techniques.
Disposer de la dernière version du driver JDBC spécifique à votre SGBD :
MySQL
mysql.com — ex. mysql-connector-java-x.x.x-bin.jar (selon votre version de MySQL)
PostgreSQL
postgresql.org — ex. postgresql-9.2-1002.jdbc4.jar (selon votre version de PostgreSQL)
Oracle
oracle.com — ex. ojdbc6.jar (selon votre version d'Oracle)
Microsoft SQL Server
microsoft.com — ex. sqljdbc4.jar (selon votre version de SQL Server)
Base de données socle
Le serveur requiert une base de données pour y stocker l'ensemble des informations liées aux processus : les règles, les données (saisies ou calculées) des documents, les acteurs des workflows et leurs droits d'accès, les tâches de l'ordonnanceur, etc. Cette base est référencée ci-après comme la base « socle ».
Installation des fichiers
Driver JDBC (connecteur), correspondant au SGBD utilisé pour la base socle et pour toute datasource supplémentaire
Non fourni
<CATALINA_HOME>/lib
log4j.jar
/server/common/lib du livrable
<CATALINA_HOME>/lib
catalina.properties, log4j.properties
/server/common/conf du livrable
<CATALINA_HOME>/conf
context.xml
/server/dbms-specific/<base_de_donnée_socle>/conf du livrable
<CATALINA_HOME>/conf
workey.war
/server/dbms_specific/<base_de_donnée_socle>/webapps du livrable
<CATALINA_HOME>/webapps
workey-license.xml (votre fichier de licence)
Fourni hors livrable
<CATALINA_HOME>/workey (à créer)
Configuration
Configuration système
Une partie de la configuration — notamment le paramétrage de la JVM (Java Virtual Machine) — ne peut être réalisée qu'au niveau système, directement dans le script de lancement de Tomcat :
Windows
<CATALINA_HOME>/bin/catalina.bat
Unix / macOS
<CATALINA_HOME>/bin/catalina.sh
Il s'agit notamment de définir (ou surcharger) les variables d'environnement Java passées au démarrage de la JVM :
Mémoire de la JVM —
-Xms1024m -Xmx1024m -XX:MaxPermSize=512m(mémoire initiale, mémoire maximale, et taille du Permanent Generation space — prévoir 512 Mo pour la publication de documentation HTML/Word depuis le modélisateur).Sous Windows :
set CATALINA_OPTS="-Xms1024m -Xmx1024m -XX:MaxPermSize=512m %CATALINA_OPTS%"— il n'y a pas de caractère=pour les paramètres-Xmxet-Xms.Encodage par défaut —
-Dfile.encoding=UTF-8et-Dmail.mime.charset=UTF-8, afin d'assurer la continuité de l'encodage du client web jusqu'à la persistance en base (et pour l'encodage des emails).Fuseau horaire —
-Duser.timezone=CET, avec un code timezone supporté en Java 1.7.Locale (langue et pays) —
-Duser.language=fret-Duser.country=FR.
Configuration du serveur
Les différentes parties fonctionnelles du serveur sont configurées à l'aide d'un ensemble de propriétés Java (couples clé-valeur), ajoutées à celles de Tomcat dans le fichier <CATALINA_HOME>/conf/catalina.properties. Éditez ce fichier pour l'adapter à vos besoins — voir Annexes Techniques.
Datasources
Le serveur requiert la définition de trois datasources, pointant vers la base socle créée pour le serveur. Elles sont spécifiées dans le fichier <CATALINA_HOME>/conf/context.xml. Éditez ce fichier pour l'adapter à votre base socle — voir Annexes Techniques.
Journalisation
Par défaut, la verbosité du moteur est DEBUG. Il est possible de la modifier et/ou de l'affiner en éditant le fichier <CATALINA_HOME>/conf/log4j.properties, un fichier de configuration spécifique au framework de journalisation Apache log4j — voir Annexes Techniques.
Journalisation des performances
À partir de la version 6.2.1, il est possible de journaliser les temps de traitement des actions suivantes :
ouverture d'une vue (standard ou utilisateur) ;
ouverture de document (nouveau ou existant) ;
soumission de document (nouveau ou existant).
Pour l'activer, ajoutez dans la configuration de log4j la journalisation du logger WorkeyPerformanceLogger, avec le niveau de priorité TRACE :
Les messages générés sont formatés pour un traitement externe automatisé : les différents éléments sont séparés par des tabulations.
Chaque action comprend l'identification de l'acteur qui la réalise :
ACTOR userKey|login id— un acteur enregistré est désigné par sa clé utilisateur (userKey) et sonidnumérique ; sinon, il est désigné par le login saisi à l'authentification et sonidvaut -1.Pour l'ouverture d'une vue :
VIEW designer_name id OPENED_IN duration ROW_COUNT total_number_of_rows—designer_nameest le nom interne de la vue,durationle temps de traitement en millisecondes,total_number_of_rowsle nombre de lignes de la vue.Pour les actions sur un document, une distinction est faite selon le cas :
nouveau document (création directe) :
NEW_DOC document_id DOC_TYPE designer_name document_type_idnouveau document dérivé (création depuis une vue embarquée d'un document père) :
NEW_DERIVED_DOC document_id DOC_TYPE designer_name document_type_iddocument existant :
EXISTING_DOC document_id DOC_TYPE designer_name document_type_id
Pour un nouveau document : à l'ouverture,
document_idvaut -1 ; à la soumission, il prend la valeur attribuée à la création effective du document. Le type est explicité par sondesigner_name(nom interne) et sondocument_type_idnumérique.L'ouverture et la soumission de document indiquent respectivement le temps de traitement en millisecondes :
OPENED_IN durationetSUBMITTED_IN duration.
Première connexion
Affecter le gestionnaire
Sélectionnez un utilisateur dans la liste de gauche (double-clic sur son nom, ou sélection puis flèche vers la droite pour l'ajouter à la liste de droite), puis validez en cliquant sur Mettre à jour les gestionnaires.
Une fois la mise à jour soumise, l'interface se rafraîchit et les nouveaux droits de gestionnaire de workflow sont immédiatement appliqués : de nouvelles sections (Processus, Rôles, Unités, Agents) deviennent disponibles, ainsi que des types supplémentaires de gestionnaires.
Mis à jour