Additional parameters

Get there: More > Administration > Additional parameters

Identity providers

This section is used to define and manage external identity providers for Koha users. This is used when your users come from an external source, such as student management system, active directory, or other similar databases.

Get there: More > Administration > Additional parameters > Identity providers

Note

Only staff with the manage_identity_providers permission (or the superlibrarian permission) will have access to this section.

Adding an identity provider

To add an identity provider, click the ‘New identity provider’ button.

New identity provider form

Basic configuration

Code: enter a code for this provider.

Note

The code for the identity provider is limited to 20 characters and can only be composed of letters, numbers, and underscore (_).

Description: enter a name for this provider. This is what you will see in the interface.

Protocol: choose which protocol this identity provider uses.

OAuth

OIDC

Advanced configuration

Configuration: Use this field to enter the configuration specific to the protocol chosen above.

You can click on the ‘Add default OAuth configuration’ button or the ‘Add default OIDC configuration’ button to prefill the field with some default values, which you can change for your own values.

The default OAuth configuration is:

{ "key": "<enter client id>", "secret": "<enter client secret>", "authorize_url": "<enter authorization endpoint>", "token_url": "<enter token endpoint>", "userinfo_url": "<enter user info endpoint (optional)>", "scope": "email" }

The default OIDC configuration is:

{ "key": "<enter client id>", "secret": "<enter client secret>", "well_known_url": "<enter openid configuration endpoint>", "scope": "openid email" }

Mapping: Use this field to define the field mappings from the external database to the Koha borrower fields.

The key is the Koha field from the borrowers table, and the value is the external field.

Note

You can find all fields of the borrowers table in the database schema.

You can click on the ‘Add default OAuth mapping’ button or the ‘Add default OIDC mapping’ button to prefill the field with some default values, which you can change for your own values.

Both the default OAuth mapping and default OIDC mapping are:

{ "email": "email", "firstname": "given_name", "surname": "family_name" }

If the external fields are nested, you can use periods to separate the levels.

For example, if the firstname is nested like so:

<user> <given_name>First name</given_name> <family_name>Family name</family_name> <email>Email address</email> </user>

Use:

"firstname": "user.0.given_name"

This will fetch the “given_name” field in the first “user” field (0 = first).

Important

If you plan on using the auto register function (see below), make sure either “userid” or “cardnumber” are present in the mappings.

Important

Make sure the field for the matchpoint (see below) is included in the mappings.

Matchpoint: choose which field is used to match incoming users to existing users.

Note

The field chosen here must be included in the mappings (see above).

Icon URL: if you want an icon to show on the login screen for this provider, enter the URL to the image file here.

Domain configuration

Note

Enter at least one domain for this provider. Once it is saved, you will be able to add more domains to this provider.

Domain: enter the email domain for incoming users.

Note

Enter an asterisk (*) to include all domains.

Default library: if auto register is enabled, choose at which library new users will be registered.

Default category: if auto register is enabled, choose which patron category will be assigned to new users.

Allow OPAC: choose if patrons of this domain can log into the OPAC with their credentials from this identity provider.

Allow staff: chose if staff members of this domain can log into the staff interface with their credentials from this identity provider.

Auto register: choose whether or not a new patron account is created in Koha when a user from this domain logs in for the first time with their credentials from this identity provider.

Note

If auto register is enabled, make sure the “userid” or “cardnumber” fields are included in the mappings (see above).

Also make sure the default library and default category are set correctly for new patrons. These will be assigned to the new patrons.

Update on login: choose whether or not the patron account in Koha is updated with the external information when a user from this domain logs in with their credentials from this identity provider.

Warning

Information may be lost if you change it directly in Koha.

Once the form is completed, click ‘Submit’ to save the new identity provider.

You will need to restart Koha once the identity provider is added.

Adding an email domain to an existing identity provider

You will need to add at least one email domain when creating a new identity provider. You can add more by clicking the ‘Manage domains’ button to the right of the identity provider from the main identity providers page, and clicking ‘New email domain’.

New email domain form

Domain: enter the email domain for incoming users.

Note

Enter an asterisk (*) to include all domains.

