Taiga 1274 (24976) Updated guided reports process

[kohadocs.git] / source / serials.rst

.. include:: images.rst

Serials
=======

Serials actions can be accessed by going to the 'More' menu at the top of
your screen and choosing 'Serials' or by clicking 'Serials' on the main Koha
staff client page. The Serials module in Koha is used for keeping track
of journals, newspapers and other items that come on a regular schedule.
As with all modules, make sure you go through the related
:ref:`implementation checklist <serials-configuration-label>` before using the Serials
module.

-  *Get there:* More > Serials

.. _manage-serial-frequencies-label:

Manage serial frequencies
-------------------------------------------

Koha keeps a record of publication frequencies for easy management and
duplication.

-  *Get there:* More > Serials > Manage frequencies

From this page you can view all of the existing frequencies in your
system

|image738|

and create new ones.

|image739|

.. _manage-serial-numbering-patterns-label:

Manage serial numbering patterns
------------------------------------------------------

Everytime you create a new numbering pattern in serials you can save it
for later use. These patters are accessible via the 'Manage numbering
patterns' page.

-  *Get there:* More > Serials > Manage numbering patterns

This page will list for you the numbering patterns you have saved in the
past as well as a few canned patterns.

|image740|

    **Note**

    If you have upgraded from a previous version of Koha you will see
    'Backup patterns' listed for patterns used in version before Koha
    3.14. This is how Koha saved your old numbering patterns. You can
    edit these to give them more meaningful names from here.

It will also allow you to create a new numbering pattern without first
adding a subscription. To add new new pattern click 'New numbering
pattern' at the top of the list of patterns.

|image741|

.. _custom-subscription-fields-label:

Custom subscription fields
----------------------------------------------

This module will allow you to add custom fields to your serial
subscriptions for reporting and searching.

-  *Get there:* Serials > Add subscription fields

To add custom fields simply click the 'Add subscription fields' link on
the left of the Serial page and choose the 'New fields' button

|image1271|

The form that appears will ask for either an authorized value or a MARC
field to populate the field with

-  Name: enter the name of the field
   
-  Authorized value category: you can use :ref:`authorized values <authorized-values-label>` 
   to fill in this field. 

-  MARC field: enter a MARC field that will be used to fill in this new 
   field

      **Note**

      You can only choose one of the two options.

      If you choose the authorized value option, you will be able to 
      fill in the new field upon the :ref:`creation <add-a-subscription-label>` 
      or :ref:`modification <edit-subscription-label>` of the subscription.

      If you choose the MARC option, the field will be automatically 
      populated with the corresponding record's value for this MARC 
      field.

      **Important**

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

      For example: 515$a

-  Searchable: check this box if you want to be able to search your 
   subscriptions using this field

|image1272|

**Example 1:** Additional field using :ref:`authorized values <authorized-values-label>`

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
   
|image1273|

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

|image1274|

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

|image1275|

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

|image1276|

**Example 2:** Additional 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'
  
|image1379|

      **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 :ref:`cataloging module <cataloging-label>`.

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

|image1380|

.. _add-a-subscription-label:

Add a subscription
-----------------------------------------

Subscriptions can be added by clicking the 'New' button on any
bibliographic record

|image742|

Or by visiting the Serials module and clicking 'New subscription'

|image743|

If you are entering a new subscription from the Serials module you will
be presented with a blank form (if creating new from a bibliographic
record the form will include the bib info).

|image744|

-  'Librarian' field will show the logged in librarian's username

-  'Vendor' can be found by either searching vendors entered via the
   `Acquisitions module <#acqmodule>`__ or entering the vendor ID number

   -  Vendor information is not required

   -  In order to claim missing and late issues you need to enter vendor
      information

      |image745|

-  'Biblio' is the MARC record you'd like to link this subscription to

   -  This can be done by searching for an existing record by clicking
      on the 'Search for record' link below the boxes or by entering the
      biblionumber for a record in the first box. Only if you search will
      the field between the parenthesis be filled in.

-  Next you can choose whether a new item is created when receiving an
   issue (if you barcode issues you'll want to create an item at this
   time)

-  In order to determine how to handle irregularities in your
   subscription answer 'When there is an irregular issue', if the
   numbers are always sequential you'll want to pick 'Keep issue number'

