Patron Record Options
This page describes the Web options for the Patron Records options group. Review these options to determine any necessary setup that your organization might need to perform.
BUT_PAT_CANCEL
This option defines the image to use for the Cancel button in patron functions. For example:
BUT_PAT_CANCEL=/screens/pat_cancel.gif
BUT_PAT_CANCELALL
This option defines the image to use for the Cancel All button in patron bookings and requests. For example:
BUT_PAT_CANCELALL=/screens/pat_cancel_all.gif
BUT_PAT_CANCELMARK
This option defines the image to use for the Cancel Selected button in patron functions. For example:
BUT_PAT_CANCELMARK=/screens/pat_cancelmark.gif
BUT_PAT_CHKOUTS
This option defines the image to use for the Checked Out Items button. For example:
BUT_PAT_CHKOUTS=/screens/pat_chkouts.gif
BUT_PAT_FINES
This option defines the image to use for the Unpaid Fines button. For example:
BUT_PAT_FINES=/screens/pat_fines.gif
BUT_PAT_HOLDS
This option defines the image to use for the Requests button. For example:
BUT_PAT_HOLDS=/screens/pat_holds.gif
BUT_PAT_INFO
This option defines the image to use for the Modify Personal Info button. For example:
BUT_PAT_INFO=/screens/pat_info.gif
BUT_PAT_MSGS
This option defines the image to use for the Show Messages button. For example:
BUT_PAT_MSGS=/screens/pat_msgs.gif
BUT_PAT_PIN
This option defines the image to use for the Modify Your PIN button. For example:
BUT_PAT_PIN=/screens/pat_pin.gif
BUT_PAT_RENEWALL
This option defines the image to use for the Renew All button. For example:
BUT_PAT_RENEWALL=/screens/pat_renewall.gif
BUT_PAT_RENEWMARK
This option defines the image to use for the Renew Selected button. For example:
BUT_PAT_RENEWMARK=/screens/pat_renewmark.gif
BUT_PAT_SORTBYCHKOUT
This option defines the image to use for the Sort by Checkout button. For example:
BUT_PAT_SORTBYCHKOUT=/screens/pat_sortbychkout.gif
BUT_PAT_SORTBYDUE
This option defines the image to use for the Sort by Due Date button. For example:
BUT_PAT_SORTBYDUE=/screens/pat_sortbydue.gif
BUT_PAT_SUBMIT
This option defines the image to use for the Submit button for patron functions. For example:
BUT_PAT_SUBMIT=/screens/pat_submit.gif
BUT_PSTARTOVER
This option defines the image to use for the Startover button. For example:
BUT_PSTARTOVER=/screens/pstartover.gif
BUT_RET2PREC
This option defines the image to use for the Patron Record button. If the BUT_PLOGOUT option is not defined, the BUT_RET2PREC option defines the image to use for the Return to Patron Record button.
For example:
BUT_RET2PREC=/screens/ret2prec.gif
BUT_UPDATE_HOLDS
This option defines the image to use for the Update List button in the holds display of the patron record information screen. For example:
BUT_UPDATE_HOLDS=/screens/pat_psearch_update.gif
CHANGE_HOLD_LOC
When this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1") the WebPAC offers the user the option to change pickup locations from a drop-down list. Patrons can change pickup locations only if the held items are not in transit to fulfill the patron's hold or on the holdshelf for the patron.
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0") or this option is not set, patrons cannot change a pickup location for held items.
EXP_MSG[scope][_P#][_lang]
This option defines the display parameters for alert messages that notify patrons when their registration is about to expire. WebPAC Pro and Encore display these alert messages whenever patrons log into their accounts during the alert period specified by this option.
In WebPAC Pro, the <!--{expmsg}--> token on the Patron Record Display Form must be present in order for the message to appear.
This option has the following pipe-delimited elements:
EXP_MSG=[# of days]|[text]
Value | Description | ||||
---|---|---|---|---|---|
[# of days] | The number of days before the expiration date to begin the alert period. The system includes the expiration date in the alert period. For example, if the value of this element is "5" and the patron's expiration date is 03-30-16, WebPAC Pro and Encore display an alert message from 03-25-16 through 03-30-16 whenever the patron logs into their account. This element accepts "0" and positive integers only. When set to "0" (or left blank), the system alerts patrons only if their expiration date falls on the current date. |
||||
[text] | The message that displays to patrons when they log into their patron account. This option accepts HTML, as well as the following placeholders:
|
For example:
EXP_MSG=6|Your record expires in %n days on %d.
If this option is not defined, WebPAC Pro and Encore use the following default setting:
EXP_MSG=
This option can vary by scope, patron type (P TYPE), and language.
FRAMEURL_PAT
In Sierra 4.1, this web option was removed from Sierra. WebPAC ignores this option if it is set in your Sierra system.
This option controls the percentage of the screen to devote to the upper frame when the user is viewing patron information (with the /patroninfo command link). An example, which sets the frame to 25%, is shown below:
FRAMEURL_PAT=25
If this option is not defined or is set to a value of "0", the system sets the upper frame to use 30% of the screen.
To turn off framing in the patron information page, set the first element of the MY_WEBPAC Web option to a "FALSE" value ("0", the characters "F", "f", "N", or "n", or any word beginning with one of these characters).
FREEZE_HOLDS[_P#]
INN-Reach Holds
The Freezing Requests feature does not allow your patrons to freeze INN-Reach holds.
Your library can let specified patrons suspend or "freeze" requests. "Freezing a request" means that the patron's position in the hold queue is skipped over until the request is reactivated.
When this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1") then specified patrons can freeze requests. For example:
FREEZE_HOLDS=t
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0") or this option is not set, then patrons cannot have the system skip over their positions in the hold queue.
This option can vary by patron type (P TYPE).
HOLD_MSG_SIMPLE
When this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1"), the WebPAC suppresses all status messages in the status column of the holds display in the View your Record screen except:
- Ready. Must pick up by [date] (if the item is on the holdshelf)
SEEPUDATE Web Option
You must set the SEEPUDATE Web option to a true value or disable this option display this message.
- ([num] of [num] HOLDS) (if the item is not on the holdshelf)
If this option is set to a "true" value, the Holds: Give precedence to local holds system option must be false.
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0"), or not defined, patron holds display normally in the View Your Record display.
ICON_BUT_PAT_CANCEL[scope][_lang]
This option defines the display properties for the Cancel link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_CANCEL=<strong>Cancel</strong>
For a graphic link example:
ICON_BUT_PAT_CANCEL=<img src="/screens/pat_cancel.gif" alt="Cancel" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_CANCEL option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_CANCEL=Cancel
This option can vary by scope and language.
ICON_BUT_PAT_CANCELALL[scope][_lang]
This option defines the display properties for the Cancel All link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_CANCELALL=<strong>Cancel All</strong>
For a graphic link example:
ICON_BUT_PAT_CANCELALL=<img src="/screens/pat_cancel_all.gif" alt="Cancel All" border="0" />
If this option is not defined, the system uses value of the BUT_PAT_CANCELALL option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_CANCEL=Cancel All
This option can vary by scope and language.
ICON_BUT_PAT_CANCELMARK[scope][_lang]
This option defines the display properties for the Cancel Selected link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_CANCELMARK=<strong>Cancel Marked Items</strong>
For a graphic link example:
ICON_BUT_PAT_CANCELMARK=<img src="/screens/pat_cancelmark.gif" alt="Cancel Marked" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_CANCELMARK option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_CANCELMARK=Cancel Selected
This option can vary by scope and language.
ICON_BUT_PAT_CHKOUTS[scope][_lang]
This option defines the display properties for the Checked Out Items link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_CHKOUTS=<strong>Cancel Marked Items</strong>
For a graphic link example:
ICON_BUT_PAT_CHKOUTS=<img src="/screens/pat_chkouts.gif" alt="Checked Out Items" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_CHKOUTS option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_CHKOUTS=Checked Out Items
This option can vary by scope and language.
ICON_BUT_PAT_FINES[scope][_lang]
This option defines the display properties for the Unpaid Fines link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_FINES=<strong>Unpaid Fines</strong>
For a graphic link example:
ICON_BUT_PAT_FINES=<img src="/screens/pat_fines.gif" alt="Unpaid Fines" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_FINES option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_FINES=Unpaid Fines
This option can vary by scope and language.
ICON_BUT_PAT_HOLDS[scope][_lang]
This option defines the display properties for the Requests link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_HOLDS=<strong>Requests</strong>
For a graphic link example:
ICON_BUT_PAT_HOLDS=<img src="/screens/pat_holds.gif" alt="Requests" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_HOLDS option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_HOLDS=Requests
This option can vary by scope and language.
ICON_BUT_PAT_INFO[scope][_lang]
This option defines the display properties for the Modify Personal Info link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_INFO=<strong>Modify Personal Information</strong>
For a graphic link example:
ICON_BUT_PAT_INFO=<img src="/screens/pat_info.gif" alt="Modify Personal Information" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_INFO option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_INFO=Modify Personal Info
This option can vary by scope and language.
ICON_BUT_PAT_MSGS[scope][_lang]
This option defines the display properties for the Show Messages link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_MSGS=<strong>Messages</strong>
For a graphic link example:
ICON_BUT_PAT_MSGS=<img src="/screens/pat_msgs.gif" alt="Messages" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_MSGS option. If neither option is defined, the system uses the value of the second element of the PATRON_MSG Web option.
This option can vary by scope and language.
ICON_BUT_PAT_PIN[scope][_lang]
This option defines the display properties for the Modify your PIN link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_PIN=<strong>Change your PIN</strong>
For a graphic link example:
ICON_BUT_PAT_PIN=<img src="/screens/pat_pin.gif" alt="Modify your PIN" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_PIN option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_PIN=Modify your PIN
This option can vary by scope and language.
ICON_BUT_PAT_RENEWALL[scope][_lang]
This option defines the display properties for the Renew All link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_RENEWALL=<strong>Renew All</strong>
For a graphic link example:
ICON_BUT_PAT_RENEWALL=<img src="/screens/pat_renewall.gif" alt="Renew All" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_RENEWALL option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_RENEWALL=Renew All
This option can vary by scope and language.
ICON_BUT_PAT_RENEWMARK[scope][_lang]
This option defines the display properties for the Renew Selected link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_RENEWMARK=<strong>Renew Marked</strong>
For a graphic link example:
ICON_BUT_PAT_RENEWMARK=<img src="/screens/pat_renewmark.gif" alt="Renew Marked" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_RENEWMARK option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_RENEWMARK=Renew Selected
This option can vary by scope and language.
ICON_BUT_PAT_SORTBYCHKOUT[scope][_lang]
This option defines the display properties for the Sort by Checkout link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_SORTBYCHKOUT=<strong>Sort by Checkout</strong>
For a graphic link example:
ICON_BUT_PAT_SORTBYCHKOUT=<img src="/screens/pat_sortbycheckout.gif" alt="Sort by Checkout" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_SORTBYCHECKOUT option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_SORTBYCHKOUT=Sort by Checkout
This option can vary by scope and language.
ICON_BUT_PAT_SORTBYDUE[scope][_lang]
This option defines the display properties for the Sort by Due Date link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_SORTBYDUE=<strong>Sort by Due Date</strong>
For a graphic link example:
ICON_BUT_PAT_SORTBYDUE=<img src="/screens/pat_sortbydue.gif" alt="Sort by Due Date" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_SORTBYDUE option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_SORTBYDUE=Sort by Due Date
This option can vary by scope and language.
ICON_BUT_PAT_SUBMIT[scope][_lang]
This option defines the display properties for the Submit link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PAT_SUBMIT=<strong>Submit</strong>
For a graphic link example:
ICON_BUT_PAT_SUBMIT=<img src="/screens/pat_submit.gif" alt="Submit" border="0" />
If this option is not defined, the system uses the value of the BUT_PAT_SUBMIT option. If neither option is defined, the system uses the following default:
ICON_BUT_PAT_SUBMIT=Submit
This option can vary by scope and language.
ICON_BUT_PSTARTOVER[scope][_lang]
This option defines the display properties for the Start Over link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_PSTARTOVER=<strong>Start Over</strong>
For a graphic link example:
ICON_BUT_PSTARTOVER=<img src="/screens/pstartover.gif" alt="Start Over" border="0" />
If this option is not defined, the system uses the value of the BUT_PSTARTOVER option. If neither option is defined, the system uses the following default:
ICON_BUT_PSTARTOVER=Start Over
This option can vary by scope and language.
ICON_BUT_RET2PREC[scope][_lang]
This option defines the display properties for the Return to Patron Record link. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_RET2PREC=<strong>Return to Patron Record</strong>
For a graphic link example:
ICON_BUT_RET2PREC=<img src="/screens/ret2prec.gif" alt="Return to Patron Record" border="0" />
If this option is not defined, the system uses the value of the BUT_RET2PREC option. If neither option is defined, the system uses the following default:
ICON_BUT_RET2PREC=Return to Patron Record
This option can vary by scope and language.
ICON_BUT_UPDATE_HOLDS[scope][_lang]
This option defines the display properties for the Update List link in the patron record. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_BUT_UPDATE_HOLDS=<strong>Update List</strong>
For a graphic link example:
ICON_BUT_UPDATE_HOLDS=<img src="/screens/psearch_update.gif" alt="Update List" border="0" />
If this option is not defined, the system uses the value of the BUT_UPDATE_HOLDS option. If neither option is defined, the system uses the following default:
ICON_BUT_UPDATE_HOLDS=Update Holds
This option can vary by scope and language.
ICON_CLOSEWINDOW[scope][_lang]
This option defines the Close Window icon display. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_CLOSEWINDOW=<strong>Close Window</strong>
For a graphic link example:
ICON_CLOSEWINDOW=<img src="/screens/closewindow.gif" alt="Close Window" border="0" />
If this option is not defined, the WebPAC uses the following default setting:
ICON_CLOSEWINDOW=Close Window
This option can vary by scope and language.
ICON_CONFIRM_NO[scope][_lang]
This option defines the display properties for the No confirmation link. This option accepts an HTML value that defines the text or image to use as the link. For example:
ICON_CONFIRM_NO=<strong>No</strong>
or
ICON_CONFIRM_NO=<img src="/screens/confirm_no.gif" alt="No" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_CONFIRM_NO=NO
This option can vary by scope and language.
ICON_CONFIRM_YES[scope][_lang]
This option defines the display properties for the YES confirmation link. This option accepts an HTML value that defines the text or image to use as the link. For example:
ICON_CONFIRM_YES=<strong>Yes</strong>
or
ICON_CONFIRM_YES=<img src="/screens/confirm_yes.gif" alt="yes" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_CONFIRM_YES=YES
This option can vary by scope and language.
ICON_PAT_CANCELALL[scope][_lang]
This option defines the image to use for the Cancel All button in the ArticleReach request display in the patron record. For example:
ICON_PAT_CANCELALL=/screens/pat_cancel_all.gif
If this option is not defined, the WebPAC uses the following default setting:
ICON_PAT_CANCELALL=Cancel All
This option can vary by scope and language.
ICON_PAT_CANCELMARK[scope][_lang]
This option defines the image to use for the Cancel Marked button in the ArticleReach request display in the patron record. For example:
ICON_PAT_CANCELMARK=/screens/pat_cancel.gif
If this option is not defined, the WebPAC uses the following default setting:
ICON_PAT_CANCELMARK=Cancel Marked
This option can vary by scope and language.
ICON_PIN_RESET[scope][_lang]
This option defines the appearance for the link enabling users to reset their PINs. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_PIN_RESET=<strong>Forgot your PIN?</strong>
For a graphic link example:
ICON_PIN_RESET=<img src="/screens/pinreset.gif" alt="Forgot your PIN?" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_PIN_RESET=Forgot your PIN?
This option can vary by scope and language.
ICON_SORTPUDATE[scope][_lang]
This option defines the display of the Sort by Holds Expiration Date toggle button. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_SORTPUDATE=<strong>Sort by Holds Expiration Date</strong>
For a graphic link example:
ICON_SORTPUDATE=<img src="/screens/sortpudate.gif" alt="Sort by Holds Expiration Date" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_SORTPUDATE=Sort by Holds Expiration Date
This option can vary by scope and language.
ICON_SORTREQDATE[scope][_lang]
This option defines the display of the Sort by Held Date toggle button. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_SORTREQDATE=<strong>Sort by Held Date</strong>
For a graphic link example:
ICON_SORTREQDATE=<img src="/screens/sortreqdate.gif" alt="Sort by Held Date" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_SORTREQDATE=Sort by Held Date
This option can vary by scope and language.
ICON_SORTSTATUS[scope][_lang]
This option defines the display of the Sort by Status toggle button. This option accepts an HTML value that defines the text or an image to use as the link. For example:
ICON_SORTSTATUS=<strong>Sort by Status</strong>
For a graphic link example:
ICON_SORTSTATUS=<img src="/screens/sortstatus.gif" alt="Sort by Status" border="0" />
If this option is not defined, the system uses the following default setting:
ICON_SORTSTATUS=Sort by Status
This option can vary by scope and language.
MASK_BARCODE
When this option is set to a "true" value ("t", "T", "y", "Y", any word that starts with those letters, or "1") the WebPAC treats verification barcodes as passwords and masks the barcode entry to show as asterisks.
When this option is set to a "false" value ("f", "F", "n", "N", any word that starts with those letters, or "0"), WebPAC does not mask barcode entry.
If this option is not defined, WebPAC uses the following default:
MASK_BARCODE=true
MAX_PIN_LENGTH
This option specifies the maximum length of characters in a valid PIN.
For example:
MAX_PIN_LENGTH=6
This value forces patrons to have a PIN with a maximum of six characters.
This option does not have a default value. If this option is not defined, or is commented out, the system does not assign a maximum length of characters for a valid PIN.
MIN_PIN_LENGTH
This option specifies the minimum length of characters in a valid PIN.
For example:
MIN_PIN_LENGTH=4
This value forces patrons to have a PIN with a minimum of four characters.
This option does not have a default value. If this option is not defined, or is commented out, the system does not assign a minimum length of characters for a valid PIN.
MODIFY_PFLDS
This option specifies the patron record field tags that the patron can modify via the /patroninfo command link. When this option has a valid value, WebPAC displays a "Modify Personal Information" link in the top frame of the Patron Information page sent by the system in response to the /patroninfo command (see also Enabling Patrons to Change Patron Record Information).
The value of this option is a list of the patron record tags that can be modified, without spaces, commas, or other punctuation. Valid tags are:
Field Tag | Description |
---|---|
a | The first address field (ADDRESS) |
h | The alternate address field (ADDRESS2) |
t | Telephone number (TELEPHONE) |
o | Mobile telephone number (MOBILE PH) |
p | Alternate telephone number (TELEPHONE2) |
z | Email address (EMAIL ADDR)
Substituting the z TagIf your library is using the EMAIL circ notices option, you can substitute the z tag with the tag of the patron record field containing the email address. |
H | Home library/default pickup location (HOME LIBR) |
For each tag in the setting, WebPAC displays prompts for the appropriate information. For example:
MODIFY_PFLDS=ahtpzH
NOTES
The system does not validate the data entered by the patron.
MY_WEBPAC
In Sierra systems, this option controls:
- The frame display from the /patroninfo command link.
-
The patron verification forms used by WebPAC.
This option has three comma-delimited elements:
MY_WEBPAC=[frame],[login],[PTYPE]
Value | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[frame] |
In Sierra systems, the only valid setting for the <frame> element is "FALSE" ("0", the characters "F", "f", "N", or "n", or any word beginning with one of these characters). If MY_WEBPAC is disabled or not defined, then WebPAC behaves as if this element were set to "TRUE". |
||||||||||
[login] |
This element controls which patron verification form is used when a patron is prompted to log in.
If your library is using the Integrated Login feature, this value is ignored, and the behavior is functionally the same as setting it to "3". The integrated login form (ipsso.html or ipsso.xml) is used
for all patron verification. This element further controls validation against other functions and accepts any one of these values:
NOTEThe Program Registration and Patron Material Ratings functions require My Account to be available. If a user is not logged in to a My Account session and tries to access one of these functions, the system prompts the user to log in to My Account, regardless of how the <login> element is defined. |
||||||||||
[PTYPE] |
This option is not used in Sierra systems. The inclusion of a search widget on the patron information screen is determined by the token on patronview_web.html. Some examples of settings are:
|
NEWPIN_MSG[_lang]
A library patron has the option to enter a Personal Identification Number (PIN) through the WebPAC. This option specifies the text that is presented to the patron, prompting him or her to enter the PIN. For example:
NEWPIN_MSG=Please enter your PIN
This option can vary by language.
NEWPIN1_PROMPT[scope][_P#][_lang]
This option specifies the text presented to a patron when the system displays the first prompt for a patron to enter a new PIN. For example:
NEWPIN1_PROMPT=Enter your PIN
If this option is not defined, WebPAC displays the following default message:
Enter Your PIN
This option can vary by scope, patron type (P TYPE), and language.
NEWPIN2_PROMPT[scope][_P#][_lang]
This option specifies the text presented to a patron when the system displays the first prompt for a patron to enter a new PIN again. For example:
NEWPIN2_PROMPT=Enter your PIN again
If this option is not defined, WebPAC displays the following default message:
Enter Your PIN Again
This option can vary by scope, patron type (P TYPE), and language.
PAT_SORTCHKOUT
This option controls the default sort order for checked out records in the patron display. If this option is set to a true value (any word starting with t, T, y, Y, or the number 1), the system sorts the checked out items display by check out order.
If this option is set to a false value (any word starting with f, F, n, N, or the number 0), or is not defined, the system sorts the checked out items display by due date.
PATRON_FIELDS
This option specifies the fields and subfields to present when a patron record is displayed by the WebPAC. The value of this option has three elements (optionally, four or more), separated by the vertical bar character:
PATRON_FIELDS=[namefld]|[addrfld]|[phonefld]|F/[fixnum][|[otherspecs]|...]
Each element consists of the field tag of the field that contains the particular patron data and a list of subfields from that field to display, separated by the forward slash character (for example, a/abc for field tag "a" and subfields "a", "b", and "c"). The subfield list may contain one or more hyphens to indicate ranges (for example, a-c, b-dfhj-o, etc.). The elements are:
[namefld] | The field tag of the field in which the patron's name appears in the patron record, and a list of subfields from that field to display (for example, n/a-d for field tag "n" and subfields "a" through "d"). |
[addrfld] | The field tag of the field in which the patron's address appears in the patron record, and a list of subfields from that field to display (for example, a/ab for field tag "a" and subfields "a" and "b"). |
[phonefld] | The field tag of the field in which the patron's phone number appears in the patron record, and a list of subfields from that field to display (for example, t/a-z for field tag "t" and subfields "a" through "z"). |
F/[fixnum] | The fixed-length field number of the patron record containing the field you want to display (for example, F/43 for the patron record expiration date). |
[otherspecs] | Additional information from the patron record may be displayed by adding one or more field/subfield pairs in this optional element (for example, f/ab for field tag "f" and subfields "a" and "b"). More than one <otherspecs> element may be added, separated from the preceding <otherspecs> element with a vertical bar. If only a field is specified (for example, "f/"), then subfields a-z from the field will display. |
For example:
PATRON_FIELDS=n/a|a/a|t/a|F/43|
If this option is not defined, the WebPAC uses the following defaults:
[namefld] | Field tag "n" and subfield "a" (for example, n/a) |
[addrfld] | Field tag "a" and subfield "a" (for example, a/a) |
[phonefld] | Field tag "t" and subfield "a" (for example, t/a) |
If this option is not defined, all field data that does not appear in a subfield displays as well.
Additional System Functions and PATRON_FIELDS
- If your organization has set the Check-out: Display patron address option to "NO", then only the patron's name field will display in the WebPAC, no matter what values are assigned to the PATRON_FIELDS option.
- If there is a y-tagged field in the patron record that begins with the strings "image:" or "url:" (case insensitive), then that field is displayed immediately to the left of the patron record data. For more information, see Displaying Photographs in Patron Records.
PATRON_MSG[_lang]
This option specifies the index tag of a variable-length field in patron records into which the library may enter a custom message to display when the Web Server receives the /patroninfo command. The syntax for this option is:
PATRON_MSG=<itag>|<Message link text>
The <Message link text> is used as the URL link to display the contents of the specified field to the patron. For example, if this option is entered as follows:
PATRON_MSG=z|Message from the library
then, if the patron's record contains a "z" field and the patron views his/her own patron record, a link with the text "Message from the library" will appear on the browser's screen. When the patron selects this link, the contents of the "z" field will be sent to the browser.
This option can vary by language.
PATRON_NOTICES
This option specifies the circulation notice delivery methods that the patron may select when modifying his or her personal information in the Patron Information screen. The value of this option is one or more of the following patron record field tags, which indicate the delivery methods to offer to the patron on this screen:
a | Postal mail |
m | Mobile Phone (required for the SMS Alerts product). |
p | Telephone |
z |
Substituting the z Tag
PATRON_NOTICES accepts a substitution of the "z" tag for email, based on the tag used for the patron email address field in the EMAIL circ notices menu option.
If more than one method is to be offered, these tags appear in the PATRON_NOTICES value without spaces or other punctuation. For example:
PATRON_NOTICES=az | Offer Postal mail and email methods |
PATRON_NOTICES=apz | Offer all three methods |
Additional Information
- Your organization must have acquired telephone notification to offer the Telephone option. Similarly, the library must have acquired the Sending Circulation Notices via Email product to offer the Email option. The system will not offer these options to the patron if these features have not been installed, even if they are specified in the PATRON_NOTICES option.
- The MODIFY_PFLDS Web option affects the ability to enter or edit patron record fields in the Patron Information screen. If a particular field tag appears in PATRON_NOTICES but does not appear in MODIFY_PFLDS, users can still select it as a delivery method, but users cannot edit that field value.
PIN_ALPHA_NUM
This option specifies whether WebPAC requires PIN values to be a mix of alpha and numeric values. If this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1"), then WebPAC requires valid PINs to contain a mixture of alpha and numeric characters (for example, 6swan54). The WebPAC does not accept special characters, such as punctuation, in PINs.
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0") or is not defined, WebPAC does not require PINs to be a mixture of alpha and numeric characters.
PIN_NUM_ONLY
This option specifies whether WebPAC requires PIN values to be numeric values only. If this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1"), then WebPAC restricts valid PINs to only numeric values.
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0") or is not defined, WebPAC does not restrict PINs to only numeric values.
If this option is set, it overrides the setting for the PIN_ALPHA_NUM Web option.
PIN_RESET
This option controls the WebPAC feature allowing patrons to reset their PINs. If this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1"), WebPAC enables the functionality allowing patrons to reset their PINs.
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0"), or is not defined, the WebPAC does not allow patrons to reset their PINs.
PIN_RESET_EMAIL[scope][_lang]
This option specifies the parameters for the headers included in the PIN reset email sent to patrons upon receipt of a PIN reset request. This option, along with the PIN_RESET Web option, is required in order to enable the WebPAC function allowing patrons to reset their PINs. The option format is:
PIN_RESET_EMAIL=[subject]|[from]|[reply-to]
Element Value | Description |
---|---|
[subject] | The subject line for the notification email sent by the system to patrons requesting a PIN reset. This element displays any alphanumeric characters as text in the subject line. |
[from] | Enter a fully qualified email address including the @[domain]. For example, "bounces@not-iii.org" sends bounced email to the email account "bounces" on the "not-iii.org" server. The fully qualified email address cannot resolve to the Innovative server that originates the email. Fully qualified email addresses are limited to 49 characters.
Innovative Servers Reject Incoming EmailInnovative servers are configured to reject incoming email, including bounced email (that is, undeliverable email that is returned to a sender-designated address). A [from] value is required or the system will generate errors when users submit requests to reset PINs. |
[reply-to] | The "Reply To" address that appears in the email header. Enter a fully qualified email address including the @[domain]. For example, "reply@not-iii.org" sends reply email to the email account "reply" on the "not-iii.org" server. Use a fully qualified email address that does not resolve to the Innovative server that originates the email. Fully qualified email addresses are limited to 49 characters. This address will not be verified prior to sending the message.
|
For example:
PIN_RESET_EMAIL=Request to reset your library PIN|circadm@library.org|help@library.org
If this option is not specified, WebPAC cannot generate the notification email to send to patrons as part of the PIN reset process.
This option can vary by scope and language.
PIN_RETRY_LIMIT
This option specifies how many failed login attempts patrons can make before they are temporarily blocked from accessing their patron accounts and the length of time they are blocked. This option applies to Sierra's native authentication only.
The option format is:
PIN_RETRY_LIMIT=[tries]|[cooldown]
Element Value | Description |
---|---|
[tries] | The number of failed login attempts permitted before the patron is blocked from accessing their patron account for the period defined by the [cooldown] element. |
[cooldown] |
Time (in seconds) patrons must wait until they can access their patron accounts again. WebPAC checks every 60 seconds to see if any blocks should be released. As such, the actual block period could be up to 59 seconds longer than the value you enter here (depending on when in the cycle the patron attempts to log back in). |
If this option is not defined, WebPAC uses the following default values:
PIN_RETRY_LIMIT=5|60
PSTARTOVER[scope][_lang]
This option specifies the command link or URL the WebPAC uses when a patron is logged in and selects LOG OUT or START OVER. For example:
PSTARTOVER=/search
In this example, the system uses an unmodified /search command link.
If this option is not defined and the patron selects START OVER from the /patroninfo screen, then the WebPAC uses the value of the XSTARTOVER option for the page to load. If neither the PSTARTOVER nor the XSTARTOVER Web options are defined, the WebPAC sends the mainmenu.html page appropriate to the current language to the browser (for example, mainmenu.html, mainmenu_frc.html, etc.) and, if your library has Scoping, resets the scope to the entire collection.
See also the STARTOVER option, which specifies a page to load when users select START OVER from a search results screen.
NOTE
If you are using Secure Sockets Layer (SSL) and setting the PSTARTOVER Web option to a specific Web page,you must use a relative URL rather than an absolute URL. For example, if you have set PSTARTOVER to:
PTARTOVER=http://my.lib.edu:80/screens/pstartover.html
You must change the URL to:
PSTARTOVER=/screens/pstartover.html
This option can vary by language.
RESTRICT_HOLD_LOC
If the CHANGE_HOLD_LOC Web option is set to a true value, the RESTRICT_HOLD_LOC Web option allows your library to restrict the list of valid pickup locations offered in a My Account list of a patron's held items.
This option contains a list of pickup locations. The format is:
RESTRICT_HOLD_LOC=[location code],[location code],[...]
Where [location code] is the up to five-character location code of a valid pickup location. Do not pad codes that are shorter than five characters when setting this option.
- If a pickup location associated with an item is listed in this option, the WebPAC does not allow patrons to change the indicated pickup location in the list of the patron's holds through the patron's My Account page.
- If a held item has a pickup location that is not listed in this option, the WebPAC displays the normal drop-down list of valid pickup locations in the patron's list of held items and suppresses display of locations listed in this option.
This option does not have a default value. If the option is not defined, WebPAC does not restrict the list of pickup locations offered to patrons in the Holds display of My Account.
SEEPUDATE
This option controls the Ready. Must Pick up by [date] message for requests that are ready for pickup. The option format is:
SEEPUDATE=[true or false]
If this option is set to a "true" value (any word starting with "t", "T", "y", "Y", or the number "1") WebPAC displays a Ready. Must pick up by [date] message (for example, Must pick up by 8-13-2004).
If this option is set to a "false" value (any word starting with "f", "F", "n", "N", or the number "0"), WebPAC displays a Ready message without the accompanying Must pick up by [date] information.
If this option is not defined, the system uses the following default:
SEEPUDATE=true
TABLEPARAM_PATDISP[scope]
This option controls the display of tables on the patron record display screen. This option is comprised of three elements, and the data entered for these elements is inserted between the appropriate <TABLE> and </TABLE> tags. The values for these elements must be valid <TABLE> tag attributes. The option elements are:
TABLEPARAM_PATDISP=<main>|<info>|<buttons>
<main> | Defines the parameters for the main patron record display table, containing patron information and function buttons. If the main patron record display is set in a framed display, this table contains all information in the top frame. |
<info> | Defines the parameters of the patron information table. |
<buttons> | Defines the parameters for the table containing patron function buttons. |
For example:
TABLEPARAM_PATDISP=WIDTH=100% BGCOLOR=#ddeeff|BGCOLOR=#0e8eff|BGCOLOR=#a0e0f8
This option can vary by scope.
TABLEPARAM_PATFUNC[scope]
This option controls the display of patron function tables on the patron record display screen. This option is composed of three elements, and the data entered for these elements is inserted between the appropriate <TABLE> and </TABLE> tags. The values for these elements must be valid <TABLE> tag attributes. The option elements are:
TABLEPARAM_PATFUNC=<main_func>|<mod_pin>|<mod_info>
<main_func> | Defines the parameters for the main patron function table containing information on patron functions such as holds, interlibrary loans, checked-out items, and fines. If the patron display is in a frame, then this information appears in the bottom frame. |
<mod_pin> | Defines parameters for the table containing the form for patron PIN modification. |
<mod_info> | Defines parameters for the table containing the form for patron modification of personal information. The fields that appear in this form are defined by the MODIFY_PFLDS option. |
For example:
TABLEPARAM_PATFUNC=WIDTH=100% BORDER=1|BORDER=2|BORDER=3
This option can vary by scope.
TIMEOUT_POPUP
This option defines the timeout in a patron session for modifying personal information, modifying the pin, and entering information in the credit card popup windows. The option accepts a numerical value, in seconds, as the timeout. For example:
TIMEOUT_POPUP=30
This value sets the timeout at 30 seconds.
If this option is not defined, or does not exist, then the patron session does not time out until the form is submitted or closed.