Update on login: choose whether or not the patron account in Koha is updated with the external information when a user from this domain logs in with their credentials from this identity provider.

Warning

Information may be lost if you change it directly in Koha.

Auto register: choose whether or not a new patron account is created in Koha when a user from this domain logs in for the first time with their credentials from this identity provider.

Note

If auto register is enabled, make sure the “userid” or “cardnumber” fields are included in the mappings of the identity provider.

Also make sure the default library and default category are set correctly for new patrons. These will be assigned to the new patrons.

Default library: if auto register is enabled, choose at which library new users will be registered.

Default category: if auto register is enabled, choose which patron category will be assigned to new users.

Allow OPAC: choose if patrons of this domain can log into the OPAC with their credentials from this identity provider.

Allow staff: chose if staff members of this domain can log into the staff interface with their credentials from this identity provider.

Once the form is completed, click ‘Submit’ to save the new email domain.

Z39.50/SRU servers

Z39.50 is a client/server protocol for searching and retrieving information from remote computer databases. In short, it’s a tool used for copy cataloging.

SRU (Search/Retrieve via URL) is a standard XML-based protocol for search queries, utilizing CQL (Contextual Query Language), a standard syntax for representing queries.

Using Koha you can connect to any Z39.50 or SRU target that is publicly available or that you have the log in information to and copy bibliographic or authority records from that source.

Get there: More > Administration > Additional parameters > Z39.50/SRU servers

Note

Only staff with the manage_search_targets permission (or the superlibrarian permission) will have access to this section.

Koha comes with a default list of Z39.50/SRU targets set up that you can add to, edit or delete.

List of Z39.50 and SRU servers

Adding a Z39.50 target

To find additional Z39.50 targets, you can use IndexData’s IRSpy: http://irspy.indexdata.com or the Library of Congress’s list of targets http://www.loc.gov/z3950/. You can also contact individual libraries and ask for their Z39.50 information.

From the main Z39.50 page, click ‘New Z39.50 server’.

New Z39.50 server form

Server name: enter a name that will help you identify the source (such as the library name). It will be saved in capital letters.

Hostname: enter the address to the Z39.50 target.

Port: enter the port number to listen on to get results from this target.

Database: enter the name of the database.

Userid: some servers might be password protected. If that is the case for the server you are trying to add, enter your user ID for that source.

Password: if the server is password protected, enter your password for that source.

Preselected: check this box if you want this target to always be selected by default.

Rank: enter a number representing where in the list you’d like this target to appear. 0 is the top position, then 1, 2, etc.

If this is left blank the targets will be in alphabetical order.

Attributes: enter PQF attributes to be added to all queries.

Syntax: choose the MARC flavor used by this target.

Encoding: choose the character encoding used by this target.

Note

If you notice special characters don’t appear correctly when you import records through Z39.50, it means the encoding is wrong. Change it to another and try importing again.

Timeout: enter a number of seconds after which to stop trying to search the target if results aren’t found in a reasonable amount of time. It is helpful for targets that take a long while.

Record type: choose if this is a bibliographic or an authority target.

XSLT file(s) for transforming results: enter one or more (comma-separated) XSLT file names that you want to apply on the search results.

When retrieving records from external targets you may wish to automate some changes to those records. XSLT’s allow you to do this. Koha ships with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:

Del952.xsl: Remove Koha items (field 952) (MARC21)

Del995.xsl: Remove Koha items (field 995) (UNIMARC)

Del9LinksExcept952.xsl: Remove links to authorities in bibliographic records ($9), except in the case of 952$9 (itemnumber) (MARC21)

Del9LinksExcept995.xsl: Remove links to authorities in bibliographic records ($9), except in the case of 995$9 (itemnumber) (UNIMARC)

Click ‘Save’.

Suggested bibliographic Z39.50 targets

Koha libraries with open Z39.50 targets can share and find connection information on the Koha wiki: http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can also find open Z39.50 targets by visiting IRSpy: http://irspy.indexdata.com.

The following targets have been used successfully by other Koha libraries:

ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC

CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC

GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC

HALIFAX PUBLIC catalog.halifaxpubliclibraries.ca:210 horizon

HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills

LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB

