16.13 refreshDocuments

16.13.1 Description

Le script refreshDocuments permet d'appliquer une méthode sur les documents d'une famille donnée.

16.13.2 Usage

famid (obligatoire)

Identifiant, ou nom logique, de la famille des documents sur lesquels s'applique le traitement.

method (default refresh)

La méthode à appliquer sur les documents de la famille.

Par défaut c'est la méthode refresh() qui est appliquée.

arg

Permet de spécifier le premier argument de la méthode.

revision (default no)

Permet de spécifier si la méthode doit être appliquée sur toutes les révisions des documents (yes) ou seulement sur la dernière révision des documents (no).

docid

Permet de restreindre le traitement à un seul document dont l'identifiant ou le nom logique est spécifié par cette option.

start

La liste des documents à traiter est ordonnée par ordre décroissant des identifiants de document (id). Cette option permet de commencer le traitement à partir d'un indice de document donné.

Voir SearchDoc::setStart()

slice

Permet de limiter le traitement à un nombre donné de documents.

Dans ce cas, seul les slice premiers documents (à partir du document désigné par start) seront traités.

Voir SearchDoc::setSlice()

fldid

Permet de restreindre le traitement aux documents présents dans un répertoire ou retournés par une recherche.

fdlid peut donc être l'identifiant ou le nom logique d'un document Répertoire (DIR ou dérivé) ou d'un document Recherche (SEARCH ou dérivé).

filter

Permet de spécifier un filtre SQL additionnel pour la sélection des documents sur lesquels est appliqué le traitement.

save (default light)

Permet de spécifier si une méthode de post-traitement doit être appliquée pour la sauvegarde des modifications effectuées par la méthode method.

Les valeurs possibles sont :

complete

Appelle la méthode store() après l'exécution de la méthode method.

light

Appelle la méthode modify(true) après l'exécution de la méthode method.

none

N'appelle aucune autre méthode additionnelle après l'exécution de la méthode method.

status-file 3.2.19

Permet de spécifier la création d'un fichier de rapport contenant :

• le nombre de documents sélectionnés pour traitement (ligne ALL:) ;
• le nombre de documents traités (ligne PROCESSED:) ;
• le nombre de documents traités avec erreur (ligne FAILURE:) ;
• le nombre de documents traités avec succès (ligne SUCCESS:) ;

Si - (tiret) est spécifié, le fichier de rapport est alors écrit sur le flux de sortie standard STDOUT.

Si le fichier spécifié existe déjà, le fichier est supprimé avant d'être re-créé.

Par défaut aucun fichier de rapport n'est créé.

stop-on-error 3.2.19

Permet de stopper le traitement lorsque la méthode store() ou modify() d'un document retourne une erreur, ou lorsqu'une exception est levée.

Par défaut le comportement est de poursuivre le traitement lorsqu'un document retourne une erreur ou lance une exception.

16.13.3 Limite d'usage

Seul le premier argument de la méthode method peut être spécifié avec l'option arg. Les autres arguments de la méthode ne seront donc pas positionnés (ce qui peut restreindre les méthodes utilisable par ce traitement).

16.13.4 Erreurs

3.2.19 Le processus se termine avec un exit code 0 s'il n'y a pas d'erreurs, ou un exit code différent de 0 lorsque au moins un document a remonté une erreur (erreur de store()/modify() ou exception lancé par le document).

16.13.5 Changements

16.13.5.1 Version 3.2.19

Depuis la version 3.2.19 les exceptions sont attrapés et traitées comme une erreur (au même titre qu'une erreur retourné par store() ou modify()) et ne stoppent donc plus l'exécution du traitement.

Dans les versions précédentes les exceptions n'étaient pas attrapées et interrompaient l'exécution du traitement.

Pour rétablir un fonctionnement similaire a celui des versions précédentes vous pouvez utiliser l'option --stop-on-error qui interrompt le traitement au premier document qui retourne une erreur ou une exception.