Cataloging plugins (value builders)

With value builders you can enhance your cataloging with additional features like validation, link creation, auto-generation of numbers etc.

A value builder is a perl script that, within a MARC framework, is linked to a certain subfield in bibliographic records, authority records or items.

Note

Cataloging plugins are not to be confused with Koha plugins

Set up

Get there: Administration > MARC bibliographic framework

To use a value builder in your MARC framework, navigate to Administration > MARC bibliographic framework and then to the MARC structure of the desired framework.

Search for or browse to a field, and choose ‘Edit subfields’ from its ‘Actions’ menu. Go to the subfield’s tab, and choose the relevant entry from the drop down list at “plugin”.

Example

Adding the call number browser to the items editor:

In your MARC framework, go to field 952 and edit subfield o.
Choose cn_browser.pl from the ‘Plugin’ list.
Save your changes.

Signaturenbrowser in Unterfeld o von Feld 952 anschließen

Default value builders for MARC21

These value builders are already integrated to the default MARC bibliographic framework in MARC21.

To access a value builder from the basic editor, click the icon on the right of the field.

Leader (bibliographic record)

The leader value builder is linked to the 000 MARC field in all the default MARC21 bibliographic frameworks.

MARC21 leader value builder for bibliographic records

The values in this builder are based on the leader values in MARC21 (bibliographic).

00-04 - Record size: this will be filled automatically by Koha.
05 - Record status: in new records, this will be set to ‘n - New’ by default.
06 - Type of record: in new records, this will be set to ‘a - Language material’ by default.
07 - Bibliographic level: in new records, this will be set to ‘m - Monograph/ item’ by default. Some features in Koha, such as item bundles, analytics and CheckPrevCheckout might depend on having a different value here.
08 - Type of control: in new records, this will be set to ‘# - No specific type’ by default.
09 - Character coding scheme: records in Koha are always in Unicode.
10-16 - Indicator/subfields/size: this will be filled automatically by Koha.
17 - Encoding level: in new records, this will be set to ‘7 - Minimal level’ by default.
18 - Descriptive cataloging form: in new records, this will be set to ‘a - AACR 2’ by default.
19 - Multipart resource record level: in new records, this will be set to ‘# - Not specified or not applicable’ by default.
20-24 - Entry map & lengths: this will be filled automatically by Koha.

Leader (authority record)

The leader value builder is linked to the 000 MARC field in all the default MARC21 authority frameworks.

MARC21 leader value builder for authority records

The values in this builder are based on the leader values in MARC21 (authority).

00-04 - Record size: this will be filled automatically by Koha.
05 - Record status: in new records, this will be set to ‘n - New’ by default.
06 - Type of record: this will be set to ‘z - Authority data’.
07-08 - Undefined character positions
09 - Character coding scheme: in new records, this will be set to ‘a - UCS/ Unicode’ by default.
10-16 - Indicator/subfields/size: this will be filled automatically by Koha.
17 - Encoding level: in new records, this will be set to ‘n - Complete authority record’ by default.
18-19 - Undefined character positions
20-24 - Entry map & lengths: this will be filled automatically by Koha.

006 (bibliographic record)

The 006 value builder is linked to the 006 MARC field in all the default MARC21 bibliographic frameworks.

MARC21 006 value builder

The values in this builder are based on the 006 field values in MARC21.

Type of material: this value will change the fields and options below, since elements in 006 are defined by type of material. In new records, this will be set to ‘BKS - Books’ by default.
00 - Form of material: the default value and options here will depend on the type of material above.

The rest of the values are the same as 008/18-34, see the description below.

007 (bibliographic record)

The 007 value builder is linked to the 007 MARC field in all the default MARC21 bibliographic frameworks.

MARC21 007 value builder

The values in this builder are based on the 007 field values in MARC21.

Material type: this value will change the fields and options below, since elements in 007 are defined by type of material. In new records, this will be set to ‘Text’ by default.

008 (bibliographic record)

The 008 value builder is linked to the 008 MARC field in all the default MARC21 bibliographic frameworks.

MARC21 008 value builder

The values in this builder are based on the 008 field values in MARC21 (bibliographic).

Type of material: this value will change the fields and options below, since elements in 008 are defined by type of material. The default value depends on the value in leader/06 (as well as the value in leader/07 in some cases).

