tools.rst 104 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
.. include:: images.rst

Tools
=====

Tools in Koha all perform some sort of action. Often many of the items
listed under Tools in Koha are referred to as 'Reports' in other library
management systems.

-  *Get there:* More > Tools

joubu's avatar
joubu committed
12 13 14
.. _patrons-and-circulation-label:

Patrons and Circulation
15 16
------------------------------------------

joubu's avatar
joubu committed
17 18 19
.. _patron-lists-label:

Patron lists
20 21
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

22
-  *Get there:* More > Tools > Patrons and circulation > Patron lists
23 24

Patron lists are a way to store a group of patrons for easy modification
joubu's avatar
joubu committed
25
via the :ref:`batch patron modification tool <batch-patron-modification-label>` or
26 27 28 29 30 31 32 33 34 35 36 37
reporting.

|image245|

To create a new list of patrons click the 'New patron list' button

|image246|

Enter a list name and save the list.

|image247|

joubu's avatar
joubu committed
38 39 40
Each list has an 'Actions' menu with more list options.

|image1218|
41 42 43 44 45 46 47 48 49

To add patrons to the list click the 'Add patrons' link in the 'Actions'
menu.

|image248|

Enter the patron's name or cardnumber in the search box and click on the
right result to add the patron.

50 51 52
Alternatively, you can click on the 'Enter multiple card numbers' link and 
scan (or type in) barcodes in the box.

53 54 55 56 57 58 59
|image249|

Once you have all of the patrons you would like to add you can click the
'Add patrons' button to save them to the list.

|image250|

Jessica Zairo's avatar
Jessica Zairo committed
60 61 62 63 64 65 66 67 68 69 70
.. _Patron-clubs-label:

Patron clubs
~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Patron clubs

Patron clubs create clubs which patrons may be enrolled in. It is
useful for tracking summer reading programs, book clubs and other such clubs.

    **Important**
71
    Staff will need permission to edit clubs, templates and enroll patrons. Go
Jessica Zairo's avatar
Jessica Zairo committed
72
    to your staff members account tab and click on the More drop down menu.
73 74
    Select Set Permissions and make sure patron clubs have checkmarks next to
    each of the functions you want your staff to have. Remember if your staff
Jessica Zairo's avatar
Jessica Zairo committed
75
    is a superlibrarian, they will have the permission.
76

Jessica Zairo's avatar
Jessica Zairo committed
77
Creating a new club template
78 79
Here you can add fields that can be filled out at the time a new club is
created based on the template, or a new enrollment is created for a given club
Jessica Zairo's avatar
Jessica Zairo committed
80 81
based on the template. Click on the New Club template button

82 83
Name is required. This could be something like Adult Book Club, Children’s
Book Club or Summer Reading Program. Remember these templates will be starting
Jessica Zairo's avatar
Jessica Zairo committed
84 85 86 87
point for each club you create.

Description can be any additional information

88
Allow Public Enrollment: if this box is checked it will allow patrons to enroll
Jessica Zairo's avatar
Jessica Zairo committed
89 90
in a club based on this template from the OPAC

91 92
Require valid email address: if this box is checked only patrons with a patrons
with a valid email address can enroll. So they will need a email address
Jessica Zairo's avatar
Jessica Zairo committed
93 94
to enroll.

95
The library drop down gives you the flexibility to enroll patrons from specific
Jessica Zairo's avatar
Jessica Zairo committed
96 97
branches. If you let it set to blank, all branches will be able to enroll.

98
Club Fields: these fields will be used when creating a club based on this
Jessica Zairo's avatar
Jessica Zairo committed
99
template you can connect authorized values here
100
Enrollment Fields: you can add any additional fields you want to have filled
Jessica Zairo's avatar
Jessica Zairo committed
101 102 103 104 105 106
out by your patrons like you can connect authorized values here.

Creating a new club based on a template
Here you can add information about a new club using a template you created.
Click on the New Club dropdown menu and select the template you want to use.

107 108
Name is required, this will be the name of the specific club using the
template you created. For example, if I used my Kids Club template, I can
Jessica Zairo's avatar
Jessica Zairo committed
109 110 111 112
create Kids Club 2017

Description – any additional information

113 114
Start  and End date will depict when this club runs, the entire duration
of the club. Once the club expires, it will be removed from the OPAC for users
Jessica Zairo's avatar
Jessica Zairo committed
115 116
to enroll if that option is selected.

117
The library drop down gives you the flexibility to enroll patrons from specific
Jessica Zairo's avatar
Jessica Zairo committed
118 119 120 121 122 123 124 125 126
branches. If you let it set to blank, all branches will be able to enroll.

Enrolling a patron in a club
    pull up a patron account
    click on the checkout tab on the left hand side
    click on the tab for club
    add the patron to the selected club by selecting the enroll button
    you can also cancel enrollment by clicking on the cancel enrollment

joubu's avatar
joubu committed
127 128 129
.. _comments-label:

Comments
130 131 132 133 134 135 136 137 138 139 140
~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Comments

All comments added by patrons via the OPAC to bibliographic records
require moderation by the librarians. If there are comments awaiting
moderation they will be listed on the main page of the staff client
below the module list:

|image251|

joubu's avatar
joubu committed
141 142 143
and next to the Comments tool on the Tools Module

|image1219|
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

To moderate comments click on the notification on the main dashboard or
go directly to the Comments Tool and click 'Approve' or 'Delete' to the
right of the comments awaiting moderation.

|image252|

If there are no comments to moderate you will see a message saying just
that

|image253|

You can also review and unapprove comments you have approved in the past
by choosing the 'Approved comments' tab

|image254|

joubu's avatar
joubu committed
161 162 163
.. _patron-import-label:

Patron Import
164 165 166 167 168 169 170 171
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Import Patrons

The patron import tool can be used at any time to add patrons in bulk.
It is commonly used in universities and schools when a new batch of
students registers.

joubu's avatar
joubu committed
172 173 174
.. _creating-patron-file-label:

Creating Patron File
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Your Koha installation comes with a blank CSV file that you can use as a
template for your patron records. If you would like to create the file
yourself, make sure that your file has the following fields in this
order as the header row:

cardnumber, surname, firstname, title, othernames, initials,
streetnumber, streettype, address, address2, city, state, zipcode,
country, email, phone, mobile, fax, emailpro, phonepro, B\_streetnumber,
B\_streettype, B\_address, B\_address2, B\_city, B\_state, B\_zipcode,
B\_country, B\_email, B\_phone, dateofbirth, branchcode, categorycode,
dateenrolled, dateexpiry, gonenoaddress, lost, debarred,
debarredcomment, contactname, contactfirstname, contacttitle,
guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
password, flags, userid, opacnote, contactnote, sort1, sort2,
altcontactfirstname, altcontactsurname, altcontactaddress1,
altcontactaddress2, altcontactaddress3, altcontactstate,
altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber,
privacy, patron\_attributes

    **Important**

    The 'password' should be stored in plaintext, and will be converted
    to a Bcrypt hash.

    If your passwords are already encrypted, talk to your systems
    administrator about options

    **Important**

joubu's avatar
joubu committed
206
    Date formats should match your :ref:`system preference <dateformat-label>`,
207 208 209 210 211
    and must be zero-padded, e.g. '01/02/2008'.

    **Important**

    The fields 'branchcode', 'categorycode' and all fields you have
joubu's avatar
joubu committed
212
    defined in the :ref:`BorrowerMandatoryField`
213 214 215 216 217
    preference are required and must match valid entries in your
    database.

    **Note**

joubu's avatar
joubu committed
218
    If loading :ref:`patron attributes <patron-attribute-types-label>`, the
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    'patron\_attributes' field should contain a comma-separated list of
    attribute types and values.

    -  The attribute type code and a colon should precede each value.

       -  For example: "INSTID:12345,BASEBALL:Cubs"

       -  This field must be wrapped in quotes if multiple values are
          defined.

       -  Since values can contain spaces, additional doubled-quotes may
          be required:

          -  "INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""

       -  When replacing a patron record, any attributes specified in
          the input file replace all of the attribute values of any type
          that were previously assigned to the patron record.

joubu's avatar
joubu committed
238 239 240
.. _importing-patrons-label:

Importing Patrons
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Once you have created your file, you can use the Patron Import Tool to
bring the data into Koha.

-  Choose your CSV file

   |image255|

-  Choose to match on 'Cardnumber' or 'Username' to prevent adding of
   duplicate card numbers to the system

   |image256|

