Les étapes d’une installation standard d’un serveur workey 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 Workey, veuillez vous assurer des points suivants :

Etre en possession de votre fichier de license Workey: workey-license.xml
Avoir installé Tomcat.

Les étapes suivantes vous amèneront à placer, dans l’arborescence de Tomcat, les différents fichiers du serveur Workey.

Diposer d’un compte LDAP pour votre/vos annuaire(s) (d’authentfication et/ou d’entreprise) : nom d’utilisateur et mot de passe associé.

Ce compte sera utilisé par le serveur Workey pour parcourir l’arborescence des utilisateurs.

Disposer d’un compte SMTP : nom d’utilisateur et mot de passe associé.

Ce compte sera utilisé par le serveur Workey pour envoyer des email aux acteurs des processus.

Créer une base de données dans votre Système de Gestion de Base de Données (SGBD) -> cf. création base socle Workey.
Disposer de la dernière version du driver JDBC spécifique à votre SGBD.

pour mySQL : http://www.mysql.com/ex : mysql-connector-java-x.x.x-bin.jar (x.x.x correspondant à votre version de mySQL)pour PostgreSQL : http://www.postgresql.org/ex : postgresql-9.2-1002.jdbc4.jar (prendre celui correspondant à votre version de PostgreSQL)pour Oracle : http://www.oracle.com/ex : ojdbc6.jar (prendre celui correspondant à votre version d’Oracle)pour Microsoft SQL Server : http://www.microsoft.com/ex : sqljdbc4.jar (prendre celui correspondant à votre version de SQL Server)

Base de données socle

Le serveur Workey requiert une base de donnnée pour y stocker l’ensemble des informations liées aux processus:

les règles,
les données (saisies ou claculées) des documents,
les acteurs des workflow et leur droits d’accès,
les tâches de l’ordonnanceur,
etc …

Cette base sera référencée ci-après comme la base « socle » de Workey.
Il est donc nécessaire de créer cette base dans votre Système de Gestion de Base de Données (SGBD).

Workey requiert obligatoirement une base transactionnelle avec gestion des contraintes de clef étrangère.-> Exemple : si votre SGBD est MySQL, les tables créées devront utiliser le moteur InnoDB.

Il faut que la base, ainsi que toutes les tables qui y seront créées, utilisent le jeu de caractères Unicode UTF-8.Ceci est généralement spécifié au moment de la création de la base ou dans la configuration même du SGBD.

Le compte utilisé par le serveur Workey pour accéder à cette base devra avoir les droits nécessaires et suffisants (être le propriétaire de son schéma) pour pouvoir créer des tables, des séquences, des déclencheurs (trigger) et des index …
-> Nous attirons votre attention quant aux identifants du compte (nom d’utilisateur et mot de passe). Ceux-ci devront être spécifiés dans des fichiers XML de configuration ou directement saisis lors de l’exécution d’outils en ligne de commande. Choisissez judicieusement les caractères constituants ces identifiants, car il sera peut-être nécessaire d’échapper certains caractères (au regard de leur encodage).

Si votre SGBD est PostgreSQL, veuillez vous assurer 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 :
ALTER DATABASE workey_tomcat SET ALLOW_SNAPSHOT_ISOLATION ON; ALTER DATABASE workey_tomcat SET READ_COMMITTED_SNAPSHOT ON; -> où workey_tomcat est le nom de votre base socle.

Installation des fichiers

Nous désignerons par :<CATALINA_HOME>, le chemin pointant vers le répertoire de base où est installé le serveur Apache Tomcat.<base_de_donnée_socle>, le nom du SGBD correspondant à l’installation.


Fichier(s) non fournis :	->	à placer dans le répertoire :
le(s) fichier(s) jar du driver JDBC,parfois dénommé(s) « connecteur » JDBC, correspondant(s) au(x) SGBD utilisé(s) pour la base socle du serveur Workey et pour toute datasource supplémentaire.	->	`<CATALINA_HOME>/lib`


Depuis le livrable d’installation décompressé :	->	à placer dans le répertoire :
le fichier sous `/server/common/lib` `log4j.jar`	->	`<CATALINA_HOME>/lib`
les fichiers sous `/server/common/conf` `catalina.properties` `log4j.properties`	->	`<CATALINA_HOME>/conf`
le fichier sous `/server/dbms-specific/<base_de_donnée_socle>/conf` `context.xml`	->	`<CATALINA_HOME>/conf`
le fichier sous`/server/dbms_specific/<base_de_donnée_socle>/webapps` `workey.war`	->	`<CATALINA_HOME>/webapps`


Fichier fourni hors livrable d’installation :	->	à placer dans le répertoire :
votre fichier de license serveur Workey `workey-license.xml`	->	`<CATALINA_HOME>/workey` (à créer)

Configuration

Configuration système

