INN-Reach Options

This page describes the Web options for the INN-Reach options group. Review these options to determine any necessary setup that your organization might need to perform. Unless otherwise noted, these options should be set on the INN-Reach Central Server by the Central System Administrator.

BUT_IR_HOLDINGS

This option defines the graphic image to use for the See Holdings button. For example:

BUT_IR_HOLDINGS=/screens/ir_holdings.gif

BUT_IR_REQUEST

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

BUT_IR_REQUEST=/screens/ir_request.gif

BUT_SCOPE

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

BUT_SCOPE=/screens/scope.gif

BUT_UNSCOPE

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

BUT_UNSCOPE=/screens/unscope.gif

CONSORTIUM_HOLDINGS

When a WebPAC user searches at an INN-Reach site and displays a single bibliographic record, the Web Server displays a list of the libraries in the INN-Reach System that have the item in their holdings. It also displays a caption above this list. The CONSORTIUM_HOLDINGS option selects which of two captions to display.

When set to a "FALSE" value ('0', the characters 'F', 'f', 'N', or 'n', or any word beginning with one of these characters), or when this option is not defined, the caption is one of the following, depending on how many libraries have the item:

1 [NAME] library has this item

or

# [NAME] libraries have this item

where [NAME] is the consortium name and # is the number of libraries holding the item.

When set to a "TRUE" value ('1', the characters 'T', 't', 'Y', or 'y', or any word beginning with one of these characters), the caption is:

Display holdings of [NAME] Libraries

See also the REFHOLDTEXT option, which specifies the caption for reference database holdings displays.

DISPLAY_583

If the INN-Reach Shared Print Management feature is enabled for an INN-Reach System, this option controls whether institutional ACTION NOTE fields display in the INN-Reach Catalog.

Institutional ACTION NOTE fields are defined as MARC 583 fields that are stored locally in bibliographic records and centrally in institution records. For more information, see Action Note Display.

The value of this option is:

DISPLAY_583=[label]|[subfields]

For example:

DISPLAY_583=RETENTION NOTE:|u

NOTES:

• This option must be defined if you want the system to display institutional MARC 583 fields.

• The institutional ACTION NOTE field displays as a separate row in the institutional holdings display. The row contains the following elements:

  Local Server

  Specifies the name of the Local Server to which the owning site belongs (that is, the Local Server at which the MARC 583 is stored in the local bibliographic record). This element displays as the initial element of the row, and is aligned with the Library column. Based on this element, the system inserts the row alphabetically into the holdings table.

  Action Note

  Specifies MARC 583 data originally stored in the local bibliographic record. This element is centered within the row. The format of the MARC 583 label and data in this element can be customized using the Bibliographic Display Classes, bibInstInfoLabel and bibInstInfoRow.

• If there are multiple instances of institutional MARC 583 fields in the institution record, the system displays only the first instance.

ICON_BUT_IR_HOLDINGS[scope][_lang]

This option defines the See Holdings link. Clicking this link shows holdings in the record display. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_IR_HOLDINGS=<strong>See Holdings</strong>

For a graphic link example:

ICON_BUT_IR_HOLDINGS=<img src="/screens/ir_holdings.gif" alt="Holdings" border="0" />

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

ICON_BUT_IR_HOLDINGS=See Holdings

This option can vary by scope and language.

ICON_BUT_IR_REQUEST[scope][_lang]

This option defines the Request link for INN-Reach items. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_IR_REQUEST=<strong>Request</strong>

For a graphic link example:

ICON_BUT_IR_REQUEST=<img src="/screens/ir_request.gif" alt="Request" border="0" />

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

ICON_BUT_IR_REQUEST=Request

This option can vary by scope and language.

ICON_BUT_SCOPE[scope][_lang]

This option defines the Scope link for INN-Reach. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_SCOPE=<strong>Scope</strong>

For a graphic link example:

ICON_BUT_SCOPE=<img src="/screens/scope.gif" alt="Scope" border="0" />

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

ICON_BUT_SCOPE=Scope

This option can vary by scope and language.

ICON_BUT_UNSCOPE[scope][_lang]

This option defines the Unscope link for INN-Reach. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_BUT_UNSCOPE=<strong>Unscope</strong>

For a graphic link example:

ICON_BUT_UNSCOPE=<img src="/screens/unscope.gif" alt="Unscope" border="0" />

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