-  Next you can choose default values to apply to all patrons you are
   importing

   -  ex. If you're importing patrons specific to one branch you can use
      the field on the Import form to apply the branch code to all those
      you are importing.

-  Finally you need to decide on what data you want to replace if there
   are duplicates.

   |image257|

   -  A matching record is found using the field you chose for matching
      criteria to prevent duplication

   -  If you included patron attributes in your file you can decide
      whether to add your values to existing values or erase existing
      values and enter only your new values.

joubu's avatar
joubu committed
274 275 276
.. _notices-&-slips-label:

Notices & Slips
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Notices & Slips

All notices and circulation receipts (or slips) generated by Koha can be
customized using the Notices & Slips Tool. The system comes with several
predefined templates that will appear when you first visit this tool.

|image258|

Each notice can be edited, but only a few can be deleted, this is to
prevent system errors should a message try to send without a template.
Each notice and slip can be edited on a per library basis, by default
you will see the notices for all libraries.

If you have a style you'd like applied to all slips you can point the
joubu's avatar
joubu committed
293 294
:ref:`SlipCSS` preference to a stylesheet. The same is true for
notices, using the :ref:`NoticeCSS` preference to define a
295 296
stylesheet.

297 298 299
You will also want to review the `Customising Notices and Slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
wiki page for more information on formatting these notices.
300

joubu's avatar
joubu committed
301 302 303
.. _adding-notices-&-slips-label:

Adding Notices & Slips
304 305 306 307 308 309 310 311 312 313 314 315 316
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To add a new notice or slip

-  Click 'New Notice'

   |image259|

-  Choose which library this notice or slip is for

   -  **Important**

          Not all notices can be branch specific for more information
317 318
          review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
          wiki page.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335

-  Choose the module this notice is related to

-  The Code is limited to 20 characters

   -  **Important**

          When working with the overdue notices you want each notice at
          each branch to have a unique code. Think about using the
          branch code in front of the notice code for each branch.

-  Use the name field to expand on your Code

   -  **Note**

          With overdue notices, be sure to put your branch name in the
          description as well so that it will be visible when setting up
joubu's avatar
joubu committed
336
          your :ref:`triggers <overdue-notice/status-triggers-label>`.
337 338 339

-  Next you can customize the notice for every possible delivery method

joubu's avatar
joubu committed
340 341 342
   -  Every notice should have an Email template set for it

      |image1220|
343 344

   -  If you're using the
joubu's avatar
joubu committed
345
      :ref:`TalkingTechItivaPhoneNotification`
joubu's avatar
joubu committed
346 347 348
      service you can set up a Phone notification

      |image1221|
349 350

   -  If you plan on printing this notice you can set the Print template
joubu's avatar
joubu committed
351 352 353
      next

      |image1222|
354 355

   -  If you have enabled SMS notices with the
joubu's avatar
joubu committed
356
      :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference you can set the text
joubu's avatar
joubu committed
357 358 359
      for your SMS notices next

      |image1223|
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375

-  Each notice offers you the same options

   -  If you plan on writing the notice or slip in HTML check the 'HTML
      Message' box, otherwise the content will be generated as plain
      text

   -  Message Subject is what will appear in the subject line of the
      email

   -  In the message body feel free to type whatever message you feel is
      best, use the fields on the left hand side to enter individualized
      data from the from database.

      -  **Note**

376 377
             Review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
             wiki page for more information.
378 379 380 381 382

      -  **Important**

             Overdue notices can use <<items.content>> tags by
             themselves, or use <item></item> to span all of the tags.
joubu's avatar
joubu committed
383 384
             Learn more about the :ref:`Overdue Notice
             Markup <overdue-notice-markup-label>`
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

             -  On overdue notices make sure to use <<items.content>>
                tags to print out the data related to all items that are
                overdue.

             -  The other option, only for overdue notices, is to use
                the <item></item> tags to span the line so that it will
                print out multiple lines One example for the
                <item></item> tag option is:

                <item>"<<biblio.title>>" by <<biblio.author>>,
                <<items.itemcallnumber>>, Barcode: <<items.barcode>> ,
                Checkout date: <<issues.issuedate>>, Due date:
                <<issues.date\_due>> Fine: <<items.fine>> Due date:
                <<issues.date\_due>> </item>

      -  **Important**

             Only the overdue notices take advantage of the
             <item></item> tags, all other notices referencing items
             need to use <<items.content>>

      -  **Note**

             To add today's date you can use the <<today>> syntax

      -  **Note**

             If you don't want to print the patron's full name on your
             slips or notice you can enter data in the Other name or
             Initials field for each patron and use that value instead.

joubu's avatar
joubu committed
417 418 419
.. _overdue-notice-markup-label:

Overdue Notice Markup
420 421 422 423
'''''''''''''''''''''''''''''''''''''''''

When creating your overdue notices there are two tags in addition to the
various database fields that you can use in your notices. You will also
424 425 426
want to review the `Customising Notices and Slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
wiki page for information on formatting item information in these notices.
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

    **Important**

    These new tags only work on the overdue notices, not other
    circulation related notices at this time.

These tags are <item> and </item> which should enclose all fields from
the biblio, biblioitems, and items tables.

An example of using these tags in a notice template might be like:

::

       The following item(s) is/are currently overdue:

       <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item>

Which, assuming two items were overdue, would result in a notice like:

::

       The following item(s) is/are currently overdue:

       "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
       "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50

joubu's avatar
joubu committed
453 454 455
.. _existing-notices-&-slips-label:

Existing Notices & Slips
456 457 458 459 460
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Among the default notices are notices for several common actions within
Koha. All of these notices can be customized by altering their text via
the Notices & Slips tool and their style using the
joubu's avatar
joubu committed
461
:ref:`NoticeCSS` preference to define a stylesheet. You will
462 463 464
also want to review the `Customising Notices and Slips
<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
wiki page for information on formatting item
465 466
information in these notices. Here are some of what those notices do:

467 468 469 470 471 472
-  ACCEPTED

   -  This notice is sent when a patron's suggestion is accepted.

   -  *Note:* If you don't want to send this notice, just delete it.

473 474 475
-  ACCTDETAILS

   -  Sent to patrons when their account is set up if the
joubu's avatar
joubu committed
476
      :ref:`AutoEmailOPACUser <autoemailopacuser-label>` preference is set to
477 478
      'Send'

479 480 481 482 483
   -  *Important:* The notice will only be sent correctly if a username,
      password and email address is added to the patron record before
      saving it for the first time.
      The notice can't be resend or triggered again after the patron account
      has been created.
484

485
-  ACQCLAIM (Acquisition claim)
486

487
   -  Used for claiming orders in the aquisitions module
488

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
   -  ACQCLAIM is the code of the sample notice, but it's possible to define
      several notices choosing any code. Only the module 'Claim
      aquisition' will be taken into account. All notices with this module
      will appear in the pull down on the late orders page.

   -  *Get there:* More > Acquisitions > Late orders

   -  This notice is sent if several criteria are met:

      #. The staff patron triggering the email has a valid email address.

      #. The vendor contact marked as 'Contact about late orders?' has 
         a valid email address.

-  ACQORDER (Acquisition order)

   -  Used in the acquisitions module to send order information to the vendor

   -  The notice is triggered manually from the basket summary page using
      the 'Email order' button in the toolbar.

   -  This notice is sent if several criteria are met:

      #. The staff patron triggering the email has a valid email address.

      #. The vendor contact marked as 'Primary acquisitions contact' and
         'Contact when ordering' has a valid email address.
516

517 518 519 520 521
-  ACQ_NOTIF_ON_REVEIV

   -  Used in the acquisition module to inform patrons on receiving orders
      they have been added to. 

522 523 524
-  AR\_CANCELLED

   -  This notice is sent to the patron when an article request is cancelled
525
      by staff.
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541

-  AR\_COMPLETED

   -  This notice is sent to the patron when an article request is marked
      as completed by staff.

-  AR\_PENDING

   -  This notice is sent to the patron when an article request has been
      made in order to confirm the request.

-  AR\_PROCESSING

   -  This notice is sent to the patron when an article request is marked
      as being processed by staff.

542 543 544 545 546 547 548
-  AVAILABLE

   -  This notice is sent to the patron who made a suggestion, when the
      order created from the suggestion is received.

   -  *Note:* If you don't want to send this notice, just delete it.

549 550 551 552 553 554 555 556
-  CHECKIN

   -  This notice is sent as the 'Check in' notice for all items that
      are checked in

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
557
         :ref:`EnhancedMessagingPreferences`
558 559 560 561 562 563 564
         is set to 'Allow'

      2. The patron has requested to receive this notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
565
            :ref:`Notices`
566 567 568 569 570 571 572 573 574

-  CHECKOUT

   -  This notice is sent as the 'Check out' notice for all items that
      are checked out

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
575
         :ref:`EnhancedMessagingPreferences`
576 577 578 579 580 581 582
         is set to 'Allow'

      2. The patron has requested to receive this notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
583
            :ref:`Notices`
584 585 586 587 588 589 590 591

-  DUE

   -  This notice is sent as the 'Item due' for an item is due

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
592
         :ref:`EnhancedMessagingPreferences`
593 594 595 596 597 598 599
         is set to 'Allow'

      2. The patron has requested to receive this notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
600
            :ref:`Notices`
601 602 603 604 605 606 607 608

-  DUEDGST

   -  This notice is sent as the 'Item due' for all items that are due

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
609
         :ref:`EnhancedMessagingPreferences`
610 611 612 613 614 615 616
         is set to 'Allow'

      2. The patron has requested to receive this notice as a digest

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
617
            :ref:`Notices`
618 619 620 621 622 623

-  HOLD (Hold Available for Pickup)

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
624
         :ref:`EnhancedMessagingPreferences`
625 626 627 628 629 630 631
         is set to 'Allow'

      2. The patron has requested to receive this notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
632
            :ref:`Notices`
633 634 635 636 637 638 639 640

   -  When this notice references the branches table it is referring to
      the pickup branch information.

-  HOLDPLACED (a notice to the library staff that a hold has been
   placed)

   -  This notice requires the
joubu's avatar
joubu committed
641
      :ref:`emailLibrarianWhenHoldIsPlaced`
642 643 644 645 646 647 648 649 650 651 652
      system preference to be set to 'Enable'

   -  When this notice references the branches table it is referring to
      the pickup branch information.

-  MEMBERSHIP\_EXPIRY

   -  This notice can be sent to patrons to warn them that their cards
      are expiring soon.

   -  Requires that you have the
joubu's avatar
joubu committed
653 654
      :ref:`MembershipExpiryDaysNotice` set
      and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
655 656 657 658 659 660 661

-  ODUE (Overdue Notice)

   -  This notice is used to send Overdue Notices to Patrons

   -  See a `Sample Overdue Notice <#samplenotice>`__