LONDON PUBLIC LIBRARY catalog.londonpubliclibrary.ca:210 INNOPAC

MANITOBA PUBLIC library.gov.mb.ca:210 horizon

MILTON PL cat.mpl.on.ca:210 horizon

NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default

NHUPAC 199.192.6.130:211 nh_nhupac

OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC

OHIOLINK olc1.ohiolink.edu:210 INNOPAC

PUBCAT prod890.dol.state.vt.us:2300 unicorn

SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER

SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON

TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn

TRI-UNI 129.97.129.194:7090 voyager

VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon

Suggested authority Z39.50 targets

The following targets have been used successfully by other Koha libraries (in the Americas):

LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid: ANLEZ / Password: z39.50

LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF

LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF

Adding an SRU target

From the main Z39.50/SRU page, click ‘New SRU server’

New SRU server form

Server name: enter a name that will help you identify the source (such as the library name).

Hostname: enter the address (URL) to the SRU target.

Port: enter which port to listen on to get results from this target.

Database: enter the name of the database.

Userid: some servers might be password protected. If that is the case for the server you are trying to add, enter your user ID for that source.

Password: if the server is password protected, enter your password for that source.

Preselected: check this box if you want this target to always be selected by default.

Rank: enter a number representing where in the list you’d like this target to appear. 0 is the top position, then 1, 2, etc.

If this is left blank the targets will be in alphabetical order.

Syntax: choose the MARC flavor used by this target.

Encoding: choose the character encoding used by this target.

Note

If you notice special characters don’t appear correctly when you import records through Z39.50, it means the encoding is wrong. Change it to another and try importing again.

Timeout: enter a number of seconds after which to stop trying to search the target if results aren’t found in a reasonable amount of time. It is helpful for targets that take a long while.

Record type: choose if this is a bibliographic or an authority target.

Additional SRU options: enter additional options of the external server here, like sru_version=1.1 or schema=marc21, etc. Note that these options are server dependent.

SRU Search field mapping: click ‘Modify’ to add or update the mapping from the available fields on the Koha search form to the specific server dependent index names.

Pop up window to add SRU search field mapping for bibliographic records, visible fields are title, author, ISBN, ISSN, LC call number, subject, control number, dewey, any, and standard ID. Each field has a text field to be filled.

Pop up window to add SRU search field mapping for authorities, fields are keyword (any), name (any), author (any), author (personal), author (corporate), author (meeting/conference), control number, subject heading, subject sub-division, title (any), and title (uniform). Each field has a text field to be filled.

To further refine your searches, you could add the following index names to the SRU search field mappings. To do this, edit the server and click the Modify button next to this field.

Title

dc.title

ISBN

bath.isbn

Any

cql.anywhere

Author

dc.author

ISSN

bath.issn

Subject

dc.subject

Standard ID

bath.standardIdentifier

Table: SRU mapping

XSLT file(s) for transforming results: enter one or more (comma-separated) XSLT file names that you want to apply on the search results.

When retrieving records from external targets you may wish to automate some changes to those records. XSLT’s allow you to do this. Koha ships with some sample XSLT files in the /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:

Del952.xsl: Remove Koha items (field 952) (MARC21)

Del995.xsl: Remove Koha items (field 995) (UNIMARC)

Del9LinksExcept952.xsl: Remove links to authorities in bibliographic records ($9), except in the case of 952$9 (itemnumber) (MARC21)

Del9LinksExcept995.xsl: Remove links to authorities in bibliographic records ($9), except in the case of 995$9 (itemnumber) (UNIMARC)

Click ‘Save’.

SMTP servers

Get there: More > Administration > Additional parameters > SMTP servers

This section is used to configure SMTP servers to send emails through Koha.

Note

Only staff with the manage_smtp_servers permission (or the superlibrarian permission) will have access to this section.

The default STMP configuration is set in the koha-conf.xml file. But this section allows you to add additional servers.

Main page of the SMTP servers configuration section, there are no servers except the default

To add a new server,

Click ‘New SMTP server’

New SMTP server form

Name (required): give the server a significant name, this is the name that will be displayed in Koha

Host (required): enter the host name or IP address of the server

