My Account Options

If your organization has been set up for the My Account feature, you can use the following Web options (see also the descriptions of the SUPPRESS_OPTION option and the BUT_PUBLIC and BUT_STAFF graphic buttons).

ALTERNATE_ID_EMAIL

This option defines the parameters for email address and subject line in the email notification sent to the patron's email address when the patron's alternate ID field is modified using the modpinfo.html form. The text of the notification email is controlled by the alternateid.html customizable Web form.

This option accepts the following values:

ALTERNATE_ID_EMAIL=[from]|[subject]

Value Description
[from] This element specifies the email account to which bounced email is returned.

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 Email

Innovative servers are configured to reject incoming email, including bounced email (that is, undeliverable email that is returned to a sender-designated address).

[subject] This element specifies the text for the subject header. The pipe (|) character is invalid for this value.

For example:

ALTERNATE_ID_EMAIL=changedid@lib.org|Your login name has changed

This option does not have a default value. If this option is not set, the WebPAC does not send an email to users confirming that the alternate ID was changed.

BUT_LOGOUT

This option defines the graphic image to use for loading the mainmenu.html screen and logging the user out of the "My Account" session. For example:

BUT_LOGOUT=/screens/logout.gif

BUT_PAT_GETPSAVEDRECS

This option defines the button to use for preferred searches. For example:

BUT_PAT_GETPSAVEDRECS=/screens/getpsavedrecs.gif

BUT_PAT_PSEARCH_REMOVE

This option defines the graphic image to use for the Remove all searches button. For example:

BUT_PAT_PSEARCH_REMOVE=/screens/pat_psearch_remove.gif

BUT_PAT_PSEARCH_UPDATE

This option defines the graphic image to use for the Update List button for preferred searches. For example:

BUT_PAT_PSEARCH_UPDATE=/screens/pat_psearch_update.gif

BUT_PAT_SEARCH

This option defines the graphic image to use for the Search the Catalog button. For example:

BUT_PAT_SEARCH=/screens/pat_search.gif

BUT_PLOGOUT

While the patron is logged in to My Account, a Return to Patron Record button appears at the top of all generated screens on which the TOPLOGO information appears and on all "static" HTML pages that include the <!--{return}--> token. This button returns to the Patron Information page. The graphic image (GIF) to display for this button is specified with the BUT_PLOGOUT option. If the BUT_PLOGOUT option is not defined, the WebPAC uses the BUT_RET2PREC option.

The BUT_PLOGOUT option defines the graphic image to use for the Return to Patron Record button in My Account. For example:

BUT_PLOGOUT=/screens/ret2prec.gif

CIRC_HIST_LIMIT_TEXT[_lang]

When this option is present, patrons or staff logged in to My Account can limit the results of a preferred phrase search to exclude previously checked-out titles. To use this feature, patrons either:

The value of the option is the text label displayed next to the limiting checkbox. For example:

CIRC_HIST_LIMIT_TEXT="Limit to titles that are not in my Reading History"

If this option is not present, or the option exists but has no value defined, the WebPAC does not offer the ability to limit results of a preferred phrase search.

This option can vary by language.

COOKIE_DOMAIN

When this option is set, the system returns the specified value in the WebPAC IPSSO/validate response. The Central Authentication Server (CAS) uses the value as the domain for login and session ID cookies. The option value must respect browser rules for valid cookie domains. The value must begin with '.' in order to work properly on all browsers. For example:

COOKIE_DOMAIN=.moosejawpl.ca

The COOKIE_DOMAIN Web option ensures proper cookie function on systems with two-node top-level domains. Such domains might appear at sites that do not use one of the six generic domains; .com, .edu, .gov, .mil, .org, or .net. If this option is not set, the system uses its standard cookie domain algorithm.

FORCE_COOKIE

This option controls whether the WebPAC requires a "cookie" in order to allow access to patron records.

When this option is set to true, the WebPAC requires a "cookie" in order to allow access to patron functions. If this option is set to false, then the WebPAC does not require cookies in order for patrons to access patron functions.

For example:

FORCE_COOKIE=true

If this option is not defined, the system uses a default setting of "true".

HAS_ALTERNATE_ID

When this option is set to a "true" value (any word starting with 't', 'T', 'y', 'Y', or the number '1'), the system checks if the WebPAC is set up to use alternate IDs in patron verification. If so, the system enables alternate IDs, providing the appropriate tokens are in place on appropriate customizable Web forms.

If this option has a "false" value (any word starting with 'f', 'F', 'n', 'N', or the number '0') or is not defined, the system does not offer alternate IDs in patron verification.

