Cron jobs and Daemons¶
Koha is supported by a number of background tasks. These tasks can either be periodically executed tasks (cron jobs) or continuously running task called daemons.
A cron job is a Linux command for scheduling a command or script on your server to complete repetitive tasks automatically. Scripts executed as a cron job are typically used to modify files or databases; however, they can perform other tasks that do not modify data on the server, like sending out email notifications.
A daemon is a Linux command that is typically started when the system is booted and runs in the background doing some function. The database used by Koha (either mysql or mariadb) is a daemon as is the webserver (typically Apache).
Koha has many cron jobs in place that you can enable (search engine indexing, overdue notice generation, data cleanup and more), and a few daemons. This chapter will explain those for you.
Exemple de crontab¶
Un exemple de crontab Koha se trouve dans 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/.
Sauvegarde¶
Daily backup¶
Chemin du script : misc/cronjobs/backup.sh
Does: creates a daily backup of the Koha database.
Périodicité préconisée : chaque jour
Rechercher¶
Carte du site¶
Chemin du script : 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/
Rebuild index¶
Chemin du script : misc/migration_tools/rebuild_zebra.pl
Does: updates Zebra indexes with recently changed data.
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é
Note On newer Koha installations, this cron job has been replaced by the koha-indexer daemon which indexes new and modified Koha data every 30 seconds.
Circulation¶
Holds queue¶
Chemin du script : misc/cronjobs/holds/build_holds_queue.pl
Does: updates holds queue report
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.
Si vous ne voulez pas que toutes vos sites participent au processus de réservation en rayon, vous devez répertorier ici les sites qui *participent* au processus en saisissant leurs codes (branchcodes), séparés par des virgules (par ex. « MPL, CPL, SPL, BML », etc).
La file d’attente des réservation sera générée par défaut de manière à ce que le système gère d’abord les réservations disponibles sur le site de retrait. S’il n’y a pas d’exemplaire disponible sur le site de retrait pour établir la liste des réservations, build_holds_queue.pl utilisera la liste des bibliothèques définie dans StaticHoldsQueueWeight. Si RandomizeHoldsQueueWeight est désactivé (il l’est par défaut), le script assignera les demandes de traitement dans l’ordre des autre sites indiqués dans la préférence système StaticHoldsQueueWeight.
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.
Il est contre-indiqué de laisser StaticHoldsQueueWeight vide pour le moment. Cela force le script build_holds_queue à ignorer RandomizeHoldsQueueWeight, les demandes sont alors assignées aux sites non pas aléatoirement, mais par ordre alphabétique.
Expired holds¶
Chemin du script : misc/cronjobs/holds/cancel_expired_holds.pl
Does: cancels holds where the user has set an expiration date. If the library is using the Permettre 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
Unsuspend holds¶
Chemin du script : misc/cronjobs/holds/auto_unsuspend_holds.pl
Does: checks to find holds that should no longer be suspended and removes the suspension if the Réactiver toutes les réservations suspendues 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¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: calculates and posts fines to patron accounts.
Requis par : finesMode system preference
Périodicité préconisée : chaque jour
Amendes fixes¶
Chemin du script : misc/cronjobs/staticfines.pl
Does: 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.
Long overdues¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: allows one to specify delays for changing items to different lost statuses, and optionally charge for them using the replacement price listed on the item record.
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¶
Chemin du script : 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
Attention
If the time on your database server does not match the time on your Koha server you will need to take that into account, and probably use the –since argument instead of the –interval argument for incremental updating.
Note
This cronjob can be used if there is a performance concern. Otherwise, use the UpdateTotalIssuesOnCirc System Preference.
Generate patron file for offline circulation¶
Chemin du script : 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
Renouvellement automatique¶
Chemin du script : misc/cronjobs/automatic_renewals.pl
Does: renews items if you’re allowing automatic renewal with your circulation and fines rules.
Périodicité préconisée : chaque jour
Utilisateurs¶
Batch delete patrons¶
Chemin du script : 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.
Note
Dates should be in ISO format, e.g., 2013-07-19, and can be generated with date -d “-3 month” « +%Y-%m-%d ».
Important
The options to select the patron records to delete are cumulative. For example, supplying both –expired_before and –library specifies that patron records must meet both conditions to be selected for deletion.
PARAMETERS
- –not_borrowed_since Delete patrons who have not borrowed since this date.
- –expired_before Delete patrons with an account expired before this date.
- –last_seen Delete patrons who have not been connected since this date. The system preference TrackLastPatronActivity must be enabled to use this option.
- –category_code Delete patrons who have this category code.
- –library Delete patrons in this library.
- -c|–confirm This flag must be provided in order for the script to actually delete patron records. If it is not supplied, the script will only report on the patron records it would have deleted.
- -v|–verbose Verbose mode.
Unverified registrations¶
Chemin du script : 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¶
Chemin du fichier : 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¶
Chemin du script : misc/cronjobs/batch_anonymise.pl
Does: removes borrowernumbers from circulation history so that the stats are kept, but the patron information is removed for privacy reasons.
Update child to adult patron type¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: converts juvenile/child patrons from juvenile patron category and category code to corresponding adult patron category and category code when they reach the upper age limit defined in the Patron Categories.
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¶
Message queue¶
Chemin du script : 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.
Advanced notice¶
Chemin du script : 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
Overdue notice¶
Chemin du script : misc/cronjobs/overdue_notices.pl
Does: prepares messages to alert patrons of overdue messages (both via email and print)
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
Voir aussi
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¶
Chemin du fichier : misc/cronjobs/printoverdues.sh
Does: generates PDF files from HTML files in directories and prints them
Print hold notices¶
Chemin du script : 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¶
To learn more about setting up this third party product view the Talking Tech chapter.
Notify patrons of expiration¶
Chemin du script : misc/cronjobs/membership_expiry.pl
Does: sends messages to warn patrons of their card expiration to the message queue cron.
Requiert : MembershipExpiryDaysNotice
Périodicité: chaque soir
In processing/book cart¶
Chemin du script : 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, and ReturnToShelvingCart system preferences
Périodicité préconisée : chaque jour
Catalogue¶
Import webservice batch¶
Chemin du script : misc/cronjobs/import_webservice_batch.pl
Does: processes 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¶
Chemin du script : misc/bin/connexion_import_daemon.pl
Does: 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¶
Chemin du script : misc/cronjobs/delete_items.pl
Does: generates a query against the items database and deletes the items matching the criteria specified in the command line arguments.
PARAMETERS
- –verbose Send the « WHERE » clause generated by the collected C<–where> arguments, as well as items affected to Standard Out.
- –where The C<–where> option may called multiple times. The following argument must be a syntactically valid SQL statement which is part of the C<WHERE> clause querying the items table. These are joined by C<AND>.
- –commit No items will be deleted unless the C<–commit> flag is present.
EXAMPLES
The following are examples of this script:
delete_items.pl –where « items.withdrawn ! 0 » –where « items.withdrawn_on < $(date –date= »13 month ago » –rfc-3339=date) » –commit
delete_items.pl –where « itemlost >= “1” » –where « itemlost <=”4” » –where « itemlost_on < “2014-04-28” » –commit
Check URL quick¶
Chemin du script : misc/cronjobs/check-url-quick.pl
Does: checks URLs from biblio records; scans all URLs found by default in 856$u of bibliographic records and displays if resources are available or not.
Note
This script replaces the check-url.pl script
PARAMETERS
–host=http://default.tld Server host used when URL doesn’t have one, ie doesn’t begin with “http:”. For example, if –host=mylib.com, then when 856$u contains “img/image.jpg”, the url checked is: http://www.mylib.com/image.jpg.
–tags Tags containing URLs in $u subfields. If not provided, 856 tag is checked. Multiple tags can be specified, for example:
check-url-quick.pl –tags 310 410 856
–verbose|v Outputs both successful and failed URLs.
–html Formats output in HTML. The result can be redirected to a file accessible by http. This way, it’s possible to link directly to the bibliographic record in edit mode. With this parameter –host-intranet is required.
–host-intranet=http://koha-pro.tld Server host used to link to bibliographic record editing page in Koha intranet interface.
–timeout=10 Timeout for fetching URLs. By default 10 seconds.
–maxconn=1000 Number of simulaneous HTTP requests. By default 200 connexions.
Retour¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: checks URLs in 856$u field. Script output can now be formatted in CSV or HTML. The HTML version links directly to MARC biblio record editor.
Périodicité préconisée : chaque jour
Pour en savoir plus : http://wiki.koha-community.org/wiki/Check-url_enhancements
Delete records via leader¶
Chemin du script : misc/cronjobs/delete_records_via_leader.pl
Does: attempts to delete any MARC records where the leader character 5 equals “d”.
PARAMETERS
- -c|–confirm Script will do nothing without this parameter
- -v|–verbose Verbose mode
- -t|–test Test mode, does not delete records. Test mode cannot determine if a record/item will be deleted successfully, it will only tell you what records and items the script will attempt to delete.
- -i|–delete-items Try deleting items before deleting record. Records with items cannot be deleted.
Update authorities¶
Chemin du script : misc/cronjobs/merge_authorities.pl
Does: updates biblio data with changes to authorities records
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: AuthorityMergeLimit system preference
Périodicité préconisée : chaque jour
Serials update¶
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
Mise à jour automatique d’exemplaire¶
Chemin du script : misc/cronjobs/automatic_item_modification_by_age.pl
Does: updates items based on the list of rules set forth in the Modification automatique d’exemplaires en fonction de l’age tool
Nécessaire pour Modification automatique d’exemplaires en fonction de l’age
Périodicité préconisée : chaque nuit
OPAC¶
RSS feeds¶
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
Authorities browser¶
Chemin du script : misc/cronjobs/build_browser_and_cloud.pl
Does: generates content for authorities browse in OPAC
Requis par : OpacBrowser system preference
Important
This preference and cron job should only be used on French systems.
Subject/author clouds¶
Chemin du fichier : misc/cronjobs/fines.pl
Does: generates HTML keywords clouds from Koha Zebra indexes. misc/cronjobs/cloud-sample.conf has a sample of how this script operates.
Frequency: This is the type of script you can run once a month or so, the content generated isn’t going to change very much over time.
System administration¶
Services throttle¶
Chemin du script : misc/cronjobs/services_throttle.pl
Does: resets the xISBN services throttle
Périodicité préconisée : chaque jour
Clean up database¶
Chemin du script : misc/cronjobs/cleanup_database.pl
Does: truncates the sessions table, cleans out old zebraqueue entries, action logs and staged MARC files.
Acquisitions¶
Nettoie les vieilles suggestions¶
Chemin du script : misc/cronjobs/purge_suggestions.pl
Does: removes old (defined by you) suggestions from the suggestion management area.
Note
The system preference PurgeSuggestionsOlderThan defines the number of days used in the script
Courriel de suggestions à traiter¶
Chemin du script : misc/cronjobs/notice_unprocessed_suggestions.pl
Does: generates a notice to the fund owner that there are suggestions in need of processing
EDI message processing¶
Chemin du script : misc/cronjobs/edi_cron.pl
Does: sends and received EDI messages
Périodicité préconisée : toutes les 15 minutes
Remove temporary EDI files¶
Chemin du script : misc/cronjobs/remove_temporary_edifiles.pl
Does: removes temporary EDI files that are older than 5 days
Bilans et statistiques¶
Run report¶
Chemin du script : misc/cronjobs/runreport.pl
Does: runs pre-existing saved reports
PARAMETERS
- -v|–verbose Verbose output
- –format=s Selects format. Choice of text, html, csv or tsv
- -e|–email Whether or not to use e-mail (implied by –to or –from)
- -a|–attachment Attach the report as a file. Cannot be used with html format
- –username Username to pass to the SMTP server for authentication
- –password Password to pass to the SMTP server for authentication
- –method The type of authentication. Ie. LOGIN, DIGEST-MD5, etc.
- –to=s E-mail address to send report to
- –from=s E-mail address to send report from
- –subject=s Subject for the e-mail
- –store-results Store the result of the report
- –csv-header Add column names as first line of csv output
ARGUMENTS
- reportID Report ID Number from saved_sql.id, multiple ID’s may be specified
Import les données des adhérents¶
NL sync to Koha¶
Script path: misc/cronjobs/nl-sync-to-koha.pl
Does: syncs 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: syncs patrons from Koha to the Norwegian national patron database (NL)
Note Relies on NorwegianPatronDBUsername and NorwegianPatronDBPassword system preferences
Daemons¶
Daemons are continuously running tasks that help support Koha operation. Your database and webserver are run as daemons. Newer versions of Koha start two different daemons for most koha instances:
- zebra - this is the index server
- koha-indexer - this daemon updates the index server with new and modified data (biblios and authorities)
These daemons are started by the script /etc/init.d/koha-common.
Zebra indexer daemon¶
Script path: /usr/sbin/koha-indexer (invoked from /etc/init.d/koha-common)
The koha-indexer script invokes rebuild_zebra.pl in daemon mode. In this mode, the script will run continuously and check the database for new or modified data every 30 seconds. New or modified records are then sent to Zebra for indexing, which only takes a second or so. The advantage of this approach is a search system which is much more responsive to changes, compared to the :ref:”cron job approach <_rebuild-index-label>”.
Supprimer abonnement¶
Il n’y a pas de modification d’adhérent en attente.
Chemin du script : 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
Chemin du script : 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