Aller au contenu
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Procédure d'Installation

Les étapes d'une installation standard d'un serveur Efalia Process sont les suivantes :

  1. Préparation de l'installation

  2. Installation des fichiers

  3. 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.xml

  • Avoir 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 :

SGBD
Driver

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 ».

La base, ainsi que toutes les tables qui y seront créées, doivent utiliser le jeu de caractères Unicode UTF-8 (généralement spécifié à la création de la base ou dans la configuration du SGBD).

Le compte utilisé par le serveur pour accéder à cette base doit avoir les droits nécessaires et suffisants (être propriétaire de son schéma) pour créer des tables, séquences, déclencheurs (trigger) et index. Choisissez judicieusement les caractères composant ces identifiants : il peut être nécessaire d'échapper certains caractères selon leur encodage.

Si votre SGBD est PostgreSQL, assurez-vous que la variable max_prepared_transactions est au moins égale à 100.

Si votre SGBD est Microsoft SQL Server, il est impératif d'autoriser l'isolation des transactions :

où workey_tomcat est le nom de votre base socle.

Installation des fichiers

Dans cette section, <CATALINA_HOME> désigne le chemin vers le répertoire de base où est installé Apache Tomcat, et <base_de_donnée_socle> le nom du SGBD utilisé pour la base socle.

Fichier(s)
Origine
À placer dans

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 :

Système d'exploitation
Fichier script

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 -Xmx et -Xms.

  • Encodage par défaut — -Dfile.encoding=UTF-8 et -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=fr et -Duser.country=FR.

Dans le livrable d'installation, les fichiers catalina.bat et catalina.sh (sous /server/common/bin) illustrent ces modifications.

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).

Seules les actions réalisées depuis l'application web par des utilisateurs authentifiés sont journalisées.

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 son id numérique ; sinon, il est désigné par le login saisi à l'authentification et son id vaut -1.

  • Pour l'ouverture d'une vue : VIEW designer_name id OPENED_IN duration ROW_COUNT total_number_of_rows — designer_name est le nom interne de la vue, duration le temps de traitement en millisecondes, total_number_of_rows le 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_id

    • nouveau 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_id

    • document existant : EXISTING_DOC document_id DOC_TYPE designer_name document_type_id

    Pour un nouveau document : à l'ouverture, document_id vaut -1 ; à la soumission, il prend la valeur attribuée à la création effective du document. Le type est explicité par son designer_name (nom interne) et son document_type_id numérique.

  • L'ouverture et la soumission de document indiquent respectivement le temps de traitement en millisecondes : OPENED_IN duration et SUBMITTED_IN duration.

Première connexion

Avant de pouvoir utiliser le serveur, il est nécessaire d'affecter un premier Workflow Manager. Assurez-vous que le serveur est démarré (voir Démarrage et Arrêt du Serveur) et connectez-vous à la Console d'Administration Web (voir Accès aux Applications).

1

Se connecter à la Console d'Administration Web

Par défaut, l'authentification se fait par formulaire. Utilisez des identifiants valides au regard de votre annuaire d'authentification.

2

Ouvrir la gestion des gestionnaires

Une fois authentifié, cliquez sur Gestionnaires pour accéder à la section d'administration des gestionnaires.

3

Sélectionner la catégorie de gestionnaire

Tant qu'aucun gestionnaire de workflow n'a été défini, seul le type Gestionnaires du Workflow est disponible. Vérifiez que le type sélectionné est bien (W) Workflow.

4

Rechercher un utilisateur

Recherchez un utilisateur soit en spécifiant directement une expression de filtrage LDAP, soit en cliquant sur l'un des filtres alphabétiques proposés. Les résultats s'affichent sous Utilisateurs/Unités.

5

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