psi classprofile - ub.uni-marburg.de · project: psi documentation document name: psi...

PSI CLASSPROFILE | reference manual

to:

from:

cc:

project: PSI Documentation

author: Maarten Heesakkers

business unit: ITC

date: 26-01-2007

document name: C:\Documents and Settings\smitp\My

Documents\SharePoint Drafts\PSI

Classprofile.doc

document status: final

version: 1.6

remarks:

project: PSI Documentation document name: PSI Classprofile.doc

version: 1.

date: 26-01-2007 page 2 of 71

VERSION CONTROL

Version Date Author Comment

0.1 05-01-2004 M. Heesakkers Creation

0.2 28-04-2004 S. Huizer / M. Heesakkers Added \DEFAULT_SPECIAL_PRS, \FORCE_MUSTIDENTIFY,

\FULLTEXT_PUBLISHERS and \OPENURL_VENDOR

0.3 29-04-2004 M. Heesakkers Updated \SHOWRESTTL

0.4 30-11-2004 S.Huizer Added TITLE_PRS_TYPES

0.5 02-03-2005 S.Huizer Added \WEBCATFCV, \WEBCATCSDB and \WEBCATCSBES

0.6 28-09-2005 P. Smit Added \CORRELATING_PHRASES and \CLUSTER_IDENTICAL_TITLES

0.7 04-11-2005 P. Smit Updated \CLUSTER_IDENTICAL_TITLES

0.8 09-03-2006 P. Smit Added \RECTYPEAUTHKEYS_SCAN + \RECTYPEANYKEYS_SCAN

0.9 21-03-2006 P. Smit Added \SCANAUTHREC_SEE_REFERENCE + \SCANAUTHREC_RELATED_TERMS

1.0 02-06-2006 S.Huizer Added ADIGROUPS, EDITHOLDINGS, WEBCAT_LABEL_WIDTH, WEBCAT_SUPPRESS_HEADER, UCNF, UCISOCV, UCISOCV_TABLE, UCISOCV_DEFCHAR, SHOW_CHARSET, PHRASEPARSEIKT, WSFLOAN_OPTION, WSFLOANOPTION_MATCODES

1.1 26-01-2007 S.Huizer Added RSSFEEDS

1.2 24-05-2007 P. Smit Added MEDADI

1.3 31-05-2007 P. Smit Added PRSFULLLOG

1.4 04-06-2007 P. Smit Added NOABS and ARTICLE_MATCODES

1.5 27-06-2007 M. Heesakers Added ILLREQUESTOPTION and UPDATE_ILLCANDIDATELIST

1.6 26-07-2007 M. Zwaal Corrected DEBUGLEVEL => DEBUG in SHOWDEBUG comment.

1.7 10-09-2007 M. Zwaal Added TTLDOC_ADMIN.

1.9 22-10-2007 P. Smit Added GET247IIFOWNEREXCLUDED and GET247PIFOWNEREXCLUDED

1.10 01-11-2007 P. Smit Added WEBCATEDITONLYHOLDINGS, WEBCATFCVPICATOSCREEN and WEBCATFCVSCREENTOPICA

1.11 25-01-2007 P. Smit Added SHORTPRS_WITH_COPY

1.12 22-02-2008 M. Zwaal Added KSEL_RECTYPE.

1.13 28-03-2008 P. Smit Actualised SHOWINOWNLIB Alow more than one subfield being specified in LINKFIELD

1.14 01-04-2008 F. Daalmans Added COINS

1.15 02-04-2008 S.Huizer Added HMS_XSLSKIN

1.16 19-08-2008 M. Zwaal Added SHORTCCH and SHORTCCH_FMT.

1.17 22-09-2008 M. Zwaal Added REDIRECT_<template>.

23-10-2008 P. Smit Added RELOPS

26-03-2009 P. Smit Added OPENURL_LINKS

13-07-2009 P. Smit Added ABSTRACTICONFIELDS

20-10-2009 P. Smit FULLTEXTICON has no effect in XML interface

30-11-2009 P. Smit Added USERCOPYFILTER

01-12-2009 P. Smit Added USERILNFILTER and USERILNFILTER_SRU

11-12-2009 S.Huizer Added SNS_INTERFACE, SNS_USER_TITLE, LOANINFOFROMLBS


version: 1.

date: 26-01-2007 page 3 of 71

CONTENTS

1 INTRODUCTION 4

2 CLASSOPTIONS 7


version: 1.

date: 26-01-2007 page 4 of 71

1 Introduction PSI uses the so-called classprofile to control its search behavior and appearance.

A classprofile record is stored in the standard table. Each record can contain one or more classoptions.

Classoptions are configurable per database id (DB), language (LNG) and user login location (ULOC), under the following

table record key ”HERMES#CLASSPRF#[<DB>]#[<LNG>][#<ULOC>]”.

If an option depends on the origin of a title record, the key is ”HERMES#CLASSPRF#[<DB>]#[<LNG>][#<origin>]” (note

that <origin> is used instead of <ULOC>).

Each option is described as a “\<option>=<value>” pair and should not contain trailing spaces.

If an option is configurable per record owner, the attribute syntax is “\<option>_<iln>=<value>”.

Language dependent options take precedence over database dependent options, which in turn overrule the default options

in “HERMES#CLASSPRF##”.

The classoptions are described in the next chapter.

Each description of a classprofile option contains the following fields:

Field Description/value

name Name of the classoption.

description Functional purpose description.

status Optional status indication (e.g. deprecated, obsolete, bug).

product / service Product or service for which the classoption is created. This field is empty if the

classoption is for generic use (e.g. in case it affects the default search behavior).

PSI can be operated through an end-user interface or by other programs.

� End-user interfaces:

- meta-catalogs (e.g. PiCarta, EUCat, Sudoc/Abes, ZDB/DDB and GBV

document order)

- OPC4

- ORS databases

- PSI relay servers for ILL and login (a.k.a. webservers)

- stand-alone PSI implementations (e.g. Krantenbank)

� Program interfaces (direct communication through PSI commands):

- CBS4 (CAT, IMP, BibServ)

- TOLK

- iPort

- SRU

- XML

A classoption that is introduced for a particular product/service can be used by other

products/services, unless stated otherwise (e.g. “OPC4 only”). Be advised that

unexpected side effects may occur due to unintended use of a classoption.

program Program(s) that use(s) the classoption (e.g. hm_search, hm_bulkidx, hm_loan, etc.).

function Functionality that the classoption applies to (e.g. display, title matching, OUS).

configuration Configuration level of the classoption (in addition to configuration per database,

language and user login location):


version: 1.

date: 26-01-2007 page 5 of 71

� origin : record origin code;

� owner : owner iln.

This field is empty if the option applies to all origin codes and owners.

implementation Location where the classoption is implemented and/or evaluated:

� sw : in the software itself;

� asc : in a standard table record;

� FCV : in a FCV syntax with a pre-processor call.

since Indication when the option was first introduced, such as a product version or release

date/name.

comment Additional notes, for example:

� general remarks, such as side-effects;

� “see also” reference to an other classoption or document.

usage Description of the classoption syntax.

example Example of a classoption.

Remarks:

� Unless stated otherwise, the following case-independent option toggle values (<toggle>) are supported:

- 1 ON Y[ES] T[RUE] J[A]

- 0 OFF N[O] F[ALSE]

� A list (denoted by <list>) is comma-separated, unless stated otherwise.

� A range (denoted by <range>) is a comma-separated list of numbers. A ‘-‘ can be used to indicate an interval. An

interval can be closed (start-end) or open ended (start-).

� The end-user interface can be displayed in “old style” and “new style”.

The “new style” refers to the interface that was introduced with PiCarta version 3.2b.

Unless stated otherwise, a classoption that is available in the old interface is also available in the new interface.

� Unless stated otherwise, the syntax of a subfield specification is as follows:

<subfield> ::= <level><type><indicator>[/<occurrence>][ $<sbftype>]

<level> ::= one of '0', '1', '2', '*'

<type> ::= 2-digits

<indicator> ::= '@', uppercase-char or '*'

<occurrence> ::= 2-digits

<sbftype> ::= alphanumeric

<classoption name> <status>

description product/service program function

configuration implementation since

comment usage

example


version: 1.

date: 26-01-2007 page 6 of 71


version: 1.

date: 26-01-2007 page 7 of 71

2 Classoptions

A

ABSTRACTICONFIELDS

description Fields triggering the abstract icon in the brief title presentation. product/service end-user program hm_search function display

configuration implementation asc since

comment Default: "052R/00 $a, 047I/00 $a, 147J/02 $a, 047P/00 $a”.

If NOABSTRACTICON=Y then ABSTRACTIONICON has no effect. Otherwise it should contain

a comma separated list of subfields.

Fields of level 1 or 2 will only trigger the icon if you’ve specified

\SHORTPRS_WITH_COPY=YES

as well. And then they will only be seen by the software if they are in one of the ILN’s specified

by the option OWNERS usage \ABSTRACTIONICON=<subfield>[, <subfield>]…

example \ABSTRACTIONICON=047I $a, 047K $a, 044L $a, 147I $a, 247I $a, 247P $a

ADIGROUPS

description Available ADI's for set analysis product/service end-user program hm_search function limit options

configuration implementation asc since PSI 4.2

comment Used to provide a list from which a subset can be chosen in the interface configuration

usage \ADIGROUPS=<list>

example \ADIGROUPS=9001,9003,9008

ADIMAX

description External ADI filter for creating subsets (parts of a fileset, differentiated by ADI). product/service program hm_search function limit search

configuration implementation sw since

comment The external ADI filter is a string containing ADI commands, separated by semi-colons. An ADI

command is a string consisting of either an ADI mnemonic or an ADI IKT, followed by one or

more spaces, followed by its value and zero or more spaces.

If the filter contains more than one ADI command that refers to the same ADI field, the last one

is used.

The ‘;’ is interpreted as a literal if it is preceded by a ‘\’. The ‘\’ must be preceded by a ‘\’ if it is to

be taken literally.

ADI IKTs start at 9000.

usage \ADIMAX=\<filter>

<filter> ::= <command>[;<command>]...

<command> ::= <type> <value>

<type> ::= <mnemonic>|\<ikt>

<value> ::= <char>[,<char>]...


version: 1.

date: 26-01-2007 page 8 of 71

example To allow only titles with opacflag 1 to be seen: \ADIMAX=\9008 Y

Another example: \ADIMAX=\9008 J,1,N,0,U,4,5,7;\9002 5

ALLCOPIES

description Present the holdings (local and copy records) of all owners. product/service program hm_search function holding presentation


comment Switched off by default. If switched on, the holdings for all owners are presented. If switched off,

the holdings are only presented for owners that are specified with \OWNERS and not included in

\EXCLUDE_OWNERS.

Overruled by the request command of the same name. usage \ALLCOPIES=<toggle>

example

ALTLOGO

description Alternate text for the image in the upper left corner of the screen. product/service end-user (old style) program hm_search, hm_loan function Display


comment See also \LOGO and \LOGOURL. usage \ALTLOGO=<string>

example

ALWAYSFULLTEXTICON

description HTML interface: always display the fulltext icon in the brief title presentation.

XML interface: no effect. product/service end-user program hm_search function Display


comment Switched off by default. Use ‘1’ to enable. Any other value is interpreted as FALSE.

When switched on, the fulltext icon is always presented, even if a title contains no fulltext link.

\FULLTEXTICON must be switched on.

usage \ALWAYSFULLTEXTICON=<1|0>

example

ARTICLE_MATCODES

description Perform an autoscan after a search that retrieves no hits, and present the scan result.

product/service end-user program hm_search function full presentation

configuration implementation asc since 13-02-2006


version: 1.

date: 26-01-2007 page 9 of 71

comment Default value: "Ao,As".

Articles are processed differently in the following cases:

• To determine the availability of an article, the holdings of the journal must be checked if that

is requested with USELINKEDHOLDINGS.

• In full and availability presentations, replace the article by its abstract record if that is

requested with NOABS. usage \ARTICLE_MATCODES=<matcode>[,<matcode>]...

example \ARTICLE_MATCODES=Ao,As,AO,Os

AUTOSCAN

description Perform an autoscan after a search that retrieves no hits, and present the scan result.

product/service program hm_search function search behavior

configuration implementation sw since CBS4 (Abes, BSZ)

comment Switched on by default. Use ‘N’ to disable. Any other value is interpreted as TRUE. Set to 'N' to

suppress an index scan in case a search fails. usage \AUTOSCAN=<Y|N>

example

B

BITMAPADI_<ikt>

description Define the original IKT that should be used in case an IKT number is that of a bitmap ADI.

product/service end-user program hm_search function advanced search

configuration implementation sw, asc since

comment usage \BITMAPADI_<ikt>=<original ikt>

example \BITMAPADI_9023=56

BOUTON_PEB

description Display a button on the ILL request screen that allows (non-participating) libraries to retrieve the

selected title via PebNet. product/service PSI relay (Sudoc/Abes) program csw_ind function ILL

configuration implementation asc since Sudoc/Abes


Note: Not (yet) supported in the “new style” interface.

usage \BOUTON_PEB=<1|0>

example

BUYOPTION Deprecated

description Display a isbn/issn purchase request link to names.oclc.org. product/service end-user (old style) program hm_search function Display



version: 1.

date: 26-01-2007 page 10 of 71

comment Switched off by default. Use “ON” to enable. Any other value is interpreted as FALSE.

When possible, an isbn request link is generated with the content of 004A $0, otherwise an issn

request link is generated with the content of 005A $0.

Note: The destination “names.oclc.org” no longer exists.

usage \BUYOPTION=<ON|OFF>

example

C

C_CODE_TYPE

description Type of country codes in the country-of-publication selection list. product/service end-user program hm_search function advanced search