ICON_BUT_UNSCOPE=Unscope

This option can vary by scope and language.

ICON_INNREACH_ENCORE[scope][_lang]

This option defines the Search Encore link to forward search terms to the Encore catalog specified by the INNREACH_ENCORE Web option. If this option and the INNREACH_ENCORE option are enabled, the WebPAC ignores the setting of the INNREACH Web option. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_INNREACH_ENCORE=<strong>Search Encore</strong>

For a graphic link example:

ICON_INNREACH_ENCORE=<IMG SRC="/screens/searchencore.gif" CLASS="button" BORDER="0" ALT="search Encore for this title" />

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

ICON_INNREACH_ENCORE=Search Encore for this title

This option can vary by scope and language.

ICON_IR_NOHIT[scope][_lang]

This option defines the Your entry would be here link the WebPAC displays in a no-hits search results screen on the INN-Reach Central catalog. This option accepts an HTML value that defines the text or an image to use as the link. For example:

ICON_IR_NOHIT=<strong>Your entry would be here</strong>

For a graphic link example:

ICON_IR_NOHIT=<img src="/screens/irnohit.gif" alt="No hits" border="0" />

If this option is not defined, the system uses the user prompt specified in the INNREACH Web option.

This option can vary by scope and language.

INNREACH[scope][_lang] (Local Servers only)

This option controls the INN-Reach transfer search method (also known as "pass-through searching"). The syntax of this option is:

INNREACH=[User Prompt]@[Central URL]

where [User Prompt] specifies the prompt presented to users to search the INN-Reach Catalog and [Central URL] represents the URL of the INN-Reach Central Server. For example:

INNREACH=<img src="/screens/ohiolink.gif" alt="OhioLINK Central" border="0">@csul.iii.com

If the Local Server and the INN-Reach Central Server use different tags for particular indexes, you can include a map of local index tags and their equivalents at the INN-Reach Central Server immediately after the [Central URL] element. The syntax for these maps is:

([LOCALTAG1]=[CENTRALTAG1];[LOCALTAG2]=[CENTRALTAG2];[...])

where [LOCALTAG] is the tag used for a given index on the Local Server and [CENTRALTAG] is the tag used for the same index on the INN-Reach Central Server. Note that if you use index mapping, you must include ALL indexes to be used, even those that are identical on the two machines. If an index is not listed, it cannot be used to search the INN-Reach Catalog.

For example, if the Local Server uses tag 's' for Serials while the INN-Reach Central Server uses tag 'j', but all other tags are the same, the INNREACH line would resemble the following:

INNREACH=<img src="/screens/ohiolink.gif" alt="OhioLINK Central" border="0">@csul.iii.com(a=a;t=t;d=d;w=w;c=c;o=o;s=j)

(See also the PARTNER option, which controls the Partners function.)

You can use the following tags to map keyword searches. Note that the 'X', 'Y', and 'Z' indexes are part of the Advanced Word Search feature.

• X (Advanced Boolean keyword)
• Y (Simple Boolean keyword)
• Z (Advanced keyword)

The local keyword index can be mapped to any available keyword index on the INN-Reach Central Server (for example, X=X or X=Y). For example:

INNREACH=<img src="/screens/ohiolink.gif" alt="OhioLINK Central" border="0">@csul.iii.com(s=j;u=t;X=X;Y=Y;Z=Y)

When a local Advanced Word Search index is mapped to an INN-Reach Central Server Advanced Word Search index, the following search limits are preserved:

• Language
• Material Type
• DOCDATE
• Sort

If an asterisk character is appended to the central index tag, for example, X=X*, these limits are not used in the central search.

This option can vary by scope and language.

INNREACH_ENCORE

This option defines the URL of an Encore search. If this option and the ICON_INNREACH_ENCORE option are enabled, WebPAC ignores the setting for the INNREACH Web option. The value is:

INNREACH_ENCORE=[Encore Server]

Where [Encore Server] is the URL of an Encore search.  This value accepts a %s variable. The system replaces this variable with the search term to forward to Encore.

For example:

INNREACH_ENCORE=http://encore.iii.com/iii/encore/plus/C__S%s__Orightresult__U?lang=eng&suite=social

This option does not have a default value.

INNREACH_REMOTE[scope][_lang] (Local Servers only)

If your library is an INN-Reach site and uses Single Sign-On (SSO), this option controls how the WebPAC offers INN-Reach pass-through searches.