Port (required): enter the port number provided by your administrator

Timeout (seconds): enter the number of seconds after which an unsent email will result in an error

SSL: choose the security protocol provided by your administrator

Disabled: no security (not recommended)

SSL

STARTTLS

Username: enter the username provided by your administrator

Password: enter the password provided by your administrator

Debug mode: choose whether to enable the debug mode to send additional output to the logs

Default server: choose whether this server is the default one to be used by all libraries

Click ‘Submit’

Once the server is added, you can select it in the library’s details.

Did you mean?

Get there: More > Administration > Additional parameters > Did you mean?

Note

Only staff with the manage_didyoumean permission (or the superlibrarian permission) will have access to this section.

Koha can offer ‘Did you mean?’ options on searches based on values in your authorities.

Important

Did you mean? only works in the OPAC at this time. The intranet options are here for future development.

Using this page you can control which options Koha gives patrons on their search results.

image235

To turn on the ‘Did you mean?’ bar on your search results you need to check the box next to each plugin you would like to use. The two plugins you have to choose from are:

The ExplodedTerms plugin suggests that the user try searching for broader/narrower/related terms for a given search (e.g. a user searching for “New York (State)” would click the link for narrower terms if they’re also interested in “New York (City)”). This is only relevant for libraries with highly hierarchical authority data.

The AuthorityFile plugin searches the authority file and suggests the user might be interested in bibs linked to the top 5 authorities

If you want one plugin to take priority over another you simply drag it above the other.

image236

If you choose both plugins you will see several options at the top of your search results

image237

If you choose just the AuthorityFile you’ll see just authorities.

image238

Table settings

This administration area will help you hide or display columns on fixed tables throughout the staff interface and OPAC.

Get there: Administration > Additional parameters > Table settings

Screenshot of the Table settings page, where we can see all the modules of Koha that have customizable tables

Note

Only staff with the manage_column_config permission (or the superlibrarian permission) will have access to this section.

Clicking on the module you’d like to edit tables for will show you the options available to you.

This area lets you control the columns that show in the table in question. If nothing is hidden you will see no check marks in the ‘is hidden by default’ column.

The currencies table settings, no columns are marked as hidden

And will see all of the columns when viewing the table on its regular page.

The currencies administration table, all columns are visible

If columns are hidden they will have checks in the ‘is hidden by default’ column.

The currencies table settings, the symbol and ISO code columns are marked as hidden

And hidden when you view the table.

The currencies administration table, the symbol and ISO code columns are hidden

The ‘Cannot be toggled’ column is used to prevent individual users from showing or hiding this column when viewing the table.

Individual users can toggle columns using the ‘Columns’ button at the top of the table.

The button 'Columns' above the currencies administration table is clicked open and all the column names appear

For example, in the Currencies table, the ‘Currency’ and ‘Rate’ columns cannot be toggled. When the user clicks on the ‘Columns’ button, they are not able to choose whether these two columns are hidden or visible.

Note that using the ‘Columns’ button show or hide columns will only toggle them for the current user and session. Once the user logs out, the columns will go back to their default settings as set in the table settings administration page. It will not affect any other user.

Module

Tables

Acquisitions

Funds table on the main acquisition page (accounts)

Basket summary (orders)

Order search results (histsearcht)

Late orders (late_orders)

Suggestions (suggestions)

Administration

Patron categories (patron_categories)

Cities (table_cities)

Currencies (currency)

Item types (table_item_type)

Libraries (libraries)

Authorities

There aren’t any tables that can be configured from the Authorities module.

Catalog

Acquisition details (acquisitiondetails-table)

Item bundles (bundle_tables)

Checkout history (checkoutshistory-table)

Holdings/items (holdings_table)

Holdings/items from other libraries (otherholdings_table) (when SeparateHoldings is enabled)

Cataloging

Reservoir results (reservoir-table)

Item table above edit item form (Items Editor)

Catalog concern management (table_concerns)

Z39.50 search results (resultst)

Circulation

Holds tab in the patron’s checkout page (holds-table)

Checkouts (issues-table)

Relatives’ checkouts (relatives-issues-table)

Patron search results (table_borrowers)