For more information, see Using Alternate IDs in the WebPAC.

ICON_BUT_LOGOUT[scope][_lang]

This option defines the Logout link in My Account. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_LOGOUT=<strong>Logout</strong>

For a graphic link example:

ICON_BUT_LOGOUT=<img src="/screens/logout.gif" alt="Logout" border="0" />

If this option is not defined, the system uses the value of the BUT_LOGOUT Web option. If neither option is set, the system uses the following default:

ICON_BUT_LOGOUT=Logout

This option can vary by scope and language.

ICON_BUT_PAT_GETPSAVEDRECS[scope][_lang]

This option defines the Preferred Searches link in My Account. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_PAT_GETPSAVEDRECS=<strong>Preferred Searches</strong>

For a graphic link example:

ICON_BUT_PAT_GETPSAVEDRECS=<img src="/screens/getpsavedrecs.gif" alt="Preferred Searches" border="0" />

If this option is not defined, the system uses the value of the BUT_PAT_GETPSAVEDRECS Web option. If neither option is set, the system uses the following default:

ICON_BUT_PAT_GETPSAVEDRECS=Preferred Searches

This option can vary by scope and language.

ICON_BUT_PLOGOUT[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_PLOGOUT=<strong>Return to Patron Record</strong>

For a graphic link example:

ICON_BUT_PLOGOUT=<img src="/screens/plogout.gif" alt="Return to Patron Record" border="0" />

If this option is not defined, the system uses the value of the BUT_PLOGOUT Web option. If neither option is set, the system uses the following default:

ICON_BUT_PLOGOUT=Return to Patron Record

This option can vary by scope and language.

ICON_BUT_PAT_PSEARCH_REMOVE[scope][_lang]

This option defines the Remove All Searches link in My Account. Clicking this link removes all the patron's saved preferred searches. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_PAT_PSEARCH_REMOVE=<strong>Remove All Searches</strong>

For a graphic link example:

ICON_BUT_PAT_PSEARCH_REMOVE=<img src="/screens/pat_psearch_remove.gif" alt="Remove All Searches" border="0" />

If this option is not defined, the system uses the value of the BUT_PAT_PSEARCH_REMOVE Web option. If neither option is set, the system uses the following default:

ICON_BUT_PAT_PSEARCH_REMOVE=Remove All Searches

This option can vary by scope and language.

ICON_BUT_PAT_PSEARCH_UPDATE[scope][_lang]

This option defines the Update List link in My Account. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_PAT_PSEARCH_UPDATE=<strong>Update List</strong>

For a graphic link example:

ICON_BUT_PAT_PSEARCH_UPDATE=<img src="/screens/pat_psearch_update.gif" alt="Update List" border="0" />

If this option is not defined, the system uses the value of the BUT_PAT_PSEARCH_UPDATE Web option. If neither option is set, the system uses the following default:

ICON_BUT_PAT_PSEARCH_UPDATE=Update List

This option can vary by scope and language.

ICON_BUT_PAT_SEARCH[scope][_lang]

This option defines the Search the Catalog link in My Account. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_PAT_SEARCH=<strong>Search</strong>

For a graphic link example:

ICON_BUT_PAT_SEARCH=<img src="/screens/pat_psearch_update.gif" alt="Search the Catalog" border="0" />

If this option is not defined, the system uses the value of the BUT_PAT_SEARCH Web option. If neither option is set, the system uses the following default:

ICON_BUT_PAT_SEARCH=Search the Catalog

This option can vary by scope and language.

ICON_PAT_DELETE_ALL[scope][_lang]

This option defines the display properties of the Delete All link on the patron record display. When a patron clicks this link, the system displays a warning that the system will delete all entries on the screen. If the patron confirms the deletion, the system deletes all entries on the page. The value of this option is HTML, defining either the text or an image to use as the link. For example:

ICON_PAT_DELETE_ALL=Delete All

or:

ICON_PAT_DELETE_ALL=<img src="/screens/pat_delete_all.gif" alt="Delete All" border="0" />

If this option is not defined, text of "Delete All" displays.

This option can vary by scope and language.

ICON_PAT_DELETE_MARKED[scope][_lang]

This option defines the display properties of the Delete Marked link on the patron record display. When a patron clicks this link, the system displays a warning that the system will delete selected entries on the screen. If the patron confirms the deletion, the system deletes the selected entries on the page. The value of this option is HTML, defining either the text or an image to use as the link. For example:

ICON_PAT_DELETE_MARKED=Delete Marked

or:

ICON_PAT_DELETE_MARKED=<img src="/screens/pat_delete_marked.gif" alt="Delete Marked" border="0" />

If this option is not defined, text of "Delete Marked" displays.

This option can vary by scope and language.

ICON_READING_HISTORY[scope][_lang]

This option defines the display properties of the My Reading History link on the patron record display. Clicking this link displays the patron's circulation history, if collection of it has been enabled for the patron in question. The value of this option is HTML, either defining the text or an image to use as the link. For example:

ICON_READING_HISTORY=My Reading History

or:

ICON_READING_HISTORY=<img src="/screens/reading_history.gif" alt="Reading History" border="0" />

If this option is not defined, text of "My Reading History" displays.

This option can vary by scope and language.

ICON_READING_HISTORY_EXPORT[scope][_lang]

This option defines the display properties of the Export Reading History link on the Book Cart form. Clicking this link exports the patron's circulation history to the book cart. The value of this option is HTML, either defining the text or an image to use as the link. For example:

ICON_READING_HISTORY_EXPORT=<strong>Export my Reading History</strong>

or:

ICON_READING_HISTORY_EXPORT=<img src="/screens/export_readinglist.gif" alt="Export Reading History" border="0" />

If this option is not defined, the system uses the following default:

ICON_READING_HISTORY_EXPORT=Export Reading History

This option can vary by scope and language.

ICON_READING_HISTORY_OPTIN[scope][_lang]

This option defines the display properties of the Opt In link on the patron record display. Clicking this link enables collection of circulation history for the patron in question, if collection of it has been enabled for the system and the patron's PTYPE. This link displays only if the patron is not currently opted in for circulation history collection. The value of this option is HTML, defining either the text or an image to use as the link. For example:

ICON_READING_HISTORY_OPTIN=Opt In

or:

ICON_READING_HISTORY_OPTIN=<img src="/screens/reading_history_opt_in.gif" alt="Opt In" border="0" />

If this option is not defined, text of "Opt In" displays.

This option can vary by scope and language.

ICON_READING_HISTORY_OPTOUT[scope][_lang]

NOTE

Patrons must delete all items from their circulation history before they can opt out of Reading History.

This option defines the display properties of the Opt Out link on the patron record display. Clicking this link disables collection of circulation history for the patron in question, if collection of it has been enabled for the system and the patron's PTYPE. This link displays only if the patron is currently opted in for circulation history collection. The value of this option is HTML, defining either the text or an image to use as the link. For example:

ICON_READING_HISTORY_OPTOUT=Opt Out

or:

ICON_READING_HISTORY_OPTOUT=<img src="/screens/reading_history_opt_out.gif" alt="Opt Out" border="0" />

If this option is not defined, text of "Opt Out" displays.

This option can vary by scope and language.

LOGGEDIN_MSG[scope][_lang]

This option allows library staff to customize the "you are logged in as" message in My Account. The option takes HTML tags, allowing for customization of font and color. This option accepts two %s placeholders in the setting, the first %s for the library name (including the name of the scope, if applicable), the second for the patron name. For example:

LOGGEDIN_MSG=You are logged in %s as %s

Thus, patron Jean Ween at Tri-County Library,using the Smithville Town Library scope, would get the following message:

You are logged in Tri-County Library Consortium / Smithville Town Library as Jean Ween

The %s placeholders only work in succession. You cannot use the %s placeholder for the patron name without first using it for the library name.

This option can vary by scope and language.

NO_REVERIFY

Patrons log in to the My Account feature by selecting the Search the Catalog option while viewing their own patron record (accessed with the /patroninfo command link). Since the patron has already provided his or her name and ID to the system while logging in, it is not necessary to request verification again when the patron accesses a WebPAC function that normally requires verification, such as ILL requests or bookings.

The NO_REVERIFY option specifies those functions for which reverification is not required. The value of this option is a comma-separated list of one or more of the following keywords:

acq Materials the Library Should Acquire function
asr ASRS
book Booking function
ill Interlibrary Loan requests
media Electronic Course Reserves
mfrpro Research Pro
req Request this Item function
wam Web Access Management
z39 Z39.50 ILL requests

The keywords may appear in any order. An example is:

NO_REVERIFY=req,ill,acq

This setting means that the patron will not be required to verify his or her identity when accessing the Request, ILL, or Acquire functions while he or she is logged into the My Account feature.

PATRONVIEW_START

This option lets your library specify a patron activity screen (such as checkouts, holds, etc.) to display immediately when the patron logs in with the /patroninfo command link. The value of this option defines the default patron activity type to display, if the patron has activity to show.

For example, your library can specify that patrons can immediately see their checked out items when accessing the /patroninfo command link, instead of having to click the BUT_PAT_CHKOUTS button. You can specify multiple patron activity types, which display in order of priority. If you specify checked out items as the activity to display first and the patron has no checked out items, the WebPAC displays the next listed option that has activity (for example, holds or fines).

Enter the values for this option in a comma-delimited list of activity types. Enter them in order of priority. Valid values are:

Value Description
chkouts The patron's checked out items
holds The patron's held materials
ill The patron's interlibrary loan requests
bookings The patron's booked materials
fines The patron's fees and fines
patrate The patron's material ratings
mffavs The patron's My Favorite Databases list
mylists The patron's My Lists display
readhist The patron's Reading History
programs Programs the patron has registered for
psearch The patron's preferred searches
irnr Deprecated. This value was used for the patron's ArticleReach requests.

For example:

PATRONVIEW_START=chkouts,holds,ill,bookings,fines,patrate,mffavs,mylists,readhist,programs,psearch,irnr,patreview

In this example, the WebPAC displays checked out items in the View Your Patron Record display. If the patron does not have checked out items, the WebPAC displays holds in the default display. The patron can still click the appropriate buttons specified in the Patron Record Display Form to view other activity.

This option does not have a default value. If this option is not defined or does not exist, the system directs users to the top level Patron Record Display via the /patroninfo command link.

Innovative recommends that you order the value of this option in a similar sequence to the visual arrangement you have in your patron record display.

PREF_SEARCHES[_P#]

This option sets the number of preferred searches that logged-in My Account users can save. It also controls whether the system offers a Mark for Email option on the Edit Preferred Searches page. The format of the Preferred Searches Email is controlled by the Search Alert Options file. The two elements of the value for this option are separated by a vertical bar:

PREF_SEARCHES=[NumSearches]|[EmailOpt]

Element Description
[NumSearches] The maximum number of Preferred Searches that users can save.
[EmailOpt] If this element is set to a "true" value (any word starting with 'T', 't', 'Y', or 'y' or the number '1'), the system offers a Mark for Email option on the Edit Preferred Searches page.
NOTE

Contact Innovative to enable the email notification functionality for Preferred Searches.

If this feature is enabled, every time a logged-in patron performs a search and gets results, a button displays offering to save the current search on the search results page. The text on this button is specified with the PREFTEXT option. An option to manage the preferred search list also appears on the patron's Patron Information page.

This option can vary by patron type (P TYPE).

PREFTEXT[_lang]

This option specifies the text for the button that appears on all search result screens offering users the ability to save the current search as a preferred search. The PREF_SEARCHES option specifies the maximum number of searches that a patron can save.

This option can vary by language.

READING_HISTORY_DELETE

This option specifies whether the patron can delete circulation history entries. The option format is:

READING_HISTORY_DELETE=<true or false>

If this option is set to "true", and your organization uses circulation history, and the patron has enabled circulation history, then the patron can delete individual circulation history entries or the entire circulation history via the ICON_PAT_DELETE_MARKED and ICON_PAT_DELETE_ALL options, respectively.

If this element is set to "false" and the patron has enabled circulation history, then the patron cannot delete circulation history and the ICON_PAT_DELETE_MARKED and ICON_PAT_DELETE_ALL options are not available to the patron.

Deleting Reading History

If the READING_HISTORY_DELETE Web option is set to a "false" value, the system does not allow users to opt out from Reading History because the false setting prohibits users from deleting circulation history entries.

 

TOPLOGO_LOGGEDIN

This option controls specific TOPLOGO displays. When this option is set to "true" (e.g., 't', 'T', 'true,' 'y', 'Y'), patrons logged in to My Account will view a TOPLOGO defined by the appropriate toplogo_loggedin.html custom form.

Offering Navigation Links

If your library uses the toplogo_loggedin.html form, the system offers the Log Out, Return to Patron Record, and Start Over links from the top logo and does not offer links from the navigation row.

TRUSTED_FORWARD_HOSTS

This option specifies the host or domain names that Central Authentication Server (CAS) can redirect to during logout. The system uses this option for Vega customers.

This option can accept multiple values separated by a pipe character ("|"). Each value must begin with a period ("."). For example:

TRUSTED_FORWARD_HOSTS=.moosejawpl.ca|.moosejaw.ca

If this option is not defined, the system uses a default value of ".iii-conv.com|.iiivega.com".