ZEN - Documentation technique et installation

a) Sur Debian Sarge

Ajouter dans le fichier /etc/apt/sources.list la ligne :

deb http://ftp.pimentech.net/debian/ sarge pimentech backport
deb http://www.backports.org/debian/ sarge-backports main

Pour ne pas polluer la sarge, ajouter dans le fichier /etc/apt/preferences :

Package: *
Pin: release a=sarge-backports
Pin-Priority: 200

puis, après l'update :

sh# apt-get install task-pimentech zope-libcommon zope2.7 python2.2-psycopg \
python2.2-egenix-mxdatetime  python2.2-egenix-mxtools \
python2.3-psycopg zope-psycopgda zope-cookiecrumbler \
python-pychart tetex-extra apache2 sysutils

sh# ln -s /usr/lib/zope/lib/python/Products/CookieCrumbler \
/usr/lib/zope2.7/lib/python/Products
sh# ln -s /usr/lib/zope/lib/python/Products/ZPsycopgDA \
/usr/lib/zope2.7/lib/python/Products

sh# apt-get install postgresql-common postgresql-8.1 postgresql-contrib-8.1

La section backport ajoute la version postgresql-8.1, supprimer backport pour debian testing/unstable. Postgresql 8.0 fonctionne également.

Apache2 est recommandé mais Zen fonctionnera également avec Apache1.3. Les modules utilisés seront mod_proxy, mod_rewrite et mod_user.

b) Autres UNIX

Installer :

• Python2.3
• Apache (1.3 ou 2.0 recommandé) avec mod_proxy, mod_rewrite et mod_user.
• Zope2.7
• Cookiecrumbler
• PostgreSQL >= 8.0 (8.1 recommandé) et trgm - Trigram Matching (depuis postgresql-contrib)
• Zope-PsycopgDA (http://initd.org/projects/psycopg1)
• Python-Pychart (for SVG chats)
• Tetex-extra (for TeX => PDF generation)

Librairies pimentech nécessaires, impérativement en dernière version :

• pimentech-scripts.tgz ou packet debian pimentech-scripts
• zope-libcommon.tgz ou packet debian zope-libcommon
• python-libcommon.tgz ou packet debian python-libcommon
• pimentech-dbutils.tgz ou packet debian pimentech-dbutils

Normalement un simple make install suffit à installer ces outils.

c) Services nécessaires

Pour fonctionner correctement Zen a besoin d'un serveur de mail opérationnel dont vous pouvez changer la configuration dans le fichier globals.mak. Il s'agit de la variable SMTPHOST, par défaut localhost.

Le service de cron doit également fonctionner pour la génération des rapports et l'envoi d'emailing.

a) Créer un utilisateur 'crm'

sh# adduser crm
sh# su - crm

sh$ mkdir src ; cd src
sh$ wget http://ftp.pimentech.net/src/crm.tar.gz
sh$ tar zxf crm.tar.gz

# zen_crm comme lien vers la version de Zen à installer
sh$ ln -s zen_crm_X.Y zen_crm

b) Paramétrage SQL

Paramétrer son pg_hba.conf (droits d'accès à Postgresql) - si besoin -

Voici un fichier type, notez la nécessité de la ligne host all 127.0.0.1 md5 si votre base Postgres est sur localhost et de l'avant dernière host all 192.168.1.0 md5 si la base est sur le réseau local. Zen n'utilise pas les connexions en socket Unix, mais elles sont utiles si vous faites de la ligne de commande avec psql.

sh# cat /etc/postgresql/8.1/main/pg_hba.conf

# "local" is for Unix domain socket connections only
local   all     postgres,root           ident sameuser
local   crm     crm                     ident sameuser
local   all     all                     md5

# IPv4 local connections:
host    all     all     127.0.0.1/32    md5
host    all     all     192.168.1.0/24  md5
host    all     all     0.0.0.0/0       reject

Mot de passe d'administration de Postgresql (si besoin) :

sh# su - postgres
sh$ psql -U postgres template1

template1=# alter user postgres with encrypted password 'your_postgresql_ADMIN_password';
ALTER USER
template1=# \q

Avant de créer la base, il est possible (et fortement recommandé) de paramétrer certains éléments de la base selon ses besoins spécifiques. Il faut pour cela modifier 3 fichiers de chargement de PostgreSQL suivant :

• zen_crm/src/lst/fonction.lst : pour les fonctions des employes et contacts
• zen_crm/src/lst/type_origine.lst : pour l'origine des cibles
• zen_crm/src/lst/activite_societe.lst : pour le type d'activité des sociétés
• zen_crm/src/lst/type_cible.lst : pour les types de cible

Si vous en ajoutez après avoir terminer l'installation, il faudra instancier Zen à nouveau ! Ne touchez PAS aux autres fichiers, Zen ne fonctionnerait plus ! Ces fichiers sont du type :

UID | CODE | TITRE

Ils sont codés en UTF-8. Ne PAS mettre d'UID à Zéro !

c) Installation de la base

