Navigation dans les fichiers de configuration
Avant de procéder à l'installation avancée, il est conseillé de consulter le document "Navigation dans les fichiers" pour mieux comprendre la structure des différents fichiers.
L'installation manuelle de ce module nécessite les étapes suivantes:
Configurations minimales
Dans la configuration "par module", un fichier build.properties doit être créé à partir du fichier init-build.properties et éditer pour changer les parmètres en gras de la section 2):
############################ ## ## ## PARTIE INSTALLATION ## ## 2 modes d'installation ## ## 1) ou 2) ## ## ## ############################ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 1) Utilisation de ori-oai-commons-quick-install #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #URL du fichier contenant toutes les propriétés pour ce module en installation rapide #Commentez le paramètre si vous ne voulez pas utiliser les fonctionnalités d'installation de ori-oai-commons-quick-install commons.parameters.central.file.url=[COMMONS_PARAMETERS_CENTRAL_FILE_URL] #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# ## 2) Installation manuelle du module # Dans ce cas, il est nécessaire de commenter # le paramètre commons.parameters.central.file.url #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Cette partie du fichier doit être mise à jour avant # la première utilisation de votre application dans votre environnement deploy.home=[PATH_TOMCAT_VOCABULARY]/webapps #Nom de ditribution de l'application - distribution name app.name.deploy=[CONTEXT_VOCABULARY] custom.recover.files= #conf/properties/domain/domain.xml \ #conf/properties/static_vocabularies/unitvocab/languages.xml \ #conf/properties/static_vocabularies/unitvocab/keywords.xml # indicate here the directory containing custom old static vocabularies # (used ONLY when you call ant upgrade.to.vdex is called) vocab.upgrade.dir=[VDEX_UPGRADE_DIR]
- [PATH_TOMCAT_VOCABULARY] est le chemin du Tomcat où doit s'executer le module
- [CONTEXT_VOCABULARY] est le contexte auquel sera accéder le module, et correspond au nom du répertoire de déploiement dans Tomcat
- [VDEX_UPGRADE_DIR] facultatif, sert à indiquer un répertoire contenant d'anciens vocabulaires (d'avant la version VDEX), afin de l'utiliser avec la target ANT upgrade.to.vdex (voir section "Migration des vocabulaires statiques")
Le fichier principal de configuration du module et qui doit permettre de mettre en place rapidement un module Ori-Oai-Vocabulary fonctionnel est le fichier conf/properties/main-config.properties.
Les paramètres entre crochet sont à modifier à la main, ou seront modifiés par la configuration centrale du quick-install
# ldap [ldap.xml] # WARNING: you should modify ldapVocabulary.xml TOO (config vcard) ldap.url=ldap://[LDAP_ETABLISSEMENT]:[PORT_LDAP_ETABLISSEMENT] ldap.username= ldap.password= ldap.base=[LDAP_BASE_DN] ldap.people.searchBase=[VOCABULARY_LDAP_PEOPLE_SEARCH_BASE] ldap.people.objectClassValue=[VOCABULARY_LDAP_PEOPLE_OBJECTCLASS_VALUE] ldap.people.uid=[VOCABULARY_LDAP_PEOPLE_UID] ldap.people.filter=[VOCABULARY_LDAP_PEOPLE_FILTER] ldap.group.searchBase=[VOCABULARY_LDAP_GROUP_SEARCH_BASE] ldap.group.objectClassValue=[VOCABULARY_LDAP_GROUP_OBJECTCLASS_VALUE] ldap.group.uid=[VOCABULARY_LDAP_GROUP_UID] ldap.group.filter=[VOCABULARY_LDAP_GROUP_FILTER] # exceptions [exceptionHandling.xml] exceptions.recipientEmail=[SMTP_ADMINISTRATOR_MAIL] # smtp [smtp.xml] smtp.smtpFromAddress.address=[SMTP_ADMINISTRATOR_MAIL] smtp.smtpFromAddress.personal=[SMTP_ADMINISTRATOR_NAME] smtp.smtpInterceptAddress.address=[SMTP_ADMINISTRATOR_MAIL] smtp.smtpInterceptAddress.personal=[SMTP_ADMINISTRATOR_NAME] smtp.smtpServer.host=[SMTP_ETABLISSEMENT] smtp.smtpServer.port=25 # lifeTime for cache in seconds # WARN : if you change this value, you must clean the last cache (vocabularyServiceCache.data and vocabularyServiceCache.index) # from your tmp directory [so that the new value of cache.lifeTime is used] cache.lifeTime=3600 # indexing [indexingVocabulary.xml] indexing1.wsdlDocumentUrl=http://[HOST_INDEXING]:[PORT_INDEXING]/[CONTEXT_INDEXING]/xfire/IndexingService?WSDL indexing1.lookupServiceOnStartup=false # Edited vocabulary [domain.xml] editor.home.override=[ori-oai-vocabulary.src.dir]/conf/properties/ori_vocabularies/override editor.home.edited=[ori-oai-vocabulary.src.dir]/conf/properties/ori_vocabularies/edited editor.home.official=[ori-oai-vocabulary.src.dir]/conf/properties/ori_vocabularies/official
Voici la description de ces paramètres :
[PATH_TOMCAT_VOCABULARY]
Racine du serveur Tomcat sur lequel est déployé ori-oai-vocabulary
[HOST_VOCABULARY]
Nom de domaine de la machine sur laquelle est déployée ori-oai-vocabulary
[PORT_VOCABULARY]
Port du serveur Tomcat par lequel est appelé ori-oai-vocabulary
[CONTEXT_VOCABULARY]
Nom du contexte choisi pour le déploiement de ori-oai-vocabulary
[VOCABULARY_LDAP_PEOPLE_SEARCH_BASE]
le subdn de la branche contenant les individus
[VOCABULARY_LDAP_PEOPLE_OBJECTCLASS_VALUE]
l'ObjectClass utilisé pour les individus
[VOCABULARY_LDAP_PEOPLE_UID]
l'attribut d'un individu désignant son uid
[VOCABULARY_LDAP_PEOPLE_FILTER]
un filtre permettant de filtrer les individus à exploiter/lister (vcard)
[VOCABULARY_LDAP_GROUP_SEARCH_BASE]
le subdn de la branche contenant les groupes
[VOCABULARY_LDAP_GROUP_OBJECTCLASS_VALUE]
l'ObjectClass utilisé pour les groupes
[VOCABULARY_LDAP_GROUP_UID]
l'attribut d'un groupe désignant son uid
[VOCABULARY_LDAP_GROUP_FILTER]
un filtre permettant de filtrer les groupes à exploiter/lister [vcard]
[VOCABULARY_LDAP_PROVIDER_PEOPLE_ORG]
Paramètre qui permet de pré-remplir le champ ORG d'une vcard d'une personne dans un vocabulaire LDAP
[VOCABULARY_LDAP_PROVIDER_PEOPLE_URL]
Paramètre qui permet de pré-remplir le champ URL d'une vcard d'une personne dans un vocabulaire LDAP
[VOCABULARY_LDAP_PROVIDER_GROUP_ORG]
Paramètre qui permet de pré-remplir le champ ORG d'une vcard d'un groupe dans un vocabulaire LDAP
[VOCABULARY_LDAP_PROVIDER_GROUP_URL]
Paramètre qui permet de pré-remplir le champ URL d'une vcard d'un groupe dans un vocabulaire LDAP
Configurations avancées (optionnel)
Se reporter à la page suivante.
Déploiement
Une fois configuré le build.properties et les fichiers de configuration décrits ci dessus, la target deploy permet de déployer simplement l'application.
ant deploy
Vous pouvez alors démarrer l'applciation en lancant le Tomcat concerné.
Vous pouvez alors vérifier que votre Web Service répond bien * en pointant l'url sur le wsdl du WEB Service du vocabulaire (point d'entrée de ce module pour les autres modules ORI-OAI) : pour UNIT, cela donne http://www.unit.eu/ori-oai-vocabulary/xfire/OriVocabularyService?WSDL
- en consultant les vocabulaires via le module ori-oai-md-editor utilisé dans ori-oai-workflow (cf la documentation de ori-oai-workflow)