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 tasks 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 web server (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.

Crontab example

An example of a Koha crontab can be found in misc/cronjobs/crontab.example

The example includes sample boilerplate cron job entries for the most commonly-used cron jobs.

Cron jobs

The locations in the documentation assume a development install where files are found in misc/ relative to the git root checkout. If you have installed using Debian packages or the standard install from source, you will want to look for files in /usr/share/koha/bin/.

Other locations are possible with other installation methods. You can perform a simple find search if they are not located in these directories.

Nota

For anyone with shell access using Debian packages, the following command is an easy way to find files installed by a Debian package:

dpkg -L koha-common

This provides a comprehensive listing of the files installed by the koha-common package. You can then easily find the file from there.

Backup

Daily backup

Script path: misc/cronjobs/backup.sh

Does: creates a daily backup of the Koha database.

Frecuencia sugerida: diaria

Buscar

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/

Rebuild index

Ruta del script: misc/migration_tools/rebuild_zebra.pl

Does: updates Zebra indexes with recently changed data.

Requerido por: Zebra

Frecuencia sugerida: cada x minutos, (entre 5-15 minutos), dependiendo de las necesidades de rendimiento

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.

Circulación

Fila de reservas

Ruta del script: misc/cronjobs/holds/build_holds_queue.pl

Qué hace: actualiza el informe de fila de reservas

Requerido por: Informe de fila de reservas

Frecuencia sugerida: cada 1-4 horas

Descripción:

• Un script que se debe ejecutar periódicamente si su sistema de bibliotecas permite a los usuarios hacer reservas. Este script decide qué biblioteca debe ser responsable del cumplimiento de una solicitud de reserva dada.

  Su comportamiento está controlado por las preferencias del sistema StaticHoldsQueueWeight y RandomizeHoldsQueueWeight.

  Si no desea que todas las bibliotecas participen en el proceso de satisfacer reservas, se deberán incluir las bibliotecas que *sí* participan introduciendo los códigos de sucursal de todas las bibliotecas participantes, separados por comas ( por ejemplo «MPL,CPL,SPL,BML» etc. ).

  Por defecto, la fila de reservas será generada de forma que el sistema intentará primero cubrir las reservas utilizando ejemplares disponibles en la biblioteca de retiro de ser posible. Si no hay ejemplares disponibles para cubrir la reserva, build_holds_queue.pl utilizará la lista de bibliotecas definida en StaticHoldsQueueWeight. Si RamdomizeHoldsQueueWeight está deshabilitada (comportamiento por defecto), el script asignara los pedidos de cobertura en el orden de ubicación de las sucursales en la preferencia del sistema StaticHoldsQueueWeight.

  Por ejemplo, si su sistema cuenta con tres bibliotecas, de diferentes tamaños ( pequeño, mediano y grande ) y quiere que la carga de cumplimiento esté en las bibliotecas más grandes más que en las bibliotecas más pequeñas, usted querría que StaticHoldsQueueWeight fuese algo así «LRG,MED,SML».

  Si quiere que la carga de cumplimiento se extienda por igual por todas las bibliotecas del sistema, sólo tiene que activar RandomizeHoldsQueueWeight. Cuando esta preferencia del sistema está activada, el orden en el que las bibliotecas se les pedirá que satisfagan una reserva se asignará aleatoriamente cada vez que se vuelve a generar la lista.

Expired holds

Ruta del 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 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.

It is possible to add a cancellation reason with the –reason parameter. Use the cancellation code from the HOLD_CANCELLATION authorized value category

Frecuencia sugerida: diaria

Unsuspend holds

Ruta del 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 AutoResumeSuspendedHolds preference is set to “allow”. This puts the patron back in to the queue where they were when the hold was suspended.

Frecuencia sugerida: diaria

Multas

Ruta del script: misc/cronjobs/fines.pl

Does: calculates and charges (or increments) overdue fines per item to patron accounts. The fine calculation is done using the grace period, fine interval, fine amount and other parameters from the circulation and fines rules.

Required by: finesMode system preference

Frecuencia sugerida: todas las noches

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 will not be applied on a holiday.

PARAMETERS - -h|–help

• get help message

• -l|–log

  • log the output to a file (optional if the -o parameter is given)

• -o|–out

  • output directory for logs (defaults to env or /tmp if the directory does not exist)

• -v|–verbose

  • verbose mode

• -m|–maxdays

  • how many days back of overdues to process

  • this can improve performance by simply the number of records that need to be processed. It can be safe to limit the overdues processed to those under X days overdues given that circulation policy often caps fines at a maximum after a number of days.

Static fines

Script path: misc/cronjobs/staticfines.pl

Does: charges a single static fine for any/all overdues a patron currently has outstanding. The charge amount is either defined on the command line per borrower category or will use the circulation rules associated with the oldest overdue item the patron has currently checked out (for the first fine period only) Once charged, the fine is static: No new fines will be added until the existing fine is paid off in full.

Frecuencia sugerida: todas las noches

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.

Batch writeoff charges

Script path: misc/cronjobs/writeoff_debts.pl

Does: writes off outstanding charges in patron accounts.

PARAMETERS

Nota

The options to select the debt records to writeoff are cumulative. For example, supplying both --added_before and --type specifies that the accountline must meet both conditions to be selected for writeoff.

Nota

You must use at least one of the filtering options for the script to run. This is to prevent an accidental “writeoff all” operation.

• -h | --help

  • Displays help message.

• -v | --verbose

  • Verbose output.

• --added-before

  • Write off charges added before the specified date.

  • Dates should be in ISO format, e.g., 2013-07-19, and can be generated with date -d '-3 month' --iso-8601.

• --added-after

  • Write off charges added after the specified date.

  • Dates should be in ISO format, e.g., 2013-07-19, and can be generated with date -d '-3 month' --iso-8601.

  Version

  The --added-after parameter was added in Koha version 23.11.

• --category-code

  • Write off charges of patrons belonging to the specified categories.

  • Repeatable.

  Version

  The --category-code parameter was added in Koha version 23.11.

• --type

  • Write off charges of the specified type.

  • Accepts a list of debit type codes.

• --file

  • Write off charges passed as one accountlines_id per line in this file.

  • If other criteria are defined it will only writeoff those in the file that match those criteria.

• --confirm

  • This parameter is needed to actually writeoff the charges.

  • Running the script without this parameter will only output which charges would have been written off.

USAGE EXAMPLES

writeoff_debts.pl --added_after 2023-06-20 --confirm

Will write off charges added after 2023-06-20.

writeoff_debts.pl --added_before `date -d '-3 month' --iso-8601` --category-code K --confirm

Will write off charges older than 3 months for patrons in the “K” category.

Restrict patrons with fines

Version

This script was added to Koha in version 23.11.

Script path: misc/cronjobs/debar_patrons_with_fines.pl

Does: Adds a manual restriction to patrons with more than X amount in unpaid charges.

Frequency suggestion: nightly or depending on needs

PARAMETERS

• -h | --help

  • Displays the help message.

• -a | --amount

  • Minimum amount the patron owes in order to be restricted.

  • Defaults to 0, meaning anyone who owes anything will be restricted.

• -m | --message

  • Message to be added as the restriction comment.

• -f | --messagefile

  • File that contains the message to be added as the restriction comment.

• -e | --expiration

  • Expiration date for the restriction.

• -c | --confirm

  • Use this parameter to confirm the changes.

  • Without this parameter, no patrons will be restricted.

• -v | --verbose

  • Shows which patrons are affected.

USAGE EXAMPLES

debar_patrons_with_fines.pl -a 5 -m "Fines" -v

Will show which patrons have more than 5 in unpaid fees, but will not actually restrict them (missing --confirm parameter).

debar_patrons_with_fines.pl -a 5 -m "Fines" -e '2024-12-31' -v -c

Will restrict patrons who owe more than 5, the restriction will have the comment «Fines» and will expire on 2024-12-31. The script output will also show which patrons were restricted.

Long overdues

Ruta del script: misc/cronjobs/longoverdue.pl

Qué hace: permite especificar los retrasos para que los ítems cambien a estado de perdidos, y opcionalmente cobrar el precio de sustitución en el registro del ítem.

Frecuencia sugerida: todas las noches

Nota

Staff can control some of the parameters for the longoverdue cron job with the DefaultLongOverdueLostValue and DefaultLongOverdueDays, DefaultLongOverdueSkipLostStatuses, DefaultLongOverdueChargeValue, DefaultLongOverduePatronCategories, and DefaultLongOverdueSkipPatronCategories system preferences.

PARAMETERS

• -l | --lost

  • This option takes the form of n=lv, where n is the number of days overdue, and lv is the value from the LOST authorized value category the item should be set to after the number of days.

  • The DefaultLongOverdueLostValue and DefaultLongOverdueDays system preferences can be used to set these two values from the staff interface instead of from the cron job directly. If the system preferences are set, there is no need to use the --lost parameter.

• -c | --charge

  • This specifies which lost status triggers Koha to charge the item’s replacement cost to the patron.

  • The DefaultLongOverdueChargeValue system preference can be used to set the value from the staff interface instead of from the cron job directly.

  • If neither the --charge parameter nor the DefaultLongOverdueChargeValue are set, the long overdue process will not charge the patron for the lost item.

• --confirm

  • This parameter is required for the script to change values. Without this option, the script will report the number of affected items without modifying any records.

• -v | --verbose

  • This parameter prints out the number of affected items.

• --quiet

  • This parameter suppresses the regular output.

• --maxdays

  • This parameter specifies the end of the range of overdue days to deal with.

  • If this parameter is not specified, it defaults to 366.

• --mark-returned

  • This parameter removes the long overdue items from the patrons” checkouts.

  • The MarkLostItemsAsReturned system preference can be used to set this parameter from the staff interface instead of from the cron job directly.

• -h | --help

  • This parameter displays a short help message and exits.

• -man | --manual

  • This parameter displays the entire help message and exits.

• --category

  • This parameter is used to limit the processing to a specific patron category. All other categories will be excluded.

  • This parameter is repeatable to include multiple categories.

  • The DefaultLongOverduePatronCategories system preference can be used to set the categories to be included from the staff interface instead of from the cron job directly.

  Importante

  This parameter cannot be used with --skip-category.

  Similarly, the DefaultLongOverduePatronCategories system preference cannot be used with the DefaultLongOverdueSkipPatronCategories system preference.

• --skip-category

  • This parameter is used to exclude a specific patron category from the process. All other categories will be included.

  • This parameter is repeatable to exclude multiple categories.

  • The DefaultLongOverdueSkipPatronCategories system preference can be used to set the categories to be excluded from the staff interface instead of from the cron job directly.

  Importante

  This parameter cannot be used with --category.

  Similarly, the DefaultLongOverdueSkipPatronCategories system preference cannot be used with the DefaultLongOverduePatronCategories system preference.

• --list-categories

  • This parameter lists the available patron categories which can be used in --category or --skip-category and exits.

• --library

  • This parameter is used to limit the processing to a specific library code. All other libraries will be excluded.

  • This parameter is repeatable to include multiple libraries.

  • The selected libraries follow the CircControl system preference.

  Importante

  This parameter cannot be used with --skip-library.

• --skip-library

  • This parameter is used to exclude a specific library from the process. All other libraries will be included.

  • This parameter is repeatable to exclude multiple libraries.

  • The selected libraries follow the CircControl system preference.

  Importante

  This parameter cannot be used with --library.

• --itemtype

  • This parameter is used to limit the processing to a specific item type code. All other item types will be excluded.

  • This parameter is repeatable to include multiple item types.

  Importante

  This parameter cannot be used with --skip-itemtype.

• --skip-itemtype

  • This parameter is used to exclude a specific item type from the process. All other item types will be included.

  • This parameter is repeatable to exclude multiple item types.

  Importante

  This parameter cannot be used with --itemtype.

• --list-itemtypes

  • This parameter lists the available item type which can be used in --itemtype or --skip-itemtype and exits.

• --skip-lost-value

  • This parameter is used to exclude a specific LOST value from the process. All other values will be included.

  • The DefaultLongOverdueSkipLostStatuses system preference can be used to set the lost values to be excluded from the staff interface instead of from the cron job directly.

USAGE EXAMPLES

misc/cronjobs/longoverdue.pl --lost 30=1 --confirm

Will set the lost status to 1 for all items overdue for more than 30 days (up to 366 days).

misc/cronjobs/longoverdue.pl --lost 60=2 --charge 2 --confirm

Will set the lost status to 2 for all items overdue for more than 60 days (up to 366 days), and charge the patrons the replacement cost.

Seguimiento de total de préstamos

Ruta del 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.

Frecuencia sugerida: todas las noches

Advertencia

Si la hora en su servidor de base de datos no coincide con la hora en el servidor Koha tendrá que tener esto en cuenta, y probablemente utilizar el argumento –since en vez de el argumento –interval para la actualización incremental.

Nota

This cronjob can be used if there is a performance concern. Otherwise, use the UpdateTotalIssuesOnCirc System preference.

Generate patron file for offline circulation

Ruta del script: misc/cronjobs/create_koc_db.pl

Does: generates the borrowers.db file for use with the Koha offline circulation tool

Frecuencia sugerida: semanal

Renovación automática

Ruta del script: misc/cronjobs/automatic_renewals.pl

Does: renews items if you’re allowing automatic renewal with your circulation and fines rules.

Frecuencia sugerida: todas las noches

Importante

To run this properly, you must use the –confirm parameter, otherwise it will only run in test mode

PARAMETERS - -h|–help

• get help message

• –send-notices

  • sends the AUTO_RENEWALS notice to patrons if the automatic renewal has been done

• -v|–verbose

  • verbose mode

• -c|–confirm

  • without this parameter no changes will be made, the script will run in test mode

  • without this parameter, the script will default to verbose mode as well

Automatic checkin

Script path: misc/cronjobs/automatic_checkin.pl

Does: automatically checks in items after the loan period. This is set at the item type level.

Frecuencia sugerida: todas las noches

Nota

Optionally, holds can be filled automatically when items are checked in with this script. This option is enabled with the AutomaticCheckinAutoFill system preference.

Recalls

Expire recalls

Script path: misc/cronjobs/recalls/expire_recalls.pl

Does: automatically marks as expired recalls that

• have been requested, but have not been fulfilled and are past their expiry date

• recalls that have been awaiting pickup longer than the pickup period in the circulation rules or the period set in the RecallsMaxPickUpDelay system preference

Frecuencia sugerida: todas las noches

Overdue recalls

Script path: misc/cronjobs/recalls/overdue_recalls.pl

Does: sets a recalled item as overdue if it hasn’t been returned by the adjusted due date

Frecuencia sugerida: todas las noches

Usuarios

Batch delete patrons

Ruta del 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.

Nota

Dates should be in ISO format, e.g., 2013-07-19, and can be generated with date -d “-3 month” «+%Y-%m-%d».

Importante

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.

  Advertencia

  Patrons who have all their old checkouts anonymized will have an empty circulation history and be deleted if this option is used. Anonymization can happen because the patron has borrowers.privacy = 2, through cronjobs doing anonymization or by the patron choosing to anonymize their history in the OPAC.

• –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.

Anonymize patron data

Ruta del 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 patron categories

Ruta del script: misc/cronjobs/update_patrons_category.pl

Hace: Convertir la categoría de los usuarios igualando el criterio dado a otra categoría de usuarios específicos. Esto se puede usar para convertir usuarios juveniles de una categoría de usuario niño a una categoría de usuario adulto cuando alcancen la edad superior limitada definida en :ref:”categoría de usuario <patron-categories-label>”.

This script replaces the j2a.pl script.

Frecuencia sugerida: todas las noches

DESCRIPTION

This script is designed to update patrons from one category to another using the criteria specified using command line arguments.

PARAMETERS

• –too_old Update, if patron is over the upper age limit of their current patron category.

• –too_young Update, if patron is below the minimum age limit of their patron category.

• –fo=X|–fineover=X Update, if the total fine amount on the patron account is over X.

• –fu=X|–fineunder=X Update, if the total fine amount on the patron account is below X.

• –rb=date|regbefore=date Update, if the registration date of the patron is before the given date.

• –ra=date|regafter=date Update, if the registration date of the patron is after the given date.

• -d –field name=value Update, if the given condition is met. <name> has to be replaced by a column name of the borrowers table. The condition is met, if the the content of the field equals <value>.

• –where <conditions> Update, if the SQL <where> clause is met.

• -v|–verbose Verbose mode: Without this flag only fatal errors are reported.

• -c|–confirm Commits the changes to the database. No changes will be made unless this argument is added to the command.

• -b|–branch <branchcode> Update, if the home branch of the patron matches the <branchcode> given.

• -f|–form <categorycode> Update, if the patron currently has this patron category.

• -t|–to <categorycode> Update the patrons matching the criteria to this patron category.

USAGE EXAMPLES

«update_patrons_category.pl»

«update_patrons_category.pl» -b=<branchcode> -f=<categorycode> -t=<categorycode> -c» (Processes a single branch, and updates the patron categories from category to category)

«update_patrons_category.pl» -f=<categorycode> -t=<categorycode> -v» (Processes all branches, shows all messages, and reports the patrons who would be affected. Takes no action on the database)

Update patrons” messaging preferences

Ruta del script: misc/maintenance/borrowers-force-messaging-defaults.pl

Does: updates patrons” messaging preferences to the default values set in the patron categories.

Messaging preferences defaults are automatically set when adding a new patron or when importing patrons with the patron import tool. However, if you import patrons directly in the database, these messaging preferences will not be set.

There is no suggested frequency. This is a tool to be used when needed, although if you regularly import patrons directly in the database (through a third-party, for example), you can add it to your crontab.

DESCRIPTION

If the EnhancedMessagingPreferences system preference is enabled after borrowers have been created in the DB, those borrowers won’t have messaging transport preferences default values as defined for their borrower category. So you would have to modify each borrower one by one if you would like to send them “Hold Filled” notice for example.

This script creates/overwrites messaging preferences for all borrowers and sets them to default values defined for the category they belong to (unless you use the options -not-expired or -no-overwrite to update a subset).

PARAMETERS

• --help

  • Display help message.

• --doit

  • Update the patrons. The script will not update patrons” messaging preferences without this option. It will only list the patrons who would have been updated.

• --not-expired

  • Only update patrons who are still active (whose files are not yet expired).

• --no-overwrite

  • Only update patrons without any messaging preferences. This option will skip patrons who have already set their preferences.

• --category

  • Only update patrons from the specified category.

  Advertencia

  This option cannot be repeated.

  For example:

  borrowers-force-messaging-defaults.pl --doit --category PT --category B
  

  will only update patrons from category B (the last category specified).

• --library

  • Will only update patrons whose home library matches the given branchcode.

  Version

  The --library parameter was added in Koha version 23.11.

• --message-name

  • Will only update preferences for the specific message.

  • The list of values can be found in installer/data/mysql/mandatory/sample_notices_message_attributes.sql, in message_attributes.message_name in the database, or in the notices and slips tool.

  Version

  The --message-name parameter was added in Koha version 23.11.

• --since

  • Only update patrons enrolled since the specified date.

  Nota

  This option can use specific or relative dates.

  For example:

  borrowers-force-messaging-defaults.pl --doit --since "2022-07-12"
  

  will only update patrons enrolled since July 12, 2022.

  And:

  borrowers-force-messaging-defaults.pl --doit --since `date -d "1 day ago" '+%Y-%m-%d'
  

  will only update patrons enrolled since yesterday.

USAGE EXAMPLES

borrowers-force-messaging-defaults.pl --doit

Updates all patrons to give them the default messaging preferences values from their respective category.

borrowers-force-messaging-defaults.pl --doit --not-expired

Updates all patrons whose memberships are not expired to give them the default messaging preferences values from their respective category.

borrowers-force-messaging-defaults.pl --doit --category PT

Updates all patrons in the PT category to give them the default messaging preferences for that category.

borrowers-force-messaging-defaults.pl --doit --no-overwrite --since "2022-03-01"

Updates patrons who do not have any messaging preferences set and who are enrolled since March 1st, 2022.

borrowers-force-messaging-defaults.pl --doit --no-overwrite --since `date -d "1 day ago" '+%Y-%m-%d'

Updates patrons who do not have any messaging preferences set and who are enrolled since yesterday.

borrowers-force-messaging-defaults.pl --doit --library CPL

Updates patrons whose home library is CPL.

borrowers-force-messaging-defaults.pl --doit --message-name Item_due

Updates preferences for the «Item due» message only.

Avisos

Message queue

Ruta del script: misc/cronjobs/process_message_queue.pl

Does: processes the message queue to send outgoing emails and SMS messages to patrons. Messages are queued in the message queue by other scripts, such as advance_notices.pl, overdue_notices.pl, and holds_reminder.pl.

Nota

Requires that EnhancedMessagingPreferences be set to “Allow”.

Frecuencia sugerida: 1-4 horas

DESCRIPTION

This script processes the message queue in the message_queue database table. It sends out the messages in that queue and marks them appropriately to indicate success or failure. It is recommended that you run this regularly from cron, especially if you are using the advance_notices.pl script.

PARAMETERS

• -u | –username

  • Username of the mail account used to send the notices.

• -p | –password

  • Password of mail account used to send the notices.

• -t | –type

  • If supplied, only processes this type of message. Possible values are

    • email

    • sms

  • Repeatable

• -c | –code

  • If supplied, only processes messages with this letter code.

  • Repeatable.

• -l | –limit

  • The maximum number of messages to process for this run.

• -m | –method

  • Authentication method required by SMTP server (see perldoc Sendmail.pm for supported authentication types).

• -h | –help

  • Help message.

• -v | –verbose

  • Provides verbose output to STDOUT.

• -w | –where

  • Filter messages to send with additional conditions in a where clause.

Advanced notice

Ruta del 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

Frecuencia sugerida: todas las noches

Nota

This script does not actually send the notices. It queues them in the message queue for later

Overdue notice

Ruta del script: misc/cronjobs/overdue_notices.pl

Qué hace: prepara los mensajes para alertar a los usuarios de mensajes de retrasos (ambas vías correo electrónico e impresión)

Frecuencia sugerida: todas las noches

DESCRIPTION

This script creates and queues the overdue notices according to the parameters set in the overdue notice/status triggers tool.

PARAMETERS

• -n | –nomail

  • Do not send any email. Overdue notices that would have been sent to the patrons or to the admin are printed to standard out. CSV data (if the –csv flag is set) is written to standard out or to any CSV filename given.

• –max <days>

  • Maximum days overdue to deal with.

  • Items overdue since longer than max days are assumed to be handled somewhere else, probably the longoverdues script. They are therefore ignored by this script. No notices are sent for them, and they are not added to any CSV files.

  • Defaults to 90 days.

• –library <branchcode>

  • Only deal with overdues from this library.

  • Use the value in the branches.branchcode table.

  • This parameter is repeatable, to process overdues for a group of libraries.

• –csv <filename>

  • Produces a CSV file.

  • If the -n (no mail) flag is set, this CSV data is sent to standard out or to a filename if provided. Otherwise, only overdues that could not be emailed are sent in CSV format to the admin.

• –html <directory>

  • Output html to a file in the given directory.

  • If a patron does not have an email address or if the -n (no mail) flag is set, an HTML file is generated in the specified directory. This can be downloaded or further processed by library staff.

  • The file will be called notices-YYYY-MM-DD.html and placed in the directory specified.

• –text <directory>

  • Output plain text to a file in the given directory.

  • If a patron does not have an email address or if the -n (no mail) flag is set, a text file is generated in the specified directory. This can be downloaded or further processed by library staff.

  • The file will be called notices-YYYY-MM-DD.txt and placed in the directory specified.

• –itemscontent <list of fields>

  • Item information in templates.

  • Takes a comma separated list of fields that get substituted into templates in places of the <<items.content>> placeholder.

  • Defaults to due date,title,barcode,author

  • Other possible values come from fields in the biblio, items and issues tables.

• –borcat <categorycode>

  • Prepare only overdue notices for specified patron categories.

  • This parameter is repeatable, to include several patron categories.

  • Use the value in categories.categorycode.

• –borcatout <categorycode>

  • Do not prepare overdue notices for specified patron categories.

  • This parameter is repeatable, to exclude several patron categories.

  • Use the value in categories.categorycode.

• • t | –triggered

  • This option causes a notice to be generated if and only if an item is overdue by the number of days defined in the overdue notice trigger.

  • By default, a notice is sent each time the script runs, which is suitable for less frequent run cron script, but requires syncing notice triggers with the cron schedule to ensure proper behavior.

  • Add the –triggered option for daily cron, at the risk of no notice being generated if the cron fails to run on time.

• –test

  • This option makes the script run in test mode.

  • In test mode, the script won’t make any changes on the DB. This is useful for debugging configuration.

• –list-all

  • By default, <<items.content>> lists only those items that fall in the range of the currently processing notice.

  • Choose –list-all to include all overdue items in the list (limited by the –max setting).

• –date <yyyy-mm-dd>

  • Emulate overdues run for this date.

• –email <email_type>

  • Specify the type of email that will be used.

  • Can be “email”, “emailpro” or “B_email”.

  • This parameter is repeatable.

• –frombranch

  • Organize and send overdue notices by home library (item-homebranch) or checkout library (item-issuebranch).

  • Defaults to item-issuebranch.

  Nota

  This option is only used if the OverdueNoticeFrom system preference is set to “command-line option”.

USAGE EXAMPLES

«overdue_notices.pl»

(All libraries are processed individually, and notices are prepared for all patrons with overdue items for whom we have email addresses. Messages for those patrons for whom we have no email address are sent in a single attachment to the library administrator’s email address, or to the address in the KohaAdminEmailAddress system preference.)

«overdue_notices.pl -n –csv /tmp/overdues.csv»

(Sends no email and populates /tmp/overdues.csv with information about all overdue items.)

«overdue_notices.pl –library MAIN max 14

(Prepares notices of overdues in the last 2 weeks for the MAIN library.)

Nota

This script does not actually send the notices. It queues them in the message queue to be sent later or generates the HTML for printing.

Nota

See also:

The misc/cronjobs/advance_notices.pl script 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.

The misc/cronjobs/process_message_queue.pl script sends the emails.

Holds reminder

Script path: misc/cronjobs/holds/holds_reminder.pl

Does: prepares reminder messages to be sent to patrons with waiting holds.

EnhancedMessagingPreferences must be set to “Allow”, and patrons must have requested to have this notice (either through the Messaging tab in their online account in the OPAC, if EnhancedMessagingPreferencesOPAC is set to “Show”, or in their messaging preferences in the staff interface).

Frecuencia sugerida: todas las noches

PARAMETERS

• -c | –confirm

  • Confirm flag, no email will be generated if this parameter is not set

• -date <YYYY-MM-DD>

  • Send notices as would have been sent on a specific date

• -days <number of days>

  • Number of days the hold has been waiting

  • If this parameter is not set, a notice will be sent to all patrons with waiting holds

  • Optional parameter

• -holidays

  • Use the calendar exclude holidays from waiting days

• -lettercode <lettercode>

  • Code of the predefined notice to use

  • Optional parameter, the default is HOLD_REMINDER

• -library <branchcode>

  • Only deal with holds from this library

  • This flag is repeatable, to select notices for a group of libraries

• -mtt <message_transport_type>

  • Type of messages to send (email, sms, print)

    • “email” and “sms” will fall back to “print” if the patron does not have an email address/phone number

  • The default is to use the patrons” messaging preferences for the “Hold reminder” notice

  • Passing this parameter will force send even if the patron has not chosen to receive hold reminder notices

  • This can be repeated to send various notices

• -t | –triggered

  • Include only holds <days> days waiting, and not longer

  • If this is not set, the script will send messages for all holds waiting for equal to or more than <days> days

  • This option is useful if the cron is being run daily to avoid spamming the patrons

  • Optional parameter

• -v

  • Verbose

  • Without this flag set, only fatal errors are reported.

  • If verbose is set but not confirm, a list of notices that would have been sent to the patrons are printed to standard out

• -help

  • Brief help message

• -man

  • Full documentation

  EXAMPLES

  The following are examples of this script:

  ::

  holds_reminder.pl -library MAIN -days 14

  prepares notices of holds waiting for 2 weeks for the MAIN library

  ::

  holds_reminder.pl -lettercode LATE_HOLDS -library MAIN -days 14

prepares notices of holds waiting for 2 weeks for the MAIN library, using the “LATE_HOLDS” notice template

Imprimir retrasos

Script path: misc/cronjobs/printoverdues.sh

Does: generates PDF files from HTML files in directories and prints them

Print hold notices

Ruta del script: misc/cronjobs/gather_print_notices.pl

Qué hace: busca en la cola de mensajes avisos de reserva que no pasaron porque el usuario no tenía correo electrónico y genera un aviso impreso

Frecuencia sugerida: todas las noches

Talking Tech

Para obtener más información sobre la configuración de este producto de terceros vea el capítulo Talking Tech

Sending notices file

Ruta del script: misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl

Does: generates Spec C outbound notifications file for Talking Tech i-tiva phone notification system.

Required by: TalkingTechItivaPhoneNotification

Frecuencia sugerida: todas las noches

Receiving notices file

Ruta del script: misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl

Does: processes received results files for Talking Tech i-tiva phone notification system.

Required by: TalkingTechItivaPhoneNotification

Frecuencia sugerida: todas las noches

Notify patrons of expiration

Ruta del script: misc/cronjobs/membership_expiry.pl

Does: sends messages to warn patrons of their card expiration to the message queue cron. Can optionally renew patron accounts as well.

Requires: MembershipExpiryDaysNotice

Frecuencia: mensual

PARAMETERS

• --man

  • Prints the manual page and exits.

• --help

  • Prints a brief help message and exits.

• -v

  • Verbose.

  • Without this flag set, only fatal errors are reported.

• -n

  • Do not send any email. Membership expiry notices that would have been sent to the patrons are printed to standard out.

• -c

  • Confirm flag: Add this option. The script will only print a usage statement otherwise.

• -branch

  • Optional branchcode to restrict the cronjob to that branch.

• -before

  • Optional parameter to extend the selection with a number of days BEFORE the date set by the MembershipExpiryDaysNotice system preference.

• -after

  • Optional parameter to extend the selection with a number of days AFTER the date set by the MembershipExpiryDaysNotice system preference.

  • For example, --before 100 --after 100 will notify patrons who have accounts expiring within a date range of 100 days before and 100 days after the MembershipExpiryDaysNotice system preference.

• -where

  • Use this option to specify a condition. Add «me» (alias) followed by the column name from the borrowers table.

  • Spaces, if necessary, must be escaped by a backslash.

  • Qoutes or double qoutes must be escaped by a backslash.

  • For example:

    • --where="me.categorycode!='YA'" will notify patrons from categories other than “YA”

    • --where="me.categorycode='S'" will notify patrons from the category “S” only

    • --where 'me.lastseenISNOTNULL' will only notify patrons who have been seen.

• -letter

  • Optional parameter to use another notice than the default: MEMBERSHIP_EXPIRY

• -letter_renew

  • Optional parameter to use another renewal notice than the default: MEMBERSHIP_RENEWED

  Version

  The -letter_renew parameter was added in Koha version 23.11.

• -active

  • Followed by a number of months.

  • Optional parameter to include active patrons only (active within passed number of months).

  • This parameter needs the TrackLastPatronActivityTriggers system preference.

  • Cannot be used with -inactive below, the two parameters are mutually exclusive

  Version

  The -active parameter was added in Koha version 23.11.

• -inactive

  • Followed by a number of months.

  • Optional parameter to include inactive patrons only (inactive since passed number of months).

  • This parameter needs the TrackLastPatronActivityTriggers system preference.

  • Cannot be used with -active above, the two parameters are mutually exclusive

  Version

  The -inactive parameter was added in Koha version 23.11.

• -renew

  • Optional parameter to automatically renew patrons instead of sending them an expiry notice.

  • They will be informed by a membership renewal notice (the default MEMBERSHIP_RENEWED or a custom one specified by -letter_renew)

  Version

  The -renew parameter was added in Koha version 23.11.

USAGE EXAMPLES

membership_expiry.pl -c

Will generate MEMBERSHIP_EXPIRY notices for patrons whose membership expires in the number of days set in MembershipExpiryDaysNotice.

membership_expiry.pl -c -renew

Will renew patrons whose membership expires in the number of days set in MembershipExpiryDaysNotice, and generate MEMBERSHIP_RENEWED notices for them.

membership_expiry.pl -c -renew -letter_renew PATRON_RENEWAL

Will renew patrons whose membership expires in the number of days set in MembershipExpiryDaysNotice, and generate the custom «PATRON_RENEWAL» notices for them. A «PATRON_RENEWAL» notice would have to have been created in the notices and slips tool beforehand.

membership\_expiry.pl -c -before 30

Will generate MEMBERSHIP_EXPIRY notices for patrons whose membership expires 30 days before the number of days set in MembershipExpiryDaysNotice.

membership_expiry.pl -c -renew -active 3

Will renew patrons whose membership expires in the number of days set in MembershipExpiryDaysNotice, and who have been active in the last three months («activity» is determined by the TrackLastPatronActivityTriggers system preference), and generate MEMBERSHIP_RENEWED notices for them.

membership_expiry.pl -c -inactive 6 -letter INACTIVE_PATRON

Will generate the custom «INACTIVE_PATRON» notices for patrons whose membership expires in the number of days set in MembershipExpiryDaysNotice, and who have been inactive for the last six months («activity» is determined by the TrackLastPatronActivityTriggers system preference). An «INACTIVE_PATRON» notice would have to have been created in the notices and slips tool beforehand.

In processing/book cart

Ruta del 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, UpdateItemLocationOnCheckin, and UpdateItemLocationOnCheckout system preferences.

Frecuencia sugerida: cada hora

Catálogo

Import webservice batch

Ruta del script: misc/cronjobs/import_webservice_batch.pl

Does: processes import bach queues of type “webservice”. Batches can also be processed through the UI.

Nota

This script is used for OCLC Connexion

Eliminar ítems en lote

Ruta del 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. A lightweight batch deletion tool for items, suitable for running in a cron job.

PARAMETERS

• --help

  • Prints a brief help message.

• --man

  • Prints the manual, with examples.

• --verbose

  • Prints the «WHERE» clause generated by the collected --where arguments, as well as items affected to Standard Out.

  • The item information printed is

    • itemnumber

    • barcode

    • title

• --where

  • The following argument must be a syntactically valid SQL statement which is part of the WHERE clause querying the items table.

  • Repeatable. If there are multiple --where parameters, they will be joined by AND.

• --commit

  • No items will be deleted unless this parameter is present.

USAGE EXAMPLES

delete_items.pl --where "items.withdrawn != 0" --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit

This will delete items where the withdrawn status is not zero AND where the withdrawn date is older than 13 months ago.

delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit

This will delete items where the lost status is between 1 and 4 (inclusively) AND that were lost before 2014-04-28.

Check URL quick

Script path: misc/cronjobs/check-url-quick.pl

Nota

This script replaces the deprecated check-url.pl script

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.

PARAMETERS

• –host=http://default.tld Server host used when URL doesn’t have one, i.e. 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 simultaneous HTTP requests. By default 200 connections.

Delete records via leader

Ruta del 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

Ruta del script: misc/cronjobs/merge_authorities.pl

Does: updates biblio data with changes to authorities records

Nota

El nombre de este script es engañoso. Este script no combina autoridades juntas, en cambio, combina datos de autoridad con registros bibliográficos enlazados. Ediciones a los registros de autoridades serán aplicados a registros bibliográficos que utilizan esas autoridades cuando este script se está ejecutando.

Required by: AuthorityMergeLimit system preference

Frecuencia sugerida: todas las noches

Serials update

Ruta del script: misc/cronjobs/serialsUpdate.pl

Qué hace: comprueba si existe un ejemplar «retrasado» en las suscripciones activas, y si existe, el script lo pondrá como retrasado, y agregará el siguiente como «esperado».

Frecuencia sugerida: todas las noches

Automatic item update

Ruta del script: 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

Frecuencia sugerida: todas las noches

Stock rotation

Script path: misc/cronjobs/stockrotation.pl

Does: moves items from one stock rotation stage to the next, if they are available for processing.

Each library will receive a report with «items of interest» for them for today’s rota checks. Each item there will be an item that should, according to Koha, be located on the shelves of that branch, and which should be picked up and checked in.

Nota

The email sent is based on the SR_SLIP template. It can be customized in the Notices and slips tool.

The item will either:

• have been placed in transit to their new stage library;

• have been placed in transit to be returned to their current stage library;

• have just been added to a rota and will already be at the correct library;

Upon check-in,

• items that need to be transferred elsewhere will be put in transit and a message will pop up requesting the item be sent to their new branch.

• items that are already at the correct library will be checked in and no message will pop up.

Required by: Stock rotation tool

Frecuencia sugerida: todas las noches

PARAMETERS

• -a|–admin-email

  • An address to which email reports should also be sent

  • This is an additional email address to which all email reports will be sent, in addition to sending them to branch email addresses.

• -b|–branchcode

  • Select branch to report on for “email” reports (default: all)

  • If the “email” report is selected, you can use the “branchcode” parameter to specify which branch’s report you would like to see.

  • The default is “all”.

• -x|–execute

  • Actually perform stockrotation housekeeping

  • By default, this script merely reports on the current status of the stock rotation subsystem. In order to actually place items in transit, the script must be run with the “execute” argument.

• -r|–report

  • Select either “full” or “email”

  • The “report” argument allows you to select the type of report that will be emitted.

  • The default is “full”.

  • If the “email” report is selected, you can use the “branchcode” parameter to specify which branch’s report you would like to see.

• -S|–Send-all

  • Send email reports even if the report body is empty

  • This argument causes even reports with an empty body to be sent.

• -s|–send-email

  • Send reports by email

  • This argument causes the script to send reports by email.

• -h|–help

  • Display the help message

OPAC

RSS feeds

Ruta del script: misc/cronjobs/rss/rss.pl

Does: produces an RSS XML document for any SQL query (not used for search results RSS feed). Learn more.

Frecuencia sugerida: cada hora

Authorities browser

Ruta del script: misc/cronjobs/build_browser_and_cloud.pl

Does: generates content for authorities browse in OPAC

Required by: OpacBrowser system preference

Importante

Esta preferencia y el cron job debería aplicarse solo en los sistemas franceses.

Subject/author clouds

Ruta del script: misc/cronjobs/cloud-kw.pl

Does: generates HTML keywords clouds from Koha Zebra indexes. misc/cronjobs/cloud-sample.conf has a sample of how this script operates.

Frecuencia: Este es el tipo de script que usted puede ejecutar una vez al mes o menos, el contenido generado no va a cambiar mucho con el tiempo.

System administration

Services throttle

Ruta del script: misc/cronjobs/services_throttle.pl

Does: resets the xISBN services throttle

Frecuencia sugerida: todas las noches

Clean up database

Ruta del script: misc/cronjobs/cleanup_database.pl

Does: truncates Koha database tables, cleaning out old entries and files. See the Koha database schema for details of each of the tables mentioned in the script parameters.

Frecuencia sugerida: todas las noches

PARAMETERS

• -h or --help

  • Prints a brief help message and exits, ignoring all other options.

• -v or --verbose

  • Verbose mode.

• --confirm

  • Confirm flag: add this option after your other parameters. The script will only print a usage statement otherwise.

• --cards

  • Followed by a number of days.

  • To purge from the creator_batches table any patron card creator batches added before the number of days specified.

• --del-exp-selfreg

  • To delete expired self registration accounts (accounts that haven’t been upgraded from the “temporary” category) from the borrowers table.

  • The number of days for expiry is set in the PatronSelfRegistrationExpireTemporaryAccountsDelay system preference.

  • The temporary patron category is set in the PatronSelfRegistrationDefaultCategory system preference.

• --del-unv-selfreg

  • Followed by a number of days.

  • To delete all unverified self registrations in borrower_modifications older than the number of days specified.

• --deleted-catalog

  • Followed by a number of days.

  • To purge from tables deletedbiblio, deletedbiblio_metadata, deletedbiblioitems and deleteditems any bibliographic records deleted before the number of days specified.

• --deleted-patrons

  • Followed by a number of days.

  • To purge from the deletedborrowers table any patrons deleted before the number of days specified.

• --edifact-messages

  • Followed by a number of days.

  • To purge from the edifact_messages table any EDIFACT messages older than the number of days specified. Messages with the status “new” are exempt and will not be deleted.

  • Defaults to 365 days if no number specified.

• --fees

  • Followed by a number of days.

  • To purge entries in the accountlines table older than the number of days specified, where the amountoutstanding is 0 or NULL.

  • For this parameter, the number of days specified must be greater than or equal to 1.

• import

  • Followed by a number of days.

  • To purge from the import_batches, import_biblios, import_items, import_record_matches and import_records tables any entries older than the number of days specified.

  • In import_batches, the batches that are the result of Z39.50 searches are removed with the --z3950 parameter (see further down).

  • Defaults to 60 days if no number specified.

• --jobs-days

  • Followed by a number of days.

  • To purge all completed background jobs older than the number of days specified.

  • Defaults to 1 day if no number specified.

• --jobs-type

  • Followed by a job type.

  • To specify what type(s) of background jobs will be purged according to --jobs-days.

  • Using --jobs-type all will purge all types.

  • This parameter is repeatable.

  • Defaults to the update_elastic_index type if omitted.

• --labels

  • Followed by a number of days.

  • To purge from the creator_batches table any item label batches added before the number of days specified.

• --list-invites

  • Followed by a number of days.

  • To purge (unaccepted) list share invites from the virtualshelfshares table older than the number of days specified.

  • Defaults to 14 days if no number specified.

• --logs

  • Followed by a number of days.

  • To purge entries from the action_logs table older than the number of days specified.

  • Defaults to 180 days if no number specified.

• --log-module

  • Specify which action_log modules to purge.

  • This option is repeatable.

  • See action logs modules and actions for the module names.

• --preserve-log

  • Specify which action_log modules to exclude.

  • This option is repeatable.

  • See action logs modules and actions for the module names.

• -m or --mail

  • Followed by a number of days.

  • To purge entries from the message_queue table that are older than the number of days specified.

  • Defaults to 30 days if no number specified.

• --merged

  • To purge completed entries from the need_merge_authorities table.

• --messages

  • Followed by a number of days.

  • To purge from the messages table any entries older than the number of days specified.

  • Defaults to 365 days if no number specified.

• --oauth-tokens

  • To delete expired OAuth2 tokens.

• --old-issues

  • Followed by a number of days.

  • To purge from the old_issues table any checkouts of items returned before the number of days specified.

• --old-reserves

  • Followed by a number of days.

  • To purge from the old_reserves table any holds older than the specified number of days.

• --pseudo-transactions

  • To purge entries from the pseudonymized_transactions and pseudonymized_borrower_attributes tables.

  • This parameter can be used in several ways:

    • with a number of days. E.g., using --pseudo-transactions 750 will remove entries older than 750 days.

    • with the --pseudo-transactions-from and / or the --pseudo-transactions-to

      parameter followed by a date in the YYYY-MM-DD format. E.g. using --pseudo-transactions-from 2023-01-01 --pseudo-transactions-to 2023-12-31 will remove entries dated from 1 January 2023 to 31 December 2023.

• --reports

  • Followed by a number of days.

  • To purge from the saved_reports table any data saved before the number of days specified. It concerns the data created by running runreport.pl with the --store-results option.

• --restrictions

  • Followed by a number of days.

  • To purge from the borrower_debarments table any patrons restrictions expired for longer than the specified number of days.

  • Defaults to 30 days if no days specified.

• --all-restrictions

  • To purge all expired patrons restrictions from the borrower_debarments table.

• --return-claims

  • To purge all resolved return claims older than the number of days specified in the system preference CleanUpDatabaseReturnClaims.

• --searchhistory

  • Followed by a number of days.

  • To purge entries from the search_history table older than the number of days specified.

  • Defaults to 30 days if no number specified.

• --sessions

  • To purge the sessions table.

  • If you use this while users are logged into Koha, they will have to login again.

• --sessdays

  • Followed by a number of days.

  • To purge only sessions older than the specified number of days.

• --statistics

  • Followed by a number of days.

  • To purge entries from the statistics tables that are older than the specified number of days.

  Nota

  The statistics table is often used in reports. Make sure you are aware of the consequences before using this parameter.

• --temp-uploads

  • To delete temporary uploads from the uploaded_files table older than the number of days specified in the UploadPurgeTemporaryFilesDays system preference.

• --temp-uploads-days

  • Followed by a number of days.

  • To override the UploadPurgeTemporaryFilesDays system preference value.

• --transfers

  • Followed by a number of days.

  • To purge from the branchtransfers table any transfers completed before the number of days specified .

• --unique-holidays

  • Followed by a number of days.

  • To delete from the special_holidays table any unique holidays older than the number of days specified.

• --uploads-missing

  • Followed by a flag.

  • To delete upload records for missing files when the specified flag is true; and count them otherwise.

• --zebraqueue

  • Followed by a number of days.

  • To purge completed zebraqueue entries older than the number of days specified.

  • Defaults to 30 days if no number specified.

• --z3950

  • To purge records from import tables that are the result of Z39.50 searches.

  • If you are looking to purge all other import information, see the --import parameter above.

USAGE EXAMPLE

cleanup_database.pl --sessdays 7 --zebraqueue --list-invites --temp-uploads --mail 375
--import 375 --logs 200 --searchhistory 60 --del-exp-selfreg --statistics 731
--pseudo-transactions 1827 --deleted-patrons 1 --restrictions 90 --unique-holidays 180 --confirm

This script will:

• delete OPAC sessions for users who last accessed the site over 7 days ago;

• keep the record of zebra reindexes to 30 days;

• expire invitations to view a list shared over 14 days ago;

• clear the temporary uploads according to the UploadPurgeTemporaryFilesDays system preference;

• remove the record of notices sent to patrons when those notices were sent over 375 days ago;

• delete files uploaded for batch import after 375 days (though the bibliographic and item records imported as part of the process will remain);

• clear the logs from any actions performed over 200 days ago;

• remove both patron and staff search history older than 60 days;

• delete patron self-registration requests according to the PatronSelfRegistrationExpireTemporaryAccountsDelay system preference.

• delete transactions stored in the statistics table when they are over 731 days old;

• clear the pseudonymized transactions data that’s older than 5 years;

• fully delete patrons the day following their manual deletion in the Koha staff interface;

• clear the record of patrons” expired restrictions when that restriction has been lifted for over 90 days;

• remove closed days older than 180 days from the calendar.

Share usage stats

Ruta del script: misc/cronjobs/share_usage_with_koha_community.pl

Does: sends your info to the Hea website if you’re sharing information via the UsageStats feature

Frecuencia: mensual

Search for data inconsistencies

Script path: misc/maintenance/search_for_data_inconsistencies.pl

Does: reveals problems in data, such as

• items without home or holding library

• items without item type or with invalid item type

• bibliographic records without item type or with invalid item type

• bibliographic records with invalid MARCXML

• bibliographic records without biblionumber or biblioitemnumber in MARCXML

• bibliographic records without title

• invalid values in fields where the framework limits to an authorized value category

• authority records without authority type or with invalid authority type

• patrons who are too old or too young for their category

Some of these issues can cause problems in circulation or catalog search, so it’s important that they be corrected.

There is no suggested frequency. This is a tool to be used when needed.

Adquisiciones

Limpiar sugerencias antiguas

Ruta del script: misc/cronjobs/purge_suggestions.pl

Does: removes old suggestions from the suggestion management area.

PARAMETERS

• help|?

  Show help message

• days

  Define the age of suggestions to be deleted, based on “managed on” date

  Nota

  The system preference PurgeSuggestionsOlderThan can also be used to define the number of days used in the script. If using the system preference, don’t use the “days” parameter.

  Nota

  The number of days is based on the “managed on” date of the suggestion.

• confirm

  This parameter is mandatory for the script to run.

Email suggestions to process

Ruta del 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

Ruta del script: misc/cronjobs/edi_cron.pl

Does: sends and received EDI messages

Frecuencia sugerida: cada 1-4 horas

Remove temporary EDI files

Ruta del script: misc/cronjobs/remove_temporary_edifiles.pl

Does: removes temporary EDI files that are older than 5 days

E-resource management (ERM)

Harvesting cron job

Script path: /misc/cronjobs/erm_run_harvester.pl

Does: this script will run the SUSHI harvesting for any Active usage data providers set up in the E-resource management module.

Frequency: it is recommended you set it up to run at a regular interval (e.g., every month since providers usually produce statistics data monthly).

PARAMETERS

• --help or -h

  • Prints a help message

• --begin-date

  • Set the start date for the harvest in yyyy-mm-dd format (e.g.: “2023-08-21”)

• --end-date

  • Set the end date for the harvest in yyyy-mm-dd format (e.g.: “2023-08-21”)

• --dry-run

  • Produces a run report, without actually doing anything permanent

• --debug

  • Prints additional debugging information during the run

USAGE EXAMPLE

erm_run_harvester.pl --begin-date 2023-06-21 --debug

Will run the SUSHI harvest for Active usage data providers for the period starting 21 June 2023 to the present date (or to the date for which data is available). Additional debugging information about the way the harvest has run will be displayed.

Informes

Ejecutar informe

Script path: misc/cronjobs/runreport.pl

Does: runs pre-existing saved reports, optionally sends the results by email.

PARAMETERS

• -h | --help

  • Displays help message

• -m | --man

  • Displays full documentation

  • Same as --help --verbose

• -v | --verbose

  • Verbose output

  • Without this parameter, only fatal errors are reported

• --format=s

  • Selects output format

  • Possible values:

    • text

    • html

    • csv

    • tsv

  • At the moment, “text” and “tsv” both produce tab-separated output

  • Defaults to “text”

• -e | --email

  • Send the output by email (implied by --to or --from)

• --send_empty

  • Send the email even if the report returns no results

  Version

  The --send_empty parameter was added in Koha version 23.11.

• -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, i.e. LOGIN, DIGEST-MD5, etc.

• --to=s

  • E-mail address to which to send report results

  • If --email is specified, but --to is not, the address in KohaAdminEmailAddress is used

• --from=s

  • E-mail address from which to send report

  • If --email is specified, but --from is not, the address in KohaAdminEmailAddress is used

• --subject=s

  • Subject for the e-mail

• --param=s

  • Pass value for the runtime parameter

  • Repeatable

  • Provide one --param per runtime parameter requested for the report. Report parameters are not combined as they are on the staff side, so you may need to repeat parameters.

• --separator=s

  • Separator character

  • Only for csv format

  • Defaults to comma

• --quote=s

  • Quote character

  • Only for csv format

  • Defaults to double quote

  • Empty string is allowed

  Version

  The --quote parameter was added in Koha version 23.11.

• --store-results

  • Store the result of the report into the saved_reports database table.

  • To access the results, go to Reports > Guided reports > Saved 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

  • Mandatory

USAGE EXAMPLES

runreport.pl 1

Will output results from report 1 in the terminal (STDOUT).

runreport.pl 1 5

Will output results from reports 1 and 5 in the terminal (STDOUT).

runreport.pl --format html --to admin@myDNSname.org 1

Will send results from report 1 to admin@myDNSname.org in HTML format.

runreport.pl --format html --to admin@myDNSname.org --param CPL --param FICTION 1

Will send results from report 1 to admin@myDNSname.org in HTML format. “CPL” will be passed to the first runtime parameter, and “FICTION” will be passed to the second runtime parameter.

runreport.pl --store-results 1

Will save the report results in the saved_reports database table, and they will be available from the staff interface in Reports > Guided reports > Saved report.

Social data

Get report social data

Ruta del script: misc/cronjobs/social_data/get_report_social_data.pl

Does: downloads data from Babelthèque to add to OPAC records

Frecuencia sugerida: todas las noches

Actualizar datos de redes sociales

Ruta del script: misc/cronjobs/social_data/update_social_data.pl

Does: updates OPAC records with Babelthèque social data

Daemons

Daemons are continuously running tasks that help support Koha operation. Your database and web-server are run as daemons.

Automatically started 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 cron job approach.

Other daemons

These are not started automatically by Koha. You could run them manually, or create your own systemd unit to keep them running.

OCLC Connexion import daemon

Script path: misc/bin/connexion_import_daemon.pl

Does: Listens for requests from OCLC Connexion clients and is compliant with the OCLC Gateway specification.

See Setting up the OCLC Connexion Daemon for more details.

Scripts no aprobados

Éstos no se deberían ejecutar sin modificar:

Ruta del script: misc/cronjobs/update_items.pl

Ruta del script: misc/cronjobs/smsoverdues.pl

Ruta del script: misc/cronjobs/notifyMailsOp.pl

Ruta del script: misc/cronjobs/reservefix.pl

Ruta del script:misc/cronjobs/zebraqueue_start.pl