-  Checking the 'Manual history' box will allow you to enter serials
   outside the prediction pattern once the subscription is saved by
   going to the 'Planning' tab on the subscription detail page.

   |image1277|

-  'Call number' is for your item's call number or call number prefix

-  'Library' is the branch that owns this subscription.

   -  If more than one library subscribes to this serial you will need
      to create a subscription for each library

   -  This can be done easily by using the 'Edit as new (duplicate)'
      option found on the subscription information page and changing
      only the 'Library' field

      |image746|

-  Use the 'Public note' for any notes you would like to appear in the
   OPAC for the patrons

-  'Nonpublic note' should be used for notes that are only visible to
   the librarians via the staff client

-  The 'Patron notification' option lets you pick a notice to send to
   patrons who subscribe to updates on this serial via the OPAC.

   -  For this option to appear you need to make sure that you have a
      Routing list notice set up in the :ref:`Notices Tool <notices-&-slips-label>`

-  'Location' is for the shelving location

-  The 'Grace period' is the number of days before an issue is
   automatically moved from 'Expected' status to 'Late'.
   This mechanism requires that the :ref:`SerialsUpdate.pl cron job
   <serials-update-label>` is set up to run regularly.

-  The Staff and OPAC display options allow you to control how many
   issues appear by default on bibliographic records in the Staff Client
   and the OPAC

   -  If no values are entered in these fields, they will use the
      :ref:`OPACSerialIssueDisplayCount` and
      :ref:`StaffSerialIssueDisplayCount`
      system preference values

Once that data is filled in you can click 'Next' to enter the prediction
pattern information.

|image747|

-  In 'First issue publication date' you want to enter the date of the
   issue you have in your hand, the date from which the prediction
   pattern will start

-  There are several pre-defined options for the 'Frequency' of
   publication all of which are visible alongside your own custom
   frequencies by visiting ':ref:`Manage frequencies <manage-serial-frequencies-label>`'

   -  Without periodicy: some very specific (usually high level science
      journals) don't have a true periodicity. When you subscribe to the
      title, you subscribe for 6 issues, which can arrive in 1 year...
      or 2... There is no regularity or known schedule.

   -  Unknown select this if none of the other choices are relevant

   -  Irregular: The journal is not "regular" but has a periodicity. You
      know that it comes out on January, then in October and December,
      it is irregular, but you know when it's going to arrive.

   -  2/day: Twice daily

   -  1/day: Daily

   -  3/week: Three times a week

   -  1/week: Weekly

   -  1/ 2 weeks: Twice monthly (fortnightly)

   -  1/ 3 weeks: Tri-weekly

   -  1/month: Monthly

   -  1/ 2 months (6/year): Bi-monthly

   -  1/ 3 months (1/quarter): Quarterly

   -  1/quarter (seasonal) : Quarterly related to seasons (ie. Summer,
      Autumn, Winter, Spring)

   -  2/year: Half yearly

   -  1/year: Annual

   -  1/ 2 years: Bi-annual

-  'Subscription length' is the number of issues or months in the
   subscription. This is also used for setting up renewal alerts

-  'Subscription start date' is the date at which the subscription
   begins. This is used for setting up renewal alerts