List of holds on a bibliographic record (patron_holds_table)

Version

Table settings for the list of holds on a bibliographic record (patron_holds_table) was added in version 23.11 of Koha.

Holds awaiting pickup (holds with cancellation requests) (holdscr)

Holds awaiting pickup (holds waiting over X days) (holdso)

Holds awaiting pickup (holds waiting) (holdst)

Hold ratios (holds-ratios)

Overdues report (circ-overdues)

Checkouts table when printing the summary (print-summary-checkouts)

Charges table when printing the summary (print-summary-fines)

Holds table when printing the summary (print-summary-holds)

Checkins (checkedintable)

Holds queue (holds-table)

Course reserves

Courses (courses page, course_reserves_table)

Reserves (reserves page, course_reserves_table)

E-resource management

Agreements (agreements)

E-holdings packages (packages)

E-holdings titles (titles)

Licenses (licenses)

Interlibrary loans

Requests (ill-requests)

Patrons

Patron checkout history (checkouthistory-table)

Accounting > Transactions (account-fines)

Holds history (holdshistory-table)

Patron search results (memberresultst)

Details > Holds (holds-table)

Details > Checkouts (issues-table)

Details > Relatives’ checkouts (relatives-issues-table)

Patron lists (patron-list-table)

Accounting > Make a payment (pay-fines-table)

Point of sale

Point of sale (invoices)

Tools

Batch patron modification tool (borrowerst)

Log viewer (logst)

MARC modification templates templatest

Notices and slips (lettert)

Stock rotation rotas (stock_rotation)

Stock rotation items (stock_rotation_manage_items)

List of files in upload tool (uploadresults)

OPAC

Course reserves (course-items-table)

Courses (course_reserves_table)

Holdings/Items (holdingst)

Serials issues on subscription tab (subscriptionst)

Reports

Items lost (lostitems-table)

Orders by fund (funds-table)

Saved SQL reports (table_reports)

Serials

Acquisition details (orders)

Note

Patrons in the OPAC can’t toggle column visibility. For OPAC tables this feature only allows to control the visibility of columns.

Note

Any tables with columns listed here also have the option to export to Excel, export to CSV, copy, or print within the table header.

Audio alerts

If you have your AudioAlerts preference set to ‘Enable’ you will be able to control the various alert sounds that Koha uses from this area.

Get there: More > Administration > Additional parameters > Audio alerts

Note

Only staff with the manage_audio_alerts permission (or the superlibrarian permission) will have access to this section.

Each dialog box in Koha has a CSS class assigned to it that can be used as a selector for a sound.

image1213

You can edit the defaults by clicking the ‘Edit’ button to the right of each alert.

image1214

You can assign alerts to other CSS classes in Koha by entering that information in the selector box. For example if you enter

body:contains('Check in message')

Then when you visit the check-in page you will hear an alert.

Every page in Koha has a unique ID in the body tag which can be used to limit a sound to a specific page

Any ID selector (where HTML contains id=”name_of_id” ) and can also be a trigger as: #name_of_selector

SMS cellular providers

Important

This option will only appear if the

SMSSendDriver preference is set to ‘Email’.

Note

Only staff with the manage_sms_providers permission (or the superlibrarian permission) will have access to this section.

Note

Many mobile providers have deprecated support for the SMS::Send::Email feature. It is not recommended for use unless you have a dedicated SMS to Email gateway.

From here you can enter as many cellular providers as you need to send SMS notices to your patrons using the email protocol.

image1215

Some examples in the US are:

Mobile carrier

SMS gateway domain

Alltel

sms.alltelwireless.com

AT&T

txt.att.net

Boost Mobile

sms.myboostmobile.com

Project Fi

msg.fi.google.com

Republic Wireless

text.republicwireless.com

Sprint

messaging.sprintpcs.com

T-Mobile

tmomail.net

U.S. Cellular

email.uscc.net

Verizon Wireless

vtext.com

Virgin Mobile

vmobl.com

Table: SMS provider examples

To add new providers enter the details in the form and click ‘Add new’ to save.

image1216

These options will appear in the OPAC for patrons to choose from on the messaging tab if you have EnhancedMessagingPreferences enabled.