joubu's avatar
joubu committed
662 663
   -  Requires that you set :ref:`Overdue Notice/Status
      Triggers <overdue-notice/status-triggers-label>`
664

665 666 667 668 669 670 671
-  ORDERED

   -  This notice is sent to the patron who made a suggestion, when the
      'from a suggestion' option is used to create an order from it.

   -  Note: If you don't want to send this notice, just delete it.

672 673 674 675 676 677 678
-  PREDUE

   -  This notice is sent as the 'Advanced notice' for an item is due

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
679
         :ref:`EnhancedMessagingPreferences`
680 681 682 683 684 685 686
         is set to 'Allow'

      2. The patron has requested to receive this notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
687
            :ref:`Notices`
688 689 690 691 692 693 694 695 696

-  PREDUEDGST

   -  This notice is sent as the 'Advanced notice' for all items that
      are due

   -  This notice is used if two criteria are met:

      1. The
joubu's avatar
joubu committed
697
         :ref:`EnhancedMessagingPreferences`
698 699 700 701 702 703 704
         is set to 'Allow'

      2. The patron has requested to receive this notice as a digest

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
705
            :ref:`Notices`
706

707 708 709 710 711 712
-  REJECTED

   -  This notice is sent when a patron's suggestion is rejected.

   -  Note: If you don't want to send this notice, just delete it.

713 714 715 716 717 718 719 720
-  RENEWAL

   -  This notice is sent as the 'Check out' notice for all items that
      are renewed

   -  This notice is used if three criteria are met:

      1. The
joubu's avatar
joubu committed
721
         :ref:`EnhancedMessagingPreferences`
722 723
         is set to 'Allow'

joubu's avatar
joubu committed
724
      2. The :ref:`RenewalSendNotice` preference is
725 726 727 728 729 730 731
         set to 'Send'

      3. The patron has requested to receive the checkout notice

         -  *Get there:*\ OPAC > Login > my messaging

         -  *Get there:*\ Staff Client > Patron Record >
joubu's avatar
joubu committed
732
            :ref:`Notices`
733

734
-  SERIAL_ALERT (New serial issue)
735

736 737 738 739 740
   -  Notice used in the serials module to notify patrons/staff
      of new issues of a serial. SERIAL_ALERT (RLIST in older verisons)
      is provided as a sample notice, but the notice code can be chosen
      freely as only the module is taken into account. Multiple notices
      can also be managed.
741

joubu's avatar
joubu committed
742 743
      -  *Get there:* More > Serials > :ref:`New
         Subscription <add-a-subscription-label>`
744

745 746 747 748 749 750 751
   -  You have the option to select the notice used to inform the patron
      about a received serial issue for a subscription. Choose from the
      'Patron notification' drop down.

   -  If a notice has been selected for a subscription, patrons can
      subscribe to the email notification from the subscription tab
      in the detail view in the OPAC.
752 753 754 755 756 757 758 759 760 761 762 763 764

   -  **Note**

          Notice also that if you'd like to notify patrons of new serial
          issues, you can click on 'define a notice' which will take you
          to the 'Notices' tool

-  SHARE\_ACCEPT

   -  Used to notify a patron when another patron has accepted their
      shared list.

   -  Requires that you set
joubu's avatar
joubu committed
765
      :ref:`OpacAllowSharingPrivateLists`
766 767 768 769 770 771 772 773
      to 'Allow'

-  SHARE\_INVITE

   -  Used to notify a patron that another patron would like to share a
      list with them.

   -  Requires that you set
joubu's avatar
joubu committed
774
      :ref:`OpacAllowSharingPrivateLists`
775 776 777 778 779 780 781 782
      to 'Allow'

-  TO\_PROCESS

   -  Used to notify a staff member if a purchase suggestion has been
      moved to the fund they manage

   -  Requires the
joubu's avatar
joubu committed
783
      :ref:`notice\_unprocessed\_suggestions <email-suggestions-to-process-label>` cron job
784 785 786 787

There are also a set of predefined slips (or receipts) listed on this
page. All of these slips can be customized by altering their text via
the Notices & Slips tool and their style using the
joubu's avatar
joubu committed
788
:ref:`SlipCSS` preference to define a stylesheet. Here is what
789 790
those slips are used for:

791 792 793 794 795 796 797 798 799
-  AR\_SLIP

   -  Used to print a slip for an article request

   -  The slip or receipt can be printed manually when managing article
      requests from the staff interface.

   -  *Get there:* Circulation > Article requests > Actions > Print slip

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
-  ISSUEQSLIP

   -  Used to print the quick slip in circulation

   -  The quick slip only includes items that were checked out today

-  ISSUESLIP

   -  Used to print a full slip in circulation

   -  The slip or receipt will show items checked out today as well as
      items that are still checked out

-  HOLD\_SLIP

   -  Used to print a holds slip

817 818
   -  The holds slip is generated when a hold is confirmed and set to 
      waiting.
819

820 821 822 823 824 825
-  OVERDUE\_SLIP

   -  Used to print an overdues slip

   -  The overdues slip can be generated manually using the 'print' menu
      in the patron account in staff. It will show all items overdue.
826 827 828 829 830 831 832 833

-  TRANSFERSLIP

   -  Used to print a transfer slip

   -  The transfer slip is printed when you confirm a transfer from one
      branch to another in your system

joubu's avatar
joubu committed
834 835 836
.. _overdue-notice/status-triggers-label:

Overdue Notice/Status Triggers
837 838 839 840 841 842
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Overdue
   Notice/Status Triggers

In order to send the overdue notices that you defined using the
joubu's avatar
joubu committed
843
:ref:`Notices <notices-&-slips-label>` tool, you need to first set the triggers to have
844 845 846 847 848
these messages.

    **Important**

    In order to have overdue notices sent to your patrons, you need to
joubu's avatar
joubu committed
849
    :ref:`set that patron category <adding-a-patron-category-label>` to require overdue
850 851 852 853 854
    notices.

    **Important**

    Depending on the value of your