configuration implementation src, asc, FCV since Sudoc/Abes

comment The countries listed in the country-of-publication selection list are stored under the table record

key "HERMES##COUNTRY_CODES#[<code_type>]#[<language>]", where <code_type> is

substituted with the contents of \C_CODE_TYPE and <language> with the LNG variable.

In case the country list is searched with the %country pre-processor call for a code that does not

exist, the missing code will be logged and ignored.

usage \C_CODE_TYPE=<code_type>

example \C_CODE_TYPE=PICA1999

CBSLOGIN

description Perform a Central System login. product/service end-user / CBS4 program hm_login function CS login

configuration implementation sw since CBS4

comment Switched on by default. If activated, a CS login is performed for a DATABASE and LOGIN

request. Otherwise a default login is performed.

See also \DEFAULTLOGIN. usage \CBSLOGIN=<toggle>

example

CLUSTER_IDENTICAL_TITLES

description Cluster identical records before presenting them. product/service end-user program hm_search function Searching

configuration implementation sw since PSI Autumn 2005


version: 1.

date: 26-01-2007 page 11 of 71

comment Switched off by default. Variable CLUSTER overrules value of this option.

Expects the program hm_cluster to have filled the following files:

$IDXFILEREADDIR/cluster/cluster_from_ipnidx_<database-id>_<title_fileset>

$IDXFILEREADDIR/cluster/cluster_from_ipnblock_<database-id>_<title_fileset>

$IDXFILEREADDIR/cluster/cluster_sizes_<database-id>

as well as the index files of as many cluster index filesets as are mentioned in the definition of

<database-id>. An example definition is:

\2.43=1;cluster:1,96;2;cluster:2,95

It generates the variable CLUSTER_SIZE when presenting full; it fills the cluster_size field of a

brief presentation as well. The templates can then decide to present something if these fields are

not empty. Also, it enables the CLUSTER command, for example:

http://develop.pica.nl:9900/DB=2.41/SET=23/TTL=1/CLUSTER?PPN=17314327X&TITLESET=1

usage \CLUSTER_IDENTICAL_TITLES=<toggle>

example \CLUSTER_IDENTICAL_TITLES=Y

CODEEXPANSION

description Perform code expansion in the search server. product/service program hm_search function title expansion

configuration implementation sw since OPC4 v1.15

comment Switched off by default. If switched on, the NOCODEXPN variable must be unset.

If switched off, the code expansion is left to the FCV syntax tables.

usage \CODEEXPANSION=<toggle>

example

COINS

description Display a CoiNS OpenURL at the full title presentation product/service program hm_search function display

configuration implementation sw since PSI 4.5

comment Switched off by default. If activated, a link is generated and stored in the

OPENURL_COINS_HREF variable (as well as in the COINS variable, but don’t use that). The link

