Blocked Borrower - Capita Libraries

Blocked Borrower
Implementation Guide
May 2011
About this document
This document is an introduction to the blocked borrower functionality and can be used by System
Managers as a guide to how to set up this functionality along with any known issues and problems
that may be encountered.
Support
If you are experiencing difficulties, please contact your System Manager/IT Department in the first
instance.
You can now raise, track, and close your support cases using our 24 x 7 My Support web service.
You must have a user name and password to access the service – you can register at the following
address: http://www.talis.com/services/register/index.shtml
Support Site: http://www.talis.com/services/support/
Telephone:
+44 (0)870 400 5400
Email:
[email protected]
Copyright notice
This document is the copyright material of Capita. It may not be copied without prior consent, in
writing, from Capita. All trademarks are acknowledged.
Capita endeavours to ensure that the information in this document is correct, but does not accept
liability for any error or omission. However, Capita would be pleased to receive readers‟ views on
the contents of this document.
The products described in this document are subject to licence agreements, which govern their
use. Statements in this document are not part of any licence or contract save insofar as they are
incorporated into a licence or contract by express agreement. Issue of this document does not
imply any entitlement to use of or access to any or all of the products or facilities it describes.
BB-TN-510-01
Page 2
Contents
Section 1: Introduction ............................................................................................................... 5
Section 2: Information for Library Staff .................................................................................. 5
1.
Reasons for Implementing Blocked Borrower functionality ......................................................................... 5
2.
Library Staff and Borrower views ............................................................................................................................ 6
2.1
Alto ........................................................................................................................................................................ 6
2.2
Prism 2.1 and 3 ................................................................................................................................................. 7
Section 3: System Management ............................................................................................... 8
1.
How to implement Blocked Borrower functionality ......................................................................................... 8
1.1
Setting up the Rules in Configure Alto .................................................................................................... 8
1.2
Running bor_block.pl ...................................................................................................................................... 9
1.2.1
Usage................................................................................................................................................................... 10
1.2.2
Reporting ........................................................................................................................................................... 10
1.3
2.
Automatic unblocking .................................................................................................................................. 11
1.3.1
Alto ....................................................................................................................................................................... 11
1.3.2
Bridge .................................................................................................................................................................. 12
1.3.3
E-payments ....................................................................................................................................................... 12
1.3.4
Prism 2.1 and 3 ................................................................................................................................................ 13
Alternatives to ‘blocked borrowers’ ............................................................................................................... 13
2.1
Option 1: environment variables .............................................................................................................. 13
2.1.1
Advantages........................................................................................................................................................ 14
2.1.2
Disadvantages .................................................................................................................................................. 14
2.2
Option 2: perl utility scripts ........................................................................................................................ 14
2.2.2
2.3
Disadvantages .................................................................................................................................................. 14
Other options .................................................................................................................................................. 15
2.3.1
BB-TN-510-01
Advantages........................................................................................................................................................ 15
Page 3
Capita
Blocked Borrower Implementation Guide
2.3.2
3.
Known Issues with Blocked Borrowers ............................................................................................................... 15
3.1
Alto ...................................................................................................................................................................... 15
3.1.1
3.2
Block being removed when Offset Fines Against Credit is set to Yes (APD-9528) ................. 15
Prism 2.1 (only) ............................................................................................................................................... 15
3.2.1
4.
Disadvantages .................................................................................................................................................. 15
Blocked borrowers can log in (Talis Prism 2776) ................................................................................. 15
3.3
Prism 2.1 and 3 ............................................................................................................................................... 16
3.4
Configure Alto ................................................................................................................................................. 16
3.4.1
Drop down menus not appearing correctly when trying to set up Blocking Rules ................ 16
3.4.2
Blocked borrower rules disappearing from the rules table ............................................................. 16
Suggestions for improvements ............................................................................................................................. 16
Appendix A.....................................................................................................................................
18
4.1
Bridge: environment variables ................................................................................................................... 18
4.2
Prism 2.1. and 3: environment variables ................................................................................................ 18
4.2.1
Reservations / Bookings ............................................................................................................................... 18
4.2.2
Renewals ............................................................................................................................................................ 19
BB-TN-510-01
Page 4
Section 1: Introduction
Blocked borrower functionality enables libraries to set up „blocks‟ on customer accounts when one
or more of the following conditions apply:
 A total of outstanding charges of type „fine‟ that exceeds a specified amount
 A charge of type „fine‟ has been owing for a long time
 Many items are overdue
 An item has been overdue for a long time.
