Frequency suggestion: nightly
**Warning**
-
- Updating immediately increases server load significantly
-
- **Warning**
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
the :ref:`message queue <message-queue-label>` for later or generates the
HTML for later printing
-.. _perl-documentation-overdue-notice-label:
-
-Perl Documentation
-'''''''''''''''''''''''''''''''''''''''''''''''
-
-**NAME**
-
-overdue\_notices.pl - prepare messages to be sent to patrons for overdue
-items
-
-**SYNOPSIS**
-
-overdue\_notices.pl [ -n ] [ -library <branchcode> ] [ -library
-<branchcode>...] [ -max <number of days> ] [ -csv [ <filename> ] ]
-[-itemscontent <field list> ]
-
-Options:
-
--help brief help message
-
--man full documentation
-
--n No email will be sent
-
--max <days> maximum days overdue to deal with
-
--library <branchname> only deal with overdues from this library
-(repeatable : several libraries can be given)
-
--csv <filename> populate CSV file
-
--html <filename> Output HTML to file
-
--itemscontent <list of fields> item information in templates
-
--borcat <categorycode> category code that must be included
-
--borcatout <categorycode> category code that must be excluded
-
-**OPTIONS**
-
--help Print a brief help message and exits.
-
--man Prints the manual page and exits.
-
--v Verbose. Without this flag set, only fatal errors are reported.
-
--n 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 Items older than max days are assumed to be handled somewhere else,
-probably the longoverdues.pl script. They are therefore ignored by this
-program. No notices are sent for them, and they are not added to any CSV
-files. Defaults to 90 to match longoverdues.pl.
-
--library
-
-select overdues for one specific library. Use the value in the
-branches.branchcode table. This option can be repeated in order to
-select overdues for a group of libraries.
-
--csv Produces CSV data. if -n (no mail) flag is set, then 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.
-
--itemscontent
-
-comma separated list of fields that get substituted into templates in
-places of the <<items.content>> placeholder. This defaults to
-issuedate,title,barcode,author
-
-Other possible values come from fields in the biblios, items, and issues
-tables.
-
--borcat Repetable field, that permit to select only few of patrons
-categories.
-
--borcatout
-
-Repetable field, permis to exclude some patrons categories.
-
--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 a 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.
-
--list-all
-
-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 -max setting).
-
-**DESCRIPTION**
-
-This script is designed to alert patrons and administrators of overdue
-items.
-
-Configuration
-
-This script pays attention to the overdue notice configuration performed
-in the "Overdue notice/status triggers" section of the "Tools" area of
-the staff interface to Koha. There, you can choose which letter
-templates are sent out after a configurable number of days to patrons of
-each library. More information about the use of this section of Koha is
-available in the Koha manual.
-
-The templates used to craft the emails are defined in the "Tools:
-Notices" section of the staff interface to Koha.
-
-Outgoing emails
-
-Typically, messages are prepared for each patron with overdue items.
-Messages for whom there is no email address on file are collected and
-sent as attachments in a single email to each library administrator, or
-if that is not set, then to the email address in the
-"KohaAdminEmailAddress" system preference.
-
-These emails are staged in the outgoing message queue, as are messages
-produced by other features of Koha. This message queue must be processed
-regularly by the misc/cronjobs/process\_message\_queue.pl program.
-
-In the event that the "-n" flag is passed to this program, no emails are
-sent. Instead, messages are sent on standard output from this program.
-They may be redirected to a file if desired.
-
-Templates
-
-Templates can contain variables enclosed in double angle brackets like
-<<this>>. Those variables will be replaced with values specific to the
-overdue items or relevant patron. Available variables are:
-
-<<bib>>
-
-the name of the library
-
-<<items.content>>
-
-one line for each item, each line containing a tab separated list of
-title, author, barcode, issuedate
-
-<<borrowers.\*>>
-
-any field from the borrowers table
-
-<<branches.\*>>
-
-any field from the branches table
-
-CSV output
-
-The "-csv" command line option lets you specify a file to which overdues
-data should be output in CSV format.
-
-With the "-n" flag set, data about all overdues is written to the file.
-Without that flag, only information about overdues that were unable to
-be sent directly to the patrons will be written. In other words, this
-CSV file replaces the data that is typically sent to the administrator
-email address.
-
-**USAGE EXAMPLES**
-
-"overdue\_notices.pl" - In this most basic usage, with no command line
-arguments, 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" - prepare notices of overdues
-in the last 2 weeks for the MAIN library.
-
-**SEE ALSO**
-
-The misc/cronjobs/advance\_notices.pl program allows you to send
-messages to patrons in advance of their items becoming due, or to alert
-them of items that have just become due.
-
-**INTERNAL METHODS**
-
-These methods are internal to the operation of overdue\_notices.pl.
-
-parse\_letter
-
-parses the letter template, replacing the placeholders with data
-specific to this patron, biblio, or item
-
-named parameters:
-
-letter - required hashref
-
-borrowernumber - required integer
-
-substitute - optional hashref of other key/value pairs that should be
-substituted in the letter content
-
-returns the "letter" hashref, with the content updated to reflect the
-substituted keys and values.
-
-prepare\_letter\_for\_printing
-
-returns a string of text appropriate for printing in the event that an
-overdue notice will not be sent to the patron's email address. Depending
-on the desired output format, this may be a CSV string, or a
-human-readable representation of the notice.
-
-required parameters:
-
-letter
-
-borrowernumber
-
-optional parameters:
-
-outputformat
+ **See also**
+
+ The misc/cronjobs/advance\_notices.pl program allows you to send
+ messages to patrons in advance of their items becoming due, or to alert
+ them of items that have just become due.
.. _print-hold-notices-label:
Frequency suggestion: nightly
-:ref:`Perl Documentation`
-
-
-**USAGE**
-
-TalkingTech\_itiva\_outbound.pl
-
-TalkingTech\_itiva\_outbound.pl --type=OVERDUE -w 0 -w 2 -w 6
---output=/tmp/talkingtech/outbound.csv
-
-TalkingTech\_itiva\_outbound.pl --type=RESERVE --type=PREOVERDUE
---lang=FR
-
-Script to generate Spec C outbound notifications file for Talking Tech
-i-tiva phone notification system.
-
---help -h
-
-Prints this help
-
--v Provide verbose log information.
-
---output -o
-
-Destination for outbound notifications file (CSV format). If no value is
-specified, output is dumped to screen.
-
---lang
-
-Sets the language for all outbound messages. Currently supported values
-are EN, FR and ES. If no value is specified, EN will be used by default.
-
---type
-
-REQUIRED. Sets which messaging types are to be used. Can be given
-multiple times, to specify multiple types in a single output file.
-Currently supported values are RESERVE, PREOVERDUE and OVERDUE. If no
-value is given, this script will not produce any outbound notifications.
-
---waiting-hold-day -w
-
-OPTIONAL for --type=RESERVE. Sets the days after a hold has been set to
-waiting on which to call. Use switch as many times as desired. For
-example, passing "-w 0 -w 2 -w 6" will cause calls to be placed on the
-day the hold was set to waiting, 2 days after the waiting date, and 6
-days after. See example above. If this switch is not used with
---type=RESERVE, calls will be placed every day until the waiting reserve
-is picked up or canceled.
-
---library-code --code -c
-
-OPTIONAL The code of the source library of the message. The library code
-is used to group notices together for consortium purposes and apply
-library specific settings, such as prompts, to those notices. This field
-can be blank if all messages are from a single library.
-
.. _receiving-notices-file-label:
Receiving Notices File
Frequency suggestion: nightly
-:ref:`Perl Documentation`
-
-
-**USAGE**
-
-TalkingTech\_itiva\_inbound.pl
-
-TalkingTech\_itiva\_inbound.pl -v --input=/tmp/talkingtech/results.csv
-
-Script to process received Results files for Talking Tech i-tiva phone
-notification system.
-
---help -h
-
-Prints this help
-
--v Provide verbose log information.
-
---input -i
-
-REQUIRED. Path to incoming results file.
-
.. _notify-patrons-of-expiration-label:
Notify Patrons of Expiration
projects / kohadocs.git / commitdiff