-  'Subscription end date' should only be entered for subscriptions that
   have ended (if you're entering in a backlog of serials)

-  'Numbering pattern' will help you determine how the numbers are
   printed for each issue. Patterns entered here are saved and editable
   at any time by visiting ':ref:`Manage numbering
   patterns <manage-serial-numbering-patterns-label>`'

   -  Start with the numbering on the issue you have in hand, the
      numbering that matches the date you entered in the 'First issue
      publication' field

   -  You can choose to create your own numbering pattern by choosing
      'None of the above' and clicking the 'Show/hide advanced pattern'
      button at the bottom of the form

      |image748|

-  The 'Locale' option is useful when you want to display days, month or
   season. For example, if you have a German serial, you can use the
   German locale option to display days, etc. in German.

-  Once a 'Numbering pattern' is chosen the number formula will
   appear.

   |image1278|

   -  The 'Begins with' number is the number of the issue you're holding
      in your hand.

   -  The 'Inner counter' is used to tell Koha where the "receiving
      cycle" starts

      -  For example: If the first issue to receive is "vol. 4, no. 1,
         iss. 796", you need to set up "inner counter = 0" But if it's
         "vol. 4, no. 2, iss. 797", the inner counter should be "1".

   -  After filling in this data click the 'Test prediction pattern'
      button to see what issues the system will generate, if there are
      irregularities you can choose which issues don't exist from the
      list presented.

      |image749|

-  If you have added a :ref:`custom subscription field <custom-subscription-fields-label>`, it
   will be editable above the buttons at the bottom of the screen

   |image1274|

Click 'Save subscription' to save the information you have entered.
`Find sample serial examples in the serial pattern library on the wiki <https://wiki.koha-community.org/wiki/Serial_Pattern_Library>`__.

.. _edit-subscription-label:

Edit a subscription
-----------------------------------

To edit a subscription, click on 'Edit' and 'Edit subscription' from the 
subscription page. This will take you back to the same form as the one 
used when :ref:`creating a new subscription <add-a-subscription-label>`.

|image1376|

You can also batch edit subscriptions. To do so, search for the subscriptions 
you want to change. In the results, check the boxes next to the subscriptions 
to edit. The link 'Edit selected serials' will appear.

|image1377|

From there, you can change: 

-  the vendor
   
-  the shelving location
   
-  the library
   
-  the item type
   
-  the public note
   
-  the nonpublic note
   
-  whether or not to create an item when receiving an issue
   
-  the expiration date

|image1378|

      **Note**

      Leave the field unchanged to keep the original values.


.. _receive-issues-label:

Receive issues
-----------------------------------

Issues can be marked as received from several locations. To find a
subscription, use the search box at the top of the Serials page to
search for the serial you'd like to receive issues for:

|image750|

From the search results you can click the 'Serial receive' link or you
can click on the subscription title and then click the 'Receive' button.

|image751|

The final way to receive serials is from the 'Serial collection' page.
To the left of the Subscription summary page there is a menu with a link
to 'Serial collection'

|image752|

From the page that opens up you can click 'Edit serial' with the issue
you want to receive checked.

|image753|

All three of these options will open up the issue receive form:

|image754|

-  Choose 'Arrived' from the status pull down to mark a serial as
   received.

-  If you have decided to have an item record created for each issue an
   :ref:`item add form <adding-items-label>` will appear after choosing 'Arrived'

   |image755|

-  If your issue has a supplemental issue with it, fill in the
   Supplemental issue information.

   -  Key the entire numbering in the box after "Supplemental issue" no
      numbering will be inherited/auto-filled from the main issue, and
      exactly what you key in the box after "Supplemental issue" will be
      auto-filled in the item record's Serial enumeration/chronology
      [MARC21 952$h] (if you create item records).

      -  E.g., key this in its entirety if it's what you would like
         displayed: "v.69 no.3 (Mar. 2015) suppl."

-  If you have decided to have an item record created for each issue an
   :ref:`item add form <adding-items-label>` will appear for your supplement and
   for the issue itself

-  Once you have entered your info you can click 'Save'

If you are receiving multiple issues at once, or have marked an issue as
'Late' or 'Missing' there you can click the 'Generate next' button below
the list of issues.

|image756|

Clicking this button will generate the next issue for you and mark the
previously expected issue as 'Late' automatically. You can then check
the 'Edit' box to the right of each issue and edit the status on
multiple issues at once.

.. _create-a-routing-list-label:

Create a routing list
----------------------------------------

A routing list is a list of people who receive the serial before it goes
to the shelf. To enable routing lists you want to set your
:ref:`RoutingSerials` preference to 'Add'.

When on the subscription page you will see a link to the left that reads
'Create routing list' or 'Edit routing list'

|image757|

Clicking that link will bring you to the menu to add a new routing list.

|image758|

From here you want to click 'Add recipients' in order to add people to
the routing list. In the menu that appears you can filter patrons by
part of their name, their library and/or patron category.

|image759|

Clicking 'Add' to the right of each name will add them to the routing
list. When you have chosen all of the people for the list, click the
'Close' link to be redirected to the routing list.

|image760|

If the list looks the way you expect it to, then click 'Save'. Next you
will be brought to a preview of the routing list. To print the list
click 'Save and preview routing slip.' This will open a printable
version of the list.

|image761|

If :ref:`RoutingListAddReserves` is set to on
then patrons listed in the routing list will automatically be added to
the holds list for the issue.

To see a list of all of the routing lists a specific patron is on visit
the :ref:`Routing lists tab <routing-lists-label>` on their patron record.

.. _subscriptions-in-staff-client-label:

Subscriptions in staff client
-----------------------------------------------------

Subscription information will appear on bibliographic records under the
'Subscriptions' tab

|image762|

Clicking the 'Subscription details' link will take you to the
Subscription summary page in the staff client.

|image763|

If you are using the `Acquisitions <#acqmodule>`__ module to keep `track
of serial subscriptions <#ordersubscription>`__ you will see that info
before your subscription details.

|image764|

.. _subscriptions-in-opac-label:

Subscriptions in OPAC
--------------------------------------------

When viewing the subscription in the OPAC there will be several options.

Like in the staff client, there will be a Subscriptions tab on the
bibliographic record.

|image765|

Under this tab will appear the number of issues you chose when setting
up the subscription or in your
:ref:`OPACSerialIssueDisplayCount` system
preference. Clicking the 'More details' link will provide you with
additional information about the serial history. You can set the default
view of a serial in the OPAC with the
:ref:`SubscriptionHistory` system preference.

There are two views, compact and full. The compact serial subscription
will show basic information regarding the subscription

|image766|

From this compact display patrons can subscribe to be notified of new
issues as they are released by clicking the 'Subscribe to email
notifications of new issues' button. For this link to appear you will
want to have chosen to notify patrons :ref:`on the
subscription <add-a-subscription-label>` itself.

|image767|

You can see those who subscribe to new issue alerts by going to the
subscription page in the staff client and looking on the right of the
'Information' tab.

|image1279|

Whereas the full view shows extensive details, broken out by year,
regarding the subscription

|image768|

.. _claim-late-serials-label:

Claim late serials
--------------------------------------

Koha can send email messages to your serial vendors if you have late
issues. To the left of the main serials page there is a link to 'Claims'

|image769|

The links to claims also appears to the left of the subscription detail
page

|image770|

If you don't have a claim notice defined yet you will see a warning
message that you need to first define a notice.

|image771|

Clicking 'Claims' will open a report that will ask you to choose from
your various serial vendors to generate claims for late issues.

|image772|

From the list of late issues you can choose which ones you want to send
a claim email to by clicking the checkbox to the left of late issue,
choosing the notice template to use and clicking the 'Send notification'
button.

.. _check-serial-expiration-label:

Check serial expiration
-----------------------------------------------

When adding serials you enter a subscription length, using the check
expiration tool you can see when your subscriptions are about to expire.
To use the tool click the link to 'Check expiration' on the serials
menu.

|image773|

In the form that appears you need to enter at least a date to search by.

In your results you will see all subscriptions that will expire before
the date you entered. From there you can choose to view the subscription
further or renew it in one click.

|image774|

If there is more than one subscription, you can check the boxes and 
click on 'Renew selected subscriptions' to renew all the serials. 
The serials will be renewed for the same amount of time as their previous 
subscription (i.e. if the last subscription for that serial lasted one 
year, the serial will be renewed for one year; if the last subscription 
was for 16 issues, it will be renewed for another 16 issues).

|image1356|

.. _renewing-serials-label:

Renewing serials
-----------------------------------

If your serial subscription has expired you won't be able to receive
issues. To renew your subscription you can click the 'Renew' button at
the top of your subscription detail page.

|image775|

Another option is to click the 'Renew' link to the right of the
subscription on the Serial collection page.

|image776|

Once you click the 'Renew' link or button you will be presented with
renewal options.

|image777|

-  The start date should be the date your subscription period starts.

-  For the subscription length you'll want to fill in one of the three
   fields presented: Number of issues, Number of months or Number
   of weeks.

-  Finally enter any notes you might have about this renewal.

.. _searching-serials-label:

Searching serials
-------------------------------------

Once in the Serials module there is basic search box at the top that you
can use to find subscriptions using any part of the ISSN and/or title.

|image778|

You can also click the 'Advanced search' link to the right of the
'Submit' button to do a more thorough search of your serials.

|image779|

From your results you can filter by using the search boxes at the bottom
of each column and adjust the number of results using the toolbar at the
top of the results set.

|image780|