When a borrower is „blocked‟ it means that they can‟t place reservations, borrow or renew items
until they have cleared their ticket of the fine and returned the items. The rules for blocking a
borrower are set up as part of Alto. There is a tool that can be run (bor_block.pl) in order to set a
message with a high „ignore‟ level on borrowers matching the criteria. Parameters can also be
configured so that blocked borrower messages are automatically removed once the condition is no
longer met.
This document describes:
 The reasons for implementing blocked borrower functionality
 The information that borrowers and Circulation staff will see when a borrower is blocked
 How to set up the configuration rules
 How to run the tool that sets the blocking message
 How to remove blocked borrower messages
 Any issues to be aware of before and during implementation.
Section 2: Information for Library Staff
1.
Reasons for Implementing Blocked Borrower functionality
Blocked Borrower functionality is appropriate for use when there is one set of rules that needs to
be applied across specific borrower types. There are other ways of setting messages onto
borrowers who have overdues or large fines but the Blocked Borrower functionality enables the
rules to be applied to borrower automatically and consistently. One of the advantages is that the
message that is applied to blocked borrowers can be removed automatically rather than needing to
be removed manually by library staff (although there are some issues to be aware of in this area –
see Automatic removal of blocked borrower message).
BB-TN-510-01
Page 5
Capita
Blocked Borrower Implementation Guide
A borrower can be blocked for one or more of the following reasons: they have fines outstanding
whose total is over a certain limit, they have more than a specified number of loans that are
overdue, they have one or more fine charges that has been outstanding longer than a specified
number of days or they have one or more loans that have been overdue for more than a specified
number of days. Certain borrower types can then be „blocked‟ using a special borrower message
for this purpose.
2.
Library Staff and Borrower views
2.1
Alto
When a borrower has been blocked, their borrower record will have the blocking message
associated with it. So, when library staff enter the borrower barcode, they will see a message that
looks something like this:
Figure 1: Borrower form – Blocked Borrower
BB-TN-510-01
Page 6
Capita
Blocked Borrower Implementation Guide
The blocking message is shown in red. Alto staff users will still be able to continue through this
message unless the levels are set on the blocking message so that the operator enablements
profile levels cannot override it. If the borrower returns their loans (in this instance) then the
message can either be removed manually or, if the parameters have been set up, the message will
be removed automatically the next time the borrower record is called up (see Automatic removal of
blocked borrower message).
Note: there will be no indication of the message removal to Library Staff.
The line „Borrower is blocked‟ is an exception, similar to the „Overdue loan(s)‟ exception. This
exception is set by Alto using the blocking rules when the borrower record is accessed, and will be
seen regardless of whether the blocking message has been placed. It does not, by itself, prevent
the operator continuing.
2.2
Prism 2.1 and 3
Blocked borrowers will be able to login but will only be able to perform any actions such as
renewing their loans or placing requests if the configuration is set up to allow this. Otherwise, if
they attempt such an action they will be presented with an error message:
Figure 2: Error screen when blocked borrower attempts a renewal
BB-TN-510-01
Page 7
Capita
Blocked Borrower Implementation Guide
Section 3: System Management
3.
How to implement Blocked Borrower functionality
3.1
Setting up the Rules in Configure Alto
1. Go to Parameter Management | Rules | Circulation | Borrower | Blocking Rules.
Figure 3: Borrower Blocking Rules in Configure Talis Alto
Fields for the Blocking Rules form are described below:
Field
Description
Fines
Outstanding
Limit
If you wish to block a borrower because their cumulative fines are over a certain amount then use
this to specify the threshold. The default is 0.00, which means that borrowers will not be blocked
for this reason. Note: this applies only to fines and not to miscellaneous or hire charges.
Example: 9.99 will block any borrowers with fines of £10.00 or over.
BB-TN-510-01
Page 8
Capita
Blocked Borrower Implementation Guide
Field
Description
Days
Outstanding
Limit
Enter the threshold number of days after which the borrower is blocked. This is the number of days
that a borrower fine has been outstanding. The default is 0, which means that borrowers will not be
blocked for this reason.
Example: 14 will block borrowers when they have had fines for 15 or more days
Items Overdue
Limit
Enter the threshold number of overdue items above which a borrower is blocked. The default is 0,
which means that borrowers will not be blocked for this reason.
Example: 5 will block any borrowers with 6 or more overdue items.
Days Overdue
Limit
Enter the threshold number of days that items may be overdue before the borrower is blocked. The
default is 0, which means that borrowers will not be blocked for this reason.
Example: 14 will block borrowers with one or more overdue items that are 15 or more days
overdue.
Blocking
Message
Choose which blocking message is to be displayed to borrowers and staff from the list of standard
borrower messages. You can enter the blocking message name (or its code) directly or select it
from the drop-down list.
Borrower Types
For Inclusion
Choose the borrower types to which these blocking rules apply. To do this, click in the Borrower
Types For Inclusion field. A down arrow is displayed on the right-hand side of the field. Click on
this arrow to display the Select borrower types for inclusion form, where you choose from the
borrower types in your system by checking the boxes in the X column. Click Continue F9 to return
to the Blocking Rules form, where the number of borrower types chosen is displayed.
Automatic
Unblocking
Choose whether to unblock the borrower automatically or whether to make unblocking a borrower
a manual process. To do this, click in the field and do one of the following:
Click on the down arrow displayed on the right-hand side of the field and choose Yes or No from
the drop-down list.
Type T (for yes) or F (for no).
Offset Fines
Against Credit
Choose whether any outstanding fines are offset against any credit that the borrower may have
made on their ticket. To do this, click in the field and do one of the following:
Click on the down arrow displayed on the right-hand side of the field and choose Yes or No from
the drop-down list.
Type T (for yes) or F (for no).
2. Click Save F9 to update the blocking rules on the system.
Note: it is possible to specify more than one criterion for blocking and then the report will block
any borrowers meeting one or all of the criteria.
3.2
Running bor_block.pl
Once the blocked borrower rules have been set up in Configure Alto, the bor_block.pl script can
be set up to run in the cron. This will set the specified blocking message onto any borrower‟s
record when the borrower meets the criteria in the borrower Blocking Rules Form.
BB-TN-510-01
Page 9
Capita
3.2.1
Blocked Borrower Implementation Guide
Usage
Log on as talis and go to the talis utils directory, which is likely to be /usr/opt/blcmp/talis/utils/bin.
Enter the following command:
bor_block.pl -b<begin id> -d<database> -e<end id> -h -r<report directory> -v
Argument
Description
-b
The “-b” argument is optional and specifies the BORROWER_ID from which to begin processing.
If this argument is not given then processing will commence from the first Borrower on the
database (i.e. where BORROWER_ID=1).
-d
The -d argument allows you to specify the database against which the report is to be run. If this
argument is not given, then the default is defined by the TAL_DEFAULT_DBNAME environment
variable. This will default to prod_talis if it has not been set already.
-e
The argument “-e” may be used to specify the ID of the Borrower with which to stop processing. If
not given, processing stops after the Borrower with the highest BORROWER_ID.
-h
The -h argument displays brief help on-screen about the arguments supported by the script. Note
that the help text will also be displayed if an invalid command is given.
-r
The -r argument may be used to specify the report directory where the process will write its report
file. If a report file of the same name already exists in the same directory, it will be renamed with a
date/time extension. When not given, the report will be written to the directory specified by the
$TAL_REP_DIR environment variable or to $BLCMP_HOME/data/utils if this is not set.
-v
The -v argument specifies that a verbose report file should be generated. Verbose report files
contain more detailed information than standard reports.
The bor_block.pl script places the blocking message against any active borrower found to have
exceeded the limit or limits specified in the borrower Blocking Rules. The message will not be
placed on borrowers with a status of „deleted‟. The script checks whether the borrower is one of the
types specified and whether they have the message already set. If they already have the message
with the id specified then the script updates the date in the PLACED_MESSAGE table and leaves
the message on.
Please note: we recommend that you set up this utility to run overnight.
3.2.2
Reporting
The report produced from the bor_block.pl script shows the number of borrowers with a blocked
borrower message attached as a result of running the script. If run with the –v switch, then the
borrower barcodes will also be displayed. In Decisions under Circulation there is a Standard
messages object in the Borrower conditions folder. This can be used to report all borrowers who
have the blocked message attached – see example screenshot below.
BB-TN-510-01
Page 10
Capita
Blocked Borrower Implementation Guide
Figure 4 – example of Decisions report to retrieve borrowers with blocked borrower message
3.3
Automatic unblocking
3.3.1
Alto
The bor_block.pl script will block a borrower based on the criteria specified in the Blocking
Rules. When entering a borrower barcode, the borrower is checked against the blocking rules. If
they no longer meet the blocking criteria and the field Automatic Unblocking is set to Yes then
the block will be removed from the borrower. Please note that there will be no indication of this
process for staff.
BB-TN-510-01
Page 11
Capita
3.3.2
Blocked Borrower Implementation Guide
Bridge
Bridge treats a blocked borrower message like any other message on a borrower record. So, it
compares the Ignore Level setting for the message with the value held in
TAL_SELF_MESSAGE_LEVEL (this parameter is set in the configuration file for Bridge – see the
Bridge website for further information). If it finds that the Ignore Level is greater than or equal to
the value held in TAL_SELF_MESSAGE_LEVEL then Bridge will return “You have a message on
your card” when the borrower tries to issue or renew an item.
If a Bridge user attempts to issue or renew and the borrower has the specific blocking message
attached, Bridge will check if the blocking conditions still apply and remove the message if they
don‟t.
Note: Bridge will only check if the blocking condition still applies if the borrower is
attempting to issue or renew.
As payments can be made via Bridge changes were made to check for blocking conditions
following any payments and to remove the message if the conditions no longer apply. This is
optional; please raise a support case if you wish to have this customised.
Bridge can also be configured to remove the blocking message when the user logs in (requires
borrower‟s card scanning) and logs out of the kiosk. To force unblocking set
FORCE_BORROWER_UNBLOCK = YES (this parameter is set in the configuration file for Bridge
– see the Bridge website for further information).
3.3.3
E-payments
If a fine payment is made using Keystone ePayment service then the borrower block will be
removed following payment (if the block was set due to this fine). However, if the fine is removed
via another ePayment service the block will remain.
BB-TN-510-01
Page 12
Capita
3.3.4
Blocked Borrower Implementation Guide
Prism 2.1 and 3
Prism 2.1 also treats the blocked borrower message like any other message. So, it compares the
Ignore Level setting for the message with the value held in TAL_SELF_MESSAGE_LEVEL (this
parameter is set in the configuration files in Webmin). If it finds that the Ignore Level is greater
than or equal to the value held in TAL_SELF_MESSAGE_LEVEL then Prism 2.1 will return “You
have a message on your card” when the borrower tries to issue or renew an item. However, Prism
2.1 cannot currently check if a blocking condition has been removed, it can only check if there is a
blocking message in place. This can be a problem if borrowers pay a fine using an e-payment
service other than through Talis Keystone or if the borrower has paid a member of library staff but
the message has not been removed. However, a change is imminent in Prism 3 which will mean
that the message will be removed when the blocking condition no longer applies. .
4.
Alternatives to „blocked borrowers‟
There are other mechanisms that can be used in order to stop borrowers from being able to make
active transactions via self-service mechanisms. Some of these mechanisms are set up at the
self-service software (Bridge or Prism) whereas other mechanisms use scripts or manual
intervention by library staff.
4.1
Option 1: environment variables
It is possible in both Bridge and Prism (2.1 and 3) to set parameters that will disallow renewals
(for Bridge and Prism) and reservations (for Prism). These environment variables are detailed in
Appendix A. Please note: these variables can also be used in conjunction with the Blocked
Borrower functionality.
Example:
If you wish for a blocked borrower to be able to renew loans in Prism and Bridge but not make
any reservations in Prism then ensure that the message that is specified in the Blocked Borrower
configuration has an Ignore Level lower than the setting in TAL_SELF_MESSAGE_LEVEL
setting. For further information about where these configurations are set, please see Appendix A.
BB-TN-510-01
Page 13
Capita
4.1.1
Blocked Borrower Implementation Guide
Advantages
This is a fairly straightforward process that enables control via self-service mechanisms. No extra
work is required, no running of scripts, it is just a case of setting up the environment variables
once. Also the environment variables relate to particular transaction types, so you can configure
loans, renewals and reservations differently if you wish.
4.1.2
Disadvantages
These environment variables need to be configured both in Prism and Bridge. Also, Bridge has
more environment variables available so behaviour may appear inconsistent between products.
Another disadvantage is that the two variables - TAL_SELF_FINE_LIMIT and
TAL_SELF_HIRE_LIMIT are calculated on a per transaction basis based upon the potential fine,
so are not cumulative. This means that a transaction will only be disallowed if the fine or hire
charged incurred by the action is greater than the amount specified. It does not consider any
outstanding borrower fines or hire charges.
4.2
Option 2: perl utility scripts
It is possible to use loa_long_odue and bor_mes_finedays_ins in order to add messages to a
borrower ticket. Loa_long_odue can be used to add a specific message for borrowers with
overdues over a specified number of days. The bor_mes_finedays_ins script can be used to add
a message when a borrower has outstanding fines older than the value specified by the number of
days parameter at the command line. For further information about running these scripts, see
http://www.talis.com/services/docs/sysman/webhelp/sysman.htm
You would then use the TAL_SELF_MESSAGE_LEVEL environment variables within Prism and
Bridge to disallow loans, renewals and reservations until the message is cleared by library staff.
These levels can also affect whether Alto staff are able to override the message or not.
4.2.1
Advantages
It is possible to define different messages for different criteria, so this makes it easier to see what
the message is for. It is also easy to set this up in the cron to run regularly.
4.2.2
Disadvantages
Library Staff have to remove messages manually in Alto. It is not possible to remove these via
any other product. It is also fundamentally important that messages are set up in relation to the
environment variable settings in Bridge and Prism so that borrower privileges are ceased.
BB-TN-510-01
Page 14
Capita
Blocked Borrower Implementation Guide
4.3
Other options
There are also other options. Staff can place ad hoc messages on a borrower so that they are not
able to borrow material. They could also expire the borrower or set a new borrower „type‟ with no
loan or reservation privileges.
4.3.1
Advantages
Fairly straightforward process and the library counter staff have complete control over these
options.
4.3.2
Disadvantages
These approaches may lack consistency. Library staff will also need to remember to manually
remove any messages manually and/or change borrower type or expiry date themselves. It is also
fundamentally important that messages are set up with the correct levels to ensure that borrower
privileges are ceased.
5.
Known Issues with Blocked Borrowers
5.1
Alto
5.1.1
Block being removed when Offset Fines Against Credit is set to Yes (APD-9528)
If the blocking rules are set up to apply when a large fine is owed and the Offset Fines Against
Credit option is set to Yes, then when staff view a record where the blocking message has been
applied, the system is removing the block automatically. It shouldn't do this as the fine is still
outstanding and the borrower doesn't have any credits/enough credits associated with their record
to cover the debt.
Note: there is a fix for this, please raise a support case for this to be applied. This fix will be included
for everyone in the Alto 5.2. upgrade.
5.2
Prism 2.1 (only)
5.2.1
Blocked borrowers can log in (Talis Prism 2776)
There is a problem with the setting in Webmin – Operational Parameters – General –
ExcludeBlockedBorrowers. If set to True, this is meant to stop blocked borrowers from logging
in. However, it still enables users to log in, it just doesn‟t allow them to request or renew loans.
BB-TN-510-01
Page 15
Capita
Blocked Borrower Implementation Guide
5.3
Prism 2.1 and 3
5.3.1
Block message is not removed when blocking condition no longer exists (COR-189)
Prism does not remove the block message when the condition is removed e.g. when the user pays
a fine. This means that borrowers who for example make an epayment for a fine are still not able
to reserve or renew via Prism.
Note: this is being worked on currently and a fix for this should be available in the new version of the
LDS for Prism 3 only. Please raise a support case for further information.
5.4
Configure Alto
5.4.1
Drop down menus not appearing correctly when trying to set up Blocking Rules
This can occur if there is more than one row in the BLOCK_BORROWER_RULE table. To check
this, use the following sql:
select * from BLOCK_BORROWER_RULE
If more than one row is returned then please raise a support case.
5.4.2
Blocked borrower rules disappearing from the rules table
It is not possible to set up blocked borrower rules via Configure Alto as the row needs to be
inserted into the table using isql. Only then will it be possible to amend the rules via Configure
Alto. Please raise a support case and we can do this for you.
6.
Suggestions for improvements
Here is a list of some suggestions that have already been made for improving the software. If you
have any other suggestions, please do raise using Alto Ideas.
APD-9721: Enable the existence of multiple borrower blocking parameters, so that several runs of
the bor_block.pl script can be carried out specifying different criteria without having to change the
blocking rules between each run. Also integrate bor_block.pl with other scripts that include similar
functionality.
APD-8419: Extend borrower blocking to Hire and Miscellaneous charges.
APD-8956: Allow borrowers to be blocked based on their home site
BB-TN-510-01
Page 16
Capita
Blocked Borrower Implementation Guide
APD-9727: Improve the report produced by bor_block.pl so that users can see who has had the
message placed and why, including being able to filter out borrowers that have expired x number
of days ago.
APD-8375: Facility to apply a borrower block for overdue short loan items with the degree of
'overdue-ness' measured in hours not days.
PRIS-489: Prism 3 -Tell the borrower when they are blocked and why
APD-9743 – provide interaction with other third party products that use Alto for their user
authentication e.g. Lorensberg‟s Netloan.
BB-TN-510-01
Page 17
Capita
Blocked Borrower Implementation Guide
Appendix A
6.1
Bridge: environment variables
Bridge environment variables are set in the configuration file for each self-service machine. See
the Bridge website for further information: http://www.talis.com/bridge/
 TAL_SELF_CHARGE – set to YES to stop borrowers with outstanding charges being able
