Customizable Web Forms

By default, the WebPAC generates a default HTML document when command links or command functions, such as Requesting or Modifying PIN, are issued by the user. Your library can instead create a custom form for many of these commands by placing specially-named HTML pages into the HTML Screens directory. If the WebPAC finds the specialized HTML file, it displays the HTML contained within that file rather than the system-generated page.

Tokens

Tokens and Forms

Unless otherwise specified, tokens are form-specific. Review the individual form descriptions for a list of valid tokens for each form.

The custom form approach has been designed around the concept of HTML tokens. Tokens are contextual placeholders in an HTML source document that outputs HTML and, in some cases, JavaScript, based on information in other parts of the system. Many elements of the custom forms have been replaced with tokens to minimize the effort involved in maintaining these pages. Tokens also can be dynamic; they can read system files and respond according to library-defined settings so that HTML pages employing these tokens will not always have to be updated when changes are made to the Innovative system settings.

Custom forms also read the system, then react and output different HTML page elements dynamically. This makes the system more flexible. For example, a patron verification form must be able to output an error message if the patron's information is incorrect. Tokens allow for error messages to be coded into the forms conditionally, so that error messages will display only under certain circumstances.

Token Display in the WebPAC

The system resolves tokens dynamically (via a command link or similar system method). Therefore, if you access a customizable form directly through a browser the system cannot resolve the tokens on the page.

For example, if you execute an advanced search via http://lib.cat.edu/search/X the WebPAC returns the srchhelp_X.html form with all appropriate tokens resolved.

If you directly access the srchhelp_X.html form in your WebPAC via http://lib.cat.edu/screens/srchhelp_X.html, the WebPAC does not resolve the tokens in the form display and they might not display correctly to the viewer.

Tokens appear in the format:

<!--{token}-->

For example:

<!--{toplogo}-->

or:

<!--{nameprompt}-->

All HTML forms and files in the live/screens and staging/screens directories, unless otherwise noted, accept the following tokens:

Token Description
<!--{toplogo}--> WebPAC replaces this token as follows:

On certain HTML forms, this token inserts the opening <html> and <body> tags. Review the individual form descriptions to confirm which forms are affected.

<!--{botlogo}-->

The WebPAC replaces this token with the value of the BOTLOGO Web option.

On certain HTML forms, this token inserts the closing </body> and </html> tags. Review the individual form descriptions to confirm which forms are affected.

WebBridge Forms

WebBridge forms (article.html, resserv_panel.html, resserv_staff_panel.html, and wp_panel.html) do not accept the <!--{toplogo}--> and <!--{botlogo}--> tokens.

Formatting Tokens

Tokens must appear alone on a line in the HTML file and must be left-justified to be handled properly. Note that even a single blank space before the token will prevent the WebPAC from properly interpreting the token. For example, format token lines as follows:

<br />
<span class="errormessage">
<!--{errmsg}-->
</span>

Do not format lines like this:

<br /><FONT COLOR=RED><!--{errmsg}-->

Or this:

<br />
<span class="errormessage">
<!--{errmsg}--></span>

Or this:

<br />
<span class="errormessage">
   <!--{errmsg}-->
</span>

Tokens whose name begins with "if" are used for conditional processing of blocks of HTML code and tokens. The end of such a block is marked with an <!--{xif}--> token. For example:

<!--{ifpinerrormessage}-->
<!--{pinerrormessage}-->
<!--{xif}-->

Every <!--{if...}--> must have a closing <!--{xif}--> statement, similar to HTML tags.

You can insert HTML into these conditional expressions to make error messages more prominent, for example:

<!--{ifpinerrormessage}-->
<span class="errormessage">
<!--{pinerrormessage}-->
</span>
<!--{xif}-->

The <!--{pinerrormessage}--> token in this block is only executed if there is an error due to lack of a PIN in the patron's record. If there is a particular formatting effect applied within a conditional block, such as <span class="errormessage">, and that branch is not taken, then the formatting effect will not be applied.

Conditional tokens can be nested, as in the following example from the /illx form:

<!--{iferrmsg}-->
<!--{iferrmsgisPIN}-->
<!--{newpinmsg}-->
<!--{else}-->
<!--{errmsg}-->
<!--{xif}-->
<!--{xif}-->

Exact syntax is essential for these tokens to interact properly with the WebPAC.

Customization for Language, Scope, and P TYPE

You can create separate custom forms for each combination of language, scope, and patron type by using the following naming convention:

<form name>_LANG_s#_p#.html

LANG The language code (spi for Spanish, frc for French, etc.).
s# The number of the scope (s1, s2, s3, etc.).
p# The patron type or PTYPE (p0 or p243, etc.).

This convention applies to all customizable forms unless otherwise noted.

For example:

