Cron jobs¶
Un cron job est une commande Linux permettant de planifier le lancement d'une commande ou d'un script sur votre serveur afin d'exécuter automatiquement des tâches à répéter. Les scripts exécutés en tant que cron job sont généralement utilisés pour effectuer des modifications sur des fichiers ou bases de données ; ils peuvent cependant effectuer d'autres tâches qui ne modifient pas les données sur le serveur, comme expédier des notifications par courriel. Vous pouvez activer plusieurs cron jobs sur Koha (lancement de l'indexation du moteur de recherche, génération d'avertissement pour retard, nettoyage des données, etc...), qui seront détaillées dans ce chapitre.
Crontab example¶
An example of a Koha crontab can be found in misc/cronjobs/crontab.example
The example includes sample boilerplate cronjob entries for the most commonly-used cronjobs.
Cron jobs¶
Les chemins de fichier mentionnés ci-dessous présupposent que les fichiers crons sont placés dans misc/. Si vous disposez d'une installation standard et que ceux-co ne sont pas dans misc/, regardez dans bin/.
Backup¶
Daily Backup¶
Script path: misc/cronjobs/backup.sh
Does: Creates a daily backup of the Koha database.
Périodicité préconisée : chaque jour
Rechercher¶
Sitemap¶
Script path: misc/cronjobs/sitemap.pl
Does: Processes all biblio records from a Koha instance and generates sitemap files complying with the protocol as described on http://sitemaps.org. The goal of this script is to be able to provide to search engines direct access to biblio records. It avoids leaving search engines browsing Koha's OPAC which would generate a lot of site traffic and server workload.
Note A file named sitemapindex.xml is generated. It contains references to multiple sitemap files. Each file contains at most 50,000 URLs and is named sitemapXXXX.xml.
The files must be stored on the Koha OPAC's root directory. In the same directory a robots.txt file with the following contents is required:
Sitemap: sitemapindex.xml User-agent: * Disallow: /cgi-bin/
Reconstruction de l'index¶
Script path: misc/migration_tools/rebuild_zebra.pl
Tâche effectuée : Mise à jour des index Zebra avec les données récemment modifiées
Requis par : Zebra
Périodicité préconisée : tous les n minutes (plutôt entre 5 et 15 mn), selon le niveau de performance recherché
Circulation¶
File des réservations¶
Script path: misc/cronjobs/holds/build_holds_queue.pl
Tâche effectuée : Mise à jour de la file de réservations
Required by: Holds Queue Report
Périodicité préconisée : toutes les 15 mn
Description :
Ce script devrait être exécuté régulièrement si vos adhérents sont autorisés à placer des réservations sur des documents en rayon. Le script établit quelle bibliothèque doit prendre en charge la demande de réservation.
It's behavior is controlled by the system preferences StaticHoldsQueueWeight and RandomizeHoldsQueueWeight.
If you do not want all of your libraries to participate in the on-shelf holds fulfillment process, you should list the the libraries that *do* participate in the process here by inputting all the participating library's branchcodes, separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).
By default, the holds queue will be generated such that the system will first attempt to hold fulfillment using items already at the pickup library if possible. If there are no items available at the pickup library to fill a hold, build_holds_queue.pl will then use the list of libraries defined in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is disabled ( which it is by default ), the script will assign fulfillment requests in the order the branches are placed in the StaticHoldsQueueWeight system preference.
Par exemple si votre réseau compte trois sites de taille variable (petit, moyen et grand) et que vous souhaitez que la gestion des réservations soit effectuée par le plus grand site avant le plus petit, votre préférence système StaticHoldsQueueWeight ressemblera à quelquechose comme "LRG,MED,SML".
Si vous souhaitez répartir de manière équitable la réponse aux demandes de réservations au sein de votre réseau, activez RandomizeHoldsQueueWeight. Lorsque cette préférence système est activée, l'ordre dans lequel les sites devront répondre aux demandes de réservations pour une demande de document disponible sera généré de façon aléatoire à chaque réactualisation de la liste.
Leaving StaticHoldsQueueWeight empty is contraindicated at this time. Doing so will cause the build_holds_queue script to ignore RandomizeHoldsQueueWeight, causing the script to request hold fulfillment not randomly, but by alphabetical order.
Réservations expirées¶
Script path: misc/cronjobs/holds/cancel_expired_holds.pl
Does: By default, this cron job will only automatically cancel holds where the user has set an expiration date. If the library is using the ExpireReservesMaxPickUpDelay and ExpireReservesMaxPickUpDelayCharge preferences then this script will also cancel holds that have been sitting on the hold shelf for too long and will (if the library does) charge the patron for not picking up the hold.
Périodicité préconisée : chaque jour
Réactiver les réservations¶
Script path: misc/cronjobs/holds/auto_unsuspend_holds.pl
Does: This script checks to find holds that should no longer be suspended and removes the suspension if the AutoResumeSuspendedHolds preference is set to 'allow'. This puts the patron back in to the queue where they were when the hold was suspended.
Périodicité préconisée : chaque jour
Amendes et frais¶
Chemin du fichier : misc/cronjobs/fines.pl
Fonction: Calcules et attribue les amendes aux comptes des adhérants.
Required by: finesMode system preference
Périodicité préconisée : chaque jour
Static Fines¶
Script path: misc/cronjobs/staticfines.pl
Does: this script calculates and charges overdue fines to patron accounts
Note If the Koha System Preference 'finesMode' is set to 'production', the fines are charged to the patron accounts. If set to 'test', the fines are calculated but not applied.
Note Fines won't be applied on a holiday.
Retards de longue durée¶
Chemin du fichier : misc/cronjobs/fines.pl
Fonction: permet de spécifier des délais avant de changer le status d'un exemplaire, et optionnellement mettre une facture pour ceux-ci en utilisant le montant de remplacement listé dans la notice de l'exemplaire.
Périodicité préconisée : chaque jour
Note
Staff can control some of the parameters for the longoverdue cron job with the DefaultLongOverdueLostValue and DefaultLongOverdueChargeValue preferences.
Track Total Checkouts¶
Script path: misc/cronjobs/update_totalissues.pl
Does: updates the biblioitems.totalissues field in the database with the latest tally of checkouts based on historical issue statistics.
Périodicité préconisée : chaque jour
Warning
Si le temps dans votre base de données ne concorde pas avec le temps sur votre serveur Koha, vous devrez prendre cela en compte, et probablement utiliser --since plutôt que --interval pour la mise a jour incrémentielle
Note
This cronjob can be used if there is a performance concern. Otherwise, use the UpdateTotalIssuesOnCirc System Preference.
Generate Patron File for Offline Circulation¶
Script path: misc/cronjobs/create_koc_db.pl
Does: Generates the borrowers.db file for use with the Koha Offline Circulation tool
Périodicité préconisée : chaque jour
Pas de renouvelements¶
Script path: misc/cronjobs/automatic_renewals.pl
Does: Will automatically renew items if you're allowing automatic renewal with your circulation and fine rules.
Périodicité préconisée : chaque jour
Adhérents¶
Batch Delete Patrons¶
Script path: misc/cronjobs/delete_patrons.pl
Does: Deletes patron records in batch based on date not borrowed since, expired before, last seen, category code, or library branch.
Instrument à cordes frottées, non précisé¶
Script path: misc/cronjobs/delete_expired_opac_registrations.pl
Does: Deletes patron registrations that were submitted via the OPAC but not reviewed by the library within the number of days entered in the PatronSelfRegistrationExpireTemporaryAccountsDelay preference.
Périodicité préconisée : chaque jour
Unconfirmed Registrations¶
Script path: misc/cronjobs/delete_unverified_opac_registrations.pl
Does: Deletes patron self registrations that were submitted via the OPAC but not confirmed via email within 24 hours. This is only necessary if you are requiring patrons to confirm their registrations via email with the PatronSelfRegistrationVerifyByEmail preference.
Périodicité préconisée : chaque jour
Anonymize Patron Data¶
Script path: misc/cronjobs/batch_anonymise.pl
Fonction: utilisé pour anonymiser les données d'un adhérant. Ceci enlèvera les borrowernumbers de l'historique de circulation, de sorte que les statistiques sont conservées mais que les informations de l'adhérant soit retirées.
Changement de type d'utilisateur: enfant à adulte¶
Chemin du fichier : misc/cronjobs/fines.pl
Fonction: Converti les adhérents juvéniles/enfant de la catégorie juvénile avec leur code de catégorie le type de catégorie adule, en changeant le code une fois qu'ils atteignent la limite d'âge définie dans les préférences de catégories d'adhérents.
Périodicité préconisée : chaque jour
DESCRIPTION
This script is designed to update patrons from juvenile to adult patron types, remove the guarantor, and update their category codes appropriately when they reach the upper age limit defined in the Patron Categories.
USAGE EXAMPLES
"juv2adult.pl"
"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> (Processes a single branch, and updates the patron categories from category to category)
"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n (Processes all branches, shows all messages, and reports the patrons who would be affected. Takes no action on the database)
Notifications¶
File des messages¶
Script path: misc/cronjobs/process_message_queue.pl
Does: processes the message queue to send the check out, check in and hold filled emails and SMS message to users and sends outgoing emails to patrons. requires EnhancedMessagingPreferences to be on
Périodicité préconisée : toutes les 15 mn
Important
Item due and Advanced due notices are controlled by the advance_notices cron.
2 = préavis de rappel¶
Script path: misc/cronjobs/advance_notices.pl
Does: prepares "pre-due" notices and "item due" notices for patrons who request them prepares notices for patrons for items just due or coming due soon. requires EnhancedMessagingPreferences to be on
Périodicité préconisée : chaque jour
Note
This script does not actually send the notices. It queues them in the message queue for later
ODUE (Notification de retard)¶
Script path: misc/cronjobs/overdue_notices.pl
Fonction : prépare les messages de retard pour les usagers (à la fois en version email et imprimée)
Périodicité préconisée : chaque jour
Note
This script does not actually send the notices. It queues them in the message queue for later or generates the HTML for later printing
See also
The misc/cronjobs/advance_notices.pl program allows you to send messages to patrons in advance of their items becoming due, or to alert them of items that have just become due.
Print Overdues¶
Script path: misc/cronjobs/printoverdues.sh
Does: generates PDF files from HTML files in directories and prints them
Print Hold Notices¶
Script path: misc/cronjobs/gather_print_notices.pl
Does: looks through the message queue for hold notices that didn't go through because the patron didn't have an email address and generates a print notice
Périodicité préconisée : chaque jour
Talking Tech¶
Pour apprendre plus à propos de la configuration de ce produit tiers-parti, voir le Talking Tech Appendix.
Envoyer un fichier de notices¶
Script path: misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl
Does: Script to generate Spec C outbound notifications file for Talking Tech i-tiva phone notification system.
Required by: TalkingTechItivaPhoneNotification
Périodicité préconisée : chaque jour
Receiving Notices File¶
Script path: misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl
Does: Script to process received Results files for Talking Tech i-tiva phone notification system.
Required by: TalkingTechItivaPhoneNotification
Périodicité préconisée : chaque jour
Notify Patrons of Expiration¶
Script path: misc/cronjobs/membership_expiry.pl
Does: Sends messages to warn patrons of their card expiration to the messaage queue cron.
Requires: MembershipExpiryDaysNotice
Périodicité: chaque soir
In Processing/Book Cart¶
Script path: misc/cronjobs/cart_to_shelf.pl
Does: Updates all items with a location of CART to the item's permanent location.
Required by: NewItemsDefaultLocation, InProcessingToShelvingCart, & ReturnToShelvingCart system preferences
Périodicité préconisée : chaque jour
Catalogue¶
Import Webservice Batch¶
Script path: misc/cronjobs/import_webservice_batch.pl
Does: A cron job for processing import bach queues of type 'webservice'. Batches can also be processed through the UI.
Note
This script is used for OCLC Connexion
Connexion Import Daemon¶
Script path: misc/bin/connexion_import_daemon.pl
Does: A daemon that listens for OCLC Connexion requests and is compliant with OCLC Gateway specification. It takes requests with MARC XML and import batch parameters from a configuration file and forwards it to svc/import_bib
Note
This script is used for OCLC Connexion
Batch Item Deletion¶
Script path: misc/cronjobs/delete_items.pl
Does: A batch item deletion tool, which generates a query against the items database and deletes the items matching the criteria specified in the command line arguments.
Check URL Quick¶
Script path: misc/cronjobs/check-url-quick.pl
Does: Check URLs from biblio records.
Note
This script replaces the check-url.pl script
Retour¶
Chemin du fichier : misc/cronjobs/fines.pl
Fonction: vérifie les URL des champs 856$. La production du script peut maintenant être formattée en CSV ou HTML. La version HTML est lié directement avec l'édieur de notices.
Périodicité préconisée : chaque jour
Learn more: http://wiki.koha-community.org/wiki/Check-url_enhancements
Delete Records via Leader¶
Script path: misc/cronjobs/delete_records_via_leader.pl
Does: Attempt to delete any MARC records where the leader character 5 equals 'd'
Modifier des autorités¶
Script path: misc/cronjobs/merge_authorities.pl
Permission d'accéder à la gestion des notices d'autorité
Note
The name of this script is misleading. This script does not merge authorities together it instead merges authority data with linked bib records. Edits to authority records will be applied to bibliographic records that use that authority when this script is run.
Required by: dontmerge system preference
Périodicité préconisée : chaque jour
Abonnement(s) mis à jour :¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: checks if there is a "late" issue on active subscriptions, and if there is, the script will set it as late, and add the next one as expected.
Périodicité préconisée : chaque jour
Automatic item update¶
Script path: misc/cronjobs/automatic_item_modification_by_age.pl
Does: updates items based on the list of rules set forth in the Automatic item modifications by age tool
Required by: Automatic item modifications by age
Frequency suggestions: nightly
OPAC¶
Flux RSS¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: Produces an RSS XML document for any SQL query (not used for search results RSS feed). Learn more.
Périodicité préconisée : chaque jour
Autorités à fusionner¶
Script path: misc/cronjobs/build_browser_and_cloud.pl
Fonction: Génère du contenu pour les authorité dans l'OPAC.
Required by: OpacBrowser system preference
Important
Cette préférence et job de Cron devraient être seulement utilisés dans des systèmes Français.
Nuage de sujets¶
Chemin du fichier : misc/cronjobs/fines.pl
Fonction: Génères des mots-clef HTML à partir des index de Koha et Zebra. misc/cronjobs/cloud-sample.conf en tant qu'exemple de la façcon dont ce scriptes opères.
Fréquence: Ceci est le type de scripte qui s'active une fois par mois ou environ,et le contenu généré
Administration du système¶
Services Throttle¶
Script path: misc/cronjobs/services_throttle.pl
Does: resets the xISBN services throttle
Périodicité préconisée : chaque jour
Clean up Database¶
Script path: misc/cronjobs/cleanup_database.pl
Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs and staged MARC files.
Acquisitions¶
Clean up old suggestions¶
Script path: misc/cronjobs/purge_suggestions.pl
Does: Removes old (defined by you) suggestions from the suggestion management area.
Email suggestions to process¶
Script path: misc/cronjobs/notice_unprocessed_suggestions.pl
Fonction: génère une notification au propriétaire du fond, pour indiquer qu'il y a des suggestions en demande de traitement.
EDI Message Processing¶
Script path: misc/cronjobs/edi_cron.pl
Fonction: Envoi et reçois des messages EDI
Périodicité préconisée : toutes les 15 minutes
Remove Temporary EDI Files¶
Script path: misc/cronjobs/remove_temporary_edifiles.pl
Does: removes temporary EDI files that are older than 5 days
Norwegian patron database¶
NL sync to Koha¶
Script path: misc/cronjobs/nl-sync-to-koha.pl
Does: sync patrons from the Norwegian national patron database (NL) to Koha
Note Relies on NorwegianPatronDBUsername and NorwegianPatronDBPassword system preferences
NL sync from Koha¶
Script path: misc/cronjobs/nl-sync-from-koha.pl
Does: sync patrons from Koha to the Norwegian national patron database (NL)
Note Relies on NorwegianPatronDBUsername and NorwegianPatronDBPassword system preferences
Supprimer abonnement¶
Il n'y a pas de modification d'adhérent en attente.
Script path: misc/cronjobs/update_items.pl
Chemin du fichier : misc/cronjobs/fines.pl
Chemin du fichier : misc/cronjobs/fines.pl
Chemin du fichier : misc/cronjobs/fines.pl
Script path:misc/cronjobs/zebraqueue_start.pl
Social data¶
Get report social data¶
Script path: misc/cronjobs/social_data/get_report_social_data.pl
Does: downloads data from Babelthèque to add to OPAC records
Périodicité préconisée : chaque jour
Update social data¶
Script path: misc/cronjobs/social_data/update_social_data.pl
Does: updates OPAC records with Babelthèque social data