Une partie de la configuration, telle que le paramétrage de la Java Virtual Machine (JVM), ne peut être réalisée qu’au niveau système.
Cette configuration s’effectue directement dans le script de lancement de Tomcat.

Système d’exploitation	Fichier script
Windows	-> `<CATALINA_HOME>/bin/catalina.bat`
Unix (ou Mac OS X)	-> `<CATALINA_HOME>/bin/catalina.sh`

Il s’agit notamment de définir (ou surcharger) les variables d´environnement Java qui seront passées au démarrage de la JVM :

Paramètre	Exemple sous Windows
Ajustez les limites minimales et maximales de mémoire allouée à la JVM.`-Xms1024m -Xmx1024m -XX:MaxPermSize=512m` Ces paramètres contrôlent respectivement: la quantité de mémoire initialement disponible pour la JVM,la quantité maximale de mémoire allouée à la JVM,la taille de la zone distincte de mémoire (tas) appelée Permanent Generation space -> prévoir 512m pour utiliser la fonctionnalité de publication de documentation au format HTML ou Word depuis le modélisateur.	set CATALINA_OPTS=”-Xms1024m -Xmx1024m -XX:MaxPermSize=512m %CATALINA_OPTS%”Note: Il n’y a pas de caractère ‘ = ‘ pour les paramètres `-Xmx` et `-Xms`.
Précisez l’encodage par défaut.`-Dfile.encoding=UTF-8-Dmail.mime.charset=UTF-8`Afin d´assurer la continuité de l’encodage du client web jusqu’à la persistance dans la base de donnée (ainsi que pour la gestion des fichiers et pour l’encodage des emails), modifiez le charset (jeu de caractère) utilisé par défaut par Tomcat pour être en `UTF-8`.	set charset=UTF-8 set CATALINA_OPTS=”-Dfile.encoding=%charset% %CATALINA_OPTS%” set CATALINA_OPTS=”-Dmail.mime.charset=%charset% %CATALINA_OPTS%”
Précisez le fuseau horaire.`-Duser.timezone=CET`Renseigné avec un code `timezone` supporté en Java 1.7.	set CATALINA_OPTS=”-Duser.timezone=CET %CATALINA_OPTS%”
la locale (langue et pays),`-Duser.language=fr-Duser.country=FR`Renseignés avec les codes Java 1.7 pour les langues et les pays.	set CATALINA_OPTS=”-Duser.language=fr %CATALINA_OPTS%” set CATALINA_OPTS=”-Duser.country=FR %CATALINA_OPTS%”

Dans le livrable d’installation, les fichiers catalina.bat et catalina.sh, présents sous /server/common/bin illustrent ces modifications.

Configuration du serveur Workey

Les différentes parties fonctionnelles du serveur Workey sont configurées à l’aide d’un ensemble de propriétes Java (des couples clef-valeur).
Ces propriétés sont ajoutées à celle de Tomcat, dans le fichier <CATALINA_HOME>/conf/catalina.properties.

Éditez ce fichier afin de l´adapter à vos besoins.
-> Reportez-vous à l´Annexe A – Propriétés serveur Workey, qui couvre la description et la configuration des différentes propriétés contenues dans ce fichier.

Datasources

Le serveur Workey requiert la définition de 3 (trois) datasources. Celles-ci doivent pointer vers la base de donnée socle créée pour le serveur Workey.
Ces datasources sont spécifiées dans le fichier <CATALINA_HOME>/conf/context.xml.

Éditez ce fichier afin de l´adapter à votre base socle.
-> Reportez-vous à l´Annexe C – DataSources Workey, qui détaille la configuration des datasources.

Journalisation

Par défaut, la verbosité du moteur Workey est DEBUG.
Il est possible de la modifier et/ou de l’affiner en éditant le fichier <CATALINA_HOME>/conf/log4j.properties.

Il s’agit d’un fichier de configuration spécifique au framework de journalisation Apache log4J.
De nombreuses ressources sont disponibles sur Internet pour vous guider dans le paramétrage de ce fichier (cf. Annexe E – Ressources externes).

Journalisation des performances

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

Note : ne sont journalisées que les actions réalisées depuis l’application Web Workey par les utilisateurs authentifiés.

Pour ce faire, il est nécessaire d’activer, dans la configuration de log4j, la journalisation du logger WorkeyPerformanceLogger, avec le niveau de priorité TRACE.

Exemple : log4j.logger.WorkeyPerformanceLogger=TRACE

Les messages générés sont formattés dans l’intention d’un traitement externe automatisé.
A cet effet, les différents éléments de ces messages sont séparés par des tabulations.

Exemple :