image1217

Share your usage statistics

You can share your Koha usage statistics with the Hea community. Sharing your usage statistics helps with the development of Koha as the community regularly checks these statistics to make decisions.

Note

Only staff with the manage_usage_stats permission (or the superlibrarian permission) will have access to this section.

Note that statistics are anonymized and no patron information is shared.

Worldwide statistics can be viewed at https://hea.koha-community.org/

image1479

Share my Koha usage statistics:

The default choice is ‘Undecided’, this make the message appear on the administration main page.

Choose ‘yes’ if you want to share your usage statistics

Choose ‘no’ if you don’t want to share your statistics and you don’t want to see the message on the administration page

Your country: choose the country where your library is located

Library name: enter your library’s name

Library type: choose your library’s type

Library URL: enter your library’s Web site URL

Last update: here your will see the last date when your data was uploaded to the Hea website

Geolocation: use the map on the right to put the marker where your main library is situated. The coordinates will appear in the Geolocation field.

Libraries information: if you have more than one branch, you can choose ‘yes’ here to put all your branches on the map

See your public page: this is the URL to your information on the Hea website.

Click ‘Update your statistics usage’ to save the information.

Share content with Mana KB

Mana KB is a worldwide knowledge base used to share content specific to libraries. Koha is currently connected to Mana Kb in order to share serial subscription models and reports. This section is used to configure your connexion with Mana KB.

Get there: More > Administration > Additional parameters > Share content with Mana KB

image1426

Note

Only staff with the manage_mana permission (or the superlibrarian permission) will have access to this section.

In the form, choose whether you want to use Mana KB to share content or not. The default is “No, let me think about it”. If you do want to use Mana KB, change the option to “Yes”. If you do not want to share with Mana KB, choose “No”, this will remove the blue rectangle from the Administration home page.

The rest of this section assumes you chose “Yes”.

Choose whether you want to share your subscription models automatically. This means that every time you create a subscription in the serials module, it will be automatically shared with Mana KB and other libraries will be able to copy it.

In order to configure Mana KB, you must get a Mana KB token to authenticate your Koha installation on the Mana KB server.

Enter your name or your organization’s name in the “Your name” field.

Enter your email in the “Email” field. Make sure you have access to this email inbox since you will receive further information by email.

Once you send your information to Mana KB, you will get a Mana KB token.

image1427

In the email your receive, click on the confirmation link and confirm you are not a robot to finish the Mana KB setup.

Additional fields

This section is used to add custom fields to order baskets, invoice, serial subscriptions, and accountlines.

Note

Only staff with the manage_additional_fields permission (or the superlibrarian permission) will have access to this section.

To add a new field, first choose which table you want to add it to.

Order baskets (aqbasket): a field added to aqbasket will appear upon the creation of a new order basket or the modification of an existing order basket in the acquisitions module.

New basket form with additional fields at the bottom

Order lines (aqorders): a field added to aqorders will appear when adding orders to a basket or editing orders in open baskets.

Invoices (aqinvoices): a field added to aqinvoices will appear when viewing an invoice in the acquisitions module.

Detailed invoice page, with additional fields and AcqEnableFiles enabled

Subscriptions (subscription): a field added to subscription will appear when creating a new subscription or when editing an existing subscription in the serials module.

Add a new subscription form (2 of 2), with additional fields at the bottom

Account lines (credit) (accountlines:credit): a field added to account line credits will appear when paying or writing off charges in a patron’s account or when creating manual credits.

Form to pay an individual charge

Account lines (debit) (accountlines:debit): a field added to account line debit will appear when creating a manual invoice

Create manual invoice form

Click on “Create field”

Fill out the form

Add field form

Name: this is the name of the field as you want it to appear.

Authorized value category: if you want to add a dropdown menu to the field choose an authorized value category here (you can also create a new authorized value category if you need to).

MARC field: for additional subscription fields, it is possible to link the field to a MARC field. The additional field will be automatically populated with the corresponding record’s value for this MARC field.

Note

You can only choose one of the two options (authorized value OR MARC field)

Warning

If you choose the MARC field, make sure you enter it in this format: field$subfield

For example: 590$a