to issue or renew items.
 TAL_SELF_CHARGE_LIMIT – when TAL_SELF_CHARGE = YES, this environment
variable allows you to relax the rule so that borrowers with outstanding charges up to a
certain amount are able to issue or renew.
 TAL_SELF_FINE_LIMIT – disallows renewal of an overdue item if the fine it will generate is
over the specified amount.
 TAL_SELF_HIRE_LIMIT – disallows a renewal if the hire charge for that renewal is over the
specified amount.
 TAL_SELF_OVERDUE - set to YES to disallow an issue or renewal if borrower has any
overdue loans
 TAL_SELF_RECALL – set to YES to disallow an issue or renewal if borrower has any loans
recalled.
 TAL_SELF_MESSAGE_LEVEL – disallows an issue or renewal if a borrower has a
message with an ignore level higher than the value held in this variable.
6.2
Prism 2.1. and 3: environment variables
Prism 2.1. environment variables are set up in Webmin – Operational Parameters. See the Prism
2 manual for further information: http://www.talis.com/services/docs/prism/talis_prism_rm_2.0.pdf.
Prism 3 currently uses these settings but the aim is move Prism 3 configuration over to the Admin
Console.
6.2.1
Reservations / Bookings
 To allow users with overdue items to place reservations, set TAL SELF OVERDUE to false.
