Authorized Values | Best Book Buddies
  1. Koha Manual
  2. Koha ManualKoha Manual
  3. How to configure basic parameters?

Koha Administration

How to configure basic parameters ?

Get there: More > Administration

Important

Configure all 'parameters' in the order they appear.

Authorized values can be used in several areas of Koha. One reason you would add an authorized value category would be to control the values that can be entered into MARC fields by catalogers.

  • Get there: More > Administration > Basic Parameters > Authorized Values

Koha installs with pre-defined values that your library is likely to use, for instance 'Lost'.

  • Asort1

    • Used for acquisitions statistical purposes

  • Asort2

    • Used for acquisitions statistical purposes

  • BOR_NOTES

    • Values for custom patron messages that appear on the circulation screen and the OPAC. The value in the Description field should be the message text and is limited to 200 characters.

      Koha bor_notes
  • Bsort1

    • Values that can be entered to fill in the patron's sort 1 field

  • Bsort2

    • Values that can be entered to fill in the patron's sort 2 field

  • CART

  • CCODE

    • Collection codes (appears when cataloging and working with items)

  • DAMAGED

    • Descriptions for items marked as damaged (appears when cataloging and working with items)

  • DEPARTMENT

    • Departments are required by and will be used in the Course Reserves module

  • HINGS_AS

    • General Holdings: Acquisition Status Designator :: This data element specifies acquisition status for the unit at the time of the holdings report.

  • HINGS_C

    • General Holdings: Completeness Designator

  • HINGS_PF

    • Physical Form Designators

  • HINGS_RD

    • General Holdings: Retention Designator :: This data element specifies the retention policy for the unit at the time of the holdings report.

  • HINGS_UT

    • General Holdings: Type of Unit Designator

  • LOC

    • Shelving location (usually appears when adding or editing an item)

  • LOST

    • Descriptions for the items marked as lost (appears when adding or editing an item)

    • Important

      Values given to lost statuses should be numeric and not alphabetical in order for statuses to appear properly

  • MANUAL_INV

    • Values for manual invoicing types

    • Important

      The value set as the Authorized Value for the MANUAL_INV authorized value category will appear as the Description and the Authorized Value Description will be used as the amount. Enter monetary amounts in the description without currency symbols.

  • NOT_LOAN

    • Reasons why a title is not for loan

    • Important

      Values given to lost statuses should be numeric and not alphabetical in order for statuses to appear properly

      Note

      Negative number values will still allow holds (use for on order statuses for example) where as positive numbers will not allow holds or checkouts

  • ORDER_CANCELLATION_REASON

    • Reasons why an order might have been cancelled

  • PROC

  • REPORT_GROUP

    • A way to sort and filter your reports, the default values in this category include the Koha modules (Accounts, Acquitisions, Catalog, Circulation, Patrons)

      Koha report_group
  • REPORT_SUBGROUP

    • Can be used to further sort and filter your reports. This category is empty by default. Values here need to include the authorized value code from REPORT_GROUP in the Description (OPAC) field to link the subgroup to the appropriate group.

      Koha report_subgroup
  • RESTRICTED

    • Restricted status of an item

  • ROADTYPE

    • Road types to be used in patron addresses

  • SIP_MEDIA_TYPE

    • Used when creating or editing an item type to assign a SIP specific media type for devices like lockers and sorters.

  • SUGGEST

    • List of patron suggestion reject or accept reasons (appears when managing suggestions)

  • WITHDRAWN

    • Description of a withdrawn item (appears when adding or editing an item)

  • YES_NO

    • A generic authorized value field that can be used anywhere you need a simple yes/no pull down menu.

In addition to the existing categories that come by default with Koha, librarians can add their own authorized value categories to control data that is entered into the system. To add a new category:

  • Click 'New Category'

    Koha addauthcat
  • Limit your Category to 10 characters (something short to make it clear what the category is for)

      Important

      Category cannot have spaces or special characters other than underscores and hyphens in it.

  • When adding a new category you're asked to create at least one authorized value

    • Enter a code for your Authorized Value into the 'Authorized value' field

        Important

        Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.

    • Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'

    • If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.

    • If you have StaffAuthorisedValueImages and/or AuthorisedValueImages set to show images for authorized values you can choose the image under 'Choose an icon'

  • Click 'Save'

  • Your new category and value will appear on the list of Authorized Values

    Koha authvallist

New authorized values can be added to any existing or new category. To add a value:

  • Click 'New authorized value for ...'

    Koha addauthvalue
  • Enter a code for your Authorized Value into the 'Authorized value' field

      Important

      Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.

  • Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'

  • If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.

  • If you have StaffAuthorisedValueImages and/or AuthorisedValueImages set to show images for authorized values you can choose the image under 'Choose an icon'

  • Click 'Save'

  • The new value will appear in the list along with existing values

    Koha authvals

"You are seeing this manual, thanks to Koha Community"