joubu's avatar
joubu committed
855
    :ref:`OverdueNoticeCalendar` preference the
856
    delay may or may not include days the library is closed based on the
joubu's avatar
joubu committed
857
    :ref:`holiday calendar <calendar-label>`.
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882

The Overdue Notice/Status Triggers tool gives the librarian the power to
send up to three notices to each patron type notifying them of overdue
items

|image260|

-  Delay is the number of days after an issue is due before an action is
   triggered.

   -  **Important**

          If you want Koha to trigger an action (send a letter or
          restrict member), a delay value is required.

-  To send additional notices, click on the tabs for 'Second' and
   'Third' notice

-  If you would like to prevent a patron from checking items out because
   of their overdue items, check the 'Restrict' box, this will put a
   notice on the patron's record at checkout informing the librarian
   that the patron cannot check out due to overdue items.

   -  If you choose to restrict a patron in this way you can also have
      Koha automatically remove that restriction with the
joubu's avatar
joubu committed
883
      :ref:`AutoRemoveOverduesRestrictions`
884 885 886
      preference.

-  Next you can choose the delivery method for the overdue notice. You
joubu's avatar
joubu committed
887 888 889
   can choose from Email, Phone (if you are using the :ref:`iTiva Talking
   Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
   (if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
890 891 892 893 894 895 896 897

   -  **Note**

          The Feed option is not yet a feature in Koha, it is there for
          future development.

-  See a `Sample Overdue Notice <#samplenotice>`__

joubu's avatar
joubu committed
898 899 900
.. _patron-card-creator-label:

Patron Card Creator
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patron Card Creator

The Patron Card Creator allow you to use layouts and templates which you
design to print your custom patron cards on your printer. Here are some
of the features of the Patron Card Creator module:

-  Customize patron card layouts with text retrieved from the Koha
   patron data

-  Design custom card templates for printed patron cards (to match the
   label sheets)

-  Build and manage batches of patron cards to print

-  Export (as PDF) single or multiple batches to print

-  Export (as PDF) single or multiple patron cards from within a batch

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
921
.. _patron-card-layouts-label:
joubu's avatar
joubu committed
922 923

Layouts
924 925 926 927 928 929 930 931 932 933 934 935
^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Patron Card Creator > Manage > Layouts

A layout defines the text and images that will be printed on to the card
and where it will appear.

    **Note**

    Up to three lines of text, the patron's number in barcode
    representation and up to two images can be printed on to the card.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
936
.. _patron-add-a-layout-label:
joubu's avatar
joubu committed
937 938

Add a Layout
939 940 941
'''''''''''''''''''''''''''''''''

If you have no layouts defined, you will add a new layout by clicking
joubu's avatar
joubu committed
942 943 944
the 'New' button and choosing 'Layout'.

|image1224|
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995

You may also choose to press 'Manage layout' on the left side. Here you
are offered a list of available layouts you can select for editing. But
at the top of the page there is still the 'New layout' button.

|image261|

-  The name you assign to the layout is for your benefit, name it
   something that will be easy to identify at a later date

-  The Units pull down is used to define what measurement scale you're
   going to be using for your layout.

   |image262|

   -  **Note**

          A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
          is 25.4 SI Millimeters

-  Next note if this layout is for the front or the back of the patron
   card

   -  **Note**

          You will need a layout for both the front and back of your
          card if you have 2-sided library cards, this option doesn't
          allow you to print two sided cards, just lets you track which
          side of the card you're designing.

-  You have the option of adding up to 3 lines of text to your card.
   Your text can be static text of your choosing and/or fields from the
   patron record. If you want to print fields from the patron record you
   want to put the field names in brackets like so - <firstname>

   -  **Note**

          A full list of field names can be found in the database schema
          at http://schema.koha-community.org

-  For each line of text, you can choose your font, font size and the
   location of the text on the card using the lower X and Y coordinates

-  In order to show the barcode and the patron card number you will need
   to check the 'Print Card Number as Barcode' option. This will turn
   the patron card number into a barcode. If you want the number to
   print in human readable format you will need to check the 'Print Card
   Number as Text Under Barcode' option.

-  Finally you can choose up to two images to print on the card.

joubu's avatar
joubu committed
996
   -  One can be the :ref:`patron image <upload-patron-images-label>` which you
997 998 999
      can resize to meet your needs.

   -  The other image can be something like a library logo or symbol
joubu's avatar
joubu committed
1000 1001
      that you uploaded using the ':ref:`Manage
      Images <manage-images-label>`' module of the Patron Card Creator
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
      Tool.

    **Important**

    It is the designers responsibility to define textlines, barcode and
    images such that overlap is avoided.

After saving, your layouts will appear on the 'Manage layouts' page.

|image263|

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1013
.. _patron-templates-label:
joubu's avatar
joubu committed
1014 1015

Templates
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Patron Card Creator > Manage > Card
   templates

A template describes the arrangement of labels on the label sheet/card
stock you are using. This might be Avery 5160 for address labels,
Gaylord 47-284 for spine labels or Avery 28371 for your patron cards,
just to give a couple of examples. All of the information you will need
for setting up a template may be on the packaging, and if not it can
usually be found on the vendor's website or can be measured from a
sample sheet.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1029
.. _patron-add-a-template-label:
joubu's avatar
joubu committed
1030 1031

Add a Template
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
'''''''''''''''''''''''''''''''''''''

To add a new template click on the 'New template' button at the top of
your page which brings you to the Edit template form immediately. You
may also choose to press 'Manage templates' on the left side. Here you
are offered a list of available templates you can select for editing.
But in the top of the page there is still the 'New template' button.

|image264|

Using the form that appears after pressing either 'Edit' or 'New
template'you can define the template for your sheet of labels or cards.

|image265|

-  Template ID is simply a system generated unique id

-  Template Code should be the name of this template to identify it on a
   list of templates

-  You can use the Template Description to add additional information
   about the template

-  The Units pull down is used to define what measurement scale you're
   going to be using for the template.

   |image266|

   -  **Note**

          A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
          is 25.4 SI Millimeters

-  The measurements (page height, page width, card width, card height)
   may be on the packaging, and if not it can usually be found on the
   vendor's website or can be measured from a sample sheet.

-  A profile is a set of "adjustments" applied to a given template just
   prior to printing which compensates for anomalies unique and peculiar
   to a given printer (to which the profile is assigned).

   -  Before defining a profile try printing some sample cards so that
      you can take measurements to define a profile to perform the right
      adjustments for your printer/template combination.

   -  After finding and documenting any anomalies in the printed
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1078
      document, then you can :ref:`create a profile <patron-add-a-profile-label>` and
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
      assign it to the template.

   -  **Important**

          Do not specify a profile unless needed, i.e. do not click to
          define a printer profile. It is not possible to remove a
          profile from a template but you can switch to another profile.

   -  **Note**

          If you are using different printers you may be required to
          define several templates that are identical only different
          profiles are specified.

After saving, your templates will appear on the 'Manage templates' page.

|image267|

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1097
.. _patron-profiles-label:
joubu's avatar
joubu committed
1098 1099

Profiles
1100 1101 1102 1103 1104
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Patron Card Creator > Manage > Profiles

A profile is a set of "adjustments" applied to a given
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1105
:ref:`template <patron-templates-label>` just prior to printing which compensates
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
for anomalies unique and peculiar to a given printer. This means if you
set a template up and then print a sample set of data and find that the
items are not all aligned the same on each card, you need to set up a
profile for each printer (or even different tray selections on the same
printer) to make up for the differences in printing styles, such as the
shifting of text to the left, right, top or bottom.

If your cards are printing just the way you want, you will not need a
profile.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1116
.. _patron-add-a-profile-label:
joubu's avatar
joubu committed
1117 1118

Add a Profile
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
'''''''''''''''''''''''''''''''''''

To add a new profile, you want to click on the 'Profiles' button at the
top of your page and choose 'New Profile'

|image268|

To add a new profile, you want to click on the 'New profile' button at
the top of your page. Using the form that appears you can define the
values to correct the card misalignments on your label sheet. You may
also choose 'Manage profiles' on the left side and select one of the
currently available profiles for editing.

|image269|

-  The Printer Name and Paper Bin do not have to match your printer
   exactly, they are for your reference so you can remember what printer
   you have set the profile for.

   -  **Note**

          For example: if you want to use the Printer model number in
          printer name you can, or you can call it 'the printer on my
          desk'

-  Template will be filled in once you have chosen which template to
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1145
   apply the profile to on the :ref:`template edit form <patron-add-a-template-label>`
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

-  The Units pull down is used to define what measurement scale you're
   going to be using for your profile.

   |image270|

   -  **Note**

          A Postscript Point is 1/72" an Adobe Agate is 1/64", an Inch
          is 25.4 SI Millimeters

-  Offset should be used when the entire image is off center either
   vertically or horizontally. Creep describes a condition where the
   distance between the labels changes across the page or up and down
   the page

   -  For offset and creep values, negative numbers move the printed
      information up and to the left on the printed sheet and positive
      numbers move down and to the right

   -  Example: the text is printed 0 .25" from the left edge of the
      first label, 0 .28" from the left edge of the second label and 0
      .31" from the left edge of the third label. This means the
      horizontal creep should be set to (minus) -0.03 " to make up for
      this difference.

After saving, your profiles will appear on the 'Manage Printer Profiles'
page.

|image271|

Once you have saved your new profile, you can return to the list of
templates and choose to edit the template that this profile is for.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1180
.. _patron-batches-label:
joubu's avatar
joubu committed
1181 1182

Batches
1183 1184 1185 1186 1187 1188 1189
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Patron Card Creator > Manage > Card
   batches

A batch is a collection of patrons for whom you want to generate cards.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1190
.. _patron-add-a-batch-label:
joubu's avatar
joubu committed
1191 1192

Add a Batch
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
'''''''''''''''''''''''''''''''

To add a new batch, you want to click on the 'New batches' button at the
top of your page. Choosing the menu item 'Manage batches' on the left a
list of already defined batches is displayed. In this display you can
either select a batch for editing or add a new batch.

|image272|

For a new batch a message pops up and directs you to select patrons to
joubu's avatar
joubu committed
1203 1204 1205
be processed in this batch.

|image1225|
1206 1207

After choosing the 'Add item(s)' button the Patron Search window pops
joubu's avatar
joubu committed
1208 1209 1210
up.

|image1226|
1211 1212 1213

From here you can search for patrons to add to your batch by any part of
their name, their category and/or library. Entering \* in the search box
joubu's avatar
joubu committed
1214 1215 1216
will display all the patrons.

|image1227|
1217 1218 1219 1220 1221

From the results you can add patrons to the batch by clicking the 'Add'
button. After adding patrons from the results you can start over and
perform another search or click 'Close' at the bottom of the screen to
indicate that you are done. You will then be presented with your
joubu's avatar
joubu committed
1222
batch.
1223

joubu's avatar
joubu committed
1224
|image1228|
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
If you are satisfied with your batch you can proceed to export. If you
want to correct or even delete that batch the buttons to do so can be
found at the top of your screen. You can always come back here through
the 'Manage > Card batches' button.

If you would like to export all patron cards you can click 'Export card
batch' otherwise you can choose specific patrons to print cards for by
checking the box to the right of their names and then choose 'Export
selected card(s)' at the top.

The export menu will ask you to choose a template, a layout and starting
position (where on the sheet should printing begin).

    **Note**

    For the starting position if the first 6 labels have already been
    used on your sheet you can start printing on label in position 7 on
    the sheet. The labels are numbered left to right from top to bottom.

joubu's avatar
joubu committed
1244
|image1229|
1245 1246

Once you click 'Export' you will be presented with a PDF of your labels
joubu's avatar
joubu committed
1247 1248 1249
for printing

|image1230|
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263

When you open the PDF you will see the cards for printing

|image273|

The above image shows a layout that is made up of two textlines. The
first one is just plain text, the second one is composed of the
<firstname> <surname> fields. A patron image is printed (if available)
and the barcode of patrons number is displayed in code 39. All this is
printed on a template with three columns and 8 rows using position 1-3
here. When printing this PDF please take care that your printer doesn't
rescale the PDF (e.g do not fit to paper size) otherwise the printer
will not be able to print to the right place per your templates.

joubu's avatar
joubu committed
1264 1265 1266
.. _manage-images-label:

Manage Images
1267 1268 1269 1270 1271
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Patron Card Creator > Manage > Images

Images uploaded using this tool will appear on the menu when creating
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
1272
:ref:`patron card layouts <patron-card-layouts-label>`. You are limited in how many
1273
images you can upload (not counting patron images) by the
joubu's avatar
joubu committed
1274
:ref:`ImageLimit` system preference.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302

    **Important**

    Images must be under 500k in size.

    **Note**

    Pictures uploaded with this tool should be at least 300dpi which is
    the minimum quality for a printable image.

In the center of the screen is a simple upload form, simply browse for
the file on your computer and give it a name you'll recognize later.

|image274|

Once the file is uploaded you will be presented with a confirmation
message.

|image275|

And the image will be listed with all of your others on the right hand
side of the page.

|image276|

To delete one or multiple of these images, click the checkbox to the
right of each image you want to delete and click the 'Delete' button.

joubu's avatar
joubu committed
1303 1304 1305
.. _patrons-(anonymize,-bulk-delete)-label:

Patrons (anonymize, bulk-delete)
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Patrons
   (anonymize, bulk-delete)

This tool allows you to bulk anonymize circulation histories (this means
that you keep records of how many times items were checked out - but not
the patrons who checked the items out) or bulk delete patrons (remove
them from the system completely).

    **Important**

    Patrons with outstanding fines or items checked out are not saved.
    They are not completely removed from the system (they are only moved
    to the delete\_borrowers table), but this tool does not provide as
    many checks as one may desire.

    **Important**

    Before using this tool it is recommended that you backup your
    database. Changes made here are permanent.

    **Important**

    The anonymization will fail quietly if
joubu's avatar
joubu committed
1331
    :ref:`AnonymousPatron` preference does not contain a
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
    valid value.

|image277|

To either delete or anonymize patrons

-  Check the 'Verify' box on the task you would like to complete (Delete
   or Anonymize)

-  Enter a date before which you want to alter the data

-  If deleting patrons you can also choose to find patrons who

   -  have not borrowed since a specific date

   -  have accounts that will expire before a specific date

joubu's avatar
joubu committed
1349
   -  are in a specific :ref:`patron category <patron-categories-label>`
1350

joubu's avatar
joubu committed
1351
   -  are in a :ref:`patron list <patron-lists-label>`
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363

-  Click 'Next'

-  A confirmation will appear asking if you're sure this is what you
   want to happen

   |image278|

-  Clicking 'Finish' will delete or anonymize your data

   |image279|

joubu's avatar
joubu committed
1364 1365 1366
.. _batch-patron-modification-label:

Batch patron modification
1367 1368 1369 1370 1371 1372
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Batch patron
   modification

With this tool you can make edits to a batch of patron records. Simply
joubu's avatar
joubu committed
1373 1374
load in a file of cardnumbers (one per line), choose from a :ref:`list of
patrons <patron-lists-label>` or scan patron card numbers in to the box
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
provided.

|image280|

Once you have the file loaded or the barcodes scanned click 'Continue.'
You will be presented with a list of the patrons and the changes you can
make.

|image281|

To the left of each text box there is a checkbox. Clicking that checkbox
will clear our the field values.

    **Important**

    If the field is mandatory you will not be able to clear the value in
    it.

If you have multiple patron attributes you can change them all by using
the plus (+) sign to the right of the text box. This will allow you to
add another attribute value.

|image282|

Once you have made the changes you want, you can click 'Save' and Koha
will present you with the changed patron records.

joubu's avatar
joubu committed
1402 1403 1404
.. _tag-moderation-label:

Tag Moderation
1405 1406 1407 1408
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Tags

joubu's avatar
joubu committed
1409
Depending on your :ref:`tagging system preferences <tagging-label>`,
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
librarians may need to approve tags before they are published on the
OPAC. This is done via the Tag Moderation Tool. If there are tags
awaiting moderation they will be listed on the main staff dashboard
under the module labels:

|image283|

To moderate the tags visit the Tags tool. When first visiting the tool,
you will be presented with a list of tags that are pending approval or
rejection by a librarian

|image284|

-  To see all of the titles this tag was added to simply click on the
joubu's avatar
joubu committed
1424 1425 1426
   term

   |image1230|
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452

   -  From this list of titles you can remove a tag without outright
      rejecting it from being used in the future by clicking the 'Remove
      tag' button to the right of the title.

-  To approve a tag, you can either click the 'Approve' button in line
   with the term, or check all terms you want to approve and click
   'Approve' below the table.

-  To reject a tag, you can either click the 'Reject' button in line
   with the term, or check all terms you want to approve and click
   'Reject' below the table.

Once a tag has been approved or rejected it will be moved to the
appropriate list of tags. A summary of all tags will appear on the right
of the screen.

|image285|

Even though a tag is approved or rejected, it can still be moved to
another list. When viewing approved tags each tag has the option to
reject:

|image286|

To check terms against the approved and rejected lists (and possibly
joubu's avatar
joubu committed
1453
against :ref:`the dictionary <tagsexternaldictionary-label>` you have assigned
1454 1455 1456 1457 1458 1459 1460 1461 1462
for tag moderation) simply enter the term into the search box on the
bottom right of the screen to see the status of the term

|image287|

Finally you can find tags by using the filters on the left.

|image288|

joubu's avatar
joubu committed
1463 1464 1465
.. _upload-patron-images-label:

Upload Patron Images
1466 1467 1468 1469 1470
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Patrons and Circulation > Upload Patron
   Images

joubu's avatar
joubu committed
1471 1472 1473
Patron images can be uploaded in bulk if you are :ref:`allowing patron
images <patronimages-label>` to be attached to patron records. These images
can also be used when creating :ref:`patron cards <patron-card-creator-label>`.
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504

-  Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"

-  On each line in the text file enter the patron's card number followed
   by comma (or tab) and then the image file name

   |image289|

   -  Make sure that your TXT file is a plain text document, not RTF.

-  Zip up the text file and the image files

-  Go to the Upload Patron Images Tool

   |image290|

-  For a single image, simply point to the image file and enter the
   patron card number

-  For multiple images, choose to upload a zip file

-  After uploading you will be presented with a confirmation

   |image291|

    **Important**

    There is a limit of 100K on the size of the picture uploaded and it
    is recommended that the image be 200x300 pixels, but smaller images
    will work as well.

joubu's avatar
joubu committed
1505 1506 1507
.. _rotating-collections-label:

Rotating Collections
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Rotating Collections

Rotating Collections is a tool for managing collections of materials
that frequently get shifted from library to library. It adds the ability
to store not only an item's home library and current location but also
information about where it is supposed to be transferred to next to
ensure that all items in the collection are sent to the correct library.
When an item in a rotating collection is checked in, library staff is
notified that the item is part of a rotating collection and which branch
it should be sent to if it is not at the correct one.

    **Important**

joubu's avatar
joubu committed
1523
    The :ref:`AutomaticItemReturn` system preference
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
    must be set to "Don't automatically transfer items to their home
    library when they are returned" for Rotating Collections to function
    properly.

-  To create a new rotating collection, click the "New Collection"
   button, fill in the Title and Description, and click Submit. Once
   submitted you'll see "Collection Name added successfully"; click
   "Return to rotating collections home" to return to the main Rotating
   Collections management page (or click Rotating Collections in the
   sidebar).

-  To add items to a collection, click "Add or remove items" next to the
   collection's name in the list of collections. Under "Add or remove
   items" scan or type in the barcode of the item you wish to add to the
   collection, and hit Enter or click Submit if necessary.

-  To remove an item from a collection, either click Remove next to the
   item's barcode in the list of items within the collection or check
   the "Remove item from collection" box next to the Barcode text box
   under "Add or remove items, and scan or type in the barcode, clicking
   Submit or hitting Enter if necessary. Note: The "Remove item from
   collection" checkbox will remain checked as long as you are on the
   "Add or remove items" page, unless you uncheck it, to facilitate
   quickly removing a number of items at a time by scanning their
   barcodes.

joubu's avatar
joubu committed
1550 1551 1552
.. _transfer-a-rotating-collection-label:

Transfer a Rotating Collection
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Transferring a collection will:

-  Change the current location of the items in that collection to the
   library it is to be transferred to

-  Initiate a transfer from its original current location/holding
   library to the current location/holding library it is to be rotated
   to. When a library receives a collection they will need to check in
   the items to complete the transfer.

You can transfer a collection in one of two ways:

-  From the main Rotating Collections page, click on Transfer next to
   the title of the collection you wish to transfer; choose the library
   you wish to transfer the collection to and click "Transfer
   collection".

-  Or, from the "add or remove items" page for a collection, you can
   click the Transfer button, choose the library you wish to transfer
   the collection to and click "Transfer Collection".

    **Important**

    In order to complete the transfer process, the library receiving the
    rotating collection should check in all items from the collection as
    they receive them. This will clear the transfer so that the items
    are no longer shown as being "in transit".

If an item in a rotating collection is checked in at a library other
than the one it is supposed to be transferred to, a notification will
appear notifying library staff that the item is part of a rotating
collection, also letting them know where the item needs to be sent.

|image292|

joubu's avatar
joubu committed
1590 1591 1592
.. _catalog-label:

Catalog
1593 1594
---------------------------

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
.. _batch-item-deletion-label:

Batch item deletion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Batch item deletion

This tool will allow you to delete a batch of item records from Koha.

From the tool you can choose to upload a file of barcodes or item ids,
or you can scan items one by one into the box below the upload tool.

|image298|

Once you have your file uploaded or the barcodes scanned you can click
'Continue.'

You will be presented with a confirmation screen. From here you can
uncheck the items you don't want to delete and decide if Koha should
delete the bib record if the last item is being deleted before clicking
'Delete selected items.' If you'd like you can delete the bibliogrphic
record if you're deleting the last item by clicking the checkbox next to
'Delete records if no items remain'.

|image299|

If your file (or list of scanned barcodes) has more than 1000 barcodes,
Koha will be unable to present you with a list of the items. You will
still be able to delete them, but not able to choose which items
specifically to delete or delete the biblio records.

|image300|

If the items are checked out you will be presented with an error after
clicking 'Delete selected items' and the items will not be deleted.

|image301|

If the items can be deleted they will be and you will be presented with
a confirmation of your deletion.

|image302|

joubu's avatar
joubu committed
1638 1639 1640
.. _batch-item-modification-label:

Batch item modification
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Batch item modification

This tool will allow you to modify a batch of item records in Koha.

|image293|

From the tool you can choose to upload a file of barcodes or item ids,
or you can scan items one by one into the box below the upload tool. You
can also decide the items edited should be populated with the default
joubu's avatar
joubu committed
1652 1653
values you have defined in your :ref:`default
framework <marc-bibliographic-frameworks-label>`.
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688

Once you have your file uploaded or the barcodes listed you can click
'Continue.'

|image294|

You will be presented with a summary of the items you want to modify.
From here you can uncheck the items you don't want to modify before
making changes in the form below. You can also hide columns you don't
need to see to prevent having to scroll from left to right to see the
entire item form.

    **Note**

    To uncheck all items thar are currently checked out you can click
    the 'Clear on loan' link at the top of the form.

Using the edit form you can choose which fields to make edits to. By
checking the checkbox to the right of each field you can clear the
values in that field for the records you are modifying.

|image295|

Once you have made you changes you will be presented with the resulting
items.

|image296|

    **Note**

    You can also edit items on one bib record in a batch by going to the
    bib record and clicking Edit > Edit items in batch

|image297|

joubu's avatar
joubu committed
1689 1690 1691
.. _batch-record-deletion-label:

Batch record deletion
1692 1693 1694 1695
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This tool will take a batch of record numbers for either bibliographic
records or authority records and allow you to delete all those records
joubu's avatar
joubu committed
1696 1697 1698
and any items attached to them in a batch.

|image1231|
1699 1700 1701 1702 1703

First you need to tell the tool if you're deleting bibliographic or
authority records. Next you can load a file with biblionumbers or
authids or enter a list of those numbers in the box provided. Once you
submit the form you will be presented with a summary of the records you
joubu's avatar
joubu committed
1704 1705 1706
are trying to delete.

|image1232|
1707 1708 1709 1710 1711 1712

If a record you want to delete can't be deleted it will be highlighted.

Check the records you want to delete and click the 'Delete selected
records' button to finish the process.

joubu's avatar
joubu committed
1713 1714
.. _batch-record-modification-label:

1715
Batch record modification
1716 1717 1718 1719 1720
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Batch record modification

This tool will allow you to edit batches of bibliographic and/or
joubu's avatar
joubu committed
1721 1722
authority records using :ref:`MARC Modification
Templates <marc-modification-templates-label>`. Before visiting this tool you will
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
want to set up at least one MARC modification template.

|image303|

When you visit the tool it will ask you:

-  Choose whether you're editing bibliographic or authority records

-  Enter the biblionumbers or authids

   -  You can upload a file of these numbers or

   -  Enter the numbers (one per line) in the box provided

-  Finally choose the MARC Modification Template you'd like to use to
   edit these records.

joubu's avatar
joubu committed
1740 1741 1742
Once you've entered your criteria click 'Continue'

|image1233|
1743 1744 1745 1746 1747 1748

You will be presented with a list of records that will be edited. Next
to each one is a checkbox so you can uncheck any items you would rather
not edit at this time.

Clicking Preview MARC will allow you to see what edits will be made when
joubu's avatar
joubu committed
1749 1750 1751
you finalize the edit.

|image1234|
1752 1753 1754 1755

Once you're sure everything is the way you want you can click the
'Modify selected records' button and your records will be modified.

joubu's avatar
joubu committed
1756 1757 1758
.. _automatic-item-modifications-by-age-label:

Automatic item modifications by age
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Automatic item modifications by
   age

This tool allows librarians to update item specific fields when an item
reaches a certain age.

    **Note**

    Staff need the items\_batchmod permission to access this tool

    **Important**

joubu's avatar
joubu committed
1773 1774
    The settings in this tool will be acted upon by the :ref:`corresponding
    cron job <automatic-item-update-label>`
1775 1776

If you haven't created any rules you will see the option to 'Add rules'
joubu's avatar
joubu committed
1777 1778 1779
on the Tool page. Click this button to create rules.

|image1235|
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807

If you have rules already there will be a button that reads 'Edit
rules'. To create a new rule click the 'Edit rules' button at the top of
the page

|image304|

You will be brought to a page where you can edit exisitng rules or
create a new rule

|image305|

In the form that appears you can set :

-  the age in days at which the item will update (Age)

-  what criteria is needed to trigger the update (Conditions)

-  what changes are made when the script runs (Substitutions)

|image306|

Once you're done you can click the 'Add this rule' link and then add
additional rules or you can click the 'Submit these rules' button to
save your changes.

|image307|

joubu's avatar
joubu committed
1808 1809 1810
.. _export-data-(marc-&-authorities)-label:

Export Data (MARC & Authorities)
1811 1812 1813 1814 1815 1816 1817 1818 1819
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Export Data

Koha comes with a tool that will allow you to export your bibliographic,
holdings and/or authority data in bulk. This can be used to send your
records to fellow libraries, organizations or services; or simply for
backup purposes.

joubu's avatar
joubu committed
1820 1821 1822
.. _export-bibliographic-records-label:

Export Bibliographic Records
1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

At the top of the screen you need to pick what data you're exporting. If
you're exporting bibliographic records with or without the holdings
information you want to click the 'Export bibliographic records' tab.

-  Fill in the form in order to limit your export to a specific range
   (all fields are optional)

   |image308|

   -  Choose to limit your export by any one or more of the following
      options

      -  Limit to a bib number range

      -  Limit to a specific item type

         -  **Important**

                This limit will use the type you have defined in the
joubu's avatar
joubu committed
1844
                :ref:`item-level\_itypes <item-level\_itypes-label>` preference.
1845 1846 1847 1848 1849 1850 1851 1852
                If you have the item-level\_itypes preference set to
                'specific item' and you have no items attached to a bib
                record it will not be exported. To get all bib records
                of a specific type you will need your item-level\_itypes
                preference set to 'biblio record'.

      -  Limit to a specific library or group of libraries

1853 1854 1855 1856 1857 1858 1859 1860
         -  **Important**

                This is a filter: if you leave this set to the default
                (all libraries selected) or select one or more libraries,
                bib records with no items attached will not be exported. To get
                bib records with no items you will need to 'clear all'
                (i.e. de-select all libraries).

1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
      -  Limit to a call number range

      -  Limit to an acquisition date range

   -  If you'd like you can load a file of biblionumbers for the records
      you would like to export.  File type needs to be .csv or .txt

      |image309|

   -  Next choose what to skip when exporting

      |image310|

      -  By default items will be exported, if you would like to only
         export bibliographic data, check the 'Don't export items' box

      -  To limit your export only to items from the library you're
         logged in as (if you leave the 'Library' field set to 'All') or
         to the library you selected above check the 'Remove non-local
         items' box

      -  You can also choose what fields you don't want to export. This
         can be handy if you're sharing your data, you can remove all
         local fields before sending your data to another library

   -  Finally choose the file type and file name

      |image311|

      -  Choose to export your data in marc or marcxml format

      -  Choose the name you want your file to save as

   -  Click 'Export bibliographic records'

joubu's avatar
joubu committed
1896 1897 1898
.. _export-authority-records-label:

Export Authority Records
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

At the top of the screen you need to pick what data you're exporting. If
you're exporting authority records you want to click the 'Export
authority records' tab.

-  Fill in the form in order to limit your export to a specific range or
   type of authority record (all fields are optional)

   |image312|

joubu's avatar
joubu committed
1910 1911 1912 1913 1914
-  Or you can choose a file of authids to export

  |image1236|

  File type needs to be .csv or .txt
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936

-  Next choose fields that you would like to exclude from the export
   separated by a space (no commas)

   |image313|

   -  If you'd like to exclude all subfields of the 200 for example just
      enter 200

   -  If you'd like to exclude a specific subfield enter it beside the
      field value 100a will exclude just the subfield 'a' of the 100

-  Finally choose the file type and file name

   |image314|

   -  Choose to export your data in marc or marcxml format

   -  Choose the name you want your file to save as

-  Click 'Export authority records'

1937
.. _inventory-label:
joubu's avatar
joubu committed
1938

1939
Inventory
1940 1941
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1942
-  *Get there:* More > Tools > Catalog > Inventory
1943

1944
Koha's Inventory tool can be used in one of three ways:
1945
1. By printing out a shelf list that you can then mark items off on;
1946

1947
2. By uploading a text file of barcodes gathered by a portable scanner;
1948

1949 1950
3. By comparing a text file of barcodes gathered by a portable scanner to a
   generated shelf list.
1951 1952

If you do not have the ability to use your barcode scanner on the floor
1953
of the library, the option available to you is to generate a shelf
1954 1955 1956 1957
list based on criteria you enter.

|image315|

1958 1959 1960 1961 1962
First, choose the criteria for the items you want to print out on a list.
All parameters are optional, but if none are selected, the resulting list
might be quite large.

- Library: choose the branch you want to check, as well as if that branch
1963 1964
  is the home library or the current holding library of the items.

1965
- Shelving location (items.location) is: you can filter by location.
1966

1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
- Item callnumber between ... and ...: you can also limit the list to a specific
  range of callnumbers.

You can filter even more with item statuses (not for loan status, lost status,
withdrawn status or damaged status). Check the boxes next to the statuses you
want to include. For example, if you are using the list to shelf read, check
only the 'for loan' status as the other items probably won't be on the shelves.

- Last inventory date: enter a date here to skip items that have been marked
  as seen recently.
1977

1978 1979 1980 1981 1982 1983 1984 1985 1986
- Skip items on loan: check this box to filter out loaned items from the list.

- Export to CSV file: check this box to generate a CSV file for altering in an
  application on your desktop. If this box is unchecked, the list will be
  presented on the screen.

Click on 'Submit' to generate your shelf list. You can then print it to use
while walking around the library checking your collection or use it directly
in Koha on a portable device.
1987 1988 1989

|image316|

1990 1991 1992
Once you have found the items on your shelves, return to this
list and check the boxes next to the items you found. Next, click on one of
the three buttons to continue:
1993

1994 1995
- Mark seen and quit: updates the 'last seen' date of the checked items to
  today and returns to the previous screen.
1996

1997 1998
- Mark seen and continue: updates the 'last seen' date of the checked items to
  today and shows the next page of the list.
1999

2000 2001
- Continue without marking: doesn't update any of the items on this page
  and shows the next page of the list.
2002 2003 2004

If you have a portable scanner (or a laptop and USB scanner) you can
walk through the library with the scanner in hand and scan barcodes as
2005 2006
you come across them (on a laptop, scan the barcodes into a text file). Once 
finished you can then upload the text file generated by the scanner to Koha.
2007 2008 2009 2010

|image317|

Choose the text file and the date you want to mark all items as seen and
2011 2012 2013 2014 2015 2016 2017 2018
then scroll to the very bottom and click 'Submit'. This will update all the
items' 'last seen' date to the chosen date. By default, this will also check in
the items scanned as it is assumed that they are on the shelf and so not loaned
out. If you do not want to check in scanned items, check the 'Do not check in
items scanned during inventory' before clicking 'Submit'.

Alternatively, you can combine the two methods to automatically compare a list
of scanned barcodes with a generated list. First, upload you barcode file and
2019 2020 2021 2022 2023 2024
choose the date you want to appear in the items' 'last seen' field. The 'Compare 
barcodes list to results' checkbox should automatically be checked. If you do 
not want the scanned items to be automatically checked-in if they are checked-out, 
make sure you check the 'Do not check in items scanned during inventory' checkbox. 
Choose the filters (library, shelving location, callnumbers or statuses) to generate a 
list with which to compare your barcodes. Click on 'Submit'.
2025

2026
    **Note**
2027

2028 2029 2030
    Depending on the number of barcodes you are comparing, this may take a few
    minutes. It is not recommended to compare lists of more than 1000 barcodes as
    this may cause a session timeout.
2031 2032 2033 2034 2035 2036

Once Koha has finished comparing the barcodes file to the generated list, it
will return the number of items updated and a list of problematic items.

- Missing (not scanned): the item is in the generated list but not in the
  barcodes file.
2037

2038 2039
- Found in wrong place: the item is in the barcodes list, but not in the
  generated list.
2040

2041 2042
- Still checked out: the item is checked out, but is in the generated list. It
  was not automatically checked in.
2043

2044
- Barcode not found: the barcode doesn't exist.
2045

2046 2047
- Item withdrawn: the item has 'withdrawn' status, but it is in the barcodes
  file.
2048

joubu's avatar
joubu committed
2049 2050 2051
.. _label-creator-label:

Label Creator
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  *Get there:* More > Tools > Catalog > Label Creator

The Label Creator allow you to use layouts and templates which you
design to print a nearly unlimited variety of labels including barcodes.
Here are some of the features of the Label Creator module:

-  Customize label layouts

-  Design custom label templates for printed labels

-  Build and manage batches of labels

-  Export single or multiple batches

-  Export single or multiple labels from within a batch

-  Export label data in one of three formats:

   -  PDF - Readable by any standard PDF reader, making labels printable
      directly on a printer

   -  CSV - Export label data after your chosen layout is applied
      allowing labels to be imported in to a variety of applications

   -  XML - Included as an alternate export format

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2080
.. _label-templates-label:
joubu's avatar
joubu committed
2081 2082

Templates
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Label Creator > Manage > Label templates

A template is based on the label/card stock you are using. This might be
Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery
28371 for your patron cards, just to give a couple of examples. These
labels will include all of the information you will need for setting up
a Koha, this information may be on the packaging, and if not it can
usually be found on the vendor's website.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2094
.. _label-add-a-template-label:
joubu's avatar
joubu committed
2095 2096

Add a Template
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140
''''''''''''''''''''''''''''''''''''''

To add a new template, you want to click on the 'New' button at the top
of the Label Creator and choosing 'Label template'.

|image318|

Using the form that appears you can define the template for your sheet
of labels or cards.

|image319|

-  Template ID will be automatically generated after saving your
   template, this is simply a system generated unique id

-  Template Code should be something you can use to identify your
   template on a list of templates

-  You can use the Template Description to add additional information
   about the template

-  The Units pull down is used to define what measurement scale you're
   going to be using for the template. This should probably match the
   unit of measurement used on the template description provided by the
   product vendor.

   |image320|

-  The measurements, number of columns and number of rows can be found
   on the vendor product packaging or website.

   -  **Important**

          If you do not supply a left text margin in the template, a
          3/16" (13.5 point) left text margin will apply by default.

-  A profile is a set of "adjustments" applied to a given template just
   prior to printing which compensates for anomalies unique and peculiar
   to a given printer (to which the profile is assigned).

   -  Before picking a profile try printing some sample labels so that
      you can easily define a profile that is right for your
      printer/template combination.

joubu's avatar
joubu committed
2141
   -  After finding any anomalies in the printed document, :ref:`create a
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2142
      profile <label-add-a-profile-label>` and assign it to the template.
2143 2144 2145 2146 2147 2148

After saving, your templates will appear on the 'Manage' area under
'Label templates'.

|image321|

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2149
.. _label-profiles-label:
joubu's avatar
joubu committed
2150 2151

Profiles
2152 2153 2154 2155 2156
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Label Creator > Manage > Printer Profiles

A profile is a set of "adjustments" applied to a given
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2157
:ref:`template <label-add-a-template-label>` just prior to printing which
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
compensates for anomalies unique and peculiar to a given printer (to
which the profile is assigned). This means if you set a template up and
then print a sample set of data and find that the items are not all
aligned the same on each label, you need to set up a profile for each
printer to make up for the differences in printing styles, such as the
shifting of text to the left, right, top or bottom.

If your labels are printing just the way you want, you will not need a
profile.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2168
.. _label-add-a-profile-label:
joubu's avatar
joubu committed
2169 2170

Add a Profile
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
''''''''''''''''''''''''''''''''''''

To add a new profile, you want to click on the 'New' button at the top
of the Label Creator tool and choose 'Printer profile'.

|image322|

Using the form that appears you can create a profile to fix any problems
with your template.

|image323|

-  The Printer Name and Paper Bin do not have to match your printer
   exactly, they are for your reference so you can remember what printer
   you have set the profile for. So if you want to use the Printer model
   number in printer name or you can call it 'the printer on my desk'

-  Template will be filled in once you have chosen which template to
joubu's avatar
joubu committed
2189
   apply the profile to on the :ref:`template edit
Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2190
   form <label-add-a-template-label>`
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217

-  The Units pull down is used to define what measurement scale you're
   going to be using for your profile.

   |image324|

-  Offset describes what happens when the entire image is off center
   either vertically or horizontally and creep describes a condition
   where the distance between the labels changes across the page or up
   and down the page

   -  For these values, negative numbers move the error up and to the
      left and positive numbers move the error down and to the right

   -  Example: the text is .25" from the left edge of the first label,
      .28" from the left edge of the second label and .31" from the left
      edge of the third label. This means the horizontal creep should be
      set to .03" to make up for this difference.

After saving, your profiles will appear on the 'Manage' area under
'Printer profiles'.

|image325|

Once you have saved your new profile, you can return to the list of
templates and choose to edit the template that this profile is for.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2218
.. _label-layouts-label:
joubu's avatar
joubu committed
2219 2220

Layouts
2221 2222 2223 2224 2225 2226
^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  *Get there:* More > Tools > Label Creator > Manage > Layouts

A layout is used to define the fields you want to appear on your labels.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2227
.. _label-add-a-layout-label:
joubu's avatar
joubu committed
2228 2229

Add a Layout
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
''''''''''''''''''''''''''''''''''

To add a new layout, you want to click on the 'New' button at the top of
the Label Creator tool and choose 'Layout'.

|image326|

Using the form that appears you can create a profile to fix any problems
with your template.

|image327|

-  The name of your layout can be anything you'd like to help you
   identify it later.

-  If this is a barcode label you'll want to choose the encoding (Code
   39 is the most common)

-  The layout type can be any combination of bibliographic information
   and/or barcode. For example a spine label would just be Biblio
   whereas a label for your circulation staff to use to checkout the
   book would probably be Biblio/Barcode.

-  The Bibliographic Data to Print includes any of the data fields that
   may be mapped to your MARC frameworks. You can choose from the preset
   list of fields or you can click on 'List Fields' and enter your own
   data. In 'List Fields', you can specify MARC subfields as a
   4-character tag-subfield string: (ie. 254a for the title field), You
   can also enclose a whitespace-separated list of fields to concatenate
   on one line in double quotes. (ie. "099a 099b" or "itemcallnumber
   barcode"). The fields available are from the database tables list
   below. Finally you could add in static text strings in single-quote
   (ie. 'Some static text here.')

   -  You can use the schema viewer (http://schema.koha-community.org)
      with the following tables to find field names to use:

      -  Currently all fields in the following tables are used: items,
         biblioitems, biblio, branches

         |image328|

-  Choose if the label maker should print out the guidelines around each
   label

-  Choose if you'd like Koha to try to split your call numbers (usually
   used on Spine Labels)

-  Finally choose your text settings such as alignment, font type and
   size.

After saving, your layouts will appear on the 'Manage Layouts' page.

Bernardo Gonzalez Kriegel's avatar
Bernardo Gonzalez Kriegel committed
2283
.. _label-batches-label:
joubu's avatar
joubu committed