Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Note
titleNavigation 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.

Pré-Requis

...

  • ORI-OAI-Indexing

...

  • est

...

  • une

...

  • application

...

  • fonctionnant

...

  • avec

...

  • le

...

  • langage

...

  • Java.

...

  • Le

...

  • JDK

...

  • (version

...

  • 6

...

  • ou

...

  • ultérieure)

...

  • doit

...

  • donc

...

  • être

...

  • installé

...

  • sur

...

  • la

...

  • machine

...

  • de

...

  • déploiement.

...

  • Les

...

  • tâches

...

  • de

...

  • compilation,

...

  • de

...

  • déploiement

...

  • et

...

  • certaines

...

  • actions

...

  • utilisent

...

  • ANT.

...

  • Une

...

  • version

...

  • de

...

  • Tomcat

...

  • doit

...

  • être

...

  • disponible

...

  • sur

...

  • la

...

  • machine

...

  • de

...

  • déploiement.

...

  • Le

...

  • module

...

  • a

...

  • été

...

  • testé

...

  • avec

...

  • la

...

  • version

...

  • 6.0.24

...

  • de

...

  • Tomcat.

...

  • Info

...

  • Il

...

  • est

...

  • nécessaire

...

  • de

...

  • spécifier

...

  • au

...

  • Tomcat

...

  • que

...

  • vous

...

  • utilisez

...

  • l'encodage

...

  • UTF-8

...

  • pour

...

  • tous

...

  • les

...

  • modules.

...

  • Pour

...

  • cela,

...

  • éditez

...

  • le

...

  • fichier

...

  • PATH_TOMCAT_INDEXING/bin/startup.sh

...

  • (startup.bat

...

  • sous

...

  • Windows)

...

  • ou

...

  • PATH_TOMCAT_INDEXING/bin/catalina.sh

...

  • (catalina.bat

...

  • sous

...

  • Windows)

...

  • et

...

  • y

...

  • ajoutez

...

  • la

...

  • commande

...

  • suivante:

...

    • export

...

    • CATALINA_OPTS="-Dfile.encoding=UTF-8

...

    • $CATALINA_OPTS"

...

    • (sous

...

    • Unix)

...

    • set

...

    • CATALINA_OPTS="-Dfile.encoding=UTF-8

...

    • %CATALINA_OPTS%"

...

    • (sous

...

    • Windows)

...

    Warning
    titleImportant

    Il est fortement conseillé de modifier les paramètres du Tomcat en ajoutant -Xms256m et -Xmx512m ce qui permet d'ajouter de la mémoire vive disponible au Tomcat dédié au module d'indexation. Ces paramètres sont d'autant plus nécessaires si les recherches renvoient beaucoup de résultats ou si vous utilisez le crawler web.

Configuration pour un déploiement manuel

init-build.properties


Ce fichier se trouve à la racine du repertoire ori-oai-indexing.

...

Il

...

contient

...

les

...

données

...

nécessaires

...

au

...

déploiement

...

correct

...

de

...

l'application

...

dans

...

Tomcat.

...

Copiez

...

ce

...

fichier

...

en

...

build.properties.

...

Ouvrez

...

le

...

nouveau

...

fichier

...

créé

...

et

...

modifiez-le

...

comme

...

indiqué

...

ci-dessous.

{
Info
}

Ne

supprimez

pas

le

fichier

init-build.properties.

Il

est

utilisé

dans

le

cadre

d'une

installation

rapide

avec

ori-oai-commons-quick-install.

{info}

Le

...

fichier

...

se

...

présente

...

de

...

la

...

manière

...

suivante

...

:

{
Code Block
}############################
##                        ##
##   PARTIE INSTALLATION  ##
## 2 modes d'installation ##
##        1) ou 2)        ##
##                        ##
############################


#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# 1) Utilisation de ori-oai-commons-quick-install
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#

#URL du fichier contenant toutes les proprietes pour ce module en installation rapide
#Commentez le parametre si vous ne voulez pas utiliser les fonctionnalites 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 necessaire de commenter
# le parametre commons.parameters.central.file.url
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#

# Cette partie du fichier doit etre mise a jour avant
# la premiere utilisation de votre application dans votre environnement

#Repertoire d'installation de Tomcat
tomcat.home  = [PATH_TOMCAT_INDEXING]

#Repertoire de deploiement
deploy.home  = [PATH_TOMCAT_INDEXING]/webapps/

#Nom de ditribution de l'application
app.name.deploy=[CONTEXT_INDEXING]

#URL vers Tomcat
tomcat.URL.deploy = http://[HOST_INDEXING]:[PORT_INDEXING]

#Dossier dans lequel se trouve l'index
index.directory = [INDEXES_DATA_DIR]/index-indexing/index
{code}

Etant

...

donné

...

que

...

vous

...

faites

...

une

...

installation

...

manuelle,

...

il

...

est

...

nécessaire