2015-03-31 15:24:36,138 [http-apr-8080-exec-10] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  VIEW        TO_DO   1       OPENED_IN       15      ROW_COUNT       10
[...]
2015-03-31 15:30:24,487 [http-apr-8080-exec-4] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  NEW_DOC     -1      DOC_TYPE        Ticket  253     OPENED_IN       135
2015-03-31 15:30:34,606 [http-apr-8080-exec-5] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  NEW_DOC     6956    DOC_TYPE        Ticket  253     SUBMITTED_IN    110
[...]
2015-03-31 15:31:51,497 [http-apr-8080-exec-3] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  EXISTING_DOC        3258    DOC_TYPE        Ticket  67      OPENED_IN       140
2015-03-31 15:31:54,677 [http-apr-8080-exec-8] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  EXISTING_DOC        3258    DOC_TYPE        Ticket  67      SUBMITTED_IN    205
[...]
2015-03-31 15:33:01,232 [http-apr-8080-exec-10] TRACE WorkeyPerformanceLogger - ACTOR   user02  21  NEW_DERIVED_DOC     -1      DOC_TYPE        doc fils        262     OPENED_IN       10
2015-03-31 15:33:03,532 [http-apr-8080-exec-3] TRACE WorkeyPerformanceLogger - ACTOR    user02  21  NEW_DERIVED_DOC     6957    DOC_TYPE        doc fils        262     SUBMITTED_IN    155

Chaque action comprend l’identification de l’acteur la réalisant.

Syntaxe : ACTOR userKey|login id-> lorsque l’utilisateur est un Acteur enregistré dans Workey, il sera désigné par sa clef utilisateur (userKey) et son id (numérique).-> si l’utilisateur n’est pas encore un Acteur dans Workey, il sera désigné par le login saisi lors de son authentification. Son id sera alors -1.

Pour l’ouverture d’une vue, les informations suivantes sont indiquées :

Syntaxe : VIEW designer_name id OPENED_IN duration ROW_COUNT total_number_of_rows-> designer_name correspond au nom interne de la vue saisi dans la modélisation.-> duration correspond au temps de traitement de l’action, exprimé en millisecondes.-> total_number_of_rows indique le nombre de ligne constituant la vue.

Pour les actions portant sur un document, une distinction est réalisée selon qu’il s’agit :

d’un nouveau document (création directe),

Syntaxe : NEW_DOC document_id DOC_TYPE designer_name document_type_id

d’un nouveau document dérivé (création par le biais d’une vue embarquée depuis un document père)

Syntaxe : NEW_DERIVED_DOC document_id DOC_TYPE designer_name document_type_id

d’un document existant

Syntaxe : EXISTING_DOC document_id DOC_TYPE designer_name document_type_id-> pour un nouveau document :

à l’ouverture, celui-ci n’a pas encore de document_id (il aura pour valeur -1).
à la soumission, le document_id sera la valeur attribuée à la création effective du document.

-> le type du document est explicité par son designer_name (nom interne saisi dans la modélisation) et son document_type_id (numérique).

L’ouverture et la soumission de document indiquent, respectivement, le temps de traitement exprimé en millisecondes :

Syntaxe : OPENED_IN duration
Syntaxe : SUBMITTED_IN duration

Première connexion

Avant de pouvoir utiliser le serveur Workey, il est nécessaire de réaliser l’affectation d’un premier Workflow Manager.S’assurer que le serveur Workey est démarré – cf. Démarrage & Arrêt du serveur.Se connecter à la Console d’Administration Web à l’aide d’un navigateur Web – cf. Accès aux applications.

Etapes à suivre pour affecter le gestionnaire de Workflow	Affichage dans le navigateur Web
Se connecter à la Console d’Administration Web.Par défaut, l’authentification se fait par formulaire. Vous devez utiliser des identifiants valides au regard de votre annuaire d’authentification.
Une fois authentifié, cliquer sur Gestionnaires pour vous rendre dans la section qui permet d’administrer les gestionnaires.
Sélectionner le type de gestionnaire à modifier Initialement, tant qu’aucun gestionnaire de Workflow n’a été défini, seul le type Gestionnaires du Workflow est disponible.
Vérifier que le type de gestionnaire sélectionné est bien (W) Workflow
Rechercher un utilisateur:soit en spécifiant directement une expression de filtrage LDAP,soit en cliquant sur l’un des filtres alphabétiques déjà proposés.Les résultats seront listés sous Utilisateurs/Unités.
Sélectionner un utilisateur dans la liste de gauche.-> double-cliquer sur son nomou-> Sélectionner le nom et cliquer sur la flèche (de gauche à droite) pour l’ajouter à la liste de droite.Valider l’affectation en cliquant sur le bouton Mettre à jour les gestionnaires.
Dans cet exemple, nous avons affecté en tant que gestionnaire de Workflow, l’utilisateur avec lequel nous nous sommes connecté à la console d’Administration. Après avoir soumis la mise-à-jour, l’interface s’est rafraîchie et les nouveaux droits de gestionnaire de Workflow ont été immédiatement appliqués. -> de nouvelles sections (Processus, Rôles, Unités, Agents) sont maintenant disponibles, ainsi que des types supplémentaires de gestionnaires.