BB-TN-510-01
Page 18
Capita
Blocked Borrower Implementation Guide
 To allow users with recalled items to place reservations, set TAL SELF RECALL to false.
 To allow users with outstanding charges to place reservations, set TAL SELF CHARGE to
false.
 To allow users with messages on their ticket to place reservations, set TAL SELF
MESSAGE LEVEL to a numeric value higher than the highest Ignore Level of all that user‟s
active messages.
6.2.2
Renewals
 To allow users with overdue items to renew loans, set TAL SELF OVERDUE to false.
 To allow users with recalled items to renew loans, set TAL SELF RECALL to false.
 To allow users with outstanding charges to renew loans, set TAL SELF CHARGE to false.
 To allow users with messages on their ticket to renew loans, set TAL SELF MESSAGE
LEVEL to a numeric value higher than the highest Ignore Level of all the user‟s active
messages.
 To allow users to renew items that will generate a hire charge, set TAL SELF HIRE LIMIT
to the maximum amount of hire charge you will allow. This is on a per transaction basis i.e.
it is not cumulative.
 To allow users to renew items which are overdue and which will generate fines on renewal
set TAL SELF FINE LIMIT to the maximum fine you will allow. This is on a per transaction
basis i.e. it is not cumulative.
BB-TN-510-01
Page 19