...

de

...

commenter

...

la

...

variable

...

commons.parameters.central.file.url

...

dans

...

ce

...

fichier

...

comme

...

ceci:

{
Code Block
}#URL du fichier contenant toutes les propriétés pour ce module en installation rapide
#Commentez le parametre si vous ne voulez pas utiliser les fonctionnalites d'installation de ori-oai-commons-quick-install
#commons.parameters.central.file.url=[COMMONS_PARAMETERS_CENTRAL_FILE_URL]
{code}
{span:class=term}

Span
classterm
tomcat.home

...

Répertoire racine de Tomcat.

...

Remplacez

...

[PATH_TOMCAT_INDEXING

...

]

...

par

...

le

...

chemin

...

...

se

...

trouve

...

le

...

serveur

...

Tomcat

...

...

sera

...

installé

...

le

...

module

...

ori-oai-indexing

...

Span
classterm
deploy.home

Répertoire dans lequel sera déployée l'application (il doit s'agir du répertoire webapps de Tomcat). Remplacez [PATH_TOMCAT_INDEXING

...

]

...

par

...

la

...

même

...

valeur

...

que

...

celle

...

donnée

...

dans

...

tomcat.home

...

Span
classterm
app.name.deploy

...

Nom de l'application

...

dans

...

le

...

contexte

...

Tomcat.

...

Remplacez

...

[CONTEXT_INDEXING

...

]

...

par

...

le

...

nom

...

que

...

vous

...

souhaitez

...

donner

...

au

...

répertoire

...

de

...

déploiement

...

du

...

module

...

(exemple

...

:

...

ori-oai-indexing

...

ou

...

indexing).

...

Ce

...

nom

...

servira

...

également

...

à

...

retrouver

...

la

...

page

...

d'accueil

...

du

...

module

...

qui

...

sera

...

:
http://

...

[HOST_INDEXING

...

]

...

:

...

[PORT_INDEXING

...

]/

...

[CONTEXT_INDEXING

...

]/

...


(voir

...

section

...

4

...

de

...

la

...

page

...

utilisation).

...

Span
classterm
tomcat.URL.deploy

...

URL vers la page d'accueil

...

de

...

Tomcat.

...

Ce

...

champ

...

est

...

utile

...

dans

...

le

...

cadre

...

des

...

Premiers

...

Tests.

...

Remplacez

...

[HOST_INDEXING

...

]

...

et

...

[PORT_INDEXING

...

]

...

par

...

le

...

nom

...

de

...

la

...

machine

...

et

...

le

...

numéro

...

de

...

port

...

du

...

Tomcat

...

...

est

...

installé

...

le

...

module

...

ori-oai-indexing.

Span
classterm
index.directory

Répertoire dans lequel se trouve l'index.

log4j.properties


Le fichier log4j.properties se présente de la manière suivante :

Code Block

{quote}
{span:class=term}index.directory
{span}
{quote}Répertoire dans lequel se trouve l'index.
{quote}

h2. log4j.properties

\\
Le fichier log4j.properties se présente de la manière suivante         :
{code}# ----- PARTIE A MODIFIER PAR L'UTILISATEUR
log4j.appender.fichier.file=[PATH_TOMCAT_INDEXING]/logs/ori-oai-indexing.log

# ----- Definition des logs fichier
log4j.logger.org.orioai.indexing=INFO,fichier
#log4j.appender.fichier=org.apache.log4j.ConsoleAppender
log4j.appender.fichier=org.apache.log4j.FileAppender

log4j.appender.fichier.layout=org.apache.log4j.PatternLayout
log4j.appender.fichier.layout.ConversionPattern=%5p %d{MMM/dd HH:mm:ss} %c :: %m%n
{code}

Les

...

paramètres

...

à

...

modifier

...

éventuellement

...

sont

...

les

...

suivants

...

:

...


Span

...

class

...

term

...

log4j.logger.org.orioai.indexing

...

Niveau de logs Trois niveaux sont utilisés dans ORI-OAI-Indexing.

...

  • ERROR

...

  • :

...

  • C'est

...

  • le

...

  • niveau

...

  • à

...

  • utiliser

...

  • en

...

  • production.

...

  • Seules

...

  • les

...

  • erreurs

...

  • seront

...

  • notifiées

...

  • dans

...

  • le

...

  • fichier

...

  • pour

...

  • optimiser

...

  • au

...

  • maximum

...

  • les

...

  • performances.

...

  • INFO

...

  • :

...

  • Il

...

  • contient

...

  • les

...

  • erreurs

...

  • mais

...

  • aussi

...

  • les

...

  • informations

...

  • sur

...

  • l'identifiant

...

  • des

...

  • fiches

...

  • indexées

...

  • ainsi

...

  • que

...

  • les

...

  • requetes

...

  • lancées

...

  • et

...

  • le

...

  • nombre

...

  • de

...

  • résultats

...

  • correspondants.