Éditer le fichier zen_crm/config/globals.mak et indiquer les paramètres de la base & apache. Mettre au moins un mot de passe dans DBPWD qui sera votre mot de passe pour la base de Zen (différent de celui pour l'administration de Postgresql).

Création de la base :

sh$ cd ~/src/zen_crm/base/generation
sh$ make install

doing createuser.ok
password (postgres) : your_posstgresql_ADMIN_password
CREATE USER
doing create.ok
CREATE DATABASE
loading crm.ok
psql:crm.sql:11: NOTICE:  CREATE TABLE créera des séquences implicites «statut_uid_seq» pour ...
psql:crm.sql:11: NOTICE:  CREATE TABLE / PRIMARY KEY créera un index implicite «statut_pkey» ...
psql:crm.sql:24: NOTICE:  CREATE TABLE créera des séquences implicites «object_uid_seq» ...
psql:crm.sql:24: NOTICE:  CREATE TABLE / PRIMARY KEY créera un index implicite «object_pkey» ...
psql:crm.sql:191: NOTICE:  CREATE TABLE / UNIQUE créera un index implicite «userid_login_key» ...
loading vital_generation.ok

Maintenant que la base est créée, il faut la remplir avec quelques éléments par défaut. Cela va charger les fichiers que vous avez peut-être modifiés précédemment.

Chargement de la base initiale :

sh$ cd ~/src/zen_crm/base/chargement
sh$ make install

Certains moteurs de recherche de Zen ont besoin de faire des recherches approchées, il faut donc ajouter les fonctions de similarité de postgresql-contrib :

sh# cd /usr/share/postgresql/8.X/contrib/
sh# psql -U postgres crm -h localhost

crm=# \i pg_trgm.sql
crm=# \q

Nous en avons fini avec la base de données. Nous n'avons plus à modifier la base de données désormais, Zen va devenir maître et elle seule devra modifier la base. Dans le cas contraire, il faudra mettre à jour Zen pour prendre en compte les modifications manuelles faites en base. Pour cela, il faudra lancer la fonction d'update via l'url http://url-zen/update puis redémarrer Zope.

a) Petit paramétrage Python

Il faut paramétrer le fichier sitecustomize.py situé de préférence dans /usr/lib/zope2.7/lib/python/ sinon dans /usr/lib/python2.3/site-packages/dbutils/, ajouter ou modifier :

import sys
sys.setdefaultencoding('latin-1')

b) Installation des sources

Installation du produit Zope "ZEN" :

sh$ cd ~/src/zen_crm
sh$ make install
# vérification :
sh$ ls ~crm/bin/ZEN/

sh$ su
sh# ln -s ~crm/bin/ZEN /usr/lib/zope2.7/lib/python/Products

Droits UNIX et sécurité (Important !) :

sh$ su
sh# cd ~crm/src/zen_crm
sh# make security

c) Installation de Zope

Si besoin uniquement, création d'une instance de Zope :

Bien lire les commentaires, un nom d'instance ZOPE (et non ZEN !) est demandé, mettre default par exemple et un répertoire 'default' sera créé. Un login & pass Manager ZOPE sont également demandés.

sh# mkzope2.7instance
sh# /etc/init.d/zope restart
# vérification :
sh# ls /var/lib/zope2.7/instances/default/*

d) Installation de Zen

Zope permet d'instancier différents produits. À ne pas confondre avec l'instance de Zope créé par mkzope2.7instance.

Zope utilise une base de données interne, dans laquelle nous pouvons "instancier" des objets. Zen est un object instanciable, on peut même en mettre plusieurs ! Quand vous êtes dans http://mon_serveur:9673/manage, Zope vous propose un bouton "Add" avec une boite de sélection. Cela permet d'ajouter des instances de différents objets.

Pour que Zen fonctionne, il faudra sélectionnez "Virtual Host Monster" (s'il n'en existe pas déjà un) et faites "add" (id quelconque). Pour (enfin!) créer Zen, il faudra faire la même chose en sélectionnant "ZEN" et faire "add". L'ID demandé pour Zen (par défaut la chaîne "ZEN") correspond au fichier globals_ZEN.py dans ~/config.

sh$ cp ~/config/globals.py ~/config/globals_ZEN.py

Relancer Zope, y créer une instance de Zen avec d'ID "ZEN". L'instance "ZEN" sera joignable à l'adresse http//mon_serveur:9673/ZEN Ajoutez également à la racine une instance de 'Virtual Host Monster' (id sans importance) s'il n'existe pas déjà.

Cartouche Statique :

Ceci est un cartouche non éditable par le commercial qui va l'envoyer :

<html>
        <p tal:content="structure here/HEADER"></p>
        <body>
        <p tal:content="structure here/CONTENT"></p>
        </body>
</html>

Cartouche Éditable :

Le même que le statique mais avec l'ajout du texte du commercial :

<html>
        <p tal:content="structure here/HEADER"></p>
        <body>

        <!-- cartouche spécial "text" va inclure le message du commercial -->
        <p tal:content="structure here/text"></p>

        <p tal:content="structure here/CONTENT"></p>
        </body>
</html>

Cartouches d'Inclusion :

Ces cartouches sont invisibles pour les commerciaux, ils ne servent qu'à faire des blocs à inclure dans d'autres cartouches pour faire des parties communes réutilisables.

• HEADER :

<head>
        ... some header stuff
</head>

• CONTENT :

<p>
        ... some xhtml stuff
</p>
<!-- un appel a un autre cartouche d'inclusion -->
<p tal:content="structure here/SIGNATURE"></p>

• SIGNATURE :

<p>
<img src="signature.png" />
Ma signature
</p>

Résultat obtenu avec le cartouche éditable :

<html>
        <head>
                ... some header stuff
        </head>
        <body>
                ... some xhtml stuff

        <!-- cartouche spécial "text" va inclure le message du commercial -->
        <p>texte du commercial</p>

        <!-- un appel a un autre cartouche d'inclusion -->
        <p>
        <img src="signature.png" />
        Ma signature
        </p>
        </body>
</html>

Particularité du cartouche MODELE_STANDARD

Le cartouche ayant l'id MODELE_STANDARD est utilisé pour envoyer les emails personalisés, il doit donc être sobre et posséder un inclusion de "text" comme un cartouche éditable qui contiendra le message du commercial.

<p tal:content="structure here/text"></p>

Par contre, il peut être défini en temps que cartouche d'inclusion pour ne par apparaître dans le choix de cartouche de l'emailing.