Searchable: check this box if you want to be able to search baskets or subscriptions based on this field

Order basket searchable additional fields will be available in the orders advanced search form

Invoice searchable additional fields will be available in the invoice search form

Subscription searchable additional fields will be available in the subscription advanced search form

Examples of additional fields

Example 1: Additional subscription field using authorized values

You might want to track which department you’re ordering this serial for

In the ‘Name’ field, enter ‘Department’

In the ‘Authorized value category’ field, choose DEPARTMENT

Check the ‘Searchable’ box

Add field form, filled with Department as the Name, DEPARTMENT as the authorized value category and Searchable is checked

When you are adding a subscription, the field will be in the ‘Additional fields’ section with its authorized values drop-down menu.

Add a new subscription form (2 of 2), with additional fields at the bottom

When you view the subscription, the field will appear under ‘Additional fields’.

Subscription details page, Information tab, with buttons at the top (New subscription for this serial, Edit, Renew, Receive, Close) and menu on the left (Serial collection, Create routing list, Claims, Check expiration, Manage frequencies, Manage numbering patterns, Manage subscription fields, Serials statistics wizard)

Because we made the field searchable, it will also be in the serials subscription search.

Serials advanced search form

Example 2: Additional subscription field using MARC field

This is particularly useful if you want to view bibliographic information in the subscription detail page. In this example, we will add the 521$a field, which is, in MARC21, the target audience note.

In the ‘Name’ field, enter ‘Target audience’

In the ‘MARC field’ field, enter ‘521$a’

Add field form, filled with Target audience as the Name, and 521$a as the MARC field

Note

You will not be able to edit this field from the subscription form. If you need to add or change the value in this field, you must go through the cataloging module.

When you view the subscription, the field and the information from the bibliographic record will appear under ‘Additional fields’.

Subscription details page, Information tab, with buttons at the top (New subscription for this serial, Edit, Renew, Receive, Close) and menu on the left (Serial collection, Create routing list, Claims, Check expiration, Manage frequencies, Manage numbering patterns, Manage subscription fields, Serials statistics wizard)

Example 3: Free text invoice additional field

If you need to enter additional information in invoices, such as the number of the check used to pay for the invoice, you can choose not to use an authorized value at all.

In the ‘Name’ field, enter ‘Check #’

Check the ‘Searchable’ box

Add field form, filled with Check # as the Name, and Searchable is checked

The new fields will be displayed when viewing the invoice in the acquisitions module.

Detailed invoice page, with additional fields and AcqEnableFiles enabled

Because we made the field searchable, it will also be in the invoice search.

Invoice search form, additional fields that are searchable are available in this search

Keyboard shortcuts

This section is used to redefine the keyboard shortcuts used in the advanced cataloging editor.

Note

This section will only appear if the EnableAdvancedCatalogingEditor system preference is enabled.

Note

Only staff with the manage_keyboard_shortcuts permission (or the superlibrarian permission) will have access to this section.

To change a shortcut, enter the combination of keys to use in the field in the ‘Shortcut keys’ column, and click ‘Save shortcuts’.

Make sure to follow the key map rules when entering your key combinations:

Separate keys using a hyphen ‘-’

Control key is ‘Ctrl’

Alt key is ‘Alt’

Shift is ‘Shift’

If combining multiple keys they must be in specified order: Shift-Cmd-Ctrl-Alt

Built with Sphinx using a theme provided by Read the Docs.

FAQ Category
Koha
Summary
Additional parameters Get there: More Administration Additional parameters Identity providers This section is used to define and manage external identity providers for Koha users. This is used when your users come from an external source, such as student management system, active directory, or other similar databases. Get there: More Administration Additional parameters Identity providers Note Only staff with the manage_identity_providers permission (or the superlibrarian permission) will have access to this section. Adding an identity provider To add an identity provider, click the ‘New identity provider’ button. Basic configuration Code: ...
Keyword
Share; Subscription; Models; Reports; Permission; Superlibrarian; Token; Email; Confirmation; Marc; Field; Authorized; Value; Category; Searchable; Department; Target; Audience; Bibliographic; Information; Cataloging; Editor; Advanced; Shortcuts