leader/06 value	leader/07 value	008 Type of material
a - Language material	a - Monographic component part	BKS - Books
	b - Serial component part	CR - Continuing resources
	c - Collection	BKS - Books
	d - Subunit	BKS - Books
	i - Integrating resource	CR - Continuing resources
	m - Monograph/Item	BKS - Books
	s - Serial	CR - Continuing resources
c - Notated music		MU - Music
d - Manuscript notated music		MU - Music
e - Cartographic material		MP - Maps
f - Manuscript cartographic material		MP - Maps
g - Projected medium		VM - Visual materials
i - Nonmusical sound recording		MU - Music
j - Musical sound recording		MU - Music
k - Two-dimensional nonprojectable graphic		VM - Visual materials
m - Computer file		CF - Computer files
o - Kit		VM - Visual materials
p - Mixed materials		MX - Mixed materials
r - Three-dimensional artifact or naturally occurring object		VM - Visual materials
t - Manuscript language material		BKS - Books

008 (authority record)

The 008 value builder is linked to the 008 MARC field in all the default MARC21 authority frameworks.

MARC21 008 value builder for authority records

The values in this builder are based on the 008 field values in MARC21 (authority).

Other default value builders

As well as the default value builders for specific MARC fields, there are other cataloging plugins that are linked to fields by default in Koha.

Barcode

This value builder is the plugin linked to the barcode field in all default MARC bibliographic frameworks ( 952$p in MARC21 or 995$f in UNIMARC) by default.

It is used by the autoBarcode system preference. If the preference is set to a barcode format, the barcode value builder will generate a barcode automatically when the user clicks in the barcode field.

You can alternatively use the optional manual barcode value builder instead of this default one.

Date of acquisition

This value builder is the plugin linked to the date of acquisition item field in all default MARC bibliographic frameworks ( 952$d in MARC21 or 995$5 in UNIMARC) by default.

This simply enters today’s date when the user clicks in the field.

Optional value builders

As well as the default value builders for specific MARC fields or other fields, there are other cataloging plugins that can optionally be added to MARC frameworks to help with various tasks when cataloging records.

Manual barcode

This value builder is an optional alternative to the Barcode value builder. It does the same thing, but the barcode is only generated when the user clicks on the ellipsis (…) next to the barcode field.

It can be used in libraries that don’t necessarily want a barcode generated automatically for all items.

To use this value builder instead of the regular barcode value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the barcode tab (‘p’ in MARC21, or ‘f’ in UNIMARC)
Under ‘Other options’ choose ‘barcode_manual.pl’ as the plugin
Click ‘Save changes’

Call number (sequential, 4 characters with prefix)

This value builder can optionally be used to create in-house sequential alphanumeric call numbers.

You must supply a letter prefix (of any length), followed by an empty space and an alphanumeric number. The alphanumeric number is 4 characters long, and is either a letter or number sequence, which is then appended by 1, 2, 3, etc.

If the input is not in this exact format, nothing will be generated.

Here are some examples of values that will trigger a call number generation:

AAA 0 returns first unused number AAA 0xxx starting with AAA 0001
BBB 12 returns first unused number BBB 12xx starting with BBB 1201
CCC QW returns first unused number CCC QWxx starting with CCC QW01

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the call number tab (‘o’ in MARC21, or ‘k’ in UNIMARC)
Under ‘Other options’ choose ‘callnumber-KU.pl’ as the plugin
Click ‘Save changes’

To generate a call number, type the prefix, space and start of the sequential number in the call number field, then click the ellipsis (…) next to the field. The call number will be generated according to the pattern supplied.

Call number (sequential digits with prefix)

This value builder can optionally be used to create in-house sequential numeric call numbers, with or without a letter prefix.

You must supply a letter prefix (of any length). The plugin will append an incremented number to the prefix.

For example, if the highest call number with the prefix “PREFIX” is “PREFIX 5236”, the next “PREFIX” call number to be generated will be “PREFIX 5237”.

If you leave the field empty, a simple incremented call number is generated.

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the call number tab (‘o’ in MARC21, or ‘k’ in UNIMARC)
Under ‘Other options’ choose ‘callnumber.pl’ as the plugin
Click ‘Save changes’

To generate a call number, type the prefix, then click the ellipsis (…) next to the field. The call number will be generated according to the pattern supplied.

Callnumber browser

This plugin can be optionally used to browse the call numbers directly from the item editor.

