Vanilla Installation Guide d'installation de la plateforme Vanilla Charles Martin, Côme Moyne et Patrick Beaucamp BPM Conseil Contact : charles.martin@bpm-conseil.com, come.moyne@bpm-conseil.com, patrick.beaucamp@bpm-conseil.com Janvier 2013 Document : BPM_Vanilla_Installation_v4.2_FR.odt Version 4.2 1
Index Introduction...3 Pré-requis de l'environnement...3 A propos de cette documentation...3 Pré-requis...4 Base de données...4 Distribution Vanilla MySQL...4 Distribution Vanilla PostgreSQL...4 Distribution Vanilla H2...4 Serveur...5 Environnement Windows...5 Environnement Unix...5 Caractéristiques performances et générales...6 Architecture & Installation...7 Téléchargements des serveurs...7 Téléchargements additionnels...7 Restauration des bases de données...8 Version MySQL...8 Version PostgreSQL...8 Version H2...8 Installation du serveur...9 Version MySQL...9 Version PostgreSQL...10 Version H2...10 Administration initiale...11 Vanilla Setup...11 Référentiel...11 Première connexion au portail...12 Documentations...12 Annexes...13 Ajout de l'application Web 'BirtViewer'...13 2
Introduction La plateforme Vanilla est distribuée en téléchargement suivant 2 versions principales : MySQL (version déjà packagée) ou PostgreSQL (scripts et configuration packagés) H2 La plateforme comprend un serveur applicatif tomcat hébergeant les applications web et les scripts des bases de données. Le serveur est par défaut configuré pour s'exécuter en environnement localhost. Afin de mettre en production votre plateforme, suivez attentivement cette documentation. Les 3 phases expliquées dans ce document sont les suivantes : Restauration des bases de données Configuration et mise en place du serveur Administration initiale de la plateforme Pré-requis de l'environnement (Ne tenez pas compte de ce paragraphe pour la version H2). Votre environnement serveur (Unix ou Windows) doit posséder un environnement Java version 1.6 minimum. Votre paramètre système doit être tel que : JAVA_HOME = répertoire contenant votre jdk A propos de cette documentation Cette documentation porte sur l'installation de la plateforme Vanilla (version 4.2, sortie Janvier 2013). Elle présente les phases principales d'installation en décrivant les points importants. 3
Pré-requis Base de données En fonction du type de serveur de base de données souhaité (parmi ceux disponibles pour l'installation des bases requises pour le fonctionnement de la plate-forme Vanilla), ce dernier doit être installé. Les pré-requis décrits ici ne concernent que le serveur de base de données qui contiendra les bases de données nécessaires au fonctionnement de la plate-forme Vanilla. Votre entrepôt de données peut être situé sur un autre serveur de base de données (Sql Serveur, Oracle ou autres). Distribution Vanilla MySQL Nous préconisons l'utilisation de MySQL Serveur version 5.1. Le serveur doit être installé et accessible depuis le serveur hébergeant l'applicatif Vanilla (vérification de la configuration réseau et des accords de connexion). La propriété «lower_case_table_names» doit être égale à 1. (voir fichier de config mysqld) Créer un utilisateur biplatform (id) / biplatform (mot de passe). Distribution Vanilla PostgreSQL Nous préconisons l'utilisation de PostgreSQL Serveur version 8.3.. Le serveur doit être installé et accessible depuis le serveur hébergeant l'applicatif Vanilla (vérification de la configuration réseau et des accords de connexion). Créer un utilisateur biplatform (id) / biplatform (mot de passe). Distribution Vanilla H2 Aucune installation ni manipulation n'est requise concernant le serveur de base de données (embarqué). 4
Serveur Environnement Windows Si vous désirez installer Vanilla sur un serveur Windows (nous préconisons l'utilisation de Windows 2008 serveur R2), veuillez lire attentivement les points suivants. Environnement Java Un environnement Java 1.6 doit être installé sur le serveur (JDK 6 de chez Sun). Variables systèmes Les variables JAVA_HOME et PATH doivent être renseignées comme suivant. JAVA_HOME référence le chemin du dossier Java. PATH doit être complétée (ajout de ' ;') avec la valeur '%JAVA_HOME%\bin'. Ports disponibles Veuillez vous assurez que les ports 8005,8009,8443 et 8080 ne sont pas déjà utilisés ni bloqués sur le serveur. Effectuez la même vérification pour les ports 8082 et 9092 dans le cas d'une utilisation d'une version H2. Environnement Unix Si vous désirez installer Vanilla sur un serveur Unix (nous préconisons l'utilisation de Debian 6), veuillez lire attentivement les points suivants. Environnement Java Un environnement Java 1.6 doit être installé sur le serveur (JDK 6 de chez Sun). Ports disponibles Veuillez vous assurez que les ports 8005,8009,8443 et 8080 ne sont pas déjà utilisés ni bloqués sur le serveur. Effectuez la même vérification pour les ports 8082 et 9092 dans le cas d'une utilisation d'une version H2. Interface graphique Si le serveur est installé sans interface graphique, l'installation d'une librairie supplémentaire est nécessaire. «Apt-get install lib32gcc1» 5
Caractéristiques performances et générales Processeur 2 Ghz et DUAL CORE sont recommandés (QUADRI CORE suivant utilisation). Mémoire 4 Go de mémoire RAM sont recommandés (8 Go suivant utilisation). Espace disque 10 Go d'espace disque libres sont nécessaires et recommandés 6
Architecture & Installation Téléchargements des serveurs Les deux versions de la plateforme Vanilla et les fichiers spécifiques à une installation sur SGBD PostgreSQL sont disponibles en téléchargement à l'url suivante : http://www.bpm-conseil.com (section download) Téléchargements additionnels Les modules de création d'objets décisionnels sont disponibles en téléchargement à l'url suivante: http://www.bpm-conseil.com (section download) Les modules d'administration de la plateforme Vanilla sont disponibles en téléchargement à l'url suivante : http://www.bpm-conseil.com (section download) 7
Restauration des bases de données Les scripts des bases de données sont distribués avec la plateforme Vanilla. Les trois SGBD supportés par défaut sont MySQL, PostgreSQL et H2. Nous détaillons ici la restauration des scripts concernant ces trois SGBD. Version MySQL Les scripts de la version MySQL sont accompagnés d'un fichier HOWTO vous décrivant les phases de la restauration. Restaurez vos bases depuis votre interface d'administration (scripts créés via MySQLAdministrator) et affectez tous les droits sur ces bases à votre utilisateur 'biplatform/biplatform'. Notez que vous devrez cocher l'option 'ANSI Quote' dans votre interface d'administration. (alternative sur environnement Windows : ajout de 'ansi' dans la section [mysqld] du fichier my.ini). Notez que sur environnement Unix, il faut ajouter 'sql-mode=ansi' dans la section [mysqld] du fichier my.cnf. Version PostgreSQL Les scripts de la version PostgreSQL sont accompagnés d'un fichier HOWTO vous décrivant les phases de la restauration. Restaurez vos bases depuis votre interface d'administration (backups créés via PgAdmin) et affectez tous les droits sur ces bases à votre utilisateur 'biplatform/biplatform'. Version H2 Le serveur packagé H2 contient déjà les bases de données nécessaires au fonctionnement de la plateforme Vanilla et sont présentes dans le serveur applicatif et démarrés automatiquement au lancement du serveur. Aucune manipulation n'est donc nécessaire si vous possédez la version H2. 8
Installation du serveur Vos bases de données nécessaires au fonctionnement de la plateforme Vanilla restaurées (version H2 non concernée par la phase de restauration des bases de données), la plateforme livrée est fourni par défaut avec une configuration 'localhost'. Afin de passer votre plateforme en production, lisez attentivement les paragraphes ci-dessous. Ne pas dézipper la plate-forme Vanilla tomcat dans un répertoire dont le nom du chemin contiendrait un espace. La configuration de la plateforme s'effectue dans le dossier suivant : 'vanilla-conf'. Le fichier log.xml est à laisser dans l'état : pas de modifications. Version MySQL Dossier bonita Le dossier bonita contient les éléments de configuration de l'environnement workflow (voir documentation du module BIWorkflow pour plus d'informations). Les trois fichiers à impacter contiennent les références aux bases de fonctionnement et voici les configurations à appliquer dans le cas d'une version MySQL : Dialect : Driver class : Connection url : org.hibernate.dialect.mysqldialect com.mysql.jdbc.driver jdbc:mysql://votreserveur:3306/bonita_core Fichier vanilla.properties Le fichier vanilla.properties contient les références aux bases de données nécessaires au fonctionnement de la plateforme Vanilla. Par défaut, toutes les références sont en 'localhost', veuillez modifier les connections (si nécessaires) afin de vous connecter à votre SGBD. 9
Version PostgreSQL Dossier bonita Le dossier bonita contient les éléments de configuration de l'environnement workflow (voir documentation du module BIWorkflow pour plus d'informations). Les trois fichiers à impacter contiennent les références aux bases de fonctionnement et voici les configurations à appliquer dans le cas d'une version PostgreSQL : Dialect : Driver class : Connection url : org.hibernate.dialect.postgresqldialect org.postgresql.driver jdbc:postgresql://votreserveur:5432/bonita_core Fichier vanilla.properties Le fichier vanilla.properties contient les références aux bases de données nécessaires au fonctionnement de la plateforme Vanilla. Par défaut, toutes les références sont en 'localhost', veuillez modifier les connections (si nécessaires) afin de vous connecter à votre SGBD. Version H2 La version H2 ne demande aucune modification de votre part concernant ces fichiers de configuration car les bases de données sont embarquées dans le serveur applicatif. 10
Administration initiale Une fois votre configuration serveur effectuée, veuillez démarrer le serveur (start-vanilla.cmd ou start-vanilla.sh suivant votre environnement d'exécution). Votre serveur indique qu'il est démarré par le message 'INFO : Vanilla Server startup in xx ms'. (Veillez à lire le HOWTO de restauration des bases : des manipulations sur la base bonita_core sont à effectuer après le premier lancement) Vanilla Setup Votre serveur démarré, il est configuré par défaut pour fonctionner en localhost. Pour modifier l'adresse du serveur, ouvrir et modifier le fichier «vanilla-conf/vanilla.properties» Référentiel Le référentiel par défaut fourni dans la plateforme Vanilla est : http://localhost:8080/birepository. Rendez-vous dans la vue 'Repositories Administration' du module EnterpriseServices. Modifiez ici le champ URL de votre référentiel (si nécessaire) puis cliquez sur Update. 11
Première connexion au portail Afin d'établir votre première connexion au portail (une fois le serveur démarré), veuillez démarrer un navigateur internet et renseigner l'url suivante : http://votreserveur:8080/vanilla (votreserveur est à remplacer par l'ip ou le nom de votre serveur) La page d'accueil du portail Vanilla apparaît : Documentations Les documentation relatives aux applications web, aux modules d'administration et de création des objets décisionnels de la suite Vanilla sont disponibles dans les modules en eux-mêmes et en téléchargement à l'url suivante : http://www.bpm-conseil.com (section download) 12
Annexes Ajout de l'application Web 'BirtViewer' Nous décrivons ici comment ajouter l'application Web 'Birt Viewer' à votre serveur (ne suivez pas cette procédure si vous ne souhaitez pas explicitement cette application : Vanilla Viewer est par défaut installé sur votre serveur). Téléchargez le package 'Birt Viewer' sur le site de Birt. Récupérez le fichier (sur notre site Web) zip : Birt Viewer oda plugins Dézippez le contenu du fichier dans le répertoire de votre serveur :../BirtViewer/WEB- INF/platform/plugins Editez le fichier../vanilla-conf/vanilla.properties : Modifiez la propriété bpm.vanilla.server.usebirtviewer=false true Vérifiez que dans la vanilla-setup (via ES), les champs relatifs à Birt Viewer soient bien renseignés. Redémarrez votre serveur. 13