The option setting is similar to the INNREACH Web option:

INNREACH_REMOTE=[user prompt]@[SSO server]

Where [user prompt] specifies the prompt presented to users to search the INN-Reach Catalog and [SSO server] is the server used for Single Sign-On.

For example:

INNREACH_REMOTE=<img src="/screens/accesslaw.gif" border="0"> @sharelaw.iii.com(X=X;t=t;g=g;a=a;d=d;i=i)

This option accepts additional index tags identically to the INNREACH Web option.

This option can vary by scope and language.

INNREACH_REMOTE_SSL[scope][_lang] (Local Servers only)

If your library is an INN-Reach site and uses Single Sign-On (SSO), this option controls how the WebPAC offers INN-Reach pass-through searches using SSL.

The option setting is similar to the INNREACH_REMOTE Web option:

INNREACH_REMOTE_SSL=[user prompt]@[SSO server]

Where [user prompt] specifies the prompt presented to users to search the INN-Reach Catalog and [SSO server] is the server used for SSL Single Sign-On.

For example:

INNREACH_REMOTE_SSL=<img src="/screens/accesslaw.gif" border="0"> @sharelaw.iii.com(X=X;t=t;g=g;a=a;d=d;i=i)

This option accepts additional index tags identically to the INNREACH Web option.

This option can vary by scope and language.

INSTITUTIONLABEL

This option lets you replace the phrase ,"With which institution are you affiliated?", with a customized phrase. This option accepts HTML formatting, and is set as follows:

INSTITUTIONLABEL=[desired text]

If this option is not set, the default text is "With which institution are you affiliated?"

IR_CENT_DISTLEARN

This option specifies request parameters for INN-Reach Systems that have acquired the Pickup Anywhere for INN-Reach product. It consists of two vertical-bar-delimited fields and is set as follows:

IR_CENT_DISTLEARN=[boolean]|[label]

For example:

IR_CENT_DISTLEARN=t|Pickup Institution

IR_CENT_HOLD_CHECKIN

This option defines which checkin data subfields to display in the institutional holdings display, and defines the basic column formatting of that display. Set the option with vertical-bar-delimited fields equal to the number of vertical-bar-delimited fields used in the IR_CENT_HOLD_HEADERS option, less the first column. For example:

IR_CENT_HOLD_CHECKIN=[data]|[data]|[data]|...

Valid [data] values, in any order, are:

 1    2      3
<call #> <volume> c. <copy #>

For example:

IR_CENT_HOLD_CHECKIN=E|^|^

If this option is not defined or does not appear in the WWWOPTIONS file, the system uses a default setting of:

IR_CENT_HOLD_CHECKIN=E|F

IR_CENT_HOLD_HEADERS[_lang]

This option defines the following attributes of the holdings table in the institutional holdings display:

• Number of columns
• Order of columns
• Column headers
• Column widths

Set the option as follows:

IR_CENT_HOLD_HEADERS=[header text];[column %]|[header text];[column %]

For example:

IR_CENT_HOLD_HEADERS=Library;10|Shelving Location;20|Electronic Link;20|Call Number and Serial Holdings;30|Request Status;20

If this option is not defined in the WWWOPTIONS file, the system uses a default of:

IR_CENT_HOLD_HEADERS=Location;20|Call Number;40|Status;40

This option can vary by language.

IR_CENT_HOLD_INST

This option defines basic column formatting for the institution record-level URL in the institutional holdings display. Set the option with vertical-bar-delimited fields equal to the number of vertical-bar-delimited fields used in the IR_CENT_HOLD_HEADERS Web option, less the first column. For example:

IR_CENT_HOLD_INST=[data]|[data]|[data]|...

Valid [data] values, in any order, are:

For example:

IR_CENT_HOLD_INST=u|^

IR_CENT_HOLD_INST is optional. If this option is not defined or does not appear in the WWWOPTIONS file, the system uses a default setting of:

IR_CENT_HOLD_INST=u||

IR_CENT_HOLD_INST_VARFLD

This option defines basic column formatting for the institution record-level variable length fields. Set the option with vertical-bar-delimited fields equal to the number of vertical-bar-delimited fields used in the IR_CENT_HOLD_HEADERS Web option, less the first column. For example:

IR_CENT_HOLD_INST_VARFLD=[institution MARC fields]|[data]|[data]|...

