linkuk_cat_update.pl

The linkuk_cat_update.pl script, which is derived from the rlb_non_isbn.pl script, allows libraries to create files of holdings records for export to LinkUK.  Only monograph records with an ISBN, BNB or Library of Congress control number are reported. The script does not currently handle ISBN-13 control numbers.

The script should be run regularly to produce notifications of all stock changes where the first copy has been added or the last copy has been deleted since the last run. It can also be used to report on all items or to produce a subset of holdings data limited by site, item status and/or item type.

The records are output in the format specified by OCLC PICA in June 2005.

Usage

Log on as talis and enter the following command:

linkuk_cat_update.pl –d<database> -h –p<filename> -r<report directory> -s<output directory>

Standard script arguments are described here. The remaining arguments for this script are described in the following table.

Argument

Description

-p

This mandatory switch specifies the parameter file. The parameter file must be located in the data directory (see below).

 

Parameter file

The parameter file must be located in the data directory. The parameters are case-insensitive. There is a default parameter file, linkuk_cat_update.param.default, in ‘/usr/opt/blcmp/data/expdir’ which can be copied to create the file.

The valid parameters are described in the following table.

Parameter

Options

LIST=

This optional parameter controls how the LIST_VALUES= option will work.

Set it to FI if output is to be created from a file of WORK_IDS.

Set it to FC if output is to be created from a file of control numbers.

Set it to I if output is to be created from a list of WORK_IDs specified in the LIST_VALUES= parameter.

Set it to C if output is to be created from a list of control numbers specified in the LIST_VALUES= parameter.

If any of these values is set the script will only process works in the file or list and will ignore all other optional parameters except REFERENCE_TYPES.

If this parameter is set to N or is not set, the script will ignore the LIST_VALUES= parameter.

LIST_VALUES=

This parameter is used in conjunction with the LIST parameter above.

  • If the value ‘I’ is specified in the LIST parameter, then a comma-separated list of WORK_IDs should be specified here.

  • If the value ‘C’ is specified in the LIST parameter, then a comma-separated list of control numbers should be specified here.

  • If the ‘FI’ value is given in the LIST parameter then the name of a file that contains a list of WORK_IDs or control numbers should be given here. This file should be located in the data directory.

  • If the ‘FC’ value is given in the LIST parameter then the name of a file that contains a list of control numbers should be given here. This file should be located in the data directory.

In all cases the output will only contain records with valid control numbers. Only 10-digit ISBNs should be entered; the script cannot currently handle ISBN-13 control numbers.

MODE=

This optional parameter determines the content of the output file to be created. There are three possible options:

• ADL produces a file of holdings records for which the first item has been added or the last item has been either withdrawn or changed to a not in stock status since the script was last run.

• FDA produces a full dump of holdings records for all Items

• FLT produces a file of holdings records for all Items that match the Status, Type and Location specified using the LOCATION, ITEM_STATUS and ITEM_TYPE parameters.

The default is ADL.

When MODE=ADL, the statuses that represent ‘in stock’ or ‘out of stock’ should be specified using the TAL_IN_STOCK or TAL_NOT_IN_STOCK environment variable. The variable should be set in the .profile of the Talis user. If neither is set, IS is assumed to be the only ‘in stock’ status.

Note: A full database dump can be produced by specifying MODE=FDA in the parameter file. This will use the WORKS table. Note that only Works with Items in the ITEM table will be included in the output files. You should use the ITEM_STATUS parameter to exclude works that have only deleted items, for example, attached.

LOCATION=

This optional parameter can be used to restrict the selection to Items that belong to a specific site. A list of comma-separated site codes can be entered. If no sites are specified then all sites will be selected.

Note: This parameter should only be used in conjunction with the MODE=FLT option. If you use it with the FDA or ADL option the output will not be accurate.

ITEM_STATUS=

This optional parameter can be used to restrict selection to particular item statuses. A list of comma-separated status codes may be entered (e.g. REC,IS). If no statuses are specified then all statuses will be selected.

Note: This parameter should only be used in conjunction with the MODE=FLT option. If you use it with the FDA or ADL option the output will not be accurate.

ITEM_TYPE=

This optional parameter can be used to restrict selection to particular item types. A list of comma-separated type codes may be entered (e.g. AF,ANF,JF,JNF). If no types are specified then all types will be selected. The list must include any items types that may be listed under the REFERENCE_TYPES parameter.

Note: This parameter should only be used in conjunction with the MODE=FLT option. If you use it with the FDA or ADL option the output will not be accurate.

REFERENCE_TYPES=

This optional parameter may be used specify which item types should be treated as reference stock. Item Type codes should be specified, separated by a comma. If none is specified then all Item Types are assumed to be lending.

If the ITEM_TYPE parameter is used to limit the items types processed by the script then the REFERENCE_TYPES parameter values must also be listed in the ITEM_TYPE parameter.

LOC_CODE=

This mandatory parameter specifies a four-digit library code. This comprises your one-character region code followed by your 3-digit library number.

The region code character must be one of the following:

D = West Midlands
F = Original LASER area
H = Wales
C = South West

 

Notes