Example Description
pverify_web_spi.html This example shows the View Your Own Patron Verification Form for the Spanish language.
Using Non-English Languages
  • Non-English WebPAC forms only work for the non-English languages your library has acquired.
  • You can download examples of customizable Web forms in French, Spanish, Simplified Chinese, and Traditional Chinese from CSDirect.
briefcit_s1.html This example shows the Brief Citation Form for scope 1.
newpin_p2.html This example shows the Modify your PIN Form for patrons belonging to P TYPE 2.
authority_redirect_frc_s2_p3.html This example shows the Authority Redirection Form in French, for scope 2 and patrons belonging to P TYPE 3.

Individual Customizable Forms and Files

Following are links to descriptions of customizable forms and files in the WebPAC:

WebPAC Menus

WebPAC File Name Command Link HTML File Name
Main Menu Page / mainmenu.html
Opac Menu page /search/ opacmenu.html

WebPAC Searching

WebPAC File Name Command Link HTML File Name
Search Help Pages /search/<index tag> srchhelp_<index tag>.html
Advanced Boolean Search Help Page /search/X srchhelp_X.html
Simple Boolean Search Help Page /search/Y srchhelp_Y.html

403 Error Forms

Customizable Error Messages and Alerts

You can also customize selected system responses and messages in the WebPAC using the User Messages Configuration (messages.conf) file.

WebPAC File Name Command Link HTML File Name
403 Forbidden, Generic error NONE 403error.html
403 Forbidden, Due to IP restrictions NONE 403iperror.html
403 Forbidden, No more logins available NONE 403loginerror.html

Alternate ID Forms

WebPAC File Name Command Link HTML File Name
Alternate ID Email Notification Form NONE alternateid.html

ArticleReach Forms

WebPAC File Name Command Link HTML File Name
ArticleReach Request Form /nonret request_nonret.html
ArticleReach Request Results Page NONE request_nonret_result.html

ASRS Forms

WebPAC File Name Command Link HTML File Name
ASRS Confirmation Form NONE asrsconf.html
ASRS Request Form NONE asrsreq.html

Bookings Forms

WebPAC File Name Command Link HTML File Name
Patron Verification for Bookings Form NONE pverify_bookings.html
Bookings Calendar Form NONE bookings.html
Bookings Confirmation Form NONE bookings_confirm.html
Bookings Item Selection Form NONE bookings_item_select.html

Confirmation Pages

WebPAC File Name Command Link HTML File Name
Cancelling Bookings Confirmation Page NONE cancel_bookings_confirm.html
Cancelling Holds Confirmation Page NONE cancel_holds_confirm.html
Renewing Checkouts Confirmation Page NONE renew_checkouts_confirm.html

Ecommerce Forms

Staging

Ecommerce Web forms are not stageable.

WebPAC File Name Command Link HTML File Name
Donation Form /donate donateform.html
Fees and Fines Payment Form NONE payform.html

Feeds Page

WebPAC File Name Command Link HTML File Name
Feeds Page NONE feeds.html

Global Navigation and Branding Forms

WebPAC File Name Command Link HTML File Name
TOPLOGO for Logged-in Patrons Custom Form NONE toplogo_loggedin.html

Information Pages

WebPAC File Name Command Link HTML File Name
help.html /help help.html
libinfo.html /libinfo libinfo.html
privacy.html /privacy privacy.html
resources.html /resources resources.html
rpro.html /rpro rpro.html

Innovative Integrated Login Forms

WebPAC File Name Command Link HTML File Name
The ipsso.html File NONE ipsso.html
The ipsso_ircentral.html File NONE ipsso_ircentral.html
The ipsso.xml File NONE ipsso.xml
and related files:
login_bot.html
login_top.html
login.css

INN-Reach Forms

WebPAC File Name Command Link HTML File Name
INN-Reach Central LDAP Authentication Form NONE expat_ircentral.html
INN-Reach Central Patron Verification Form NONE pverify_inst.html

Interlibrary Loan Forms

WebPAC File Name Command Link HTML File Name
Interlibrary Loan Request forms /ill<x>, where <x>=b, c, d, g, j, p, or t illbook.html
illchapter.html
illdissert.html
illgov.html
illjournal.html
illconf.html
illreport.html
Interlibrary Loan Request Confirmation Form NONE ill_confirm.html

My Encore Forms

WebPAC File Name Command Link HTML File Name
My Encore Account Display Form NONE patronview_encore.html

Patron Record Display Forms

WebPAC File Name Command Link HTML File Name
View Your Own Record Patron Verification Form /patroninfo pverify_web.html
Modify Personal Information Form NONE modpinfo.html
Modify Your PIN Form NONE newpin.html
Patron Record Display Form NONE patronview_web.html
Patron Record Framed Display Form NONE patronview_frame.html