The [institution MARC fields] field defines which institution record MARC fields contain the serials holding statements and in which institution record MARC fields to look for the subfields defined in the subsequent fields of this option.

Valid data options, in any order, for the remaining fields are:

For example:

IR_CENT_HOLD_INST_VARFLD=998..|^|^|^

IR_CENT_HOLD_ITEM

This option defines which item data subfields to display and the basic column formatting of that display in the institutional holdings dispaly. Set the option with vertical-bar-delimited elements equal to the number of vertical-bar-delimited elements used in the IR_CENT_HOLD_HEADERS option, less the first column. For example:

IR_CENT_HOLD_ITEM=[data]|[data]|[data]|...

Valid [data] values are listed below. Unless otherwise stated, these values can be used in any order.

 1    2      3
<call #> <volume> c. <copy #>

For example:

IR_CENT_HOLD_ITEM=E|"Check with Library

If this option is not defined, the system uses a default setting of:

IR_CENT_HOLD_ITEM=C|U|E|F

IR_CENT_HOLD_LIMITS

This option defines when and how Institutional Holdings appear on the bibliographic display. The format is:

IR_CENT_HOLD_LIMITS=[holdliblimit]|[campuslimit]

For example, if three libraries have contributed holdings:

IR_CENT_HOLD_LIMITS=0|0

In this example, the system shows the Campus Summary and the Detailed Holdings.

IR_CENT_HOLD_LIMITS=4|2

In this example, the system shows the Detailed Holdings and does not display a Campus Summary.

IR_CENT_HOLD_LIMITS=2|2

In this example, the system does not display the Detailed Holdings and does display a Campus Summary.

IR_CENT_HOLD_LIMITS=4|4

In this example, the system displays the Detailed Holdings and does not display a Campus Summary.

IR_CENT_HOLD_LIMITS=3|3

In this example, the system does not display the Detailed Holdings and does not display any Summary Holdings. This example is an illogical setting and is included for informational purposes only.

IR_CENT_HOLD_ORDER

This option defines which order data subfields to display and the basic column formatting of that display in the institutional holdings display. Set the option with vertical-bar-delimited fields equal to the number of vertical-bar-delimited fields used in the IR_CENT_HOLD_HEADERS option, less the first column. For example:

IR_CENT_HOLD_ORDER=[data]|[data]|[data]|...

Valid [data] values, in any order, are:

 1    2      3
								<call #> <volume> c. <copy #>

For example:

IR_CENT_HOLD_ORDER=f|^|^

If this option is not defined, the system uses a default setting of:

IR_CENT_HOLD_ORDER=f

IR_CENT_HOLD_TABLEPARAM

This option controls the display parameters of the holdings table. The format is:

IR_CENT_HOLD_TABLEPARAM=[attributes]

Where [attributes] are the HTML attributes for the holdings table display. The data entered in this option is inserted between the appropriate <TABLE> and </TABLE> tags. The attributes in this field must be valid <TABLE> attributes.

For example:

IR_CENT_HOLD_TABLEPARAM=BGCOLOR=#ddeeff CELLPADDING=3 CELLSPACING=2 WIDTH=100% BORDER=1

Note that the opening < and closing > brackets are not provided for the attributes in the example above. WebPAC assigns the element contents to a <TABLE> tag.

Using the example above, WebPAC creates a <TABLE BGCOLOR=#ddeeff CELLPADDING=3 CELLSPACING=2 WIDTH=100% BORDER=1> tag.

IR_CENT_INST_TABLEPARAM

This option controls the display parameters of the "sites with holdings" table. The format is:

IR_CENT_INST_TABLEPARAM=[boolean]|[tableparams]

For example:

IR_CENT_INST_TABLEPARAM=T|BGCOLOR=#ddeeff CELLPADDING=3 CELLSPACING=2 WIDTH=100% BORDER=1

Note that the opening < and closing > brackets are not provided for the [tableparams] element in the example above. WebPAC assigns the element contents to a <TABLE> tag.

Using the example above, WebPAC creates a <BGCOLOR=#ddeeff CELLPADDING=3 CELLSPACING=2 WIDTH=100% BORDER=1> tag.

IR_CENT_LOC_[code]

This option allows the location name for items and checkin records in the holdings to display as hyperlinks that take users to a screen providing information about that location. The [code] parameter is the (maximum) five-character Innovative code for the particular location. For example:

IR_CENT_LOC_main=/screens/info_on_main.html