is a OpenURL ContextObject in Spans (CoinS) reference (see http://ocoins.info for the spec).

Other variables like OPENURL_COINS_LINKTARGET (containing “_blank” for example) might

also be generated.

usage \COINS=<toggle>

example

CONTENTSIGNOREMATADI

description Ignore the material ADI when determining whether a title is an article. product/service program hm_search function contents processing


comment Switched off by default. Use ‘Y’ to enable. Any other value is interpreted as FALSE.

usage \CONTENTSIGNOREMATADI=<Y|N>


version: 1.

date: 26-01-2007 page 12 of 71

example

CONTENTSIGNORESUPPLIERADI

description Ignore the supplier ADI when determining whether a title is an article. product/service program hm_search function contents processing



usage \CONTENTSIGNORESUPPLIERADI=<Y|N>

example

COPYMODE

description Copy record selection mode that restricts the number of copies included in a holding block.

product/service program hm_search function holding presentation


comment The copymode is a string of two characters. It applies to labeled presentations only: the first

position of the copymode string is always ignored. The 2nd position can be a '1' (first copy), an 'L'

(last copy) or an 'A' (all copies).

All copies are included if the copymode is not configured or is incorrect. usage \COPYMODE=<char><1|L|A>

example

COPYOPTION

description Display a photocopy request link to the ILL server. product/service end-user / PSI relay program hm_search function ILL



The supported material codes can be specified with \COPYOPTION_MATCODES.

The \ILLMAT and \ILLYOP restrictions apply.

usage \COPYOPTION=<ON|OFF>

example

COPYOPTION_MATCODES

description The material codes for which the photocopy link should be presented. product/service end-user / PSI relay program hm_search function ILL


comment The material code list is a sequence of consecutive bibliographic form indicators (2nd position in

002@ $0). The \COPYOPTION must be switched on in order for the list to be evaluated. By

default, no material restrictions apply. usage \COPYOPTION_MATCODES=<list>

example \COPYOPTION_MATCODES=ADTY

CORPHRDEFAULTIKT

description ikt for which correlated phrases (associations, hints) should be presented.


version: 1.

date: 26-01-2007 page 13 of 71

product/service end-user program hm_search function Brief presentation


comment Default value is 0, (which will cause a message in the ERRORLOG).

The ikt must have been generated by a separate run of hm_clusterutil. usage \CORPHRDEFAULTIKT=<ikt >

example \CORPHRDEFAULTIKT=1016

CORPHRIKTS

description List of ikt’s for which correlated phrases (associations, hints) should be presented. product/service end-user program hm_search function Brief presentation


comment Default value is the ikt specified by the classprofile option CORPHRDEFAULTIKT.

Each of the ikt’s in the list must have been generated by a separate run of hm_clusterutil. usage \CORPHRIKTS=<ikt-list>

example \CORPHRIKTS=20,29,1016,5004

CORRELATING_PHRASES

description Whether correlated phrases (associations, hints) should be printed on top of brief presentations.

product/service end-user program hm_search function Brief presentation


comment Switched off by default. Variable CORPHR overrules value of CORRELATING_PHRASES.

Expects the program hm_correlate to have filled the following files:

$IDXFILEREADDIR/cor_phrase_<index_fileset>

$IDXFILEREADDIR/cor_pidx_<index_fileset>

$IDXFILEREADDIR/cor_ipn_<index_fileset>

Generates the variable CORRELATING_PHRASES, containing the phrases as fields in that record,

which are consequently processed by the shortlist template.

usage \CORRELATING_PHRASES=<toggle>

example \CORRELATING_PHRASES=Y

COUNTRY_CODES Obsolete

description List of country codes used to create the country-of-publication selection list. product/service end-user program hm_search function advanced search


comment The codes must be the same as the attribute names under the table record key

“HERMES##COUNTRY_CODES#[<code_type>]#[<language>]”, where <code_type> is

substituted with the contents of \C_CODE_TYPE and <language> with the LNG variable.

Codes that are not available in the table record will be logged and not ignored.

usage \COUNTRY_CODES=<list>

example \COUNTRY_CODES=AU,BE,CA,CH,DE,DK,ES,FR,GB


version: 1.

date: 26-01-2007 page 14 of 71

D

DAI_EDITRECORD

description Switch to enable the ‘Edit Record’ menu item in WebCat

product/service webcat program hm_webcat function webcat

configuration implementation MM since Deprecated since Webcat

version 2 comment If the value is set to 1 the menu item is visible in the menu box.

usage \DAI_EDITRECORD=<toggle>

example \DAI_EDITRECORD=1

DAI_EXPORTRECORD

description Switch to enable the ‘Export Record’ menu item in WebCat




usage \DAI_EXPORTRECORD=<toggle>

example \DAI_EXPORTRECORD=1

DAI_INSERTRECORD

description Switch to enable the ‘Insert Record’ menu item in WebCat




usage \DAI_INSERTRECORD=<toggle>

example \DAI_INSERTRECORD=1

DAI_MAT

description Code to be able to show the material code image in the webcat presentation screen



version: 1.

date: 26-01-2007 page 15 of 71


version 2 comment

usage \DAI_MAT=<matcode>

example \DAI_MAT=B

DATABASE_ORIGIN

description Code for identifying the source of the original bibliographic records in a title database.

product/service meta-catalog program hm_search function title matching

configuration implementation since PiCarta 3.2b

comment The database origin is required when the bibliographic database contains “foreign” records. The

origin is used to identify the “native” records that have no source code (003C $a / 203C $a is

missing).

If the database origin is not set, the first origin code from \HOLDINGS_ORDER will be used as

the default (deprecated). usage \DATABASE_ORIGIN=<source string>

example \DATABASE_ORIGIN=PICA

DBSADI

description List of characters representing the supported databases (= supplier ADI values).

product/service meta-catalog program hm_search function advanced search


comment Also referred to in the old style end-user interface (database overview template).

See also: MATADI, MEDADI

usage \DBSADI=<list>

example \DBSADI=1,2,3,4,5,6,9,A,B,D,E,F,G,I,X,a,b

DEFAULT_BORROWER_ID

description Borrower id that is used in case the user provides no login. product/service OPC4 program hm_loan function OUS


comment usage \DEFAULT_BORROWER_ID=<string>

example

DEFAULT_BORROWER_PW

description Borrower password that is used in case the user provides no login. product/service OPC4 program hm_loan function OUS


version: 1.

date: 26-01-2007 page 16 of 71


comment usage \DEFAULT_BORROWER_PW=<string>

example

DEFAULT_OUSUSERNR

description Default LBS OUS user number that the loan server uses to login. product/service OPC4 program hm_loan, hm_search function OUS


comment This default number is used in case there is no location dependent user number configured in the

table record “HERMES#OUS_USERS#[<dbname>#]”. The value is stored in the OUSUSER

variable. After loan server has logged in, it can use a different user-number in order to let LBS

adjust its context to it. usage \DEFAULT_OUSUSERNR=<usernumber>

example

\DEFAULT_SPECIAL_PRS

description Name of the presentation syntax that is configured under the “hidden” link in the full title/holding

presentation. product/service end-user program hm_search function display/debugging

configuration implementation asc since PSI Spring 2004

comment If unset, it defaults to “PP”, which is a hard-coded diagnostic presentation.

The value is supplied to the &PRS request command.

See also \PRS. usage \DEFAULT_SPECIAL_PRS=<string>

example \DEFAULT_SPECIAL_PRS=PP (diagnostic, level 0)

\DEFAULT_SPECIAL_PRS=PP%7F (diagnostic, all levels)

\DEFAULT_SPECIAL_PRS=PP%7E (diagnostic, all levels, NULL syntax)

DEFAULTIMPLIEDAND

description Use Boolean “AND” as the default search selection instead of “OR”. product/service program hm_search function search behavior



usage \DEFAULTIMPLIEDAND=<Y|N>

example

DEFAULTLOGIN

description List with default login details. product/service end-user program hm_login function CS login



version: 1.

date: 26-01-2007 page 17 of 71

comment The default login is configured as a list of cookie attribute <name><value> pairs. If unset, the

default login table is used (login details are stored under the \<dbname> attribute in the table

record “DEFAULTLOGINS”).

Note: \CBSLOGIN must be switched off. usage \DEFAULTLOGIN=<list>

<list> ::= <name><value>[,<name><value>]...

<name> ::= name of the cookie attribute

<value> ::= value of the cookie attribute

example \DEFAULTLOGIN=U99999,Kchinabase,I1,B1005 ,SY,NChinabase default login

DEFIKT

description Default IKT to be used instead of the first IKT from the IKT list. product/service program hm_search function search behavior


comment The default IKT is overruled by the IKT variable. usage \DEFIKT=<ikt>

example

DWNPRS

description List of available download presentations product/service end-user program hm_search function download


comment If unset, the default download presentations are “DEFAULT” (full presentation) and “BRIEF” (brief

presentation). These are respectively defined by the syntax table record

“HERMES#FCV#pica#weblabelled” and “HERMES#FCV#pica#webbrief”.

For other presentations, a syntax must be installed under the key

“HERMES#FCV#pica#weblabelled#<presentation>”. The corresponding presentation name must

be configured with the language table attribute “\PRS_<presentation>=<string>”.

The options in the download selection list are presented in the configured order.

usage \DWNPRS=<list>

example \DWNPRS=DEFAULT,BRIEF,pica3,mopc,ISBD

E

EDITHOLDINGS

description Allow holding editing and display button in the interface product/service end-user program hm_search function display


comment Turned off by default. usage \EDITHOLDINGS=<toggle>

example \EDITHOLDINGS=<0|1>

ELINKCODEFIELD


version: 1.

date: 26-01-2007 page 18 of 71

description Specification of the periodical subfield containing the identification code of an electronic link

supplier. product/service end-user program hm_search function electronic linking

configuration implementation sw since Consumentengids

comment The supplier code is used for validating user access to an electronic link to an article.

If the subfield specification is not set, the supplier code is retrieved from the periodical’s 001P $a.

If a supplier code is available and the user id is not 0, the code must match against the \ADIMAX.

See also \ELINK[ENDYEARFIELD|MEDIATORFIELD|STARTYEARFIELD|SUPPLIERFIELD].

The ELINK* options do not apply to the creation of electronic links from copy records.

usage \ELINKCODEFIELD=<subfield>

example \ELINKCODEFIELD=001P $a

ELINKENDYEARFIELD

description Specification of the periodical subfield containing the end of the availability interval of an

electronic link. product/service end-user program hm_search function electronic linking


comment The interval end is used for testing the availability of an electronic link.

If the subfield specification is not set, the end of the interval is retrieved from the periodical’s

001P $e. The publication date of the article may not exceed the specified end.

Note: The specified subfield can contain one or more instances of ‘x’ or ‘X’. These are

substituted with ‘9’ to assume the latest year possible.

See also \ELINK[CODEFIELD|MEDIATORFIELD|STARTYEARFIELD|SUPPLIERFIELD].


usage \ELINKENDYEARFIELD=<subfield>

example \ELINKENDYEARFIELD=001P $e

ELINKMEDIATORFIELD

description Specification of the periodical subfield containing the identification code of an electronic link

mediator. product/service end-user program hm_search function electronic linking



version: 1.

date: 26-01-2007 page 19 of 71

comment The optional mediator code (analogue to an institute id) is used with the supplier id to retrieve

the \URL attribute from the table record “HERMES#LNMDEF#LIB#<supplier>[/<mediator>]”.

The free format OpenURL template in this attribute is expanded into an electronic link.

If the subfield specification is not set, the mediator code is retrieved from the periodical’s 001P

$i.

See also \ELINK[CODEFIELD|ENDYEARFIELD|STARTYEARFIELD|SUPPLIERFIELD].


usage \ELINKMEDIATORFIELD=<subfield>

example \ELINKMEDIATORFIELD=001P $I

ELINKSTARTYEARFIELD

description Specification of the periodical subfield containing the start of the availability interval of an

electronic link. product/service end-user program hm_search function electronic linking


comment The interval start is used for testing the availability of an electronic link.

If the subfield specification is not set, the start of the interval is retrieved from the periodical’s

001P $d. The publication date of the article may not precede the specified start.

Note: The specified subfield can contain one or more instances of ‘x’ or ‘X’. These are

substituted with ‘0’ to assume the earliest year possible.

See also \ELINK[CODEFIELD|ENDYEARFIELD|MEDIATORFIELD|SUPPLIERFIELD].


usage \ELINKSTARTYEARFIELD=<subfield>

example \ELINKSTARTYEARFIELD=001P $d

ELINKSUPPLIERFIELD

description Supplier id subfield specification. product/service end-user program hm_search function electronic linking


comment The supplier code (analogue to a library id) is used with the optional mediator id to retrieve the

\URL attribute from the table record “HERMES#LNMDEF#LIB#<supplier>[/<mediator>]”. The

free format OpenURL template in this attribute is expanded into an electronic link.

If the subfield specification is not set, the supplier code is retrieved from the periodical’s 001P $h.

See also \ELINK[CODEFIELD|ENDYEARFIELD|MEDIATORFIELD|STARTYEARFIELD].


usage \ELINKSUPPLIERFIELD=<subfield>

example \ELINKSUPPLIERFIELD=001P $h

EXAMPLECOLOR

description HTML font color used for highlighting examples in help screens.


version: 1.

date: 26-01-2007 page 20 of 71

product/service end-user program hm_search function Interface


comment The value can either be a color name (e.g. “red”, “blue”) or a six-digit hexadecimal color value

preceded by a hash: #RRGGBB, where R, G and B are hexadecimal digits that respectively define

the amount of red, green and blue.

See also \TABLECOLOR. usage \EXAMPLECOLOR=<#RRGGBB>|<color name>

example \EXAMPLECOLOR=#009999

EXCLUDE_OWNERLIBS

description Range of libraries for which the holdings are not included in the title. product/service program hm_search function holding presentation

configuration origin, owner implementation sw since

comment A copy record is not added to the title in case the library number in one of the subfields 209A $b,

209J $b or 209F $a is within the specified range.

A range can only contain library ids: "<library>/<institute>" is not supported. usage \EXCLUDE_OWNERLIBS[_<iln>]=<libid range>

example [HERMES#CLASSPRF#2.41##GBV]

\EXCLUDE_OWNERLIBS_213=0974

\EXCLUDE_OWNERLIBS_239=3605,3606

\EXCLUDE_OWNERLIBS_266=3620-3624,3626

\\

EXCLUDE_OWNERS

description Range of owners for which the holdings are not included in the title. product/service program hm_search function holding presentation

configuration origin implementation sw since

comment usage \EXCLUDE_OWNERS=<iln range>

example [HERMES#CLASSPRF#2.41##GBV]

\EXCLUDE_OWNERS=

2,7-9,19,35-37,41,46,85,89,102,103,106-108,141,142,156,172-174,177-

179,181,190,210,229,236,242,246,247,249,251,261,274,275,277,284,285

\\

EXCLUDE_RECORD_CONTENTS

description Filter for excluding holding records from a title. product/service program hm_search function holding presentation

configuration origin, owner implementation sw since PSI Maintenance

comment The filter excludes holding records from a title based on the presence or absence of subfields

(main, local, copy) and their contents.


version: 1.

date: 26-01-2007 page 21 of 71

usage \EXCLUDE_RECORD_CONTENTS[_<iln>]=<contents spec>

<contents spec> ::= <option>[;<option>]...

<option> ::= <tagspec>:<stringlist>

<tagspec> ::= <level><type><indicator>[/<occurrence>][ $<sbftype>]

<level> ::= one of '0', '1', '2' or '*'

<type> ::= 2-digits

<indicator> ::= '@', uppercase-char or '*'

<occurrence> ::= 2-digits

<sbftype> ::= alphanumeric

<stringlist> ::= [&]<stringspec>[,[&]<stringspec>]...

<stringspec> ::= <flag>|[<flag>]<pos>#[<string>]

<flag> ::= +|-

<pos> ::= 1 or more digits (the position to search from)

<string> ::= any string (excluding comma, colon and semi-colon)

- If $<sbftype> is not set, the first subfield in the tag will be searched.

- A <stringspec> that is preceded by an ampersand must evaluate to TRUE in combination with any

other <stringspec> in <stringlist> that is preceded by an ampersand.

- If <stringspec> only contains a '+', the specified subfield must be present regardless its contents.

- If <stringspec> only contains a '-', the specified subfield is expected to be missing (preceding

ampersand is ignored).

- If <stringspec> starts with a '+' (implicit), the specified string must be present.

- If <stringspec> starts with a '-', the specified string must be missing.

- If <pos> is higher than 0, <string> is compared (case-sensitive) against the subfield contents,

starting at the position indicated by <pos>.

- If <pos> is 0, a normalized <string> search is performed in the subfield contents.

- If <string> is empty, the subfield contents must be terminated after the position indicated by

<pos>.

example For example, a record is in acquisition if one of the following conditions is true:

1. the third position in 002@ $0 is an 'a';

2. the first position in 208@ $b is an 'a';

3. the first position in 209<A|J> $d is an 'a';

4. subfield 209<A|J> $a contains "acq" or $f contains "acq" or "bestelling".

To exclude acquisition records, the following origin dependent classoption should be configured:

[HERMES#CLASSPRF#2.41##PICA]

\EXCLUDE_RECORD_CONTENTS=

002@ $0:3#a;208@ $b:1#a;209A $d:1#a;209A $a:0#acq;209A $f:0#acq,0#bestelling;209J

$d:1#a;209J $a:0#acq;209J $f:0#acq,0#bestelling

EXITURL

description The link that will be followed when exiting the server. product/service end-user program hm_search, hm_loan function redirection

configuration implementation asc, sw since

comment The link value is assigned to the DEST variable and stored in the LOCATION variable. If it is

empty, the EXITDONE template is presented instead. usage \EXITURL=<url>

example To direct the user to a website: \EXITURL=http://www.oclcpica.nl

To direct the user to the start page: \EXITURL=/


version: 1.

date: 26-01-2007 page 22 of 71

F

FORCE_MUSTIDENTIFY

description Force the end-user to identify himself. product/service end-user / PSI relay program hm_search, hm_loan function login

configuration implementation sw since PSI Spring 2004

comment Switched on by default. If switched on, the end-user must always identify himself. This overrules

the user account settings. usage \FORCE_MUSTIDENTIFY=<toggle>

example

FREEILL_LOGO

description Name of the image file located in the $HM_IMAGE_BASE/logo directory, which appears in the

upper left corner of the screen. product/service IPort program hm_search function display


comment The pixel size of the image should be 120 pixels (wide) by 90 pixels (high). Other sizes are likely

to result in a deformed logo.

See also \LOGOURL and \FREEILL_LOGO_ALT. usage \FREEILL_LOGO=<filename>

example

FREEILL_LOGO_ALT

description Alternate text for the image in the upper left corner of the screen. product/service IPort program hm_search function display


comment See also \FREEILL_LOGO and \LOGOURL. usage \FREEILL_LOGO_ALT=<string>

example

FREE_REQUEST_TITLE

description Display the free title request link on ppn level. product/service OPC4 only program hm_search function display



usage \FREE_REQUEST_TITLE=<ON|OFF>

example

FTCTX_BRIEF

description Show fulltext context in the brief title presentation. product/service program hm_search function display



version: 1.

date: 26-01-2007 page 23 of 71

comment Switched off by default. If switched on, the $HMSFTCACHEDIR environment variable must point

to the title cache directory. usage \FTCTX_BRIEF=<toggle>

example

FTCTX_FULL

description Show fulltext context in the full title presentation. product/service program hm_search function display


comment Switched off by default. If switched on, the $HMSFTCACHEDIR environment variable must point

to the title cache directory. usage \FTCTX_FULL=<toggle>

example

FTSUBLINKS


configuration implementation since PSI 4.2

comment Default is N. usage \FTSUBLINKS=<Y|N>

example \FTSUBLINKS=Y

FULLTEXT_PUBLISHERS

description List of publishers for which a fulltext icon is presented in the brief title presentation.

product/service end-user program hm_search function display


comment Titles that have a publisher code in 007D $l that matches one of the publishers in the list are

presented with a fulltext icon.

The list is not evaluated in case the publication is of type ‘O’ and has a 009P/03 $a.

See also \FULLTEXTICON.

usage \FULLTEXT_PUBLISHERS=<list>

example \FULLTEXT_PUBLISHERS=KHA

FULLTEXTICON

description HTML interface: activate fulltext support: display the fulltext icon in the brief title presentation

and the fulltext link in the full title presentation.

XML interface: no effect. product/service end-user program hm_search function display


comment Switched on by default. Use ‘0’ to disable. Any other value is interpreted as TRUE.

See also \ALWAYSFULLTEXTICON, \FULLTEXTLINKFROMCOPY and

\FULLTEXT_PUBLISHERS.


version: 1.

date: 26-01-2007 page 24 of 71

usage \FULLTEXTICON=<1|0>

example

FULLTEXTLINKFROMCOPY

description Retrieve the fulltext link from the copy record and display it in the full title presentation.



comment Switched off by default. If switched on, the fulltext link is retrieved from 209R $a. If this option is

disabled or no 209R $a is found, the fulltext link is retrieved from 009P/03 $a.

The link is stored in the ABSTRACTURL variable. To display it, \FULLTEXTICON must be

switched on.

usage \FULLTEXTLINKFROMCOPY=<toggle>

example

G

GET247IIFOWNEREXCLUDED

description Hack to get 247I of excluded owners presented in PiCarta. product/service end-user program hm_search function full presentation


comment 247I/** will be added in front of the first 101@ tag, outside of any copy record!

For each copy record, only the first 247I/** will be added.

If unset, it defaults to "N" usage \GET247IIFOWNEREXCLUDED=<toggle>

example \GET247IIFOWNEREXCLUDED=Y

GET247PIFOWNEREXCLUDED

description Hack to get 247P of excluded owners presented in PiCarta. product/service end-user program hm_search function full presentation


comment 247P/** will be added in front of the first 101@ tag, outside of any copy record!

For each copy record, only the first 247P/** will be added.

If unset, it defaults to "N" usage \GET247PIFOWNEREXCLUDED=<toggle>

example \GET247PIFOWNEREXCLUDED=Y

GOOIKTNUM

description IKT number of the basic classification code (GOO). product/service program hm_search function search behavior


comment Used when the &GOO request command is issued to search on classification subject.

If unset, it defaults to 5004.


version: 1.

date: 26-01-2007 page 25 of 71

usage \GOOIKTNUM=<ikt>

example

GSKEYS

description Range of supported advanced search IKTs. product/service end-user program hm_search function advanced search


comment The advanced search keys are presented in the order in which the IKTs are configured. If unset,

the content of \KEYS is used.

See also \GSKEYS_PRESET. usage \GSKEYS=<ikt range>

example \GSKEYS=1016,4,5,1004,2,1009,29,1007,3,54,1018,5004,5040,8063,8117,9001,9003

GSKEYS_PRESET bug

description List of advanced search IKT presets. product/service end-user program hm_search function advanced search


comment The number of elements in this list determines the number of advanced search entry boxes being

presented. If unset, 4 search boxes are presented.

For each IKT in the list, a search box is presented with the IKT as the preset search key value. If

an IKT is not in the \GSKEYS range, the first IKT from \GSKEY is used as the preset value.

Bug: In case \GSKEYS_PRESET is configured and \MAX_ADVANCED_SEARCHBOX is not, no

search input box is presented in the advanced search screen.

usage \GSKEYS_PRESET=<ikt list>

example \GSKEYS_PRESET=1004,4,1016,1016

H

HIGHLIGHT_IKT

description IKT used for highlighting search terms. product/service end-user program hm_search function search term highlighting

configuration implementation sw since PiCarta v3.1

comment If set to ‘0’, no highlighting will be done. If unset, IKT 4 will be used.

The <ikt> must be defined in the IDXDEF table. usage \HIGHLIGHT_IKT=<ikt>|0

example \HIGHLIGHT_IKT=8894

HMS_XSLSKIN

description Directory containing the presentation skin product/service end-user program hm_search function presentation skin

configuration implementation asc since PSI v4.5


version: 1.

date: 26-01-2007 page 26 of 71

comment Used in combination with the FILEMAP setting HMS_XSLSKINBASE

usage \HMS_XSLSKIN=<string>

example \HMS_XSLSKIN=/worldcat_gui

HOMEURL

description The link behind the Home button in the button bar. product/service end-user (old style) program hm_search, hm_loan function display


comment If unset, the environment variable of the same name will be used. usage \HOMEURL=<url>

example

HTML

description Switch for activating the “new style” interface. product/service end-user (new style) program hm_search function interface

configuration implementation sw, asc since PiCarta 3.2b


Overruled by the request command of the same name.

usage \HTML=<Y|N>

example activate new interface: \HTML=Y

activate old interface: \HTML=N

HTML_MAINTEMPLATE

description Name of the template that is used as the main entry point for the “new style” interface.

product/service end-user (new style) program hm_search function interface

configuration implementation src since PiCarta 3.2b

comment \HTML must be switched on. usage \HTML_MAINTEMPLATE=<template>

example \HTML_MAINTEMPLATE=MAIN

HOLDINGS_ORDER

description Order in which the holdings of matching titles are added to the selected title. product/service program hm_search function title matching

configuration implementation sw since PiCarta 3.2b


version: 1.

date: 26-01-2007 page 27 of 71

comment The presence of this option activates online matching of title records from different origins

(partners) and merging of their holdings. If the bibliographic database only contains records of the

same origin, then \MATCHTITLE should be used instead.

The status of online matching and merging can with overruled by the &MATCHTITLE request

command.

Note: The implicit use of the first sortcode of this classoption as the default database origin is

deprecated; the first code can be an ownergroup id (defined with \OWNERS_<ownergroup id>)

instead of a real origin code. The database origin should be configured explicitly with the

\DATABASE_ORIGIN classoption.

Defining language table attributes:

- Each folder name that is used in the holding presentation is defined by the language table

attribute “\LABEL_HOLDING_[<clustername>]|[<origin>[_<ownergroup id>]]=<text>”.

- Each cluster is presented as a top-level folder in the availability presentation (attribute

“\LABEL_HOLDING_<clustername>”).

- If a cluster's expansionflag is switched on, a second folder level is created for each sortcode.

The attribute must contain the origin code: “\LABEL_HOLDING_<origin>”.

- In case the sortcode is an ownergroup, the ownergroup id must also be appended:

“\LABEL_HOLDING_<origin>_<ownergroup id>.

Sort order:

- If the holdings of the login location must be presented first (\ULOCFIRST is switched on), the

cluster to which the login location belongs is sorted to the top and the login location is listed

first. The preferred cluster is then followed by clusters that have a partial match on the user’s

origin and ownergroup id. Finally, the remaining clusters are presented in the order as

defined by \HOLDINGS_ORDER.

- If \ULOCFIRST is switched off, the sortorder is used as defined by \HOLDINGS_ORDER.

usage \HOLDINGS_ORDER=<sortcluster spec>

<sortcluster spec> ::= <sortcluster>[;<sortcluster>]...

<sortcluster> ::= <clustername>/<expansionflag>:<sortcode>[,<sortcode>]

<clustername> ::= cluster identification string

<expansionflag> ::= <Yy1>|<Nn0>

<sortcode> ::= <origin>|<ownergroup id>

<origin> ::= record origin (e.g. PICA, GBV)

<ownergroup id> ::= ownergroup identification string (e.g. WSF)

- The <origin> matches the identification code in subfield 003C $a / 203C $a.

- The <clustername> can be of any value except “UNKNOWN”, which is the internal code for

origins that are not included in the holdings order.

- The value of each <clustername> and <sortcode> must be unique. Also the first letter of

<origin> must be unique, thus a combination like “AAA” and “ABC” is not possible.

- The <expansionflag> indicates whether the origin must be presented as a separate folder

level. Both <clustername> and <sortcode> are used to retrieve translation strings for the

folder names.


version: 1.

date: 26-01-2007 page 28 of 71

example \HOLDINGS_ORDER=NE/N:PICA;DU/N:GBV

I

IBL_REQUEST bug

description Display the ILL request link. product/service OPC4 only (new style) program hm_search function display



Bug: The underlying request command is incorrect:

"<%url(server_hms)>LBSREQUEST&PPN=<%variable(TTLPPN)>". It should be:

"<%url(server_hms)>LBSREQUEST?PPN=<%variable(REQPPN)>".

usage \IBL_REQUEST=<ON|OFF>

example

IGNOREBACKSLASHBEFOREOPWORD obsolete

description Ignore the backslash in front of a stopword. product/service program hm_search function search behavior



usage \IGNOREBACKSLASHBEFOREOPWORD=<Y|N>

example

IKT<ikt>

description Additional search IKT definitions. product/service end-user program hm_search function search behavior


comment The mnemonic is used in the search command. The description is presented in the search key

menu list. usage \IKT<ikt>=<mnemonic>=<description>

example \IKT1004=AUT=author/artist

\IKT29=TRF=subject headings

ILLMAT

description Publication types for which a request link is supported. product/service end-user program hm_search function ILL


comment In order to create an ILL request link, the REQPPN variable must be set with the PPN of the

requested title. The publication types that are eligible for ILL are configured as a sequence of

consecutive characters: first position in 002@ $0 or an ‘*’ to indicate all types.

If unset, only material type ‘A’ is used.

The \ILLYOP restrictions apply.


version: 1.

date: 26-01-2007 page 29 of 71

usage \ILLMAT=<list>

example \ILLMAT=ABDEGHIKLMOQSTUVYX

ILLOPTION

description Display the ILL request link in the full title/holding presentation. product/service OPC4 only program hm_search function display



usage \ILLOPTION=<ON|OFF>

example

ILLREQUESTOPTION

description Display a free request link to the ILL server (WebIND). product/service end-user program hm_search function ILL

configuration implementation asc since CBS 4.0

comment Switched off by default. Use "ON" to enable. Any other value is interpreted as FALSE.

The supported material codes are specified with COPYOPTION_MATCODES and

LOANOPTION_MATCODES.

usage \ILLREQUESTOPTION=<ON|OFF>

example

ILLYOP

description Year of publication for which a request link is supported. product/service end-user program hm_search function ILL


comment In order to create an ILL request link, the REQPPN variable must be set with the PPN of the

requested title. The year of publication that makes an item eligible for ILL is configured with

ILLYOP. Year of publication is a string of digits. If no year is defined, ‘1800’ is used.

The REQPPN variable is set in case subfield 011@ $a:

- contains a year that is greater than or equal to the specified year publication (instances of ‘x’

and ‘X’ are replaced with ‘9’ to assume the latest year possible);

- contains non-digits other than ‘x’ and ‘X’;

- is missing.

The \ILLMAT restrictions apply.

Note: The year of publication applies to all publication types.

usage \ILLYOP=<string>

example \ILLYOP=1960

IMPLICITTRUNCATION

description Implicitly truncate phrase index searches. product/service program hm_search function search behavior


version: 1.

date: 26-01-2007 page 30 of 71


comment Switched on by default. Some IKTs behave like ‘?’ was appended. This option is introduced to

disable this implicit truncation. usage \IMPLICITTRUNCATION=<toggle>

example

INITIALSCANBACKWARD

description Include two phrases before the requested phrase when scanning. product/service program hm_search function search behavior


comment Switched on by default. usage \INITIALSCANBACKWARD=<toggle>

example

ISBNFIELD

description Specification of the subfield(s) (repeatable) used for online matching titles on ISBN.

product/service program hm_search function title matching


comment If the subfield specification is not set, the ISBN is retrieved from each 004A $0.

If more than one subfield is specified, only the first specification that results in a match is used.

usage \ISBNFIELD=<subfield list>

example \ISBNFIELD=004A $0

ISBNIKT

description IKT used for online matching titles on ISBN. product/service program hm_search function title matching


comment If unset, \ISXNIKT is used, or IKT 7 when defined, otherwise IKT 1007.

Overruled by respectively the &ISBNIKT and &ISXNIKT request command.

The <ikt> must be defined in the IDXDEF table. usage \ISBNIKT=<ikt>

example

ISSNFIELD

description Specification of the subfield(s) (repeatable) used for online matching titles on ISSN.



comment If the subfield specification is not set, the ISBN is retrieved from each 005A $0.

If more than one subfield is specified, only the first specification that results in a match is used.

usage \ISSNFIELD=<subfield list>


version: 1.

date: 26-01-2007 page 31 of 71

example \ISSNFIELD=005A $0

ISSNIKT

description IKT used for online matching titles on ISSN. product/service program hm_search function title matching


comment If unset, \ISXNIKT is used, or IKT 8 when defined, otherwise IKT 1007.

Overruled by respectively the &ISSNIKT and &ISXNIKT request command.

The <ikt> must be defined in the IDXDEF table. usage \ISSNIKT=<ikt>

example

ISXNIKT

description IKT used for online matching titles on ISSN/ISBN. product/service program hm_search function title matching


comment Used in case \ISSNIKT or \ISBNIKT is unset. usage \ISXNIKT=<ikt>

example

ISXNOFFLINE

description Perform offline matching of titles on ISSN and ISBN. product/service program hm_search function title matching


comment Switched on by default. Overruled by the request command of the same name.

The PPN of a title that was matched offline (i.e. not by the search server) is stored in the

repeatable tag 039S in $9. The copies of the matching title(s) are merged with the selected title.

Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be configured.

\MATCHISXN must be switched on.

usage \ISXNOFFLINE=<toggle>

example \ISXNOFFLINE=N

ISXNONLINE

description Perform online matching of titles on ISSN and ISBN. product/service program hm_search function title matching



Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be configured.

\MATCHISXN and at least one of \MATCHISSN and \MATCHISBN must be switched on.

Online matching is only performed when \MATCHSWETS is switched off or returns no results.

usage \ISXNONLINE=<toggle>

example


version: 1.

date: 26-01-2007 page 32 of 71

J




comment usage

example

K

KEYS

description Range of supported simple search IKTs. product/service program hm_search function search behavior


comment The simple search keys are presented in the order in which the IKTs are configured.

If unset, all IKTs defined in the index are used.

The translations of the search keys are stored under the table record key

“HERMES#KEYTXT#<language>##LIST” in the attribute “\<ikt>=<mnemonic>=<keyname>”.

usage \KEYS=<ikt list>

example \KEYS=1016,4,5,1004,2,1009,29,1007

KSEL

description Tag/subfield selection filter. product/service program hm_search function title handling


comment The selection filter is a list of subfield specifications that define which subfields are included in a

title record. If a specification starts with a ‘-‘, the selection is inverted, i.e. all subfields except the

specified one are presented. This option is overruled by the request command of the same name.

usage \KSEL=<filter>

<filter> ::= <sbfspec>[,<sbfspec>]...

<command> ::= <type> <value>

<sbfspec> ::= [-]<lev><type><ind><occ><sbf>

<lev> ::= one of '0', '1', '2', '*'

<type> ::= 1 .. 99 or '*'

<ind> ::= '@', uppercase-char or '*'

<occ> ::= 1 .. 99 or '*'

<sbf> ::= one or more of 0-9a-zA-Z or '*'

- The ‘-‘ flag inverts the selection: select all, except the specified subfield(s).

- The syntax is not validated, except for the length of <occ>. The occurrence is limited to 2

positions so it can be followed directly by a numerical subfield identifier.


version: 1.

date: 26-01-2007 page 33 of 71

example \KSEL=002@**,003@*0,009P*a,011@*abn,021A*abdf,028A*adfgh,028B*adf,028C*adf,028I*a,033A*

d,036E*al,038N*03,047D01a

\KSEL=-029F**

KSEL_RECTYPE

description Tag/subfield pre-selection filter based on record type. product/service program hm_search function title handling


comment This filtering is done before KSEL filtering and it is record type dependent. The format is a

comma-separated list (like KSEL) where the first element indicates what records to filter. This

option cannot be overruled by the request parameter of the same name.

usage \KSEL_RECTYPE=<rectype>,<filter>

<rectype> ::= "TITLE" | "AUTHORITY" | "ILLREQUEST" | "ANY"

<filter> ::= any KSEL filter

example \KSEL_RECTYPE=AUTHORITY,-132A**

L

L_CODE_TYPE

description Type of language codes in the language-of-publication selection list. product/service end-user program hm_search function advanced search

configuration implementation src, asc, FCV since Sudoc/Abes

comment The languages listed in the language-of-publication selection list are stored under the table record

key "HERMES##LANGUAGE_CODES#[<code_type>]#[<language>]", where <code_type> is

substituted with the contents of \L_CODE_TYPE and <language> with the LNG variable.

In case the language list is searched with the %language pre-processor call for a code that does

not exist, the missing code will be logged and ignored.

The \SEARCHOPTIONS list must contain “TAA”.

usage \L_CODE_TYPE=<code_type>

example \L_CODE_TYPE=PICA1999

\L_CODE_TYPE=USMARC1999

LANGUAGE_CODES obsolete

description List of language codes used to create the language-of-publication selection list. product/service end-user program hm_search function advanced search


comment The codes must be the same as the attribute names under the table record key

"HERMES##LANGUAGE_CODES#[<code_type>]#[<language>]", where <code_type> is

substituted with the contents of \L_CODE_TYPE and <language> with the LNG variable.

Codes that are not available in the table record will be logged and ignored.

The \SEARCHOPTIONS list must contain “TAA”.

usage \LANGUAGE_CODES=<list>


version: 1.

date: 26-01-2007 page 34 of 71

example \LANGUAGE_CODES=dan,dut,eng,fin,fre,ger,hun,ita,lat

LANGUAGES

description List of supported languages. product/service end-user program hm_search function language support


comment For each mnemonic in the list, a language switch is created in the interface that sets the LNG

variable. usage \LANGUAGES=<list>

example \LANGUAGES=NE,EN,DU

LINKFIELD

description Specification of the subfield(s) that contains the PPN of a title that was matched offline (i.e.

already present in a $9 subfield). product/service program hm_search function title matching


comment If the subfield specification is not set, the PPN's are retrieved from 039S $9 subfields.

If the tag is repeatable, all PPN's will be matched. If the subfield is repeatable, only the first of

every tag is used for matching.

It is required for a match that BOTH titles refer to each other via the same type of subfield. So if

title1 contains a 039S $9 with the PPN of title2 but title2 contains no 039S $9 with the PPN of

title1 then title1 and title2 do not match.

Offline matching can be suppressed by specifying either:

\ISXNOFFLINE=N

or

\MATCHISXN=N

usage \LINKFIELD=<subfield>[, <subfield>]…

example \LINKFIELD=039T $9, 039S $9

LOANACTIONSINNEWWINDOW

description Perform loan actions in a new window. product/service OPC4 only (LBS3) program hm_loan, hm_search function display



\SHOWOPCUSERINFO must be switched on and the $HMSLBS_VERSION environment variable

not set to ‘4’.

usage \LOANACTIONSINNEWWINDOW=<Y|N>

example

LOANCOPYBUY obsolete

description Display the loan, copy and buy links in the full title/holding presentation. product/service end-user (old style) program hm_search function ILL



version: 1.

date: 26-01-2007 page 35 of 71


usage \LOANCOPYBUY=<ON|OFF>

example

LOANINFOFROMLBS

description Toggle to determine where the availability info is coming from (direct LBS or PSI) product/service end-user program hm_search function display

configuration implementation asc since OPC4 V2.8.0.4

comment Switched off by default. Use “Y” to enable. Any other value is interpreted as FALSE.

Only works with the wordlcat_gui XML/XSLT interface.

usage \LOANINFOFROMLBS=<Y|N>

example \LOANINFOFROMLBS=Y

LOANOPTION

description Display a loan request link to the ILL server. product/service end-user / PSI relay program hm_search function ILL



The supported material codes can be specified with LOANOPTION_MATCODES.

The \ILLMAT and \ILLYOP restrictions apply.

usage \LOANOPTION=<ON|OFF>

example

LOANOPTION_MATCODES

description Material codes for which the loan link should be presented. product/service end-user / PSI relay program hm_search function ILL


comment The list of material codes is a sequence of consecutive bibliographic form indicators (2nd position

in 002@ $0). The \LOANOPTION must be switched on in order for the list to be evaluated.

By default, no material restrictions apply.

usage \LOANOPTION_MATCODES=<list>

example \COPYOPTION_MATCODES=BY

LOCATION_LOGIN

description Login location. product/service end-user / CBS4 program hm_login function login


comment Source code that is used to perform a location login. usage \LOCATION_LOGIN=<location>


version: 1.

date: 26-01-2007 page 36 of 71

example \LOCATION_LOGIN=GBV

LOGO

description Name of the image file located in the $HM_IMAGE_BASE/logo directory, which appears in the

upper left corner of the screen. product/service end-user program hm_search, hm_loan function display


comment The pixel size of the image should be 120 pixels (wide) by 90 pixels (high). Other sizes are likely

to produce a deformed logo.

In the “old style” interface, the image “pica_logo.gif” is used when \LOGO is unset.

See also \LOGOURL, \ALTLOGO and \LOGO_ALT.

usage \LOGO=<filename>

example \LOGO=picarta.gif

LOGO_ALT

description Alternate text for the \LOGO image. product/service end-user (new style) program hm_search function display

configuration implementation asc since PiCarta 3.2b

comment See also \LOGO and \LOGOURL. usage \LOGO_ALT=<string>

example \LOGO_ALT=PiCarta

LOGOURL

description Link behind the \[FREEILL_]LOGO image. product/service end-user program hm_search, hm_loan function display


comment If unset, the url defaults to the server base environment variable as follows:

<SERVER_BASE>/[LNG=<LNG>/|LANGCODE=<LANGCODE>/][DB=<DB>/]

See also \LOGO and \FREEILL_LOGO. usage \LOGOURL=<url>

example

M

MAA_<matcode>

description Icon mapping for an authority material. product/service end-user program hm_search function display


comment The value of \MAA_<matcode> is used to retrieve an alternate authority material icon image,

defined with the url table attribute “\IMG_ICON_<matstring>”.

If \MAA_<matcode> is not set, the icon is retrieved from the url table attribute

“\IMG_ICON_MAT_<matcode>”.


version: 1.

date: 26-01-2007 page 37 of 71

usage \MAA_<matcode>=<matstring>

example

MAINTEMPLATE

description Name of the template that is used as the main entry point for the “old style” interface.

product/service end-user (old style) program hm_search function interface

configuration implementation since Krantenbank

comment The “new style” interface toggle must be switched off, i.e. \HTML must be switched off.

Note: The “new style” interface uses \HTML_MAINTEMPLATE.

usage \MAINTEMPLATE=<template>

example \MAINTEMPLATE=KB_MAIN

MAT_<matadi>

description Icon mapping for a non-authority material. product/service end-user program hm_search function display


comment The value of \MAT_<matadi> is used to retrieve an alternate material icon image, defined with

the url table attribute “\IMG_ICON_<matstring>”.

If \MAT_<matadi> is not set, the icon is retrieved from the url table attribute

“\IMG_ICON_MAT_<matadi>”. usage \MAT_<matadi>=<matstring>

example \MAT_I=MAA_B

MAT_VA_<matadi>

description Material icon mapping that is used in the advanced search screen. product/service end-user (old style) program hm_search function advanced search


comment The value of \MAT_VA_<matadi> is used to retrieve an alternate material icon image. The

corresponding description is then taken from \TXT_MAT_VA_<matadi>.

If \MAT_VA_<matadi> is not set, the icon is retrieved from the url table attribute

“\MAT_VA_<matadi>” and the description from the language table attribute

“\TXT_MAT_<matadi>”. The <matadi> must be set in \MATADI.

usage \MAT_VA_<matadi>=<matstring>

example \MAT_VA_I=MAA_B

\MAT_VA_P=MAA_P

MATADI

description List of supported material ADIs. product/service program hm_search function advanced search



version: 1.

date: 26-01-2007 page 38 of 71

comment The material adi list is a sequence of consecutive bibliographic form indicators (2nd position in

002@ $0). Only the listed materials are supported in the advanced search.

See also: DBSADI, MEDADI

usage \MATADI=<list>

example \MATADI=BTLOAMGVISK

MATCHISBN

description Perform online title matching on ISBN. product/service program hm_search function title matching



Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be set. Both

\MATCHISXN and \ISXNONLINE must be switched on.

See also \ISBN* and \ISXN*. usage \MATCHISBN=<toggle>

example

MATCHISSN

description Perform online title matching on ISSN. product/service program hm_search function title matching



Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be set. Both

\MATCHISXN and \ISXNONLINE must be switched on.

See also \ISSN* and \ISXN*. usage \MATCHISSN=<toggle>

example

MATCHISXN

description Perform online title matching on ISSN and ISBN. product/service program hm_search function title matching



Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be set.

When ISXN matching is activated, online matching on ISSN and ISBN can be disabled with

respectively \MATCHISSN and \MATCHISBN or \ISXNONLINE. Offline matching can be disabled

with \ISXNOFFLINE.

See also \ISSN* and \ISSN*. usage \MATCHISXN=<toggle>

example \MATCHISXN=N

MATCHSWETS

description Perform online title matching on Swets number. product/service program hm_search function title matching


version: 1.

date: 26-01-2007 page 39 of 71



Either \MATCHTITLE must be switched on or \HOLDINGS_ORDER must be set. usage \MATCHSWETS=<toggle>

example

MATCHTITLE

description Perform online title matching. product/service program hm_search function title matching


comment Switched off by default. Overruled by the request command of the same name.

If the bibliographic database only contains records of the same origin, this option should be used

instead of \HOLDINGS_ORDER. usage \MATCHTITLE=<toggle>

example

MAX_ADVANCED_SEARCHBOX bug

description Maximum number of search entry boxes in the advanced search screen. product/service end-user (new style) program hm_search function advanced search

configuration implementation asc since PiCarta 3.2b

comment If the supplied number is higher than the count of \GSKEYS_PRESET elements, the number of

search boxes is equal to that element count.

Bug: This option must be configured if \GSKEYS_PRESET is set, otherwise no search input box

will appear. usage \MAX_ADVANCED_SEARCHBOX=<number>

example

MEDADI

description List of medium ADIs available in the "advanced search" screen. product/service program hm_search function advanced search

configuration implementation asc, sw since 24-05-2007

comment The medium adi list is a sequence of consecutive bibliographic medium codes. Only the listed

medium codes are supported in the advanced search.

See also: DBSADI, MATADI usage \MEDADI=<list>

example \MEDADI=IMEX

MNMCOLONS

description Require mnemonics to be followed by a colon to distinguish them from normal search terms.




version: 1.

date: 26-01-2007 page 40 of 71

comment Switched off by default.

Note: Currently, this is only an optional feature for Hebis, but it may become standard behavior.

usage \MNMCOLONS=<toggle>

example

N

NOABS

description Do not replace the article by its abstract in the full title presentation. product/service end-user program hm_search function full presentation



If this option is switched on and the title is an article (according to classprofile option

ARTICLE_MATCODES) and has rt-family indexes then the first of these related terms (its

abstract) is presented instead of the article. usage \NOABS=<toggle>

example \NOABS=Y

NOABSTRACTICON

description Display the abstract icon in the brief title presentation. product/service end-user program hm_search function display



If this option is switched on and a title contains an abstract, the abstract icon is - not - displayed

in the brief title presentation.

See also: ABSTRACTICONFIELDS usage \NOABSTRACTION=<1|0>

example

O

OFFLINEXPNKEYBASE

description Basename of the standard table record key for the offline expansion syntax. product/service program hm_search function title expansion


comment If unset, the default key base is “XPNDEF”. usage \OFFLINEXPNKEYBASE=<string>

example

ONLINEXPNKEYBASE

description Basename of the standard table record key for the online expansion syntax. product/service program hm_search function title expansion



version: 1.

date: 26-01-2007 page 41 of 71

comment If unset, the default key base is “HERMES#XPN”. usage \ONLINEXPNKEYBASE=<string>

example \ONLINEXPNKEYBASE=XPNDEF

OPENURL

description Activate the use of OpenURL (or a free format link) in the full title/holding presentation.

product/service end-user program hm_search function display (holding or full)


comment Switched off by default. If activated, one or more links are generated and stored in variables of the

form "OPENURL_[name_]HREF" variable, depending on the command argument

OPENURL_LINKS or if no such command argument supplied the classprofile option

OPENURL_LINKS. The link can either be a formal OpenURL or a non-standard free format link.

usage \OPENURL=<toggle>

example

OPENURL_LINKS

description If \OPENURL=Y, create one or more variables, each containing a URL. product/service end-user program hm_search function display (holding or full)

configuration implementation sw since 02-10-2003

comment Default: \OPENURL_LINKS=USER

Forbidden value (reserved for COINS): COINS

Values are comma separated. For example: \OPENURL_LINKS=USER,CUSTOM is likely to

generate at least 2 variables as follows:

In database 2.41 for LIBID=1999/0001 the string USER will generate the variable

OPENURL_HREF if a record is loaded under one of the following keys:

HERMES#OPENURL#2.41#1999/0001

HERMES#OPENURL#2.41#1999

HERMES#OPENURL#2.41#

HERMES#OPENURL##1999/0001

HERMES#OPENURL##1999

HERMES#OPENURL##

If the selected record contains \LINKTARGET=_blank an extra variable OPENURL_

LINKTARGET containing “_blank” is generated (analogous to processing for CUSTOM).

Independent of database and LIBID, the string CUSTOM will generate the variable

OPENURL_CUSTOM_HREF if a template is loaded under the following key:

HERMES#OPENURL#CUSTOM

CUSTOM will also generate a variable OPENURL_CUSTOM_LINKTARGET containing “_blank”

if [HERMES#OPENURL#CUSTOM] contains: \LINKTARGET=_blank

Every attribute will result in a similar variable except "BASEURL" "FIELDS" "FCVNAME"

"FREEFORMURL" "FREEFORM" and "CHARSET". Popular attributes resulting in specific variables

are: IMAGEURL, IMAGEALT, IMAGETITLE, LINKTARGET.

usage \OPENURL_LINKS=<urlname-list>

example \OPENURL_LINKS=USER,CUSTOM

OPENURL_VENDOR

description Identification name of the OpenURL vendor.


version: 1.

date: 26-01-2007 page 42 of 71



comment \OPENURL must be switched on. usage \OPENURL_VENDOR=<string>

example \OPENURL_VENDOR=OCLCPICA

OWNERFORMAT

description Format of the ownername that is added to subfield 101@ $d. product/service program hm_search function holding presentation

configuration origin, owner implementation since


version: 1.

date: 26-01-2007 page 43 of 71

comment If \DATABASE_ORIGIN is configured, the name of the owner of a holding block is added to

subfield 101@ $d, unless plain mode is activated (&PLAIN=ON).

The ownerformat is a combination of format directives and free text.

A format directive consists of a fieldname from the “lib_address” Sybase table(*) placed between

less-then ('<') and greater-than ('>') characters. The free text can be any combination of

characters and punctuation marks (including '<' and '>').

Free text in front of a directive is ignored in case the directive is invalid or its expansion is empty.

If the ownerformat is not configured, it defaults to "<city>, <full_name> <sub_name>".

Subfield 101@ $d will be empty if the requested lib_address record cannot be found. For end-

user installations, the holding presentation syntax is responsible for handling this situation.

(*) Note

In addition to the Sybase fieldnames, the following values are supported:

“briefname” (lib_profile.short_name);

“mnemo” (lib_profile.library_mnemo);

“iln” (lib_profile.iln);

“lib” (lib_profile.library starting with the first character of the non-default

origin code, e.g. “G0018”, for library “0018” and partner origin “GBV”).

Additionally, the <format=...> directive can be used to apply a conversion specification to the

result string. The specification format is: [-] [width] [.precision] [modifier]

The semantics of all fields except the modifier are identical to those of a conversion specifier in

the format parameter of a call to printf(). The modifier can be one of:

l (el) converts the string to lowercase;

U converts the string to UPPERCASE;

u converts the first character to Uppercase and the rest to lowercase.

usage \OWNERFORMAT=<format>

example \OWNERFORMAT=<city>, <full_name> <sub_name><format=U>

\OWNERFORMAT=<briefname>

OWNERS

description Range of supported database owners. product/service program hm_search,

hm_idxgen,

bulkindexgen

function index & search behavior


comment Only records with an owner ILN in the defined range are eligible for indexation and presentation.

If unset, all records are eligible.


version: 1.

date: 26-01-2007 page 44 of 71

usage \OWNERS=<iln range>

example \OWNERS=96,125,164,181-185

OWNERS_<ownergroup id>

description Range of record owners that belong to the same holding group. product/service program hm_search function holding presentation

configuration origin implementation sw since WSF

comment Used for grouping holding records together with the record origin. If an ownergroup is defined as

a <sortcode> in \HOLDINGS_ORDER and the record owner is in the iln range, the search server

adds the <ownergroup id> to subfield 101@ $e.

usage \OWNERS_<ownergroup id>=<iln range>

example \OWNERS_WSF=8,12,13,16,19,25,27,28,33,34,41,62,180

P

PATCHMATADI

description Patch the material ADI string to the correct format. product/service CBS4 program hm_search function search behavior



When switched on, the string is patched from “\iktno space value ; space” into

“iktno\003value\003\004...”, where \004 is used to separate different ADI commands.

usage \PATCHMATADI=<Y|N>

example

PHRASEPARSEIKTS

description Set which IKT's are treated as phrase when searching/browsing. product/service enduser program hm_search function search behavior


comment This option invokes a special parsing mode that only handles wildcard operators and takes

anything else as part of the term (subject to normalization as usual).

Its value should be a range of IKTs for which this mode should be enabled. With "1-" the option

applies to all indexes that have sr_structure 'p'.

usage \PHRASEPARSEIKTS=<list>

example \PHRASEPARSEIKT=8082,1050

PIPECHARISQUOTE obsolete

description Use the pipe character as the command separator. product/service CBS4 program hm_search function search behavior



version: 1.

date: 26-01-2007 page 45 of 71


For CBS4, the pipe character is used to separate commands, outside CBS4 it is used as a boolean

“OR”.

usage \PIPECHARISQUOTE=<Y|N>

example

PPNIKT

description IKT for testing whether matching titles linked by PPN may be presented. product/service program hm_search function title matching


comment If unset, IKT 12 is used when defined, otherwise it defaults to IKT 1007.


The <ikt> must be defined in the IDXDEF table. usage \PPNIKT=<ikt>

example

PRESENTMATADIPLAIN

description Convert the ADI filter to plain format. product/service CBS4 program hm_search function search behavior



usage \PRESENTMATADIPLAIN=<Y|N>

example

PRS

description Identification string for a FCV presentation syntax. product/service program hm_search, hm_short function title presentation



version: 1.

date: 26-01-2007 page 46 of 71

comment This option is used for the identification of presentation syntaxes, which are used to create title

presentations and the brief title cache.

Syntaxes for title presentations are stored under the key

“HERMES#FCV#pica#<syntax>[#<prs>|<dbname>]#<type>[#<origin>]” or

“HERMES#FCV#pica#<syntax>[#<prs>|<dbname>][##<origin>]”

where:

- a more elabotate key prevails over a lesser detailed key;

- <syntax> is one of "webdesc", "webbrief", "webholdttl", “websort”, "webhtml", "weblabelled",

"websimplettl", "webspecial";

- <prs> is substituted with either the &PRS request command or the \PRS classoption;

- &PRS prevails over \PRS;

- <prs> prevails over <dbname>;

- <type> is substituted with “entry” in case of an authority record and “title” otherwise.

Syntaxes for brief title cache generation are stored under the key

“HERMES#FCV#pica#<syntax>[#<prs>|<dbname>]”

where:

- <syntax> is one of “webbrief” and “websort”;

- <prs> is substituted with the \PRS classoption;

- <prs> prevails over <dbname>.

usage \PRS=<string>

example \PRS=SX154

\PRS=niod

PRS<presentation>OPTIONS[_<prs>]

description Option string for the presentation library functions. product/service program hm_search function presentation


comment Can be used for tweaking the default behavior of the presentation library routines PRSFull(),

PRSBrief() and PRSHolding(). usage \PRS<presentation>OPTIONS[_<prs>]=<option spec>

The syntax of the classoption name is:

<presentation> ::= “FULL”, “BRIEF” or “HOLDING”

<prs> ::= value of the &PRS request command

The syntax of the option specification is:

<option spec> ::= <option>[;<option>]...

<option> ::= <name>=<value>

<name> ::= option name

<value> ::= option value

example \PRSFULLOPTIONS_marc21=

denormalize=usmarc-exchange;directory=no;charset=no;subfind=$;dollar=$$

PRSFULLLOG

description Name of the file used for logging full presentation requests. product/service program hm_search function presentation


version: 1.

date: 26-01-2007 page 47 of 71


comment Full presentation requests logs can be used for analysing the behavior of users or for finding

correlations between titles or for whatever. Format of a single logging is:

date time session-id title-fileset ipn presentation-format

for example:

2007-05-31 09:43:31 c74de42e-75 1 55225552 HOL 2.41

2007-05-31 12:42:08 c74de42e-75 1 1809895 PP 2.41

2007-05-31 12:43:36 c74de42e-75 1 1809895 NULL 2.41

usage \PRSFULLLOG=<toggle>

If you specify \PRSFULLLOG=Y, you also have to specify the environment variable

HMS_PRSFULLLOGFILE, for example in your FILEMAP.

Example:

HMS_PRSFULLLOGFILE=$RUNDIR/prsfulllog_$TODAY

example \PRSFULLLOG=Y

PRSFULLLOG_NRHITS

description Number of popular titles presented at the MOST VIEWED link (button start welcome screen) product/service program psi_tophits.php function presentation

configuration implementation evd since 27-01-2009

comment It makes only sense to set this class option if the offline program hm_ hitlist_create is running on

a regular basis. This program creates a file with the 100 most viewed PPN’s. The path and

filename is traced back from the FILEMAP variable HMS_PRSFULLLOGFILE. And for trigger the

logging the classoption PRSFULLLOG should be set on Y.

The classoption PRSFULLLOG_NRHITS is optional, a number between 1 and 100. The default

value is 20

usage \PRSFULLLOG_NRHITS=<1-100>

If you specify \PRSFULLLOG_NRHITS=<nr> then you also have to specify\PRSFULLLOG=Y, the

environment variable HMS_PRSFULLLOGFILE and run on a daily basis the offline

program hm_hitlist_create.

example \PRSFULLLOG_NRHITS=10

Q




comment usage

example


version: 1.

date: 26-01-2007 page 48 of 71

R

REC

description Type of records to search for. product/service program hm_search function search behavior


comment Supported record types are ‘1’ (title records), ‘2’ (authority records) and ‘*’ (title and authority

records). If unset, the default record type is ‘1’.

This option is overruled by the request command of the same name.

Activate \RECORDTYPE_SWITCH to enable the record type selection in the end-user interface.

usage \REC=<1|2|*>

example \REC=*

RECORDTYPE_SWITCH

description Display the record type selection buttons below the search entry box. product/service end-user program hm_search function search behavior



See \REC for the supported types.

usage \RECORDTYPE_SWITCH=<ON|OFF>

example

RECTYPEANYKEYS

description Range of IKTs for which both record types (title and authority) should be searched instead of only

title records. product/service program hm_search function search behavior


comment An IKT is ignored if it is also defined in \RECTYPEAUTHKEYS.

"&REC=" in the URL overrules \RECTYPEANYKEYS. usage \RECTYPEANYKEYS=<ikt range>

example

RECTYPEANYKEYS_SCAN

description Range of IKTs for which both record types (title and authority) should be scanned instead of only the

normal types (either authority records if the IKT is also specified in RECTYPEAUTHKEYS or title

records if the IKT is neither specified in RECTYPEAUTHKEYS nor in RECTYPEANYKEYS).

product/service program hm_search function scan behavior



version: 1.

date: 26-01-2007 page 49 of 71

comment An IKT is ignored if it is also defined in \RECTYPEAUTHKEYS_SCAN.

Every IKT mentioned in neither \RECTYPEAUTHKEYS_SCAN nor \RECTYPEANYKEYS_SCAN will

scan the same record types as are searched.

"&REC=" in the URL overrules \RECTYPEANYKEYS_SCAN. usage \RECTYPEANYKEYS_SCAN=<ikt range>

example \RECTYPEANYKEYS_SCAN=8082

RECTYPEAUTHKEYS

description Range of IKTs for which authority records should be searched instead of title records.



comment An IKT defined here prevails over the same IKT in \RECTYPEANYKEYS.

"&REC=" in the URL overrules \RECTYPEAUTHKEYS. usage \RECTYPEAUTHKEYS=<ikt range>

example \RECTYPEAUTHKEYS=8894,8899,8889,8890,8888

RECTYPEAUTHKEYS_SCAN

description Range of IKTs for which authority records should be scanned instead of the normal types (either both

record types (title and authority) if the IKT is also specified in RECTYPEANYKEYS or title records if

the IKT is neither specified in RECTYPEAUTHKEYS nor in RECTYPEANYKEYS).

product/service program hm_search function scan behavior


comment An IKT defined here prevails over the same IKT in \RECTYPEANYKEYS_SCAN.

Every IKT mentioned in neither \RECTYPEAUTHKEYS_SCAN nor \RECTYPEANYKEYS_SCAN will

scan the same record types as are searched.

"&REC=" in the URL overrules \RECTYPEAUTHKEYS_SCAN. usage \RECTYPEAUTHKEYS_SCAN=<ikt range>

example

RECTYPEPSEUDOADI

description Allow the record type to be used as an ADI. product/service CBS4 program hm_search function search behavior


comment Switched off by default. usage \RECTYPEPSEUDOADI=<toggle>

example

RECTYPEPSEUDOADI_AUTHORITY obsolete

description Authority record type that is to be used as a pseudo ADI. product/service CBS4 program hm_search function search behavior


comment usage \RECTYPEPSEUDOADI_AUTHORITY=<adi>


version: 1.

date: 26-01-2007 page 50 of 71

example \RECTYPEPSEUDOADI_AUTHORITY=E

RECTYPEPSEUDOADI_TITLE obsolete

description Title record type that is to be used as a pseudo ADI. product/service CBS4 program hm_search function title matching/debugging


comment usage \RECTYPEPSEUDOADI_TITLE=<adi>

example

REDIRECT_<context> obsolete

description URL (preprocessor code) to redirect to for given result context. product/service PSI program hm_servers that use

XMLPRS templates

function presentation

configuration implementation sw since 4.5

comment The XMLPRS main template checks whether classprofile option REDIRECT_<context> exists for its

current result context. If so, the contents will be preprocessed and be redirected to.

usage \REDIRECT_<context>=<preprocessor code>

example \REDIRECT_IDXNOTFOUND=http://mysite?lng=<%variable(LNG)>

REFINEMATCH description Refine title matches on Swets number / ISXN.



comment If two titles have a match on Swets number or ISXN, the match is further validated by comparing

the material code, edition details and, in case of multi-volume publications, the volume details.

Switched on by default. Overruled by the request command of the same name.

Title matching must be activated. Useful for debugging purposes.

usage \REFINEMATCH=<toggle>

example

RELOPS

description Whether to recognise relational operators. product/service program hm_search function search behavior



version: 1.

date: 26-01-2007 page 51 of 71

comment Relational operators are:

< : find terms less than the specified string

> : find terms greater than the specified string

<= : find terms less than or equal to the specified string

>= : find terms greater than or equal to the specified string

For example:

\1016 > zzzz

means with \RELOPS=N: finds records containg ikt 1016 words equal to "> zzzz"

means with \RELOPS=Y: finds records containg ikt 1016 words greater than "zzzz"

Default:

\RELOPS=N usage \RELOPS=<toggle>

example \RELOPS=Y

RELTTALWAYSCONTAINSORIGIN

description Create result sets that contain nothing but the IPN started out with.

product/service CBS4 program

configuration implementation


usage \RELTTALWAYSCONTAINSORIGIN=<toggle>

example

RSSFEEDS

description Enable RSS feeds

product/service PSI program hm_search function Toggle option



usage \RSSFEEDS=<Y|N>

example

S

SCANAUTHREC_RELATED_TERMS

description Range of IKTs for which hm_search must supply a Y/N toggle field in scan entries that indicates

whether at least one authority record has the associated phrase index. The templates can then

use this toggle to present a link to the presentation of this authority record, which may show

related terms and such. product/service program hm_search function scan behaviour

configuration implementation sw + asc since PSI 4.2

comment The scan screen of an ikt mentioned in this option will be accompanied with the variable

"RelatedTermsScan". usage \SCANAUTHREC_RELATED_TERMS=<ikt range>

example \SCANAUTHREC_RELATED_TERMS=8082

SCANAUTHREC_SEE_REFERENCE


version: 1.

date: 26-01-2007 page 52 of 71

description Range of IKTs for which hm_search must expect a separator and a preferred term to follow the

main term in the index phrases. Searching of such ikt's will be normal but scanning is special as

hm_search will supply these preferred terms in their scan entry. As a result the templates can

retrieve these preferred terms and print them as "See references".

product/service program hm_search function scan behaviour

configuration implementation sw + asc since PSI 4.2

comment In order for this to work you have to adapt the index generation of the specified ikt's in such a

way that the preferred term is printed by the term separated with the "\037" character.

Since preferred terms are likely to be absent in title records, you probably will want to combine

this feature with \RECTYPEANYKEYS_SCAN=<ikt range>.

Can also be combined with \SCANAUTHREC_RELATED_TERMS=<ikt range>.

usage \SCANAUTHREC_SEE_REFERENCE=<ikt range>

example \SCANAUTHREC_SEE_REFERENCE=8082

SEARCHOPTIONS

description List of supported advanced search options. product/service end-user program hm_search function advanced search


comment Supported search options are:

DBS (database IKT 9008)

MAT (material IKT 9001)

JVU (year of publication IKT 9000)

TAA (language of publication IKT 9004)

LND (country of publication IKT 9005)

BIB (library IKT 9023)

Note: In the “new style” interface, this option is configured in the Interface file.

If “BIB” is configured, then \BITMAPADI_9023 must be set.

See also \L_CODE_TYPE in case “TAA” is defined. usage \SEARCHOPTIONS=<list>

example \SEARCHOPTIONS=DBS,MAT,JVU,TAA,BIB

SETTYPESTYLE

description Determine the result set type for CBS. product/service CBS4 program hm_search function search context


comment \USESETTYPE must be switched on. Uses CBS rules by default. usage \SETTYPESTYLE=<string>

example \SETTYPESTYLE=CBS

SHORTCCH

description Whether to use the short title cache. product/service end-user program hm_search function



version: 1.

date: 26-01-2007 page 53 of 71

comment This option is only used for (non-plain) XMLPRS and HTML data. For hm_search defaults to true,

so omitting this parameter will turn on the short cache .

usage \SHORTCCH=<toggle>

example \SHORTCCH=N

SHORTCCH_FMT

description Format of the (emulated) short title cache. product/service end-user program hm_search function


comment For internal use only. For hm_search defaults to "html". This option will also be used when there

is no short title cache or if it is turned off. In that case the cache is emulated by reading and

transforming title records. Setting this option something else than "html" will let hm_search copy

the short title contents unmodified to the preprocessor layer (where it should be handled

properly). Setting this option to "ascii" will let the hm_search preprocessor convert the data to

the target format (HTML | XMLPRS). Other values will let the preprocessor handle the data 'as

is'.

usage \SHORTCCH_FMT=<html|ascii>

example \SHORTCCH_FMT=ascii

SHORTPRS_WITH_COPY

description Present level 1 and 2 records in short title presentations. product/service end-user program hm_short function

configuration implementation sw since 2006


The offline program that builds the short title presentations (hm_short) will read the level 0

record and each of the iln-groups (in the order of the ILN). Each iln-group consists of its 101@-

tag followed by its (optional) level 1 record, followed by each of its level 2 records. The 101@-

tag only contains subfield $a with the ILN.

usage \SHORTPRS_WITH_COPY=<YES|NO>

example \SHORTPRS_WITH_COPY=YES

SHOWCOMMANDLINK

description Hyperlink the search command in the search results screen, when possible. product/service end-user program hm_search function

configuration implementation sw since Sudoc/Abes


usage \SHOWCOMMANDLINK=<1|0>

example

SHOWDEBUG

description Display debugging information. product/service Krantenbank only program hm_search function debugging


version: 1.

date: 26-01-2007 page 54 of 71

configuration implementation asc since Krantenbank


Overruled by the &DEBUG request command.

For other end-user interfaces, use the &DEBUG=1 request command to present detailed on-

screen debugging data.

usage \SHOWDEBUG=<1|0>

example

SHOWDOWNLOADQUERYINFO

description Display information about the performed query in the download presentation. product/service end-user program hm_search function download



If switched off, only the search results will be presented.

usage \SHOWDOWNLOADQUERYINFO=<1|0>

example

SHOWEPD

description Display the link to more related publications. product/service end-user program hm_search function display



When switched on, and the selected record is an authority record, then a link is created to a

search for titles that are related to the authority record and/or its descendants.

usage \SHOWEPD=<1|0>

example

SHOWFAM

description Display the link to related publications. product/service end-user program hm_search function display



Does not apply to authority records and periodicals.

usage \SHWOFAM=<1|0>

example

SHOWHOLD

description Display the link to availability information (holdings) in the full title presentation.

product/service end-user (old style) program hm_search function display


version: 1.

date: 26-01-2007 page 55 of 71



Note: In the “new style” interface, the availability link is configured in the Interface file with

“\TABS_<mode>=<mode>_AVAILABILITY,…”.

usage \SHOWHOLD=<1|0>

example

SHOWINOWNLIB

description Show the “in own library” message in the full title and availability presentation. product/service end-user program hm_search function holding presentation


comment Switched on by default. Use ‘N’ to disable. Any other value is interpreted as TRUE.

The ILN of a copy record must match that of the active user.

The message is stored in the language table attribute “\[LABEL_]INOWNLIB”.

usage \SHOWINOWNLIB=<Y|N>

example \SHOWINOWNLIB=N

SHOWONLINERESOURCESICON

description Display the online resource icon in the brief title presentation. product/service end-user program hm_search function display



The icon is displayed if 009P $a contains an online resource link. If 009P/03 $a is present, then the

icon is not displayed for publication type ‘O’; the 3rd occurrence is reserved for a fulltext link,

which has its own icon (activated with \FULLTEXTICON).

When switched on, the short title cache must be disabled or bypassed with the &CACHEDIRECT

request option.

usage \SHOWONLINERESOURCESICON=<toggle>

example

SHOWONLINERESOURCESICONFROMCOPY

description Display the online resource icon in the brief title presentation. product/service end-user program hm_search function display


comment Switched off by default. This option should be used with caution, because for every title, the

holdings must be collected (expensive).

The icon is displayed if there is a online resource link in any 209R $a or 209S $a or in 009P $a. If

subfield 009P/03 $a is present, the icon is not displayed for publication type ‘O’; the 3rd

occurrence is reserved for a fulltext link, which has its own icon (activated with

\FULLTEXTICON).


request option. usage \SHOWONLINERESOURCESICONFROMCOPY=<toggle>


version: 1.

date: 26-01-2007 page 56 of 71

example

SHOWOPCUSERINFO

description Display a link to the OPC user information. product/service OPC4 only program hm_search function user info



If the $HMSLBS_VERSION environment variable is set to ‘4’, the information is presented in a

new window. Otherwise \LOANACTIONSINNEWWINDOW should be activated to create a

new window.

usage \SHOWOPCUSERINFO=<1|0>

example

SHOWORIGINICON

description Display the title origin indicator in the brief title presentation. product/service end-user program hm_search function display



The origin indicator is a textual clarification of the source of the selected title. It is displayed

when the origin of the title does not match that of the user. The corresponding indicator

translation is stored in the language table attribute “\ORIGIN_<origin>”.


request option.

usage \SHOWORIGINICON=<toggle>

example

SHOWOWNERWITHOUTCOPY

description Include holding blocks that only contain a local record and no copy records. product/service program hm_search function holding presentation


comment Switched on by default if \HOLDINGS_ORDER is not defined, switched off by default if

\HOLDINGS_ORDER is defined.

When switched off, holding blocks that only contain a local record are not included in the title.

usage \SHOWOWNERWITHOUTCOPY=<toggle>

example

SHOWPRF

description Display the link to the user profile. product/service end-user except OPC4 /

PSI relay (old style)

program hm_search, csw_adr,

csw_avr, csw_dpo,

csw_sdi, csw_usr

function display



version: 1.

date: 26-01-2007 page 57 of 71


In the “new style” interface, the profile option is configured in the Interface file with

“\MODES=MYPROFILE,…”.

usage \SHOWPRF=<1|0>

example

SHOWREL

description Display the link to related publications for authority records. product/service end-user program hm_search function display



usage \SHOWREL=<1|0>

example

SHOWREQ

description Display the request link in the full title/holding presentation. product/service end-user (old style) program hm_search, hm_loan function display



usage \SHOWREQ=<1|0>

example

SHOWRESTTL

description Display the title request link on ppn level. product/service OPC4 only (new style) program hm_search function display

configuration implementation asc since PSI Spring 2004


usage \SHOWRESTTL=<ON|OFF>

example

SHOWSAV

description Display the saveset link. product/service end-user (old style) program hm_search function display



Note: In the “new style” interface, the saveset option is configured in the Interface file with

“\MENUOPTION_<mode>_<tab>=SAVEINFO,…”.

usage \SHOWSAV=<1|0>

example

SHOWSDI


version: 1.

date: 26-01-2007 page 58 of 71

description Display the SDI request link. product/service end-user except OPC4 /

PSI relay

program hm_search function display



usage \SHOWSDI=<1|0>

example

SHOWSORTBY

description Display the list with options for sorting the search result. product/service end-user program hm_search function display



The sort options are presented next to the search entry box. The available options are configured

with \SORTOPTIONS.

usage \SHOWSORTBY=<1|0>

example

SHOWSUB

description Display the search-by-subject link in the search result screen. product/service end-user program hm_search function display



usage \SHOWSUB=<1|0>

example

SHOW_CHARSET

description Display current charset and a switch to another charset. product/service end-user program hm_search function display



usage \SHOW_CHARSET=<Y|N>

example

SNS_INTERFACE

description Determine if and which SNS interface will be available




INTEGRATED means that SNS will be completely integrated in the PSI interface

STANDALONE means that there will be separate interface for all SNS actions

usage \SNS_INTERFACE=<INTEGRATED|STAND_ALONE>


version: 1.

date: 26-01-2007 page 59 of 71

example \SNS_INTERFACE=INTEGRATED

SNS_USER_TITLE

description Determine if the links for user titles will be created in the interface




usage \SNS_USER_TITLE=<Y|N>

example \SNS_USER_TITLE=Y

SORTOPTIONS

description List with supported options for sorting the search result set. product/service end-user program hm_search function result set sorting


comment If unset, the default sort options are “RLV” (relevance) and “YOP” (year of publication).

The "DAY" option requires the presence of ADI ikt 9006.

The options are presented in the order in which they are configured.

Requires a syntax table for generating short title sorting fields (“HERMES#FCV#pica#websort”).

Translations are stored in the language table attribute “\SORTORDER_<sortoption>”.

\SHOWSORTBY must be switched on.

In XMLPRS it is also required to mention the non-default sort options in xml_config.xml.

usage \SORTOPTIONS=<list>

example \SORTOPTIONS=RLV,YOP,BRF_ay,BRF_ty

SORTYOPREV

description Sort the result set by year of publication in reverse (i.e. descending) order. product/service program hm_search function result set sorting



usage \SORTYOPREV=<Y|N>

example

SUBJ_IN_MENU

description Display the link to a subject search that uses the Dutch Classification System. product/service end-user / PSI relay (old

style)

program hm_search function display



Note: In the “new style” interface, this link is configured in the Interface file with

“\TABS_ADVANCED=ADVANCED_SUBJECTS,…”.

usage \SUBJ_IN_MENU=<1|0>

example

SUPPORTSURFERS

description Support ILL for un-identified end-users.


version: 1.

date: 26-01-2007 page 60 of 71

product/service PSI relay program csw_ind function ILL

configuration implementation since WSF


The WebIND relay server allows un-identified end-users to file ILL requests. Instead of logging in,

the user continues as a guest user and must select the library where to pick up the requested

item.

usage \SUPPORTSURFERS=<Y|N>

example

SWETSFIELD

description Specification of the subfield used for online matching titles on Swets number. product/service program hm_search function title matching


comment If the subfield specification is not set, the Swets number is retrieved from 006N $0.

A Swets number consists of at least 8 digits. A GBV Swets number can be followed by an extra

character in case of a title-split.

For testing purposes, an alternate number can be supplied with the &SWETSTERM request

command.

See also \SWETSSUPPLIERFIELD and \SWETSFLIPPER.

usage \SWETSFIELD=<subfield>

example \SWETSFIELD=006N $0

SWETSFLIPPER

description Terminate the match term with a wildcard when online matching titles on Swets number.




When switched on, the Swets term is terminated with a wildcard after the eighth character.

However, if &SWETSTERM is issued, a ‘*’ in the last position is considered a wildcard. To handle

it as a normal character, &SWETSFLIPPER should be disabled.

See also \SWETSFIELD.

usage \SWETSFLIPPER=<toggle>

example

SWETSIKT

description IKT used for online matching titles on Swets number. product/service program hm_search function title matching


comment If unset, IKT 8001 is used when defined, otherwise it defaults to IKT 1007.


The <ikt> must be defined in the IDXDEF table.


version: 1.

date: 26-01-2007 page 61 of 71

usage \SWETSIKT=<ikt>

example

SWETSSUPPLIERFIELD

description Specification of the supplier subfield used when online matching titles on Swets number.



comment If the subfield specification is not set, the Swets supplier is retrieved from 006N $l.

The supplier subfield must not be present!

See also \SWETSFIELD.

usage \SWETSSUPPLIERFIELD=<subfield>

example \SWETSSUPPLIERFIELD=006N $l

T

TABLECOLOR

description HTML color code used for the table background in help screens. product/service end-user program hm_search function display


comment The value can either be a color name (e.g. “red”, “blue”) or a six-digit hexadecimal color value

preceded by a hash: #RRGGBB, where R, G and B are hexadecimal digits that respectively define

the amount of red, green and blue.

See also \EXAMPLECOLOR. usage \TABLECOLOR=<#RRGGBB>|<color name>

example \TABLECOLOR=#e0eeff

TESTADIMAX

description Test if a user is authorized to see holdings of matching title records. product/service program hm_search function title matching



The ADIMAX is checked to test if a user is authorized to see matching holding records. Adimax

filtering requires an index on PPN.

See also \PPNIKT. usage \TESTADIMAX=<toggle>

example

TIMEOUT

description Idle time (in seconds) after which the search server times out. product/service end-user program hm_search function generic


comment usage \TIMEOUT=<seconds>


version: 1.

date: 26-01-2007 page 62 of 71

example

TITLE

description Title that appears in the browser's caption bar. product/service end-user program hm_search function display


comment Note: In the “new style” interface, the document title is configured in the Interface file with

“\DOCUMENT_TITLE=<string>”. usage \TITLE=<string>

example

TITLE_PRS_TYPES

description Presentation types for the full title. product/service end-user program hm_search function display


comment Created for PSI BSZ release. Only works when more than one values are given, DEFAULT is the

default presentation. Creates small tabs in the full title screen which can be selected by the user.

usage \TITLE_PRS_TYPES=<list>

example \TITLE_PRS_TYPES=DEFAULT,MOPC,MARC21

TRUNCATEPERSONAFTERCOMMA

description Truncate person IKT searches after the comma. product/service CBS4 program hm_search function search behavior


comment Switched on by default. Use ‘N’ to disable. Any other value is interpreted as TRUE.

If the search IKT is a person index and the there is a comma present, then anything before the

comma will be matched with the search string.

The search string must not be in quotes.

usage \TRUNCATEPERSONAFTERCOMMA=<Y|N>

example

TTLOWNER

description Owner of the level-0 records (database owner). product/service program hm_search function search behavior


comment If unset, it defaults to ‘0’.

For CBS, this should be the same as the column "title_owner" from the "dbs_parameters" Sybase

table. usage \TTLOWNER=<iln>

example \TTLOWNER=8

TTLDOC_ADMIN

description Title document administrator.


version: 1.

date: 26-01-2007 page 63 of 71



comment Users whose CBS logincookie attribute 'H' matches TTLDOC_ADMIN will be administrator and

can insert/delete documents into/from titles. usage \TTLDOC_ADMIN=<nr>

example \TTLDOC_ADMIN=2

TXT_MAT_<matadi> bug

description Material description that is used in the help screen. product/service end-user (new style) program hm_search function advanced search help


comment Overwrites the translation stored in the language table attribute “\MAT_<matadi>”.

The <matadi> must be set in \MATADI.

Bug: This option only affects the translation in the help screen. If necessary, the translation

table(s) should be updated to display the proper material descriptions in the advanced search

screen.

usage \TXT_MAT_<matadi>=<string>

example \TXT_MAT_I=organization

\TXT_MAT_P=persons

TXT_MAT_VA_<matadi>

description Material description that is used in the advanced search screen. product/service end-user (old style) program hm_search function advanced search


comment Description of the image that is retrieved with \MAT_VA_<matadi>. This option is ignored if

\MAT_VA_<matadi> is not set. usage \TXT_MAT_VA_<matadi>=<string>

example \TXT_MAT_VA_I=organization

\TXT_MAT_VA_P=persons

U

UCISOCV

description Unicode to ISO-8859-1 conversion product/service end-user program hm_search function display


comment Specifies how conversion of Unicode characters that cannot be displayed is handled. Current

values are DISPLAY, STRIP, TABLE. DISPLAY show the numeric value of the character, TABLE

says a table should be used and STRIP removes them from the output.

usage \UCISOCV=<string>

example \UCISOCV=STRIP

UCISOCV_TABLE


version: 1.

date: 26-01-2007 page 64 of 71

description Name of table to be used in case UCISOCV is set to TABLE. product/service end-user program hm_search function display


comment usage \UCISOCV_TABLE=<string>

example \UCISOCV_TABLE=ABES

UCISOCV_DEFCHAR

description Default character to be used for conversion of Unicode characters. product/service end-user program hm_search function display


comment usage \UCISOCV_TABLE=<char>

example \UCISOCV_TABLE=¤

UCNF

description Unicode normalized format output product/service end-user program hm_search function display


comment Choose between composed (NFC) and decomposed (NFD) usage \UCNF=<string>

example \UCNF=NFC

ULOCFIRST

description Present the holdings of the user location first. product/service program hm_search function holding presentation



If \HOLDINGS_ORDER is set, the holdings with an origin code that matches the user login

location (the “ULOC”) are presented first. usage \ULOCFIRST=<toggle>

example

UNION_INSTITUTES

description Range of owners (union institutes) for which the libraries are presented as individual record

owners. product/service program hm_search function holding presentation

configuration origin implementation sw since

comment If the owner of a copy record is in the defined range, then a separate holding block with this copy

is created for each library number in the subfields 209A $b, 209J $b or 209F $a. Each block starts

with a 101@ tag with the owner ILN in $a and the library id in $b.

The holdings of the union institute itself are not included in the title.


version: 1.

date: 26-01-2007 page 65 of 71

usage \UNION_INSTITUTES=<iln range>

example \UNION_INSTITUTES=18,21,54,56,64,77,84,196,213,225

UPDATE_ILLCANDIDATELIST

description Support end-user modifications to the list of potential suppliers. product/service PSI relay program csw_ind function ILL


comment Switched off by default. Use 'Y' to enable. Any other value is interpreted as FALSE.

The WebIND relay server allows end-users to update the list with candidate suppliers if the user

has the proper authority (determined by CBS).

usage \UPDATE_ILLCANDIDATELIST=<Y|N>

example

URLFROMLNMTABLE deprecated

description Retrieve library details from the standard table when generating electronic links for an article.

product/service end-user program hm_search function electronic linking


comment Switched on by default.

When switched on, the generation of electronic links from an article’s main and copy records,

uses the table record “HERMES#LNMDEF#LIB#<library>[/<institute>]” instead of the

“lib_address” Sybase table.

usage \URLFROMLNMTABLE=<toggle>

example

USELINKEDHOLDINGS

description Add the holdings of a linked periodical to an article. product/service program hm_search function holding presentation

configuration implementation sw since Sudoc/Abes

comment Switched on by default.

If switched off, the holdings from the article itself are used. usage \USELINKEDHOLDINGS=<toggle>

example

USERCHARSET

description User character set. product/service program function presentation


comment If unset, the charset defaults to "ISO-8859-1”. Overruled by the &CHARSET request command.

The default character set is forced in case plain mode is activated (&PLAIN=ON).

usage \USERCHARSET=<string>


version: 1.

date: 26-01-2007 page 66 of 71

example \USERCHARSET=pica

\USERCHARSET=UTF-8

USERCOPYFILTER

description Filter the copy records in full presentations product/service program function presentation


comment This option can be used in Virtual OPAC, to filter out all but the copy records of the library of

the user. The value "N" can be overridden by the URL variable with the same name, but the value

"Y" can't. Does not filter the whole ILN, just either the organisation or the

organisation/department of the user.

If unset, filtering defaults to "N". usage \USERCOPYFILTER=<Y|N>

example \USERCOPYFILTER=Y

USERELTYPE obsolete

description Execute the REL command for CBS4 product/service CBS4 program hm_search function search



usage \USERELTYPE=<Y|N>

example

USERILNFILTER description Filter the ILN'S of local and copy records in full presentations

product/service program function presentation


comment This option controls filtering of all but the copy records of the ILN of the user. The value "N" can

be overridden by the URL variable with the same name, but the value "Y" can't.

If unset, filtering defaults to "N". usage \USERILNFILTER=<Y|N>

example \USERILNFILTER=Y

USERILNFILTER_SRU

description Filter the ILN'S of local and copy records in full presentations via SRU product/service program function presentation


comment This option controls filtering of all but the copy records of the ILN of the user in SRU

presentations. The value "Y" can override the classprofile option setting \USERILNFILTER=N, but

the value "N" can't override \USERILNFILTER=Y.

If unset, filtering defaults to "DEFAULT", which doesn't override the \USERILNFILTER setting. usage \USERILNFILTER_SRU=<Y|N|DEFAULT>

example \USERILNFILTER_SRU=Y

USESETTYPE


version: 1.

date: 26-01-2007 page 67 of 71

description Remember the IPN of the root of the family tree in order to determine the result set type.

product/service CBS4 program hm_search function search context


comment Switched off by default. usage \USESETTYPE=<toggle>

example

USE_USERBITS

description Compare the owner of a local/copy record against the userbits when adding the holdings to the

selected title. product/service program hm_search function holding presentation


comment Switched off by default. Overruled by the request command of the same name.

When switched on, the owner of a holding record must be in the used-by-iln range that is

generated from the userbits in subfield 001@ $0 of the corresponding level-0 record. If switched

off, the owner must be in the range of database owners defined with \OWNERS.

usage \USE_USERBITS=<toggle>

example

V




comment usage

example

W

WEBCATEDITONLYHOLDINGS

description If WEBCATFCVPICATOSCREEN generates a screen containing only holding (level 2) fields this

toggle can be set to suppress validation errors on level 0 and level 1 fields



comment default value is: N usage \WEBCATEDITONLYHOLDINGS=<toggle>

example \WEBCATEDITONLYHOLDINGS=Y

WEBCATFCV


version: 1.

date: 26-01-2007 page 68 of 71

description FCV table to be used for presentation of the title displayed in the webcat interface



comment usage \WEBCATFCV=<string>

example \WEBCATFCV=HERMES#FCV#pica#websimplettl

WEBCATFCVPICATOSCREEN

description FCV table to be used to generate webcat's edit template screen from a title product/service webcat program hm_webcat function webcat


comment default value is: FCV#pica#webcatscreen usage \WEBCATFCVPICATOSCREEN=<string>

example \WEBCATFCVPICATOSCREEN=HERMES#FCV#pica#webcatscreen

WEBCATFCVSCREENTOPICA

description FCV table to be used to build the modified title from webcat's edit template screen



comment default value is: FCV#webcatscreen#pica usage \WEBCATFCVSCREENTOPICA=<string>

example \WEBCATFCVSCREENTOPICA=HERMES#FCV#webcatscreen#pica

WEBCATCSDB

description Database identifier for CBS product/service webcat program hm_webcat function webcat


comment usage \WEBCATCSDB=<string>

example \WEBCATCSDB=1.1

WEBCATCSBES

description SYS.BES combination for CBS product/service Webcat program hm_webcat function webcat


comment usage \WEBCATCSBES=<string>

example \WEBCATCSBES=1.1

WEBCATREDIRECTOR

description Entry to specify the location of the PHP redirection script


version: 1.

date: 26-01-2007 page 69 of 71

product/service Webcat program hm_webcat function webcat

configuration implementation svda since

comment usage \WEBCATREDIRECTOR =<string>

example \WEBCATREDIRECTOR=http://<%environ(WEBCAT_REDIRECTOR_HOST)>/dai

WEBCAT_EDIT <status>

description Toggle for enabling | disabling (default) the edit link in long title display product/service webcat program csnw_cat function webcat


comment usage \WEBCAT_EDIT=<toggle>

example \WEBCAT_EDIT=Y

WEBCAT_EDIT_SCRIPT <status>

description url to the webcat editing screen for the current record product/service webcat program csnw_cat function webcat


comment The url is typically to a php script which redirects to a webcat url with full query string.

Placement depends on the WEBCAT_EDIT toggle.

usage \WEBCAT_EDIT_SCRIPT=<url>

example \WEBCAT_EDIT_SCRIPT

=<%environ(METIS_REDIRECT_SCRIPT)>?action=edit&PPN=<%variable(PPN)>

WEBCAT_EXTRA_SCRIPT <status>

description url to some « extra function » for webcat, possibly on the current record. product/service webcat program csnw_cat function webcat




usage \WEBCAT_EXTRA_SCRIPT=<url>

example \WEBCAT_EXTRA_SCRIPT =

<%environ(METIS_REDIRECT_SCRIPT)>?action=export&cbs=<%environ(HM_CBS_BASE)>&PPN

=<%variable(PPN)>

WEBCAT_FILL_SCRIPT <status>

description url to the webcat editing screen for inserting a new record product/service webcat program csnw_cat function webcat




usage \WEBCAT_FILL_SCRIPT=url

example \WEBCAT_FILL_SCRIPT=<%environ(METIS_REDIRECT_SCRIPT)>?action=fill


version: 1.

date: 26-01-2007 page 70 of 71

WEBCAT_LABEL_WIDTH

description Set width of webcat label product/service webcat program hm_webcat function webcat


comment If not set a default of 175px is used. usage \WEBCAT_LABEL_WIDTH=<string>

example \WEBCAT_LABEL_WIDTH=200px

WEBCAT_SCREEN_TITLE

description Set width of webcat label product/service webcat program hm_webcat function webcat


version 2 comment If not set a default of 175px is used.

usage \WEBCAT_SCREEN_TITLE=<string>

example \WEBCAT_ SCREEN_TITLE =DAI

WEBCAT_SUPPRESS_HEADER

description Suppress printing of the header for webcat product/service webcat program hm_webcat function webcat


comment Default no suppression, turn on by setting to 'Y' usage \WEBCAT_SUPPRESS_HEADER=<toggle>

example \WEBCAT_SUPPRESS_HEADER=<Y|N>

WSFLOANOPTION

description Display a WSF loan request link. product/service end-user / WSF program hm_search function ILL



The supported material codes can be specified with WSFLOANOPTION_MATCODES.

usage \WSFLOANOPTION=<ON|OFF>

example

WSFLOANOPTION_MATCODES

description Material codes for which the loan link should be presented. product/service end-user / WSF program hm_search function ILL


comment The list of material codes is a sequence of consecutive bibliographic form indicators (2nd position

in 002@ $0). The \LOANOPTION must be switched on in order for the list to be evaluated.

By default, no material restrictions apply.


version: 1.

date: 26-01-2007 page 71 of 71

usage \WSFLOANOPTION_MATCODES=<list>

example \WSFCOPYOPTION_MATCODES=BM

X




comment usage

example

Y




comment usage

example

Z




comment usage

example