Évolution d'un catalogue uniform de la version 3.4  vers la version 4.x

Versions des documents de formations : un format cdmfr et un générateur

A partir de la version 4.0, Uniform est livré avec le support de plusieurs versions de format de dossiers de formations.

Avant la version 4.0, Uniform utilisait implicitement la version cdmfr dont la schéma avait été fixé en 2006. Le seul générateur reconnu par uniform était l’éditeur SOF. Par convention, nous avons nommé cette version de dossier : cdmfr-2006-sof

Des adaptations locales ont été réalisées dans les différentes organisations et par convention dans ce document nous la nommons : cdmfr-2006-sof-custom_. Bien entendu, vous pouvez définir un nom qui permet d’identifier votre établissement. A l'université Lille 1, le générateur de documents de formation est rimbaus nous avons nommé cette version cdmfr-2006-rimbaus-lille1.

La version 4.0 est livrée avec le support du cdmfr correspondant au schéma validé en 2011. Le seul générateur testé actuellement est ROF et nous l'avons donc nommé cdmfr-2011-rof

Installation de la version 4.0

Sauvegarde de la version actuelle

Évidemment, nous vous recommandons de sauver le contexte  tomcat de la version actuelle ainsi que l'ensemble des données qui sont dans le répertoire défini par la valeur de l'attribut /uniform/data-base/@path qui se trouve dans le fichier properties/uniform-config.xml.

Pré-requis

Ceux sont les mêmes  que pour la version 3.4 (jdk 1.6, ant 1.7 et tomcat 6)

Les tests ont été effectués avec un jdk 1.6 et un tomcat 6

Pour effectuer le test de votre installation, récupérer un fichier content un dossier de formation tel qu'il est généré pour la version actuelle d'uniform. Nous le nommons test.xml

Chargement de l'application

A l'aide d'un client svn, se positionner dans le dossier parent qui va accueillir le nouveau dossier du logiciel esup-uniform puis  lancer la commande:

svn export https://subversion.renater.fr/esup-uniform/trunk esup-uniformv4.0-2011

Copiez le fichier web-config.sample.properties en web-config.properties puis le fichier build.cdmfr-2006-sof.properties en build.cdmfr-2006-sof-custom.properties et modifiez les pour adapter le logiciel à votre environnement.

Dans web-config.properties ajuster les variables suivantes :

• tomcat.home: chemin absolu du dossier racine  de tomcat (reprendre la valeur existante dans le fichier de votre version courante)
• deploy.home : chemin absolu du dossier webapps de tomcat (reprendre la valeur existante dans le fichier de votre version courante)
• install.dir : chemin absolu du dossier où vous déployé esup-uniform
• ws.base : url du serveur uniform (reprendre la valeur existante dans le fichier de votre version courante)
• m-url : url du site uniform mobile (cette valeur doit être vide)
• rne : valeur du code rne de l'établissement (reprendre la valeur existante dans le fichier de votre version courante)
• admin.email: email de l'administrateur d'unform (reprendre la valeur existante dans le fichier de votre version courante)

Dans le fichier build.cdmfr-2006-sof-custom.properties, voici la liste des variables à adapter :

• log.file : chemin absolu du fichier de log d'uniform (reprendre la valeur existante dans le fichier de votre version courante)
• stat.file: chemin absolu du fichier de statistique d'uniform (reprendre la valeur existante dans le fichier de votre version courante)
• cmdfr-release : nom de votre version de documents de formation (cdmfr-2006-sof-custom)
• profil : indiquer le nom du profil par défaut qui était présent dans le fichier uniform-config.xml (/uniform/view/profil-name)
• customoai: nom de l'adaptation locale pour la génération des enregistrements oai (reprendre la valeur existante dans le fichier de votre version courante)

  Adapter vos dossiers et fichiers

Adapter le dossier properties

Copiez respectivement vos fichiers actuels dans le dossier properties:

• uniform-config.xml vers uniform-config.cdmfr-2006-sof-custom.sample.xml
• search-engine-config.xml vers search-engine-config.cdmfr-2006-sof-custom.sample.xml
• urlrewrite.xml vers urlrewrite.cdmfr-2006-sof-custom.sample.xml (si ce fichier n'existait dans votre actuelle, alors créer un fichier urlrewrite.cdmfr-2006-sof-custom.sample.xml et y injecter le contenu de urlrewrite.cdmfr-2006-sof.sample.xml)

Déplacez y un fichier :

• webpages/stylesheets/common/variablesExt.xml vers variablesExt.cdmfr-2006-sof-custom.sample.xml

Reinjectez vos fichiers actuels en écrasant les fichiers de la version 4 :

• log4j.properties
• oaicat.properties

Adapter le dossier webpages/stylesheets

Dans le dossier webpages/stylesheets :

• Copiez tous vos fichiers actuels du répertoire webpages/stylesheets/xml2xml dans un nouveau dossier appelé " webpages/stylesheets/xml2xml/cdmfr-2006-sof-custom"
• Dans ce dossier " webpages/stylesheets/xml2xml/cdmfr-2006-sof-custom" copiez aussi le dossier  webpages/stylesheets/commun/ (le  fichier "variables_PDF.xml" doit être présent)
• Copiez le dossier ainsi que ses sous-dossiers et tous les fichiers de votre "profil" (lyceen ou unrnpdc par exemple) actif actuel (ce profil est défini dans le fichier properties/uniform-config.xml (/uniform/view/profil-name) de votre version actuelle
• Si vous avez fait évoluer le contenu des fichiers inclus dans rome, écrasez les fichiers du dossier   webpages/stylesheets/rome de la livraison 4.0

Adapter le dossier import

Créez un dossier import/cdmfr-2006-sof-custom et placez y le fichier test.xml (un des fichiers généré pour la version actuelle)

Adapter le dossier import

Dans le dossier initdb :

• Copiez votre fichier actuel définissant vos constantes et nommer le constantes.cdmfr-2006-sof-custom.sample.xml
• Copiez votre fichier actuel définissant votre "orgunit" et nommer le orgUnit-universite.cdmfr-2006-sof-custom.sample.xml

Adapter le fichier properties/uniform-config.cdmfr-2006-sof-custom.sample.xml

Editez le fichier properties/uniform-config.cdmfr-2006-sof-custom.sample.xml :

• Pour y remplacer les occurences de  xml2xml/ par xml2xml/cdmfr-2006-sof-custom/

• Pour y modifier l'élément /uniform/site/url à la valeur [URL]

• Pour y ajouter un élément /uniform/site/mobile-url à la valeur [M-URL] 
• pour y modifier l'attribut /uniform/data-base/@path à la valeur [DBPATH]
• pour y modifier l'attribut /uniform/data-base/@name à la valeur [DBNAME]
• Pour y modifier le nom de la base de données modifier la valeur de /uniform/data-base/init-base/orgUnit-name de orgUnit-universite en orgUnit-universite.cdmfr-2006-sof-custom
• Pour y modifier la valeur de /uniform/data-base/import-path de import à import/cdmfr-2006-sof-custom
• Pour y modifier la valeur de /uniform/lucene-config/file-name de search-engine-config.xml en search-engine-config.cdmfr-2006-sof-custom.xml
• Pour y ajouter l'élément /uniform/view/useLangToBuildFileName à la valeur true

Créer vos fichiers de configuration et créer votre base

Lancer la commande :

ant initdb

Si vous avez déposé des fichiers dans le dossier import/cdmfr-2006-sof-custom, vous pouvez les indexer :

ant import_dir -DcodAnu=2012

Puis vous pouvez cahger l'application dans un contexte de tomcat

ant deploy