The location code may also contain an asterisk as a wildcard to match multiple locations that include the same pattern. For example:

IR_CENT_LOC_wes*=/screens/wes_locs.html

This example will match the locations wes, wesaa, wesar, and west.

Or:

IR_CENT_LOC_*ref=/screens/ref_locs.html

This example will match the locations ref, wref, mref, and scref.

IR_CENT_NO_HOLDINGS

This option defines the holdings display if there is a 7 field in the bibliographic record for an institution or agency, but there are no associated displayable items, checkins, or orders. The option format is:

IR_CENT_NO_HOLDINGS=[data]|[data]|[data]|...

Valid data options, in any order, are:

For example:

IR_CENT_NO_HOLDINGS="No local information available

IR_NOREAUTH[_agency]

When this option is set to a "true" value (any word starting with 't', 'T', 'y', 'Y', or the number '1') on the Central server, the WebPAC allows patrons from a local site to make multiple requests without having to re-authenticate.

If this option is set to a "false" value (any word starting with 'f', 'F', 'n', 'N', or the number '0'), or is not set, the WebPAC does not allow patrons from a local site to make multiple requests without having to re-authenticate.

This option can vary by site code.

IR_NOREAUTH_LOGOFF[_lang]

This option defines the Log Out button for logging off of the INN-Reach Central Server. This option accepts HTML values, defining either the text or an image to use as the link. For example:

IR_NOREAUTH_LOGOFF=<strong>Logout</strong>

or:

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

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

IR_NOREAUTH_LOGOFF=Log off

This option can vary by language.

IR_NOREAUTH_MSG[_lang]

This option specifies the You are logged in as message the system displays for users logged-in to the INN-Reach Central Server. This option accepts a text value with HTML markup as well as a %s placeholder for the patron name. For example:

IR_NOREAUTH_MSG=You are logged in as <em>%s</em>.

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

IR_NOREAUTH_MSG=You are logged in as %s

This option can vary by language.

IR_PLACEMENT

This option controls where the button to search the INN-Reach system displays in the in the browse display. This option accepts one of three numeric values:

If this option is not defined, the WebPAC displays the INN-Reach button as the last button on the right in the navigation row.

When this option is set to "0" or "2", the full WebPAC URL is used to determine what search target to put in the Encore URL. Otherwise it uses just the search target.

IR_RENEW_MSG

This option controls the message that displays after a user selects the option to renew an INN-Reach item and the renewal request is pending. For example:

IR_RENEW_MSG=[message text]

If this option is not defined, or does not appear in the WWWOPTIONS file, the default message is:

IR_RENEW_MSG=<FONT SIZE=-1>System is checking<BR>the availability of the item for renewal.<BR>Please check back later to find out<BR>if your renewal was allowed.</FONT>

IRMARCDISP

When this option is set to true, WebPAC on INN-Reach Central Servers displays 7-tagged 945 MARC fields in the MARC display of records. The value of this option is:

IRMARCDISP=[true or false]

If this option is set to false or not defined, then WebPAC MARC display on INN-Reach Central Servers will not show 7-tagged 945 MARC fields.

LOCALLINK_TAG

If your organization has acquired the INN-Reach URLs for Locally Held Resources product, this option specifies the MARC tag of the URL field in the institution record that WebPAC displays in the institutional holdings display for INN-Reach Central Servers.

The value is:

LOCALLINK_TAG=[marcfield]

Where [marcfield] is a y-tagged MARC field. For example:

LOCALLINK_TAG=956

This setting uses the y-tagged 956 field to display additional URLs in the institutional holdings list.

If this option is not set, the system does not display additional URLs in the bibliographic or institution records.

TIMEOUT_IRNOREAUTH

This option defines the timeout for patron authorization for INN-Reach requesting. If the IR_NOREAUTH Web option is set to a "true" value ('1', the characters 'T', 't', 'Y', or 'y', or any word beginning with one of these characters) and a patron validates against the system and makes multiple INN-Reach requests within the timeout period defined in this option, the system does not require additional validation to submit the requests. If the user submits a request after a period of inactivity in excess of the value of this option, the system prompts the user to validate.

This option accepts a numeric value for the timeout, in seconds. For example, to set a timeout for 5 minutes (300 seconds), use the following value:

TIMEOUT_IRNOREAUTH=300

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

TIMEOUT_IRNOREAUTH=1200