Clicking the ellipsis (…) next to the call number field will open a pop-up window with a search form.

Call number browser pop-up window, with a field to search the call number, and a drop-down menu to choose the classification scheme.

If you type in a call number and click the ellipsis, the search form will be prefilled with the call number.

In the results, a thin green line indicates where the searched call number would be in the sequence.

Call number browser pop-up window, the search was for 822.33 S in the Dewey Decimal Classification scheme. The results show 15 titles with callnumbers ranging from 822.33 H521 and 822.33 HEN, then a thin green line indicating where 822.33 S would be, followed by more results with the callnumbers 822.33 SHA.

If the call number exists, the results will show in red.

Call number browser pop-up window, the search was for 822.33 HEN in the Dewey Decimal Classification scheme. The results show some titles callnumbers that come before 822.33 HEN, and all the results with the callnumber 822.33 HEN are in red.

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the call number tab (‘o’ in MARC21, or ‘k’ in UNIMARC)
Under ‘Other options’ choose ‘cn_browser.pl’ as the plugin
Click ‘Save changes’

Stocknumber (library code)

This plugin can optionally be used to generate an incremented inventory number, prefixed by the library code.

For example, if the library code is CPL, the stocknumbers will be generated as CPL_1, CPL_2, CPL_3, etc.

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the inventory number tab (‘i’ in MARC21, or ‘j’ in UNIMARC)
Under ‘Other options’ choose ‘stocknumber.pl’ as the plugin
Click ‘Save changes’

When cataloging an item, click the ellipsis (…) next to the inventory number field. If there are no inventory numbers yet, only the prefix will be generated (CPL_ for example). If there are already inventory numbers, it will take the largest one and add one increment.

Stocknumber (10 digits with prefix)

This plugin can optionally be used to generate a 10-digit incremented inventory number, with a custom prefix.

For example, if the last inventory number is ‘CAT 0000001456’ the next ‘CAT’ inventory number will be ‘CAT 0000001457’.

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the inventory number tab (‘i’ in MARC21, or ‘j’ in UNIMARC)
Under ‘Other options’ choose ‘stocknumberam123.pl’ as the plugin
Click ‘Save changes’

When cataloging an item, type the prefix and click the ellipsis (…) next to the inventory number field. It will take the largest number with the same prefix and add one increment.

Stocknumber (10 digits with pre-determined prefix)

This plugin can optionally be used to generate a 10-digit incremented inventory number, with a custom prefix from an authorized value category.

For example, if the last inventory number is ‘CAT 0000001456’ the next ‘CAT’ inventory number will be ‘CAT 0000001457’.

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the item field (952 in MARC21, 995 in UNIMARC)
Click the inventory number tab (‘i’ in MARC21, or ‘j’ in UNIMARC)
Under ‘Other options’ choose ‘stocknumberAV.pl’ as the plugin
Click ‘Save changes’

In order to use this value builder, you need to create an authorized value category called ‘INVENTORY’.

Then, add authorized values like so:

Authorized value: enter the prefix you want for your inventory numbers (uppercase or lowercase).
Description: enter the first value for your number. For example, if your prefix is ‘CAT’ and you want your first inventory number to be ‘CAT 0000001457’, enter ‘1456’ or ‘0000001456’ in the authorized value description.
Description (OPAC): leave empty.

When cataloging an item, type the prefix and click the ellipsis (…) next to the inventory number field. It will take the largest number with the same prefix and add one increment. If you type an invalid prefix, it will not generate any number.

Upload

This plugin can optionally be used to upload files (with the upload tool) directly from the cataloging editor and automatically link the file in the field. This is useful to attach files to records (most commonly used with the $u subfield of the ‘electronic location and access’ field - 856 in MARC21 or 256 in UNIMARC).

To use this value builder,

Go to Administration > MARC bibliographic frameworks
Click Actions > MARC structure next to the framework to edit
Click Actions > Edit subfields next to the link field (856 in MARC21, 256 in UNIMARC)
Click the ‘u’ tab
Under ‘Other options’ choose ‘upload.pl’ as the plugin
Click ‘Save changes’

To attach files to records when cataloging,

Click the ‘Upload’ button next to the $u subfield.
Click the button to choose a file from your computer.
Click ‘Upload’.
Click ‘Choose’.

The link to the file will be automatically entered in the subfield.