...

  • DEBUG

...

  • :

...

  • Version

...

  • de

...

  • deboggage

...

  • en

...

  • cas

...

  • de

...

  • problème

...

  • avec

...

  • le

...

  • module.

...

  • A

...

  • ce

...

  • niveau

...

  • les

...

  • performances

...

  • de

...

  • l'indexeur

...

  • sont

...

  • plus

...

  • basses.

...

Span
classterm
log4j.appender.fichier.file

...

Emplacement et nom du fichier de logs. Remplacez [PATH_TOMCAT_INDEXING

...

]

...

par

...

le

...

chemin

...

...

se

...

trouve

...

le

...

serveur

...

Tomcat

...

...

sera

...

installé

...

le

...

module

...

ori-oai-indexing.

...

configIndexing.xml

...


Il

...

reste

...

une

...

dernière

...

étape

...

avant

...

de

...

déployer

...

l'application.

...

Il

...

s'agit

...

ici

...

de

...

remplir

...

le

...

fichier

...

configIndexing.xml

...

situé

...

dans

...

le

...

dossier

...

"properties".

...

Pour

...

cela

...

il

...

suffit

...

simplement

...

de

...

remplacer

...

[INDEXES_DATA_DIR

...

]

...

dans

...

la

...

balise

...

"indexDir".

...

Il

...

faut

...

également

...

modifier

...

[PROXY_HOST

...

]

...

et

...

[PROXY_PORT

...

]

...

par

...

la

...

valeur

...

adéquate.

...

Si

...

vous

...

n'utilisez

...

pas

...

de

...

proxy

...

il

...

suffit

...

alors

...

de

...

supprimer

...

ces

...

valeurs.

...

Enfin

...

si

...

vous

...

souhaitez

...

que

...

le

...

crawler

...

se

...

lance

...

automatiquement,

...

remplacez

...

[INDEXING_SCHEDULE_CRAWLER

...

]

...

par

...

la

...

valeur

...

de

...

votre

...

choix.

...

Si

...

vous

...

supprimez

...

la

...

valeur,

...

le

...

crawler

...

ne

...

sera

...

lancera

...

pas.

...

La

...

section

...

"Personnalisation

...

de

...

la

...

configuration"

...

offre

...

plus

...

de

...

renseignements

...

sur

...

ce

...

fichier

...

ce

...

qui

...

permet

...

une

...

configuration

...

plus

...

poussée

...

du

...

module.

...

Déploiement

...

de

...

l'application

...


  • Si c'est

...

  • votre

...

  • premier

...

  • déploiement

...

  • ou

...

  • si

...

  • vous

...

  • souhaitez

...

  • supprimer

...

  • un

...

  • index

...

  • existant

...

  • lancez

...

  • :

...

  • ant

...

  • init

...

Un

...

message

...

vous

...

préviendra

...

que

...

vous

...

tentez

...

de

...

supprimer

...

l'index.

...

Appuyez

...

sur

...

"y"

...

puis

...

la

...

touche

...

"Entrée"

...

pour

...

continuer

...

l'initialisation

...

des

...

répertoires.

...

  • Lancez

...

  • la

...

  • commande

...

  • ant

...

  • all

...

  • pour

...

  • compiler

...

  • les

...

  • fichiers

...

  • sources

...

  • et

...

  • créer

...

  • le

...

  • contexte

...

  • du

...

  • module

...

  • d'indexation

...

  • dans

...

  • le

...

  • serveur

...

  • Tomcat.

...

Lancement

...

du

...

module

...


Il

...

ne

...

reste

...

plus

...

qu'à

...

demarrer

...

Tomcat

...

pour

...

lancer

...

ORI-OAI-Indexing.

...

Vous

...

pouvez

...

vérifier

...

si

...

le

...

module

...

fonctionne

...

en

...

testant

...

sur

...

un

...

navigateur

...

l'URL

...

suivante

...

:

...

http://

...

[HOST_INDEXING

...

]

...

:

...

[PORT_INDEXING

...

]/ori-oai-indexing/

...

en

...

modifiant

...

"

...

[HOST_INDEXING

...

]:

...

[PORT_INDEXING

...

]"

...

par

...

la

...

valeur

...

adéquate.

...

Vous

...

devriez

...

obtenir

...

un

...

affichage

...

similaire

...

à

...

celui-ci :    Image Added

Note

Le module est complètement chargé au bout de quelques secondes. S'il est sollicité trop tôt, une erreur 404 survient alors.

Info

Les autres onglets ne fonctionnent que si l'index est créé. Ils ne sont donc pas utilisables à cet instant.

:    !accueil.jpg! {note}Le module est complètement chargé au bout de quelques secondes. S'il est sollicité trop tôt, une erreur 404 survient alors. {note} {info}Les autres onglets ne fonctionnent que si l'index est créé. Ils ne sont donc pas utilisables à cet instant. {info}