Patron Review Forms

WebPAC File Name Command Link HTML File Name
Add a Patron Review Form NONE patreview_add.html
Confirm A Review Form NONE patreview_confirm.html
Report Inappropriate Reviews Form NONE patreview_abuse.html

Patron Self-Registration Forms

WebPAC File Name Command Link HTML File Name
Patron Self-Registration Entry Form /selfreg selfreg.html
Patron Self-Registration Confirmation Form NONE selfregconfirm.html

Patron Suggestion Forms

WebPAC File Name Command Link HTML File Name
Items for the Library to Acquire Form /acquire acquire_web.html
Suggestions Form /suggest suggest_web.html

PIN Reset Forms

WebPAC File Name Command Link HTML File Name
PIN Reset Email Notification Form NONE pinreset_email.html
PIN Request Confirmation Form NONE pinreset_request_success.html
Request a PIN Reset Form NONE pinreset_request.html
Reset a PIN Form NONE pinreset.html

Program Registration Forms

WebPAC File Name Command Link HTML File Name
Program Cancellation Warning Form NONE program_cancelwarn.html
Program Confirmation Form NONE program_confirm.html
Program Fees Form NONE program_cart.html
Program Payment Warning Form NONE program_paywarn.html
Program Registration Form NONE program_register.html
Program Timeout Form NONE program_timeout.html
Programs Search Page NONE programs.html

Record Display Forms

WebPAC File Name Command Link HTML File Name
Bibliographic Record Display Form NONE bib_display.html
Course Record Display Form NONE course_display.html
Program Record Display Form NONE program_display.html
Resource Record Display Form NONE resource_display.html

Requesting and Exporting Forms

WebPAC File Name Command Link HTML File Name
Book Cart Form NONE viewsaves_web.html
Request Verification Form NONE pverify3_web.html
Batch Requesting Form NONE pverify4_web.html
Pickup Location Selection Form NONE pickuploc_select.html
Request Results Form NONE request_result.html
Single Request Item Selection Form NONE item_select.html
Course Reserves/Media Patron Authorization Form NONE pverify6_web.html
Volume Selection Form NONE volume_select.html

Research Pro Forms

WebPAC File Name Command Link HTML File Name
My Favorite Databases Group Names Form NONE mffavs.html
My Favorite Databases Patron Verification Form NONE pverify_mffavs.html
Research Pro Advanced Search Form NONE MFAdvancedSearch.html
Research Pro Advanced Search Category File NONE MFAdvancedSearchCategory.html
Research Pro Advanced Search Resource File NONE MFAdvancedSearchResource.html
Research Pro Advanced Search Resource Group File NONE MFAdvancedSearchResourceGroup.html
Research Pro Error Page NONE MFError.html
Research Pro Fatal Error Page NONE MFFatalError.html
Research Pro Help Page NONE MFHelp.html
Research Pro Interfiled Search Results Page NONE MFSearchResultsStandard.html
Research Pro Patron Verification Form NONE MFPVerify.html
Research Pro Refresh Status Page NONE MFRefreshStatusWebForm.html
Research Pro Saved Results Form NONE MFSavedResults.html
Research Pro Simple Search Form NONE MFSimpleSearch.html
Research Pro Simple Search Category Form NONE MFSimpleSearchCategory.html
Research Pro Simple Search Resource Form NONE MFSimpleSearchResource.html
Research Pro Simple Search Resource Group Form NONE MFSimpleSearchResourceGroup.html
Research Pro Tabbed Search Results Page NONE MFSearchResultsTabbed.html

Search Results Forms

WebPAC File Name Command Link HTML File Name
Brief Citation Form NONE briefcit.html
Brief Citation Authority Record Form NONE briefcit_auth.html
Brief Citation Program Record Form NONE briefcit_program.html
Brief Citation Resource Record Form NONE briefcit_resource.html
Limit/Sort Display Form NONE srchmod.html
Related Searches Form NONE relsearch.html
Authority Redirection Form NONE authority_redirect.html

SMS Files

This file applies to SMS Alerts only. Sierra SMS does not use this Web form.

WebPAC File Name Command Link HTML File Name
Non-U.S. SMS Alerts Terms and Conditions File NONE sms_opt_intl.html

Web Access Management Forms

WebPAC File Name Command Link HTML File Name
Web Access Management Patron Verification Form NONE pverify2_web.html

WebBridge Forms

WebPAC File Name Command Link HTML File Name
Article Finder Form NONE article.html
Resolution Server Display Form NONE resserv_panel.html
Resource Display Form NONE resserv_staff_panel.html
WebPAC Resource Display Form NONE wp_panel.html

Z39.50 Files

WebPAC File Name Command Link HTML File Name
Z39.50 Servers Menu Page /z39 z39menu.html