From d873aa64c0812f3a9a2776a1d7a4dd7c38af37fe Mon Sep 17 00:00:00 2001 From: Ben Shum Date: Sun, 27 May 2012 16:55:39 -0400 Subject: [PATCH] Convert docs files from DOS to UNIX format. Signed-off-by: Ben Shum Signed-off-by: Robert Soulliere --- docs/acquisitions/introduction.txt | 50 +- .../receive_items_from_invoice.txt | 146 +-- docs/acquisitions/selection_lists_po.txt | 272 ++--- .../vandelay_acquisitions_integration.txt | 138 +-- docs/admin/acquisitions_admin.txt | 980 +++++++++--------- docs/admin/auto_suggest_search.txt | 64 +- docs/admin/booking-admin.txt | 398 +++---- docs/admin/cn_prefixes_and_suffixes.txt | 92 +- docs/admin/customize_staff_client.txt | 118 +-- docs/admin/recent_staff_searches.txt | 98 +- .../restrict_Z39.50_sources_by_perm_group.txt | 98 +- docs/admin/staff_client-double_clicking.txt | 46 +- docs/admin/staff_client-recent_searches.txt | 84 +- ...aff_client-return_to_results_from_marc.txt | 12 +- docs/admin/staff_client-sorting_columns.txt | 118 +-- docs/admin/staff_client-tab_buttons.txt | 12 +- docs/admin/user_activity_type.txt | 64 +- docs/cataloging/batch_importing_MARC.txt | 428 ++++---- docs/cataloging/monograph_parts.txt | 114 +- .../cataloging/overlay_record_3950_import.txt | 110 +- docs/circulation/booking.txt | 544 +++++----- docs/circulation/circulating_items.txt | 654 ++++++------ docs/installation/edi_setup.txt | 424 ++++---- docs/opac/my_lists.txt | 126 +-- docs/root.txt | 640 ++++++------ 25 files changed, 2915 insertions(+), 2915 deletions(-) diff --git a/docs/acquisitions/introduction.txt b/docs/acquisitions/introduction.txt index 4680506820..a257cc9bc4 100644 --- a/docs/acquisitions/introduction.txt +++ b/docs/acquisitions/introduction.txt @@ -1,25 +1,25 @@ -Acquisitions ------------- - -This section is intended for those who are responsible for managing and processing acquisitions. - -Before beginning to use Acquisitions, the following must be configured by an administrator: - -* Cancel/Suspend Reasons (optional) -* Claiming (optional) -* Currency Types (defaults exist) -* Distribution Formulas (optional) -* EDI Accounts (optional) (see link:../installation/edi_setup.txt[Setting Up EDI Acquisitions] under Software Installation) -* Exchange Rates (defaults exist) -* Funds and Fund Sources -* Invoice Types (defaults exist) and Invoice Payment Methods -* Line Item Features (optional) -* Merge Overlay Profiles and Record Match Sets (see link:../cataloging/batch_importing_MARC.txt[Batch Importing MARC Records] in Cataloging) -* Providers - -Acquisitons Workflow -~~~~~~~~~~~~~~~~~~~~ - -The following diagram shows how the workflow functions in Evergreen. One of the differences in this process you should notice is that when creating a selection list on the vendor site, libraries will be downloading and importing the vendor bibs and item records. - -image::media/acq_workflow.jpg[workflow diagram] +Acquisitions +------------ + +This section is intended for those who are responsible for managing and processing acquisitions. + +Before beginning to use Acquisitions, the following must be configured by an administrator: + +* Cancel/Suspend Reasons (optional) +* Claiming (optional) +* Currency Types (defaults exist) +* Distribution Formulas (optional) +* EDI Accounts (optional) (see link:../installation/edi_setup.txt[Setting Up EDI Acquisitions] under Software Installation) +* Exchange Rates (defaults exist) +* Funds and Fund Sources +* Invoice Types (defaults exist) and Invoice Payment Methods +* Line Item Features (optional) +* Merge Overlay Profiles and Record Match Sets (see link:../cataloging/batch_importing_MARC.txt[Batch Importing MARC Records] in Cataloging) +* Providers + +Acquisitons Workflow +~~~~~~~~~~~~~~~~~~~~ + +The following diagram shows how the workflow functions in Evergreen. One of the differences in this process you should notice is that when creating a selection list on the vendor site, libraries will be downloading and importing the vendor bibs and item records. + +image::media/acq_workflow.jpg[workflow diagram] diff --git a/docs/acquisitions/receive_items_from_invoice.txt b/docs/acquisitions/receive_items_from_invoice.txt index 8c0adca25b..f28665ce63 100644 --- a/docs/acquisitions/receive_items_from_invoice.txt +++ b/docs/acquisitions/receive_items_from_invoice.txt @@ -1,73 +1,73 @@ -Receive Items From an Invoice ------------------------------ - -This feature enables users to receive items from an invoice. Staff can receive individual copies, or they can receive items in batch. - -Receive Items in Batch (List Mode) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In this example, we have created a purchase order, added line items and copies, and activated the purchase order. We will create an invoice from the purchase order, receive items, and invoice them. We will receive the items in batch from the invoice. - -1) Retrieve a purchase order. - -2) Click *Create Invoice*. - -image::media/Receive_Items_From_an_Invoice1.jpg[Receive_Items_From_an_Invoice1] - -3) The blank invoice appears. In the top half of the invoice, enter descriptive information about the invoice. In the bottom half of the invoice, enter the number of items for which you were invoiced, the amount that you were billed, and the amount that you paid. - - -image::media/Receive_Items_From_an_Invoice2.jpg[Receive_Items_From_an_Invoice2] - - -4) Click *Save*. You must choose a save option before you can receive items. - - -5) The screen refreshes. In the top right corner of the screen, click *Receive Items*. - - -6) The *Acquisitions Invoice Receiving* screen opens. By default, this screen enables users to receive items in batch, or *Numeric Mode*. You can select the number of copies that you want to receive; you are not receiving specific copies in this mode. - - -7) Select the number of copies that you want to receive. By default, the number that you invoiced will appear. In this example, we will receive one copy of each title. - - -NOTE: You cannot receive fewer items than 0 (zero) or more items than the number that you ordered. - - -8) Click *Receive Selected Copies*. - - -image::media/Receive_Items_From_an_Invoice4.jpg[Receive_Items_From_an_Invoice4] - - -9) When you are finished receiving items, close the screen. You can repeat this process as you receive more copies. - - - -Receive Specific Copies (Numeric Mode) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In this example, we have created a purchase order, added line items and copies, and activated the purchase order. We will create an invoice from the purchase order, receive items, and invoice them. We will receive specific copies from the invoice. This function may be useful to libraries who purchase items that have been barcoded by their vendor. - - -1) Complete steps 1-5 in the previous section. - -2) The *Acquisitions Invoice Receiving* screen by default enables user to receive items in batch, or *Numeric Mode*. Click *Use List Mode* to receive specific copies. - -3) Select the check boxes adjacent to the copies that you want to receive. Leave unchecked the copies that you do not want to receive. - -4) Click *Receive Selected Copies*. - -image::media/Receive_Items_From_an_Invoice5.jpg[Receive_Items_From_an_Invoice5] - - -The screen will refresh. Copies that have not yet been received remain on the screen so that you can receive them when they arrive. - - -5) When all copies on an invoice have been received, a message confirms that no copies remain to be received. - -6) The purchase order records that all items have been received. - -image::media/Receive_Items_From_an_Invoice7.jpg[Receive_Items_From_an_Invoice7] - +Receive Items From an Invoice +----------------------------- + +This feature enables users to receive items from an invoice. Staff can receive individual copies, or they can receive items in batch. + +Receive Items in Batch (List Mode) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In this example, we have created a purchase order, added line items and copies, and activated the purchase order. We will create an invoice from the purchase order, receive items, and invoice them. We will receive the items in batch from the invoice. + +1) Retrieve a purchase order. + +2) Click *Create Invoice*. + +image::media/Receive_Items_From_an_Invoice1.jpg[Receive_Items_From_an_Invoice1] + +3) The blank invoice appears. In the top half of the invoice, enter descriptive information about the invoice. In the bottom half of the invoice, enter the number of items for which you were invoiced, the amount that you were billed, and the amount that you paid. + + +image::media/Receive_Items_From_an_Invoice2.jpg[Receive_Items_From_an_Invoice2] + + +4) Click *Save*. You must choose a save option before you can receive items. + + +5) The screen refreshes. In the top right corner of the screen, click *Receive Items*. + + +6) The *Acquisitions Invoice Receiving* screen opens. By default, this screen enables users to receive items in batch, or *Numeric Mode*. You can select the number of copies that you want to receive; you are not receiving specific copies in this mode. + + +7) Select the number of copies that you want to receive. By default, the number that you invoiced will appear. In this example, we will receive one copy of each title. + + +NOTE: You cannot receive fewer items than 0 (zero) or more items than the number that you ordered. + + +8) Click *Receive Selected Copies*. + + +image::media/Receive_Items_From_an_Invoice4.jpg[Receive_Items_From_an_Invoice4] + + +9) When you are finished receiving items, close the screen. You can repeat this process as you receive more copies. + + + +Receive Specific Copies (Numeric Mode) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In this example, we have created a purchase order, added line items and copies, and activated the purchase order. We will create an invoice from the purchase order, receive items, and invoice them. We will receive specific copies from the invoice. This function may be useful to libraries who purchase items that have been barcoded by their vendor. + + +1) Complete steps 1-5 in the previous section. + +2) The *Acquisitions Invoice Receiving* screen by default enables user to receive items in batch, or *Numeric Mode*. Click *Use List Mode* to receive specific copies. + +3) Select the check boxes adjacent to the copies that you want to receive. Leave unchecked the copies that you do not want to receive. + +4) Click *Receive Selected Copies*. + +image::media/Receive_Items_From_an_Invoice5.jpg[Receive_Items_From_an_Invoice5] + + +The screen will refresh. Copies that have not yet been received remain on the screen so that you can receive them when they arrive. + + +5) When all copies on an invoice have been received, a message confirms that no copies remain to be received. + +6) The purchase order records that all items have been received. + +image::media/Receive_Items_From_an_Invoice7.jpg[Receive_Items_From_an_Invoice7] + diff --git a/docs/acquisitions/selection_lists_po.txt b/docs/acquisitions/selection_lists_po.txt index e308d056cc..7f5fd859f7 100644 --- a/docs/acquisitions/selection_lists_po.txt +++ b/docs/acquisitions/selection_lists_po.txt @@ -1,136 +1,136 @@ -Selection Lists and Purchase Orders ------------------------------------ - -Selection Lists -~~~~~~~~~~~~~~~ - -Selection lists allow you to create, manage, and save lists of items that you may want to purchase. To view your selection list, click Acquisitions -> My Selection Lists. Use the general search to view selection lists created by other users. - -Create a selection list -^^^^^^^^^^^^^^^^^^^^^^^ - -Selection lists can be created in four areas within the module. Selection lists can be created when you link:brief_records.txt[Add Brief Records], Upload MARC Order Records, or find records through the link:federated.txt[MARC Federated Search]. In each of these interfaces, you will find the Add to Selection List field. Enter the name of the selection list that you want to create in that field. - -Selection lists can also be created through the My Selection Lists interface: - -. Click Acquisitions -> My Selection Lists. -. Click the New Selection List drop down arrow. -. Enter the name of the selection list in the box that appears. -. Click Create. - -image::media/acq_selection_create.png[create selection list] - -Add items to a selection list -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can add items to a selection list in one of three ways: link:brief_records.txt[add a brief record]; upload MARC order records; add records through a link:federated.txt[federated search]; or use the link:federated.txt[View/Place Orders] menu item in the catalog. - -Clone selection lists -^^^^^^^^^^^^^^^^^^^^^ - -Cloning selection lists enables you to copy one selection list into a new selection list. You can maintain both copies of the list, or you can delete the previous list. - -. Click Acquisitions -> My Selection Lists. -. Check the box adjacent to the list that you want to clone. -. Click Clone Selected. -. Enter a name into the box that appears, and click Clone. - -image::media/acq_selection_clone.png[clone selection list] - -Merge selection lists -^^^^^^^^^^^^^^^^^^^^^ - -You can merge two or more selection lists into one selection list. - - -. Click Acquisitions -> My Selection Lists. -. Check the boxes adjacent to the selection lists that you want to merge, and click Merge Selected. -. Choose the Lead Selection List from the drop down menu. This is the list to which the items on the other list(s) will be transferred. -. Click Merge. - -image::media/acq_selection_merge.png[merge selection list] - -Delete selection lists -^^^^^^^^^^^^^^^^^^^^^^ - -You can delete selection lists that you do not want to save. You will not be able to retrieve these items through the General Search after you have deleted the list. You must delete all line items from a selection list before you can delete the list. - - -. Click Acquisitions -> My Selection Lists. -. Check the box adjacent to the selection list(s) that you want to delete. -. Click Delete Selected. - -Mark Ready for Selector -^^^^^^^^^^^^^^^^^^^^^^^ - -After an item has been added to a selection list or purchase order, you can mark it ready for selector. This step is optional but may be useful to individual workflows. - - -. If you want to mark part of a selection list ready for selector, then you can check the box(es) of the line item(s) that you wish to mark ready for selector. If you want to mark the entire list ready for selector, then skip to step 2. -. Click Actions -> Mark Ready for Selector. -. A pop up box will appear. Choose to mark the selected line items or all line items. -. Click Go. -. The screen will refresh. The marked line item(s) will be highlighted pink, and the status changes to selector~ready. - -image::media/acq_selection_mark_ready.png[mark ready] - -Convert selection list to purchase order -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the Actions menu to convert a selection list to a purchase order. - - -. From a selection list, click Actions ~> Create Purchase Order. -. A pop up box will appear. -. Select the ordering agency from the drop down menu. -. Enter the provider. -. Check the box adjacent to prepayment required if prepayment is required. -. Choose if you will add All Lineitems or Selected Lineitems to your purchase order. -. Check the box if you want to Import Bibs and Create Copies in the catalog. -. Click Submit. - -Brief Records -~~~~~~~~~~~~~ - -Brief records are short bibliographic records with minimal information that are often used as placeholder records until items are received. Brief records can be added to selection lists or purchase orders and can be imported into the catalog. You can add brief records to new or existing selection lists. You can add brief records to new, pending or on~order purchase orders. - -Add brief records to a selection list -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -. Click Acquisitions -> New Brief Record. You can also add brief records to an existing selection list by clicking the Actions menu on the selection list and choosing Add Brief Record. -. Choose a selection list from the drop down menu, or enter the name of a new selection list. -. Enter bibliographic information in the desired fields. -. Click Save Record. - -image::media/acq_brief_record.png[] - -Add brief records to purchase orders -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can add brief records to new or existing purchase orders. - -. Open or create a purchase order. See the section on link:03~PO.txt[purchase orders] for more information. -. Click Add Brief Record. -. Enter bibliographic information in the desired fields. Notice that the record is added to the purchase order that you just created. -. Click Save Record. - -image::media/acq_brief_record-2.png[] - -MARC Federated Search -~~~~~~~~~~~~~~~~~~~~~ - -The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source. - -. Click Acquisitions -> MARC Federated Search. -. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit. -+ ----- -image::media/acq_marc_search.png[search form] ----- -+ -. A list of results will appear. Click the "Copies" link to add copy information to the line item. See the link:line_items.txt[section on Line Items] for more information. -. Click the Notes link to add notes or line item alerts to the line item. See the link:line_items.txt[section on Line Items] for more information. -. Enter a price in the "Estimated Price" field. -. You can save the line item(s) to a selection list by checking the box on the line item and clicking Actions -> Save Items to Selection List. You can also create a purchase order from the line item(s) by checking the box on the line item and clicking Actions ~> Create Purchase Order. - -image::media/acq_marc_search-2.png[line item] +Selection Lists and Purchase Orders +----------------------------------- + +Selection Lists +~~~~~~~~~~~~~~~ + +Selection lists allow you to create, manage, and save lists of items that you may want to purchase. To view your selection list, click Acquisitions -> My Selection Lists. Use the general search to view selection lists created by other users. + +Create a selection list +^^^^^^^^^^^^^^^^^^^^^^^ + +Selection lists can be created in four areas within the module. Selection lists can be created when you link:brief_records.txt[Add Brief Records], Upload MARC Order Records, or find records through the link:federated.txt[MARC Federated Search]. In each of these interfaces, you will find the Add to Selection List field. Enter the name of the selection list that you want to create in that field. + +Selection lists can also be created through the My Selection Lists interface: + +. Click Acquisitions -> My Selection Lists. +. Click the New Selection List drop down arrow. +. Enter the name of the selection list in the box that appears. +. Click Create. + +image::media/acq_selection_create.png[create selection list] + +Add items to a selection list +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can add items to a selection list in one of three ways: link:brief_records.txt[add a brief record]; upload MARC order records; add records through a link:federated.txt[federated search]; or use the link:federated.txt[View/Place Orders] menu item in the catalog. + +Clone selection lists +^^^^^^^^^^^^^^^^^^^^^ + +Cloning selection lists enables you to copy one selection list into a new selection list. You can maintain both copies of the list, or you can delete the previous list. + +. Click Acquisitions -> My Selection Lists. +. Check the box adjacent to the list that you want to clone. +. Click Clone Selected. +. Enter a name into the box that appears, and click Clone. + +image::media/acq_selection_clone.png[clone selection list] + +Merge selection lists +^^^^^^^^^^^^^^^^^^^^^ + +You can merge two or more selection lists into one selection list. + + +. Click Acquisitions -> My Selection Lists. +. Check the boxes adjacent to the selection lists that you want to merge, and click Merge Selected. +. Choose the Lead Selection List from the drop down menu. This is the list to which the items on the other list(s) will be transferred. +. Click Merge. + +image::media/acq_selection_merge.png[merge selection list] + +Delete selection lists +^^^^^^^^^^^^^^^^^^^^^^ + +You can delete selection lists that you do not want to save. You will not be able to retrieve these items through the General Search after you have deleted the list. You must delete all line items from a selection list before you can delete the list. + + +. Click Acquisitions -> My Selection Lists. +. Check the box adjacent to the selection list(s) that you want to delete. +. Click Delete Selected. + +Mark Ready for Selector +^^^^^^^^^^^^^^^^^^^^^^^ + +After an item has been added to a selection list or purchase order, you can mark it ready for selector. This step is optional but may be useful to individual workflows. + + +. If you want to mark part of a selection list ready for selector, then you can check the box(es) of the line item(s) that you wish to mark ready for selector. If you want to mark the entire list ready for selector, then skip to step 2. +. Click Actions -> Mark Ready for Selector. +. A pop up box will appear. Choose to mark the selected line items or all line items. +. Click Go. +. The screen will refresh. The marked line item(s) will be highlighted pink, and the status changes to selector~ready. + +image::media/acq_selection_mark_ready.png[mark ready] + +Convert selection list to purchase order +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Use the Actions menu to convert a selection list to a purchase order. + + +. From a selection list, click Actions ~> Create Purchase Order. +. A pop up box will appear. +. Select the ordering agency from the drop down menu. +. Enter the provider. +. Check the box adjacent to prepayment required if prepayment is required. +. Choose if you will add All Lineitems or Selected Lineitems to your purchase order. +. Check the box if you want to Import Bibs and Create Copies in the catalog. +. Click Submit. + +Brief Records +~~~~~~~~~~~~~ + +Brief records are short bibliographic records with minimal information that are often used as placeholder records until items are received. Brief records can be added to selection lists or purchase orders and can be imported into the catalog. You can add brief records to new or existing selection lists. You can add brief records to new, pending or on~order purchase orders. + +Add brief records to a selection list +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +. Click Acquisitions -> New Brief Record. You can also add brief records to an existing selection list by clicking the Actions menu on the selection list and choosing Add Brief Record. +. Choose a selection list from the drop down menu, or enter the name of a new selection list. +. Enter bibliographic information in the desired fields. +. Click Save Record. + +image::media/acq_brief_record.png[] + +Add brief records to purchase orders +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can add brief records to new or existing purchase orders. + +. Open or create a purchase order. See the section on link:03~PO.txt[purchase orders] for more information. +. Click Add Brief Record. +. Enter bibliographic information in the desired fields. Notice that the record is added to the purchase order that you just created. +. Click Save Record. + +image::media/acq_brief_record-2.png[] + +MARC Federated Search +~~~~~~~~~~~~~~~~~~~~~ + +The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source. + +. Click Acquisitions -> MARC Federated Search. +. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit. ++ +---- +image::media/acq_marc_search.png[search form] +---- ++ +. A list of results will appear. Click the "Copies" link to add copy information to the line item. See the link:line_items.txt[section on Line Items] for more information. +. Click the Notes link to add notes or line item alerts to the line item. See the link:line_items.txt[section on Line Items] for more information. +. Enter a price in the "Estimated Price" field. +. You can save the line item(s) to a selection list by checking the box on the line item and clicking Actions -> Save Items to Selection List. You can also create a purchase order from the line item(s) by checking the box on the line item and clicking Actions ~> Create Purchase Order. + +image::media/acq_marc_search-2.png[line item] diff --git a/docs/acquisitions/vandelay_acquisitions_integration.txt b/docs/acquisitions/vandelay_acquisitions_integration.txt index 51fc2fa472..026d131a77 100644 --- a/docs/acquisitions/vandelay_acquisitions_integration.txt +++ b/docs/acquisitions/vandelay_acquisitions_integration.txt @@ -1,69 +1,69 @@ -Vandelay Integration into Acquisitions --------------------------------------- -The Acquisitions Load MARC Order Record interface enables you to add MARC records to selection lists and purchase orders and upload the records into the catalog. The Vandelay interface enables you to create specific match points between incoming MARC records and exisiting catalog records. Combining these two features enables you to track on order MARC records through the Acquisitions interface and to utilize the record matching mechanisms available in Vandelay. - -The purpose of this documentation is to describe the interaction between Vandelay and the Acquisitions MARC Batch Upload interface. For detailed instructions on - using the Acquisitions MARC Batch Upload interface, see the Evergreen Documentation Interest Group's Book of Evergreen, 2.1 documentation, Chapter 5, Load MARC -Order Records. For detailed instructions on using the Vandelay functions for record matching and importing, see the Evergreen Documentation Interest Group's Book of Evergreen, -2.2 documentation, Chapter 7, Batch Importing MARC Records. - -*Use Cases for Vandelay Integration into Acquisitions* - -You can add items to a selection list or purchase order and ignore the Vandelay options, or you can use both acquisitions and cataloging functions. In these examples, you will use both functions. - -Example 1: Using the Acquisitions MARC Batch Load interface, upload MARC records to a selection list and a Vandelay queue, and match queued records with existing catalog records. - -In this example, an acquisitions librarian has received a batch of MARC records from a vendor. She will add the records to a selection list and a Vandelay record queue. -A cataloger will later view the queue, edit the records, and import them into the catalog. - -. Click *Acquisitions -> Load MARC Order Records* -. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired. -. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill. -. Select a *Context Org Unit* from the drop down menu, or begin typing the code for the context org unit, and the field will auto-fill. -. Select a *Selection List* from the drop down menu, or begin typing the name of the selection list. You can create a new list, or the field will auto-fill. -. Create a new record queue in Vandelay, or upload the records to an existing queue. -. Select a *Record Match Set*. -. Browse your computer to find the MARC file, and click *Upload*. -+ -image::media/Vandelay_Integration_into_Acquisitions1.jpg[Vandelay_Integration_into_Acquisitions1] -+ -. The processed items appear at the bottom of the screen. -+ -image::media/Vandelay_Integration_into_Acquisitions2.jpg[Vandelay_Integration_into_Acquisitions2] -. You can click the link(s) to access the selection list or the import queue. Click the link to *View Selection List*. -. Look at the first line item. The line item has not yet been linked to the catalog, but it is linked to a Vandelay record queue. Click the link to the *queue* to examine the MARC record. -+ -image::media/Vandelay_Integration_into_Acquisitions3.jpg[Vandelay_Integration_into_Acquisitions3] -. The Vandelay interface opens in a new tab. The bibliographic records appear in the queue. Records that have matches are identified in the queue. You can edit these records and/or import them into the catalog, completing the process. - -image::media/Vandelay_Integration_into_Acquisitions4.jpg[Vandelay_Integration_into_Acquisitions4] - -Example 2: Using the Acquisitions MARC Batch Load interface, upload MARC records to a selection list, and use the Vandelay options to import the records directly into the catalog. The Vandelay options will enable you to match incoming records with existing catalog records. - -In this example, a librarian will add MARC records to a selection list, create criteria for matching incoming and existing records, and import the matching and non-matching records into the catalog. - -. Click *Acquisitions* -> *Load MARC Order Records* -. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired. -. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill. -. Select a *Context Org Unit* from the drop down menu, or begin typing the code for the context org unit, and the field will auto-fill. -. Select a *Selection List* from the drop down menu, or begin typing the name of the selection list. You can create a new list, or the field will auto-fill. -. Create a new record queue in Vandelay, or upload the records to an existing queue. -. Select a *Record Match Set*. -. Select *Merge Profile* -> *Match-Only Merge*. -. Check the box adjacent to *Merge on Best Match*. -. Browse your computer to find the MARC file, and click *Upload*. -+ -image::media/Vandelay_Integration_into_Acquisitions5.jpg[Vandelay_Integration_into_Acquisitions5] -+ -. Click the link to *View Selection List* Line items that do not match existing catalog records on title and ISBN contain the link, *link to catalog*. This link indicates that you could link the line item to a catalog record, but currently, no match exists between the line item and catalog records. Line items that do have matching records in the catalog contain the link, *catalog*. -+ -image::/media/Vandelay_Integration_into_Acquisitions6.jpg[Vandelay_Integration_into_Acquisitions6] -+ -. Click the *catalog* link to view the line item in the catalog. - -*Permissions to use this Feature* - -IMPORT_MARC - Using Vandelay to create new bib records now requres the IMPORT_MARC -permission (same as open-ils.cat.biblio.record.xml.import). If the permission fails, the queued record will fail import and be stamped with a new "import.record.perm_failure" vandelay import error - -IMPORT_ACQ_LINEITEM_BIB_RECORD_UPLOAD - This allows interfaces leveraging Vandelay, such as Acquisitions, to create a higher barrier to entry. This permission prevents users from creating new bib records directly from the ACQ vendor MARC file upload interface. +Vandelay Integration into Acquisitions +-------------------------------------- +The Acquisitions Load MARC Order Record interface enables you to add MARC records to selection lists and purchase orders and upload the records into the catalog. The Vandelay interface enables you to create specific match points between incoming MARC records and exisiting catalog records. Combining these two features enables you to track on order MARC records through the Acquisitions interface and to utilize the record matching mechanisms available in Vandelay. + +The purpose of this documentation is to describe the interaction between Vandelay and the Acquisitions MARC Batch Upload interface. For detailed instructions on + using the Acquisitions MARC Batch Upload interface, see the Evergreen Documentation Interest Group's Book of Evergreen, 2.1 documentation, Chapter 5, Load MARC +Order Records. For detailed instructions on using the Vandelay functions for record matching and importing, see the Evergreen Documentation Interest Group's Book of Evergreen, +2.2 documentation, Chapter 7, Batch Importing MARC Records. + +*Use Cases for Vandelay Integration into Acquisitions* + +You can add items to a selection list or purchase order and ignore the Vandelay options, or you can use both acquisitions and cataloging functions. In these examples, you will use both functions. + +Example 1: Using the Acquisitions MARC Batch Load interface, upload MARC records to a selection list and a Vandelay queue, and match queued records with existing catalog records. + +In this example, an acquisitions librarian has received a batch of MARC records from a vendor. She will add the records to a selection list and a Vandelay record queue. +A cataloger will later view the queue, edit the records, and import them into the catalog. + +. Click *Acquisitions -> Load MARC Order Records* +. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired. +. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill. +. Select a *Context Org Unit* from the drop down menu, or begin typing the code for the context org unit, and the field will auto-fill. +. Select a *Selection List* from the drop down menu, or begin typing the name of the selection list. You can create a new list, or the field will auto-fill. +. Create a new record queue in Vandelay, or upload the records to an existing queue. +. Select a *Record Match Set*. +. Browse your computer to find the MARC file, and click *Upload*. ++ +image::media/Vandelay_Integration_into_Acquisitions1.jpg[Vandelay_Integration_into_Acquisitions1] ++ +. The processed items appear at the bottom of the screen. ++ +image::media/Vandelay_Integration_into_Acquisitions2.jpg[Vandelay_Integration_into_Acquisitions2] +. You can click the link(s) to access the selection list or the import queue. Click the link to *View Selection List*. +. Look at the first line item. The line item has not yet been linked to the catalog, but it is linked to a Vandelay record queue. Click the link to the *queue* to examine the MARC record. ++ +image::media/Vandelay_Integration_into_Acquisitions3.jpg[Vandelay_Integration_into_Acquisitions3] +. The Vandelay interface opens in a new tab. The bibliographic records appear in the queue. Records that have matches are identified in the queue. You can edit these records and/or import them into the catalog, completing the process. + +image::media/Vandelay_Integration_into_Acquisitions4.jpg[Vandelay_Integration_into_Acquisitions4] + +Example 2: Using the Acquisitions MARC Batch Load interface, upload MARC records to a selection list, and use the Vandelay options to import the records directly into the catalog. The Vandelay options will enable you to match incoming records with existing catalog records. + +In this example, a librarian will add MARC records to a selection list, create criteria for matching incoming and existing records, and import the matching and non-matching records into the catalog. + +. Click *Acquisitions* -> *Load MARC Order Records* +. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired. +. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill. +. Select a *Context Org Unit* from the drop down menu, or begin typing the code for the context org unit, and the field will auto-fill. +. Select a *Selection List* from the drop down menu, or begin typing the name of the selection list. You can create a new list, or the field will auto-fill. +. Create a new record queue in Vandelay, or upload the records to an existing queue. +. Select a *Record Match Set*. +. Select *Merge Profile* -> *Match-Only Merge*. +. Check the box adjacent to *Merge on Best Match*. +. Browse your computer to find the MARC file, and click *Upload*. ++ +image::media/Vandelay_Integration_into_Acquisitions5.jpg[Vandelay_Integration_into_Acquisitions5] ++ +. Click the link to *View Selection List* Line items that do not match existing catalog records on title and ISBN contain the link, *link to catalog*. This link indicates that you could link the line item to a catalog record, but currently, no match exists between the line item and catalog records. Line items that do have matching records in the catalog contain the link, *catalog*. ++ +image::/media/Vandelay_Integration_into_Acquisitions6.jpg[Vandelay_Integration_into_Acquisitions6] ++ +. Click the *catalog* link to view the line item in the catalog. + +*Permissions to use this Feature* + +IMPORT_MARC - Using Vandelay to create new bib records now requres the IMPORT_MARC +permission (same as open-ils.cat.biblio.record.xml.import). If the permission fails, the queued record will fail import and be stamped with a new "import.record.perm_failure" vandelay import error + +IMPORT_ACQ_LINEITEM_BIB_RECORD_UPLOAD - This allows interfaces leveraging Vandelay, such as Acquisitions, to create a higher barrier to entry. This permission prevents users from creating new bib records directly from the ACQ vendor MARC file upload interface. diff --git a/docs/admin/acquisitions_admin.txt b/docs/admin/acquisitions_admin.txt index 30db442d5a..8f96bcf390 100644 --- a/docs/admin/acquisitions_admin.txt +++ b/docs/admin/acquisitions_admin.txt @@ -1,490 +1,490 @@ -Acquisitions Administration ---------------------------- - -Acquisitions Permissions in the Admin module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Several setting in the Library Settings area of the Admin module pertain to functions in the Acquisitions module. You can access these settings by clicking _Admin -> Local Administration ->Library Settings Editor_. - -* CAT: Delete bib if all copies are deleted via Acquisitions lineitem cancellation - If you cancel a line item, then all of the on order copies in the catalog are deleted. If, when you cancel a line item, you also want to delete the bib record, then set this setting to TRUE. -* Default circulation modifier - This modifier would be applied to items that are created in the acquisitions module -* Default copy location - This copy location would be applied to items that are created in the acquisitions module -* Fund Spending Limit for Block - When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will be blocked. -* Fund Spending Limit for Warning - When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will result in a warning to the staff. -* Temporary barcode prefix - Temporary barcode prefix for items that are created in the acquisitions module -* Temporary call number prefix - Temporary call number prefix for items that are created in the acquisitions module - -Cancel/Suspend reasons -~~~~~~~~~~~~~~~~~~~~~~ - -The Cancel reasons link enables you to predefine the reasons for which a line item or a PO can be cancelled. A default list of reasons appears, but you can add custom reasons to this list. Applying the cancel reason will prevent the item from appearing in a claims list and will allow you to cancel debits associated with the purchase. Cancel reasons also enable you to suspend or delay a purchase. For example, you could create a cancel reason of 'back ordered,' and you could choose to keep the debits associated with the purchase. - -Create a cancel/suspend reason -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -. To add a new cancel reason, click _Administration -> Server Administration -> Acquisitions -> Cancel reasons_. - -. Click _New Cancel Reason_. - -. Select a using library from the drop down menu. The using library indicates the organizational units whose staff can use this cancel reason. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units.) - -. Create a label for the cancel reason. This label will appear when you select a cancel reason on an item or a PO. - -. Create a description of the cancel reason. This is a free text field and can be comprised of any text of your choosing. - -. If you want to retain the debits associated with the cancelled purchase, click the box adjacent to Keep Debits-> - -. Click _Save_. - -Claiming -~~~~~~~~ -Currently, all claiming is manual, but the admin module enables you to build claim policies and specify the action(s) that users should take to claim items. - -Create a claim policy -^^^^^^^^^^^^^^^^^^^^^ - -The claim policy link enables you to name the claim policy and specify the organization that owns it. - -. To create a claim policy, click _Admin -> Server Administration -> Acquisitions -> Claim Policies_. -. Create a claim policy name. No limits exist on the number of characters that can be entered in this field. -. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this claim policy. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. Enter a description. No limits exist on the number of characters that can be entered in this field. -. Click _Save_. - -Create a claim type -^^^^^^^^^^^^^^^^^^^ - -The claim type link enables you to specify the reason for a type of claim. - -. To create a claim type, click _Admin -> Server Administration -> Acquisitions -> Claim types_. -. Create a claim type. No limits exist on the number of characters that can be entered in this field. -. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this claim type. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. Enter a description. No limits exist on the number of characters that can be entered in this field. -. Click _Save_. - -Create a claim event type -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The claim event type describes the physical action that should occur when an item needs to be claimed. For example, the user should notify the vendor via email that the library is claiming an item. - -. To access the claim event types, click _Admin -> Server Administration -> Acquisitions ->Claim event type_. -. Enter a code for the claim event type. No limits exist on the number of characters that can be entered in this field. -. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this event type. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. Enter a description. No limits exist on the number of characters that can be entered in this field. -. If this claim is initiated by the user, then check the box adjacent to Library Initiated. -+ -[NOTE] -Currently, all claims are initiated by a user. The ILS cannot automatically claim an issue. -+ -. Click _Save_. - -Create a claim policy action -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The claim policy action enables you to specify how long a user should wait before claiming the item. - -. To access claim policy actions, click _Admin -> Server Administration -> Acquisitions ->Claim Policy Actions_. - -. Select an Action (Event Type) from the drop down menu. - -. Enter an action interval. This field indicates how long a user should wait before claiming the item. - -. In the Claim Policy ID field, select a claim policy from the drop down menu. - -. Click _Save_. - -[NOTE] -You can create claim cycles by adding multiple claim policy actions to a claim policy. - -Currency Types -~~~~~~~~~~~~~~ - -Currency types can be created and applied to funds in the administrative module. When a fund is applied to a copy or line item for purchase, the item will be purchased in the currency associated with that fund. - -Create a currency type -^^^^^^^^^^^^^^^^^^^^^^ - -. To create a new currency type, click _Admin -> Server Administration -> Acquisitions -> Currency types_. - -. Enter the currency code. No limits exist on the number of characters that can be entered in this field. - -. Enter the name of the currency type in Currency Label field. No limits exist on the number of characters that can be entered in this field. - -. Click Save. - -Edit a currency type -^^^^^^^^^^^^^^^^^^^^ - -. To edit a currency type, click your cursor in the row that you want to edit. The row will turn blue. - -. Double~click. The pop~up box will appear, and you can edit the fields. - -. After making changes, click Save. - -[NOTE] -From the currency types interface, you can delete currencies that have never been applied to funds or used to make purchases. - -Distribution Formulas -~~~~~~~~~~~~~~~~~~~~~ - -Distribution formulas allow you to specify the number of copies that should be distributed to specific branches. You can create and reuse formulas as needed. - -Create a distribution formula -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -. Click _Admin -> Server Administration -> Acquisitions ->Distribution Formulas_. -. Click _New Formula_. -. Enter a Formula Name. No limits exist on the number of characters that can be entered in this field. -. Choose a Formula Owner from the drop down menu. The Formula Owner indicates the organizational units whose staff can use this formula. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. Ignore the Skip Count field which is currently not used. -. Click _Save_. -. Click _New Entry_. -. Select an Owning Library from the drop down menu. This indicates the branch that will receive the items. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See _Admin -> Server Administration -> Organizational Units_). -. Select a Shelving Location from the drop down menu. -. In the Item Count field, enter the number of items that should be distributed to the branch. You can enter the number or use the arrows on the right side of the field. -. Click _Apply Changes_. The screen will reload. -. To view the changes to your formula, click Admin -> Server Administration -> Acquisitions -> Distribution Formulas. The item_count will reflect the entries to your distribution formula. - -[NOTE] -To edit the Formula Name, click the hyperlinked name of the formula in the top left corner. A pop up box will enable you to enter a new formula name. - -Edit a distribution formula -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To edit a distribution formula, click the hyperlinked title of the formula. - -EDI -~~~ -Many libraries use Electronic Data Interchange (EDI) accounts to order new acquisitions. Users can set up EDI accounts and manage EDI messages in the admin module. EDI messages and notes can be viewed in the acquisitions module. See also the link:../installation/edi_setup.txt[EDI Installation Instructions] because this is required for use of EDI. - -The following fields are required to create an EDI account: - -[NOTE] -host, username, password, path, and incoming directory. - -EDI Accounts -^^^^^^^^^^^^ - -Create EDI Accounts to communicate electronically with providers. - -. Create a label. The label allows you to differentiate between accounts for the same provider. No limits exist on the number of characters that can be entered in this field. -. Enter a host. Your provider will provide you with the requisite FTP or SCP information. -. Enter the username that has been supplied by your provider. -. Enter the password that has been supplied by your provider. -. Enter account information. This field enables you to add a supplemental password for entry to a remote system after log in has been completed. This field is optional for the ILS but may be required by your provider. -. Select an owner from the drop down menu. The owner indicates the organizational units whose staff can use this EDI account. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. The Last Activity updates automatically with any inbound or outbound communication. -. Select a provider from the drop down menu to whom this account belongs. -. Enter a path. The path indicates the remote location on the server from which files are pulled in to the ILS. -. Enter the incoming directory. This directory indicates the location on your local network to which the files download. -. Enter the vendor account number supplied by your provider. -. Enter the vendor account code supplied by your provider. -. Click Save. - -EDI Messages -^^^^^^^^^^^^ - -The EDI messages screen displays all incoming and outgoing messages between the library and the vendor. - -Exchange Rates -~~~~~~~~~~~~~~ - -Exchange rates define the rate of exchange between currencies. Evergreen will automatically calculate exchange rates for purchases. Evergreen assumes that the currency of the purchasing fund is identical to the currency of the provider, but it provides for two unique situations: If the currency of the fund that is used for the purchase is different from the currency of the provider as listed in the provider profile, then Evergreen will use the exchange rate to calculate the price of the item in the currency of the fund and debit the fund accordingly. When money is transferred between funds that use different currency types, Evergreen will automatically use the exchange rate to convert the money to the currency of the receiving fund. During such transfers, however, staff can override the automatic conversion by providing an explicit amount to credit to the receiving fund. - -Create an exchange rate -^^^^^^^^^^^^^^^^^^^^^^^ - -. To create a new exchange rate, click _Admin -> Server Administration -> Acquisitions -> Exchange Rates_. - -. Click New Exchange Rate. - -. Enter the From Currency from the drop down menu populated by the currency types. - -. Enter the To Currency from the drop down menu populated by the currency types. - -. Enter the exchange Ratio. - -. Click _Save_. - -Edit an Exchange Rate -^^^^^^^^^^^^^^^^^^^^^ - -Edit an exchange rate just as you would edit a currency type. - -MARC Federated Search -~~~~~~~~~~~~~~~~~~~~~ - -The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source. - -. Click _Acquisitions -> MARC Federated Search_. -. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit. -+ -image::media/acq_marc_search.png[search form] -+ -. A list of results will appear. Click the _Copies_ link to add copy information to the line item. See the link:line_items.txt[section on Line Items] for more information. -. Click the Notes link to add notes or line item alerts to the line item. See the link:line_items.txt[section on Line Items] for more information. -. Enter a price in the _Estimated Price_ field. -. You can save the line item(s) to a selection list by checking the box on the line item and clicking _Actions -> Save Items to Selection List_. You can also create a purchase order from the line item(s) by checking the box on the line item and clicking _Actions -> Create Purchase Order_. - -image::media/acq_marc_search-2.png[line item] - -Fund Tags -~~~~~~~~~ - -You can apply tags to funds so that you can group funds for easy reporting. For example, you have three funds for children's materials: Children's Board Books, Children's DVDs, and Children's CDs. Assign a fund tag of 'children's' to each fund. When you need to report on the amount that has been spent on all children's materials, you can run a report on the fund tag to find total expenditures on children's materials rather than reporting on each individual fund. - -Create a Fund Tag - -. To create a fund tag, click _Admin -> Server Administration -> Acquisitions -> Fund Tags_. -. Click _New Fund Tag_. No limits exist on the number of characters that can be entered in this field. -. Select a Fund Tag Owner from the drop down menu. The owner indicates the organizational unit(s) whose staff can use this fund tag. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. -+ -. Enter a Fund Tag Name. No limits exist on the number of characters that can be entered in this field. -. Click _Save_. - -Funding Sources -~~~~~~~~~~~~~~~ - -Funding sources allow you to specify the sources that contribute monies to your fund(s). You can create as few or as many funding sources as you need. These can be used to track exact amounts for accounts in your general ledger. You can then use funds to track spending and purchases for specific collections. - -Create a funding source -^^^^^^^^^^^^^^^^^^^^^^^ - -. To create a new funding source, click _Admin -> Server Administration -> Acquisitions -> Funding Source_. -. Enter a funding source name. No limits exist on the number of characters that can be entered in this field. -. Select an owner from the drop down menu. The owner indicates the organizational unit(s) whose staff can use this funding source. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. For example, if a system is made the owner of a funding source, then users with appropriate permissions at the branches within the system could also use the funding source. -+ -. Create a code for the source. No limits exist on the number of characters that can be entered in this field. -. Select a currency from the drop down menu. This menu is populated from the choices in the Currency Types interface. -. Click _Save_. - -Allocate Credits to Funding Sources -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -. Apply a credit to this funding source. - -. Enter the amount of money that the funding source contributes to the organization. Funding sources are not tied to fiscal or calendar years, so you can continue to add money to the same funding source over multiple years, e.g. County Funding. Alternatively, you can name funding sources by year, e.g. County Funding 2010 and County Funding 2011, and apply credits each year to the matching source. - -. To apply a credit, click on the hyperlinked name of the funding source. The Funding Source Details will appear. - -. Click _Apply Credit_. - -. Enter an amount to apply to this funding source. - -. Enter a note. This field is optional. - -. Click _Apply_. - -Allocate credits to funds -^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you have already set up your funds, then you can then click the Allocate to Fund button to apply credits from the funding sources to the funds. If you have not yet set up your funds, or you need to add a new one, you can allocate credits to funds from the funds interface. See section 1.2 for more information. - -. To allocate credits to funds, click _Allocate to Fund_. - -. Enter the amount that you want to allocate. - -. Enter a note. This field is optional. - -. Click _Apply_. - -Track Debits and Credits -^^^^^^^^^^^^^^^^^^^^^^^^ - -You can track credits to and allocations from each funding source. These amounts are updated when credits and allocations are made in the Funding Source Details. Access the Funding Source Details by clicking on the hyperlinked name of the Funding Source. - -Funds -~~~~~ - -Funds allow you to allocate credits toward specific purchases. In the funds interface, you can create funds; allocate credits from funding sources to funds; transfer money between funds; and apply fund tags to funds. Funds are created for a specific year, either fiscal or calendar. These funds are owned by org units. At the top of the funds interface, you can set a contextual org unit and year. The drop down menu at the top of the screen enables you to focus on funds that are owned by specific organizational units during specific years. - -Create a fund -^^^^^^^^^^^^^ - -. To create a new fund, click _Admin -> Server Administration -> Acquisitions -> Funds_. -. Enter a name for the fund. No limits exist on the number of characters that can be entered in this field. -. Create a code for the fund. No limits exist on the number of characters that can be entered in this field. -. Enter a year for the fund. This can be a fiscal year or a calendar year. The format of the year is YYYY. -. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this fund. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). -+ -[NOTE] -The rule of parental inheritance applies to this list. See section -+ -. Select a currency type from the drop down menu. This menu is comprised of entries in the currency types menu. When a fund is applied to a line item or copy, the price of the item will be encumbered in the currency associated with the fund. -. Click the Active box to activate this fund. You cannot make purchases from this fund if it is not active. -. Enter a Balance Stop Percent. The balance stop percent prevents you from making purchases when only a specified amount of the fund remains. For example, if you want to spend 95 percent of your funds, leaving a five percent balance in the fund, then you would enter 95 in the field. When the fund reaches its balance stop percent, it will appear in red when you apply funds to copies. -. Enter a Balance Warning Percent. The balance warning percent gives you a warning that the fund is low. You can specify any percent. For example, if you want to spend 90 percent of your funds and be warned when the fund has only 10 percent of its balance remaining, then enter 90 in the field. When the fund reaches its balance warning percent, it will appear in yellow when you apply funds to copies. -. Check the Propagate box to propagate funds. When you propagate a fund, the ILS will create a new fund for the following fiscal year with the same parameters as your current fund. All of the settings transfer except for the year and the amount of money in the fund. Propagation occurs during the fiscal year close~out operation. -. Check the Rollover box if you want to roll over remaining funds into the same fund next year. -. Click _Save_. - -Allocate Credits from Funding Sources to Funds -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Credits can be applied to funds from funding sources using the fund interface. The credits that you apply to the fund can be applied later to purchases. - -. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_. - -. Click the hyperlinked name of the fund. - -. To add a credit to the fund, click the Create Allocation tab. - -. Choose a Funding Source from the drop down menu. - -. Enter an amount that you want to apply to the fund from the funding source. - -. Enter a note. This field is optional. - -. Click _Apply_. - -Transfer credits between funds -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The credits that you allocate to funds can be transferred between funds if desired. In the following example, you can transfer $500.00 from the Young Adult Fiction fund to the Children's DVD fund. - -. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_. - -. Click the hyperlinked name of the originating fund. - -. The Fund Details screen appears. Click Transfer Money. - -. Enter the amount that you would like to transfer. - -. From the drop down menu, select the destination fund. - -. Add a note. This field is optional. - -. Click _Transfer_. - -Track Balances and Expenditures -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The Fund Details allows you to track the fund's balance, encumbrances, and amount spent. It also allows you to track allocations from the funding source(s), debits, and fund tags. - -. To access the fund details, click on the hyperlinked name of the fund that you created. - -. The Summary allows you to track the following: - -. Balance - The balance is calculated by subtracting both items that have been invoiced and encumbrances from the total allocated to the fund. -. Total Allocated - This amount is the total amount allocated from the Funding Source. -. Spent Balance - This balance is calculated by subtracting only the items that have been invoiced from the total allocated to the fund. It does not include encumbrances. -. Total Debits - The total debits are calculated by adding the cost of items that have been invoiced and encumbrances. -. Total Spent - The total spent is calculated by adding the cost of items that have been invoiced. It does not include encumbrances. -. Total Encumbered - The total encumbered is calculated by adding all encumbrances. - -Edit a Fund -^^^^^^^^^^^ - -Edit a fund just as you would edit a currency type. - -Perform Year End Closeout Operation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The Year End Closeout Operation allows you to deactivate funds for the current year and create analogous funds for the next year. It transfers encumbrances to the analogous funds, and it rolls over any remaining funds if you checked the rollover box when creating the fund. - -. To access the year end closeout of a fund, click Admin -> Server Administration -> Acquisitions -> Funds. - -. Click _Fund Propagation and Rollover_. - -. Check the box adjacent to _Perform Fiscal Year Close~Out Operation_. - -. Notice that the context org unit reflects the context org unit that you selected at the top of the Funds screen. - -. If you want to perform the close~out operation on the context org unit and its child units, then check the box adjacent to Include Funds for Descendant Org Units. - -. Check the box adjacent to dry run if you want to test changes to the funds before they are enacted. Evergreen will generate a summary of the changes that would occur during the selected operations. No data will be changed. - -. Click _Process_. - -. Evergreen will begin the propagation process. Evergreen will make a clone of each fund, but it will increment the year by . - -Invoice menus -~~~~~~~~~~~~~ - -Invoice menus allow you to create drop down menus that appear on invoices. You can create an invoice item type or invoice payment method. - -Invoice item type -^^^^^^^^^^^^^^^^^ - -The invoice item type allows you to enter the types of additional charges that you can add to an invoice. Examples of additional charge types might include taxes or processing fees. Charges for bibliographic items are listed separately from these additional charges. A default list of charge types displays, but you can add custom charge types to this list. Invoice item types can also be used when adding non~bibliographic items to a purchase order. When invoiced, the invoice item type will copy from the purchase order to the invoice. - -. To create a new charge type, click _Admin -> Server Administration -> Acquisitions -> Invoice Item Type_. - -. Click _New Invoice Item Type_. - -. Create a code for the charge type. No limits exist on the number of characters that can be entered in this field. - -. Create a label. No limits exist on the number of characters that can be entered in this field. The text in this field appears in the drop down menu on the invoice. - -. If items on the invoice were purchased with the monies in multiple funds, then you can divide the additional charge across funds. Check the box adjacent to Prorate-> if you want to prorate the charge across funds. - -. Click _Save_. - -Invoice payment method -^^^^^^^^^^^^^^^^^^^^^^ - -The invoice payment method allows you to predefine the type(s) of invoices and payment method(s) that you accept. The text that you enter in the admin module will appear as a drop down menu in the invoice type and payment method fields on the invoice. - -. To create a new invoice payment method, click _Admin -> Server Administration -> Acquisitions -> Invoice Payment Method_. - -. Click _New Invoice Payment Method_. - -. Create a code for the invoice payment method. No limits exist on the number of characters that can be entered in this field. - -. Create a name for the invoice payment method. No limits exist on the number of characters that can be entered in this field. The text in this field appears in the drop down menu on the invoice. - -. Click _Save_. - -Payment methods can be deleted from this screen. - -Line item features -~~~~~~~~~~~~~~~~~~ - -Line item alerts are predefined text that can be added to line items that are on selection lists or purchase orders. You can define the alerts from which staff can choose. Line item alerts appear in a pop up box when the line item, or any of its copies, are marked as received. - -Create a line item alert -^^^^^^^^^^^^^^^^^^^^^^^^ - -. To create a line item alert, click _Administration -> Server Administration -> Acquisitions -> Line Item Alerts_. - -. Click _New Line Item Alert Text_. - -. Create a code for the text. No limits exist on the number of characters that can be entered in this field. - -. Create a description for the text. No limits exist on the number of characters that can be entered in this field. - -. Select an owning library from the drop down menu. The owning library indicates the organizational units whose staff can use this alert. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). - -. Click _Save_. - -Line Item MARC Attribute Definitions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Line item attributes define the fields that Evergreen needs to extract from the bibliographic records that are in the acquisitions database to display in the catalog. Also, these attributes will appear as fields in the New Brief Record interface. You will be able to enter information for the brief record in the fields where attributes have been defined. - +Acquisitions Administration +--------------------------- + +Acquisitions Permissions in the Admin module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Several setting in the Library Settings area of the Admin module pertain to functions in the Acquisitions module. You can access these settings by clicking _Admin -> Local Administration ->Library Settings Editor_. + +* CAT: Delete bib if all copies are deleted via Acquisitions lineitem cancellation - If you cancel a line item, then all of the on order copies in the catalog are deleted. If, when you cancel a line item, you also want to delete the bib record, then set this setting to TRUE. +* Default circulation modifier - This modifier would be applied to items that are created in the acquisitions module +* Default copy location - This copy location would be applied to items that are created in the acquisitions module +* Fund Spending Limit for Block - When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will be blocked. +* Fund Spending Limit for Warning - When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will result in a warning to the staff. +* Temporary barcode prefix - Temporary barcode prefix for items that are created in the acquisitions module +* Temporary call number prefix - Temporary call number prefix for items that are created in the acquisitions module + +Cancel/Suspend reasons +~~~~~~~~~~~~~~~~~~~~~~ + +The Cancel reasons link enables you to predefine the reasons for which a line item or a PO can be cancelled. A default list of reasons appears, but you can add custom reasons to this list. Applying the cancel reason will prevent the item from appearing in a claims list and will allow you to cancel debits associated with the purchase. Cancel reasons also enable you to suspend or delay a purchase. For example, you could create a cancel reason of 'back ordered,' and you could choose to keep the debits associated with the purchase. + +Create a cancel/suspend reason +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +. To add a new cancel reason, click _Administration -> Server Administration -> Acquisitions -> Cancel reasons_. + +. Click _New Cancel Reason_. + +. Select a using library from the drop down menu. The using library indicates the organizational units whose staff can use this cancel reason. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units.) + +. Create a label for the cancel reason. This label will appear when you select a cancel reason on an item or a PO. + +. Create a description of the cancel reason. This is a free text field and can be comprised of any text of your choosing. + +. If you want to retain the debits associated with the cancelled purchase, click the box adjacent to Keep Debits-> + +. Click _Save_. + +Claiming +~~~~~~~~ +Currently, all claiming is manual, but the admin module enables you to build claim policies and specify the action(s) that users should take to claim items. + +Create a claim policy +^^^^^^^^^^^^^^^^^^^^^ + +The claim policy link enables you to name the claim policy and specify the organization that owns it. + +. To create a claim policy, click _Admin -> Server Administration -> Acquisitions -> Claim Policies_. +. Create a claim policy name. No limits exist on the number of characters that can be entered in this field. +. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this claim policy. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. Enter a description. No limits exist on the number of characters that can be entered in this field. +. Click _Save_. + +Create a claim type +^^^^^^^^^^^^^^^^^^^ + +The claim type link enables you to specify the reason for a type of claim. + +. To create a claim type, click _Admin -> Server Administration -> Acquisitions -> Claim types_. +. Create a claim type. No limits exist on the number of characters that can be entered in this field. +. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this claim type. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. Enter a description. No limits exist on the number of characters that can be entered in this field. +. Click _Save_. + +Create a claim event type +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The claim event type describes the physical action that should occur when an item needs to be claimed. For example, the user should notify the vendor via email that the library is claiming an item. + +. To access the claim event types, click _Admin -> Server Administration -> Acquisitions ->Claim event type_. +. Enter a code for the claim event type. No limits exist on the number of characters that can be entered in this field. +. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this event type. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. Enter a description. No limits exist on the number of characters that can be entered in this field. +. If this claim is initiated by the user, then check the box adjacent to Library Initiated. ++ +[NOTE] +Currently, all claims are initiated by a user. The ILS cannot automatically claim an issue. ++ +. Click _Save_. + +Create a claim policy action +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The claim policy action enables you to specify how long a user should wait before claiming the item. + +. To access claim policy actions, click _Admin -> Server Administration -> Acquisitions ->Claim Policy Actions_. + +. Select an Action (Event Type) from the drop down menu. + +. Enter an action interval. This field indicates how long a user should wait before claiming the item. + +. In the Claim Policy ID field, select a claim policy from the drop down menu. + +. Click _Save_. + +[NOTE] +You can create claim cycles by adding multiple claim policy actions to a claim policy. + +Currency Types +~~~~~~~~~~~~~~ + +Currency types can be created and applied to funds in the administrative module. When a fund is applied to a copy or line item for purchase, the item will be purchased in the currency associated with that fund. + +Create a currency type +^^^^^^^^^^^^^^^^^^^^^^ + +. To create a new currency type, click _Admin -> Server Administration -> Acquisitions -> Currency types_. + +. Enter the currency code. No limits exist on the number of characters that can be entered in this field. + +. Enter the name of the currency type in Currency Label field. No limits exist on the number of characters that can be entered in this field. + +. Click Save. + +Edit a currency type +^^^^^^^^^^^^^^^^^^^^ + +. To edit a currency type, click your cursor in the row that you want to edit. The row will turn blue. + +. Double~click. The pop~up box will appear, and you can edit the fields. + +. After making changes, click Save. + +[NOTE] +From the currency types interface, you can delete currencies that have never been applied to funds or used to make purchases. + +Distribution Formulas +~~~~~~~~~~~~~~~~~~~~~ + +Distribution formulas allow you to specify the number of copies that should be distributed to specific branches. You can create and reuse formulas as needed. + +Create a distribution formula +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +. Click _Admin -> Server Administration -> Acquisitions ->Distribution Formulas_. +. Click _New Formula_. +. Enter a Formula Name. No limits exist on the number of characters that can be entered in this field. +. Choose a Formula Owner from the drop down menu. The Formula Owner indicates the organizational units whose staff can use this formula. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. Ignore the Skip Count field which is currently not used. +. Click _Save_. +. Click _New Entry_. +. Select an Owning Library from the drop down menu. This indicates the branch that will receive the items. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See _Admin -> Server Administration -> Organizational Units_). +. Select a Shelving Location from the drop down menu. +. In the Item Count field, enter the number of items that should be distributed to the branch. You can enter the number or use the arrows on the right side of the field. +. Click _Apply Changes_. The screen will reload. +. To view the changes to your formula, click Admin -> Server Administration -> Acquisitions -> Distribution Formulas. The item_count will reflect the entries to your distribution formula. + +[NOTE] +To edit the Formula Name, click the hyperlinked name of the formula in the top left corner. A pop up box will enable you to enter a new formula name. + +Edit a distribution formula +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To edit a distribution formula, click the hyperlinked title of the formula. + +EDI +~~~ +Many libraries use Electronic Data Interchange (EDI) accounts to order new acquisitions. Users can set up EDI accounts and manage EDI messages in the admin module. EDI messages and notes can be viewed in the acquisitions module. See also the link:../installation/edi_setup.txt[EDI Installation Instructions] because this is required for use of EDI. + +The following fields are required to create an EDI account: + +[NOTE] +host, username, password, path, and incoming directory. + +EDI Accounts +^^^^^^^^^^^^ + +Create EDI Accounts to communicate electronically with providers. + +. Create a label. The label allows you to differentiate between accounts for the same provider. No limits exist on the number of characters that can be entered in this field. +. Enter a host. Your provider will provide you with the requisite FTP or SCP information. +. Enter the username that has been supplied by your provider. +. Enter the password that has been supplied by your provider. +. Enter account information. This field enables you to add a supplemental password for entry to a remote system after log in has been completed. This field is optional for the ILS but may be required by your provider. +. Select an owner from the drop down menu. The owner indicates the organizational units whose staff can use this EDI account. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. The Last Activity updates automatically with any inbound or outbound communication. +. Select a provider from the drop down menu to whom this account belongs. +. Enter a path. The path indicates the remote location on the server from which files are pulled in to the ILS. +. Enter the incoming directory. This directory indicates the location on your local network to which the files download. +. Enter the vendor account number supplied by your provider. +. Enter the vendor account code supplied by your provider. +. Click Save. + +EDI Messages +^^^^^^^^^^^^ + +The EDI messages screen displays all incoming and outgoing messages between the library and the vendor. + +Exchange Rates +~~~~~~~~~~~~~~ + +Exchange rates define the rate of exchange between currencies. Evergreen will automatically calculate exchange rates for purchases. Evergreen assumes that the currency of the purchasing fund is identical to the currency of the provider, but it provides for two unique situations: If the currency of the fund that is used for the purchase is different from the currency of the provider as listed in the provider profile, then Evergreen will use the exchange rate to calculate the price of the item in the currency of the fund and debit the fund accordingly. When money is transferred between funds that use different currency types, Evergreen will automatically use the exchange rate to convert the money to the currency of the receiving fund. During such transfers, however, staff can override the automatic conversion by providing an explicit amount to credit to the receiving fund. + +Create an exchange rate +^^^^^^^^^^^^^^^^^^^^^^^ + +. To create a new exchange rate, click _Admin -> Server Administration -> Acquisitions -> Exchange Rates_. + +. Click New Exchange Rate. + +. Enter the From Currency from the drop down menu populated by the currency types. + +. Enter the To Currency from the drop down menu populated by the currency types. + +. Enter the exchange Ratio. + +. Click _Save_. + +Edit an Exchange Rate +^^^^^^^^^^^^^^^^^^^^^ + +Edit an exchange rate just as you would edit a currency type. + +MARC Federated Search +~~~~~~~~~~~~~~~~~~~~~ + +The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source. + +. Click _Acquisitions -> MARC Federated Search_. +. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit. ++ +image::media/acq_marc_search.png[search form] ++ +. A list of results will appear. Click the _Copies_ link to add copy information to the line item. See the link:line_items.txt[section on Line Items] for more information. +. Click the Notes link to add notes or line item alerts to the line item. See the link:line_items.txt[section on Line Items] for more information. +. Enter a price in the _Estimated Price_ field. +. You can save the line item(s) to a selection list by checking the box on the line item and clicking _Actions -> Save Items to Selection List_. You can also create a purchase order from the line item(s) by checking the box on the line item and clicking _Actions -> Create Purchase Order_. + +image::media/acq_marc_search-2.png[line item] + +Fund Tags +~~~~~~~~~ + +You can apply tags to funds so that you can group funds for easy reporting. For example, you have three funds for children's materials: Children's Board Books, Children's DVDs, and Children's CDs. Assign a fund tag of 'children's' to each fund. When you need to report on the amount that has been spent on all children's materials, you can run a report on the fund tag to find total expenditures on children's materials rather than reporting on each individual fund. + +Create a Fund Tag + +. To create a fund tag, click _Admin -> Server Administration -> Acquisitions -> Fund Tags_. +. Click _New Fund Tag_. No limits exist on the number of characters that can be entered in this field. +. Select a Fund Tag Owner from the drop down menu. The owner indicates the organizational unit(s) whose staff can use this fund tag. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. ++ +. Enter a Fund Tag Name. No limits exist on the number of characters that can be entered in this field. +. Click _Save_. + +Funding Sources +~~~~~~~~~~~~~~~ + +Funding sources allow you to specify the sources that contribute monies to your fund(s). You can create as few or as many funding sources as you need. These can be used to track exact amounts for accounts in your general ledger. You can then use funds to track spending and purchases for specific collections. + +Create a funding source +^^^^^^^^^^^^^^^^^^^^^^^ + +. To create a new funding source, click _Admin -> Server Administration -> Acquisitions -> Funding Source_. +. Enter a funding source name. No limits exist on the number of characters that can be entered in this field. +. Select an owner from the drop down menu. The owner indicates the organizational unit(s) whose staff can use this funding source. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. For example, if a system is made the owner of a funding source, then users with appropriate permissions at the branches within the system could also use the funding source. ++ +. Create a code for the source. No limits exist on the number of characters that can be entered in this field. +. Select a currency from the drop down menu. This menu is populated from the choices in the Currency Types interface. +. Click _Save_. + +Allocate Credits to Funding Sources +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +. Apply a credit to this funding source. + +. Enter the amount of money that the funding source contributes to the organization. Funding sources are not tied to fiscal or calendar years, so you can continue to add money to the same funding source over multiple years, e.g. County Funding. Alternatively, you can name funding sources by year, e.g. County Funding 2010 and County Funding 2011, and apply credits each year to the matching source. + +. To apply a credit, click on the hyperlinked name of the funding source. The Funding Source Details will appear. + +. Click _Apply Credit_. + +. Enter an amount to apply to this funding source. + +. Enter a note. This field is optional. + +. Click _Apply_. + +Allocate credits to funds +^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have already set up your funds, then you can then click the Allocate to Fund button to apply credits from the funding sources to the funds. If you have not yet set up your funds, or you need to add a new one, you can allocate credits to funds from the funds interface. See section 1.2 for more information. + +. To allocate credits to funds, click _Allocate to Fund_. + +. Enter the amount that you want to allocate. + +. Enter a note. This field is optional. + +. Click _Apply_. + +Track Debits and Credits +^^^^^^^^^^^^^^^^^^^^^^^^ + +You can track credits to and allocations from each funding source. These amounts are updated when credits and allocations are made in the Funding Source Details. Access the Funding Source Details by clicking on the hyperlinked name of the Funding Source. + +Funds +~~~~~ + +Funds allow you to allocate credits toward specific purchases. In the funds interface, you can create funds; allocate credits from funding sources to funds; transfer money between funds; and apply fund tags to funds. Funds are created for a specific year, either fiscal or calendar. These funds are owned by org units. At the top of the funds interface, you can set a contextual org unit and year. The drop down menu at the top of the screen enables you to focus on funds that are owned by specific organizational units during specific years. + +Create a fund +^^^^^^^^^^^^^ + +. To create a new fund, click _Admin -> Server Administration -> Acquisitions -> Funds_. +. Enter a name for the fund. No limits exist on the number of characters that can be entered in this field. +. Create a code for the fund. No limits exist on the number of characters that can be entered in this field. +. Enter a year for the fund. This can be a fiscal year or a calendar year. The format of the year is YYYY. +. Select an org unit from the drop down menu. The org unit indicates the organizational units whose staff can use this fund. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). ++ +[NOTE] +The rule of parental inheritance applies to this list. See section ++ +. Select a currency type from the drop down menu. This menu is comprised of entries in the currency types menu. When a fund is applied to a line item or copy, the price of the item will be encumbered in the currency associated with the fund. +. Click the Active box to activate this fund. You cannot make purchases from this fund if it is not active. +. Enter a Balance Stop Percent. The balance stop percent prevents you from making purchases when only a specified amount of the fund remains. For example, if you want to spend 95 percent of your funds, leaving a five percent balance in the fund, then you would enter 95 in the field. When the fund reaches its balance stop percent, it will appear in red when you apply funds to copies. +. Enter a Balance Warning Percent. The balance warning percent gives you a warning that the fund is low. You can specify any percent. For example, if you want to spend 90 percent of your funds and be warned when the fund has only 10 percent of its balance remaining, then enter 90 in the field. When the fund reaches its balance warning percent, it will appear in yellow when you apply funds to copies. +. Check the Propagate box to propagate funds. When you propagate a fund, the ILS will create a new fund for the following fiscal year with the same parameters as your current fund. All of the settings transfer except for the year and the amount of money in the fund. Propagation occurs during the fiscal year close~out operation. +. Check the Rollover box if you want to roll over remaining funds into the same fund next year. +. Click _Save_. + +Allocate Credits from Funding Sources to Funds +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Credits can be applied to funds from funding sources using the fund interface. The credits that you apply to the fund can be applied later to purchases. + +. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_. + +. Click the hyperlinked name of the fund. + +. To add a credit to the fund, click the Create Allocation tab. + +. Choose a Funding Source from the drop down menu. + +. Enter an amount that you want to apply to the fund from the funding source. + +. Enter a note. This field is optional. + +. Click _Apply_. + +Transfer credits between funds +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The credits that you allocate to funds can be transferred between funds if desired. In the following example, you can transfer $500.00 from the Young Adult Fiction fund to the Children's DVD fund. + +. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_. + +. Click the hyperlinked name of the originating fund. + +. The Fund Details screen appears. Click Transfer Money. + +. Enter the amount that you would like to transfer. + +. From the drop down menu, select the destination fund. + +. Add a note. This field is optional. + +. Click _Transfer_. + +Track Balances and Expenditures +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Fund Details allows you to track the fund's balance, encumbrances, and amount spent. It also allows you to track allocations from the funding source(s), debits, and fund tags. + +. To access the fund details, click on the hyperlinked name of the fund that you created. + +. The Summary allows you to track the following: + +. Balance - The balance is calculated by subtracting both items that have been invoiced and encumbrances from the total allocated to the fund. +. Total Allocated - This amount is the total amount allocated from the Funding Source. +. Spent Balance - This balance is calculated by subtracting only the items that have been invoiced from the total allocated to the fund. It does not include encumbrances. +. Total Debits - The total debits are calculated by adding the cost of items that have been invoiced and encumbrances. +. Total Spent - The total spent is calculated by adding the cost of items that have been invoiced. It does not include encumbrances. +. Total Encumbered - The total encumbered is calculated by adding all encumbrances. + +Edit a Fund +^^^^^^^^^^^ + +Edit a fund just as you would edit a currency type. + +Perform Year End Closeout Operation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Year End Closeout Operation allows you to deactivate funds for the current year and create analogous funds for the next year. It transfers encumbrances to the analogous funds, and it rolls over any remaining funds if you checked the rollover box when creating the fund. + +. To access the year end closeout of a fund, click Admin -> Server Administration -> Acquisitions -> Funds. + +. Click _Fund Propagation and Rollover_. + +. Check the box adjacent to _Perform Fiscal Year Close~Out Operation_. + +. Notice that the context org unit reflects the context org unit that you selected at the top of the Funds screen. + +. If you want to perform the close~out operation on the context org unit and its child units, then check the box adjacent to Include Funds for Descendant Org Units. + +. Check the box adjacent to dry run if you want to test changes to the funds before they are enacted. Evergreen will generate a summary of the changes that would occur during the selected operations. No data will be changed. + +. Click _Process_. + +. Evergreen will begin the propagation process. Evergreen will make a clone of each fund, but it will increment the year by . + +Invoice menus +~~~~~~~~~~~~~ + +Invoice menus allow you to create drop down menus that appear on invoices. You can create an invoice item type or invoice payment method. + +Invoice item type +^^^^^^^^^^^^^^^^^ + +The invoice item type allows you to enter the types of additional charges that you can add to an invoice. Examples of additional charge types might include taxes or processing fees. Charges for bibliographic items are listed separately from these additional charges. A default list of charge types displays, but you can add custom charge types to this list. Invoice item types can also be used when adding non~bibliographic items to a purchase order. When invoiced, the invoice item type will copy from the purchase order to the invoice. + +. To create a new charge type, click _Admin -> Server Administration -> Acquisitions -> Invoice Item Type_. + +. Click _New Invoice Item Type_. + +. Create a code for the charge type. No limits exist on the number of characters that can be entered in this field. + +. Create a label. No limits exist on the number of characters that can be entered in this field. The text in this field appears in the drop down menu on the invoice. + +. If items on the invoice were purchased with the monies in multiple funds, then you can divide the additional charge across funds. Check the box adjacent to Prorate-> if you want to prorate the charge across funds. + +. Click _Save_. + +Invoice payment method +^^^^^^^^^^^^^^^^^^^^^^ + +The invoice payment method allows you to predefine the type(s) of invoices and payment method(s) that you accept. The text that you enter in the admin module will appear as a drop down menu in the invoice type and payment method fields on the invoice. + +. To create a new invoice payment method, click _Admin -> Server Administration -> Acquisitions -> Invoice Payment Method_. + +. Click _New Invoice Payment Method_. + +. Create a code for the invoice payment method. No limits exist on the number of characters that can be entered in this field. + +. Create a name for the invoice payment method. No limits exist on the number of characters that can be entered in this field. The text in this field appears in the drop down menu on the invoice. + +. Click _Save_. + +Payment methods can be deleted from this screen. + +Line item features +~~~~~~~~~~~~~~~~~~ + +Line item alerts are predefined text that can be added to line items that are on selection lists or purchase orders. You can define the alerts from which staff can choose. Line item alerts appear in a pop up box when the line item, or any of its copies, are marked as received. + +Create a line item alert +^^^^^^^^^^^^^^^^^^^^^^^^ + +. To create a line item alert, click _Administration -> Server Administration -> Acquisitions -> Line Item Alerts_. + +. Click _New Line Item Alert Text_. + +. Create a code for the text. No limits exist on the number of characters that can be entered in this field. + +. Create a description for the text. No limits exist on the number of characters that can be entered in this field. + +. Select an owning library from the drop down menu. The owning library indicates the organizational units whose staff can use this alert. This menu is populated with the shortnames that you created for your libraries in the organizational units tree (See Admin -> Server Administration -> Organizational Units). + +. Click _Save_. + +Line Item MARC Attribute Definitions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Line item attributes define the fields that Evergreen needs to extract from the bibliographic records that are in the acquisitions database to display in the catalog. Also, these attributes will appear as fields in the New Brief Record interface. You will be able to enter information for the brief record in the fields where attributes have been defined. + diff --git a/docs/admin/auto_suggest_search.txt b/docs/admin/auto_suggest_search.txt index fc01215650..4a2dc6132f 100644 --- a/docs/admin/auto_suggest_search.txt +++ b/docs/admin/auto_suggest_search.txt @@ -1,32 +1,32 @@ -Auto Suggest in Catalog Search ------------------------------- - -The auto suggest feature suggestions for completing search terms as the user enters his search query. Ten suggestions are the default, but the number of suggestions is configurable at -the database level. Scroll through suggestions with your mouse, or use the arrow keys to scroll through the suggestions. Select a suggestion to view records that are linked to -this suggestion. This feature is not turned on by default. You must turn it on in the Admin module. - - -Enabling this Feature -~~~~~~~~~~~~~~~~~~~~~ - -. To enable this feature, click *Admin* -> *Server Administration* -> *Global Flags*. -. Scroll down to item 10, OPAC. -. Double click anywhere in the row to edit the fields. -. Check the box adjacent to *Enabled* to turn on the feature. -. The *Value* field is optional. If you checked *Enabled* in step 4, and you leave this field empty, then Evergreen will only suggest searches for which there are any corresponding MARC records. -+ -note: If you checked *Enabled* in step 4, and you enter the string, *opac_visible*, into this field, then Evergreen will suggest searches for which -there are matching MARC records with copies within your search scope. For example, it will suggest MARC records with copies at your branch. -+ -. Click *Save.* - -image::media/Auto_Suggest_in_Catalog_Search2.jpg[Auto_Suggest_in_Catalog_Search2] - -Using this Feature -~~~~~~~~~~~~~~~~~~ - -. Enter search terms into the basic search field. Evergreen will automatically suggest search terms. -. Select a suggestion to view records that are linked to this suggestion. - -image::media/Auto_Suggest_in_Catalog_Search1.jpg[Auto_Suggest_in_Catalog_Search1] - +Auto Suggest in Catalog Search +------------------------------ + +The auto suggest feature suggestions for completing search terms as the user enters his search query. Ten suggestions are the default, but the number of suggestions is configurable at +the database level. Scroll through suggestions with your mouse, or use the arrow keys to scroll through the suggestions. Select a suggestion to view records that are linked to +this suggestion. This feature is not turned on by default. You must turn it on in the Admin module. + + +Enabling this Feature +~~~~~~~~~~~~~~~~~~~~~ + +. To enable this feature, click *Admin* -> *Server Administration* -> *Global Flags*. +. Scroll down to item 10, OPAC. +. Double click anywhere in the row to edit the fields. +. Check the box adjacent to *Enabled* to turn on the feature. +. The *Value* field is optional. If you checked *Enabled* in step 4, and you leave this field empty, then Evergreen will only suggest searches for which there are any corresponding MARC records. ++ +note: If you checked *Enabled* in step 4, and you enter the string, *opac_visible*, into this field, then Evergreen will suggest searches for which +there are matching MARC records with copies within your search scope. For example, it will suggest MARC records with copies at your branch. ++ +. Click *Save.* + +image::media/Auto_Suggest_in_Catalog_Search2.jpg[Auto_Suggest_in_Catalog_Search2] + +Using this Feature +~~~~~~~~~~~~~~~~~~ + +. Enter search terms into the basic search field. Evergreen will automatically suggest search terms. +. Select a suggestion to view records that are linked to this suggestion. + +image::media/Auto_Suggest_in_Catalog_Search1.jpg[Auto_Suggest_in_Catalog_Search1] + diff --git a/docs/admin/booking-admin.txt b/docs/admin/booking-admin.txt index 5fc51e50b2..2a10980ffe 100644 --- a/docs/admin/booking-admin.txt +++ b/docs/admin/booking-admin.txt @@ -1,199 +1,199 @@ -Booking Module Administration ------------------------------ - -Creating Bookable Non-Bibliographic Resources -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms. - -The following pieces make up a non-bibliographic resource: - -* Resource Type -* Resource Attribute -* Resource Attribute Values -* Resource -* Resource Attribute Map - -You need to create resource types and resource attributes (features of the resource types), and add booking items (resources) to individual resource type. Each resource attribute may have multiple values. You need to link the applicable features (resource attributes and values) to individual item (resource) through the Resource Attribute Map. Before you create resources (booking items) you need to have a resource type and associated resource attributes and values, if any, for them. - -Create New Resource Type -^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Select Admin --> Server Administration --> Booking --> Resource Types. - -image::media/booking-create-resourcetype-1.png[] - -2) A list of current resource types will appear. Use Back and Next buttons to browse the whole list. - -image::media/booking-create-resourcetype-2.png[] - -[NOTE] -You may also see cataloged items in the list. Those items have been marked bookable or booked before. - - -3) To create a new resource type, click New Resource Type in the top right corner, . - -image::media/booking-create-resourcetype-3.png[] - -4) A box will appear in which you create your new type of resource. - -image::media/booking-create-bookable-1.png[] - -* Resource Type Name - Give your resource a name. -* Fine Interval - How often will fines be charged? This period can be input in several ways: - -[NOTE] -==================================================================== -** second(s), minute(s), hour(s), day(s), week(s), month(s), year(s) -** sec(s), min(s) -** s, m, h -** 00:00:30, 00:01:00, 01:00:00 -=================================================================== - -* Fine Amount - The amount that will be charged at each Fine Interval. -* Owning Library - The home library of the resource. -* Catalog Item - (Function not currently available.) -* Transferable - This allows the item to be transferred between libraries. -* Inter-booking and Inter-circulation Interval - The amount of time required by your library between the return of a resource and a new reservation for the resource. This interval uses * the same input conventions as the Fine Interval. -* Max Fine Amount - The amount at which fines will stop generating. - -5) Click Save when you have entered the needed information. - -image::media/booking-create-resourcetype-4.png[] - -6) The new resource type will appear in the list. - -image::media/booking-create-resourcetype-5.png[] - -Create New Resource Attribute -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Select Server Administration --> Booking --> Resource Attributes. - -2) Click New Resource Attribute in the top right corner. - -3) A box will appear in which you can add the attributes of the resource. Attributes are categories of descriptive information that are provided to the staff member when the booking request is made. For example, an attribute of a projector may be the type of projector. Other attributes might be the number of seats available in a room, or the computing platform of a laptop. - -image::media/booking-create-bookable-2.png[] - -* Resource Attribute Name - Give your attribute a name. -* Owning Library - The home library of the resource. -* Resource Type - Type in the first letter to list then choose the Resource Type to which the Attribute is applicable. -* Is Required - (Function not currently available.) - -4) Click Save when the necessary information has been entered. - -5) The added attribute will appear in the list. - -[NOTE] -One resource type may have multiple attributes. You may repeat the above procedure to add more. - -Create New Resource Attribute Value -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) One resource attribute may have multiple values. To add new attribute value, select Server Administration → Booking → Resource Attribute Values. - -2) Click New Resource Attribute Value in the top right corner. - -3) A box will appear in which you assign a value to a particular attribute. Values can be numbers, words, or a combination of them, that describe the particular aspects of the resource that have been defined as Attributes. As all values appear on the same list for selection, values should be as unique as possible. For example, a laptop may have a computing platform that is either PC or Mac. - -image::media/booking-create-bookable-3.png[] - -* Owning Library - The home library of the resource. -* Resource Attribute - The attribute you wish to assign the value to. -* Valid Value - Enter the value for your attribute. - -4) Click Save when the required information has been added. - -5) The attribute value will appear in the list. Each attribute should have at least two values attached to it; repeat this process for all applicable attribute values. - -Create New Resource -^^^^^^^^^^^^^^^^^^^ - -1) Add items to a resource type. Click Admin → Server Administration → Booking → Resources. - -2) Click New Resource in the top right corner. - -3) A box will appear. Add information for the resource. - -image::media/booking-create-bookable-4.png[] - -* Owning Library - The home library of the resource. -* Resource Type - Type in the first letter of the resource type's name to list then select the resource type for your item. -* Barcode - Barcode for the resource. -* Overbook - This allows a single item to be reserved, picked up, and returned by multiple patrons during overlapping or identical time periods. -* Is Deposit Required - (Function not currently available.) -* Deposit Amount - (Function not currently available.) -* User Fee - (Function not currently available.) - -4) Click Save when the required information has been added. - -5) The resource will appear in the list. - -[NOTE] -One resource type may have multiple resources attached. - -Map Resource Attributes and Values to Resources -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Admin → Server Administration → Booking → Resource Attribute Maps. - -2) Click New Resource Attribute Map in the right top corner. - -3) A box will appear in which you will map your attributes and values to your resources. - -image::media/booking-create-bookable-5.png[] - -* Resource - Enter the barcode of your resource. -* Resource Attribute - Select an attribute that belongs to the Resource Type. -* Attribute Value - Select a value that belongs to your chosen attribute and describes your resource. If your attribute and value do not belong together you will be unable to save. - -4) Click Save once you have entered the required information. - -[NOTE] -A resource may have multiple attributes and values. Repeat the above steps to map all. - -5) The resource attribute map will appear in the list. - -Once all attributes have been mapped your resource will be part of a hierarchy similar to the example below. - -image::media/booking-create-bookable-6.png[] - - -Editing Non-Bibliographic Resources -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Staff with the required permissions can edit aspects of existing non-bibliographic resources. For example, resource type can be edited in the event that the fine amount for a laptop changes from $2.00 to $5.00. - -Editing Resource Types -^^^^^^^^^^^^^^^^^^^^^^ - -1) Bring up your list of resource types. Select Admin --> Server Administration --> Booking --> Resource Types. - -2) A list of current resource types will appear. - -3) Double click anywhere on the line of the resource type you would like to edit. - -4) The resource type box will appear. Make your changes and click Save. - -5) Following the same procedure you may edit Resource Attributes, Attributes Values, Resources and Attribute Map by selecting them on Admin --> Server Administration --> Booking menu. - - - - -Deleting Non-bibliographic Resources -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1) To delete a booking resource, go to Admin → Server Administration → Booking → Resources. - -2) Select the checkbox in front the resource you want to delete. Click Delete Selected. The resource will disappear from the list. - -Following the same procedure you may delete Resource Attributes Maps. - -You may also delete Resource Attribute Values, Resource Attributes and Resource Types. But you have to delete them in the reverse order when you create them to make sure the entry is not in use when you try to delete it. - -This is the deletion order: Resource Attribut Map/Resources --> Resource Attribute Values --> Resource Attributes --> Resource Types. - - - - +Booking Module Administration +----------------------------- + +Creating Bookable Non-Bibliographic Resources +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms. + +The following pieces make up a non-bibliographic resource: + +* Resource Type +* Resource Attribute +* Resource Attribute Values +* Resource +* Resource Attribute Map + +You need to create resource types and resource attributes (features of the resource types), and add booking items (resources) to individual resource type. Each resource attribute may have multiple values. You need to link the applicable features (resource attributes and values) to individual item (resource) through the Resource Attribute Map. Before you create resources (booking items) you need to have a resource type and associated resource attributes and values, if any, for them. + +Create New Resource Type +^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Select Admin --> Server Administration --> Booking --> Resource Types. + +image::media/booking-create-resourcetype-1.png[] + +2) A list of current resource types will appear. Use Back and Next buttons to browse the whole list. + +image::media/booking-create-resourcetype-2.png[] + +[NOTE] +You may also see cataloged items in the list. Those items have been marked bookable or booked before. + + +3) To create a new resource type, click New Resource Type in the top right corner, . + +image::media/booking-create-resourcetype-3.png[] + +4) A box will appear in which you create your new type of resource. + +image::media/booking-create-bookable-1.png[] + +* Resource Type Name - Give your resource a name. +* Fine Interval - How often will fines be charged? This period can be input in several ways: + +[NOTE] +==================================================================== +** second(s), minute(s), hour(s), day(s), week(s), month(s), year(s) +** sec(s), min(s) +** s, m, h +** 00:00:30, 00:01:00, 01:00:00 +=================================================================== + +* Fine Amount - The amount that will be charged at each Fine Interval. +* Owning Library - The home library of the resource. +* Catalog Item - (Function not currently available.) +* Transferable - This allows the item to be transferred between libraries. +* Inter-booking and Inter-circulation Interval - The amount of time required by your library between the return of a resource and a new reservation for the resource. This interval uses * the same input conventions as the Fine Interval. +* Max Fine Amount - The amount at which fines will stop generating. + +5) Click Save when you have entered the needed information. + +image::media/booking-create-resourcetype-4.png[] + +6) The new resource type will appear in the list. + +image::media/booking-create-resourcetype-5.png[] + +Create New Resource Attribute +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Select Server Administration --> Booking --> Resource Attributes. + +2) Click New Resource Attribute in the top right corner. + +3) A box will appear in which you can add the attributes of the resource. Attributes are categories of descriptive information that are provided to the staff member when the booking request is made. For example, an attribute of a projector may be the type of projector. Other attributes might be the number of seats available in a room, or the computing platform of a laptop. + +image::media/booking-create-bookable-2.png[] + +* Resource Attribute Name - Give your attribute a name. +* Owning Library - The home library of the resource. +* Resource Type - Type in the first letter to list then choose the Resource Type to which the Attribute is applicable. +* Is Required - (Function not currently available.) + +4) Click Save when the necessary information has been entered. + +5) The added attribute will appear in the list. + +[NOTE] +One resource type may have multiple attributes. You may repeat the above procedure to add more. + +Create New Resource Attribute Value +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) One resource attribute may have multiple values. To add new attribute value, select Server Administration → Booking → Resource Attribute Values. + +2) Click New Resource Attribute Value in the top right corner. + +3) A box will appear in which you assign a value to a particular attribute. Values can be numbers, words, or a combination of them, that describe the particular aspects of the resource that have been defined as Attributes. As all values appear on the same list for selection, values should be as unique as possible. For example, a laptop may have a computing platform that is either PC or Mac. + +image::media/booking-create-bookable-3.png[] + +* Owning Library - The home library of the resource. +* Resource Attribute - The attribute you wish to assign the value to. +* Valid Value - Enter the value for your attribute. + +4) Click Save when the required information has been added. + +5) The attribute value will appear in the list. Each attribute should have at least two values attached to it; repeat this process for all applicable attribute values. + +Create New Resource +^^^^^^^^^^^^^^^^^^^ + +1) Add items to a resource type. Click Admin → Server Administration → Booking → Resources. + +2) Click New Resource in the top right corner. + +3) A box will appear. Add information for the resource. + +image::media/booking-create-bookable-4.png[] + +* Owning Library - The home library of the resource. +* Resource Type - Type in the first letter of the resource type's name to list then select the resource type for your item. +* Barcode - Barcode for the resource. +* Overbook - This allows a single item to be reserved, picked up, and returned by multiple patrons during overlapping or identical time periods. +* Is Deposit Required - (Function not currently available.) +* Deposit Amount - (Function not currently available.) +* User Fee - (Function not currently available.) + +4) Click Save when the required information has been added. + +5) The resource will appear in the list. + +[NOTE] +One resource type may have multiple resources attached. + +Map Resource Attributes and Values to Resources +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Admin → Server Administration → Booking → Resource Attribute Maps. + +2) Click New Resource Attribute Map in the right top corner. + +3) A box will appear in which you will map your attributes and values to your resources. + +image::media/booking-create-bookable-5.png[] + +* Resource - Enter the barcode of your resource. +* Resource Attribute - Select an attribute that belongs to the Resource Type. +* Attribute Value - Select a value that belongs to your chosen attribute and describes your resource. If your attribute and value do not belong together you will be unable to save. + +4) Click Save once you have entered the required information. + +[NOTE] +A resource may have multiple attributes and values. Repeat the above steps to map all. + +5) The resource attribute map will appear in the list. + +Once all attributes have been mapped your resource will be part of a hierarchy similar to the example below. + +image::media/booking-create-bookable-6.png[] + + +Editing Non-Bibliographic Resources +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Staff with the required permissions can edit aspects of existing non-bibliographic resources. For example, resource type can be edited in the event that the fine amount for a laptop changes from $2.00 to $5.00. + +Editing Resource Types +^^^^^^^^^^^^^^^^^^^^^^ + +1) Bring up your list of resource types. Select Admin --> Server Administration --> Booking --> Resource Types. + +2) A list of current resource types will appear. + +3) Double click anywhere on the line of the resource type you would like to edit. + +4) The resource type box will appear. Make your changes and click Save. + +5) Following the same procedure you may edit Resource Attributes, Attributes Values, Resources and Attribute Map by selecting them on Admin --> Server Administration --> Booking menu. + + + + +Deleting Non-bibliographic Resources +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1) To delete a booking resource, go to Admin → Server Administration → Booking → Resources. + +2) Select the checkbox in front the resource you want to delete. Click Delete Selected. The resource will disappear from the list. + +Following the same procedure you may delete Resource Attributes Maps. + +You may also delete Resource Attribute Values, Resource Attributes and Resource Types. But you have to delete them in the reverse order when you create them to make sure the entry is not in use when you try to delete it. + +This is the deletion order: Resource Attribut Map/Resources --> Resource Attribute Values --> Resource Attributes --> Resource Types. + + + + diff --git a/docs/admin/cn_prefixes_and_suffixes.txt b/docs/admin/cn_prefixes_and_suffixes.txt index 03b11c638f..789367edc1 100644 --- a/docs/admin/cn_prefixes_and_suffixes.txt +++ b/docs/admin/cn_prefixes_and_suffixes.txt @@ -1,46 +1,46 @@ -Call Number Prefixes and Suffixes ---------------------------------- - -You can configure call number prefixes and suffixes in the Admin module. This feature ensures more precise cataloging because each cataloger will have access to an identical drop down menu of call number prefixes and suffixes that are used at his library. In addition, it may streamline cataloging workflow. Catalogers can use a drop down menu to enter call number prefixes and suffixes rather than entering them manually. You can also run reports on call number prefixes and suffixes that would facilitate collection development and maintenance. - - -Configure call number prefixes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Call number prefixes are codes that precede a call number. - -To configure call number prefixes: - -1. Select *Admin -> Server Administration -> Call Number Prefixes*. -2. Click *New Prefix*. -3. Enter the *call number label* that will appear on the item. -4. Select the *owning library* from the drop down menu. Staff at this library, and its descendant org units, with the appropriate permissions, will be able to apply this call number prefix. -5. Click *Save*. - - - -image::media/Call_Number_Prefixes_and_Suffixes_2_21.jpg[Call_Number_Prefixes_and_Suffixes_2_21] - - - -Configure call number suffixes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Call number suffixes are codes that succeed a call number. - -To configure call number suffixes: - -1. Select *Admin -> Server Administration -> Call Number Suffixes*. -2. Click *New Suffix*. -3. Enter the *call number label* that will appear on the item. -4. Select the *owning library* from the drop down menu. Staff at this library, and its descendant org units, with the appropriate permissions, will be able to apply this call number suffix. -5. Click *Save*. - - -image::media/Call_Number_Prefixes_and_Suffixes_2_22.jpg[Call_Number_Prefixes_and_Suffixes_2_22] - - -Apply Call Number Prefixes and Suffixes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can apply call number prefixes and suffixes to items from a pre-configured list in the *Unified Volume/Copy Creator*. See the document, Unified Volume/Copy Creator, for an example. +Call Number Prefixes and Suffixes +--------------------------------- + +You can configure call number prefixes and suffixes in the Admin module. This feature ensures more precise cataloging because each cataloger will have access to an identical drop down menu of call number prefixes and suffixes that are used at his library. In addition, it may streamline cataloging workflow. Catalogers can use a drop down menu to enter call number prefixes and suffixes rather than entering them manually. You can also run reports on call number prefixes and suffixes that would facilitate collection development and maintenance. + + +Configure call number prefixes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Call number prefixes are codes that precede a call number. + +To configure call number prefixes: + +1. Select *Admin -> Server Administration -> Call Number Prefixes*. +2. Click *New Prefix*. +3. Enter the *call number label* that will appear on the item. +4. Select the *owning library* from the drop down menu. Staff at this library, and its descendant org units, with the appropriate permissions, will be able to apply this call number prefix. +5. Click *Save*. + + + +image::media/Call_Number_Prefixes_and_Suffixes_2_21.jpg[Call_Number_Prefixes_and_Suffixes_2_21] + + + +Configure call number suffixes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Call number suffixes are codes that succeed a call number. + +To configure call number suffixes: + +1. Select *Admin -> Server Administration -> Call Number Suffixes*. +2. Click *New Suffix*. +3. Enter the *call number label* that will appear on the item. +4. Select the *owning library* from the drop down menu. Staff at this library, and its descendant org units, with the appropriate permissions, will be able to apply this call number suffix. +5. Click *Save*. + + +image::media/Call_Number_Prefixes_and_Suffixes_2_22.jpg[Call_Number_Prefixes_and_Suffixes_2_22] + + +Apply Call Number Prefixes and Suffixes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can apply call number prefixes and suffixes to items from a pre-configured list in the *Unified Volume/Copy Creator*. See the document, Unified Volume/Copy Creator, for an example. diff --git a/docs/admin/customize_staff_client.txt b/docs/admin/customize_staff_client.txt index c70ff58aed..05e805cda2 100644 --- a/docs/admin/customize_staff_client.txt +++ b/docs/admin/customize_staff_client.txt @@ -1,59 +1,59 @@ -Customizing the Staff Client ----------------------------- - -Customizable Toolbar -~~~~~~~~~~~~~~~~~~~~ - - -By default, two toolbars are available in the staff client: circulation and -cataloging. This feature enables you to customize toolbars in the staff client. -You can create toolbars for specific org unit(s), workstation(s), or login(s). - - -Configure Toolbar -^^^^^^^^^^^^^^^^^ - -. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure -Toolbars*. -. Click *New Toolbar*. -. *Enter label for toolbar*. -+ -image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1] -+ -. Click *Ok*. -.Select one of the buttons in the *Available* panel. The *Button ID* describes -that action that the button will take, and the *Label* will display in the -toolbar. -. Click the *--> A* button to add the selected function to the -*Selected* panel on the bottom right side of the screen. To remove a button, -click the *<--R* button. -+ -image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2] -+ -. Continue adding buttons if desired. The buttons will display in the order that you add -them. If you want to reorder the buttons, click the *Up* or *Down* buttons. -. To separate buttons onto left and right sides of the screen on the same -toolbar, select *toolbarspacer*, and click *--> A*. -+ -image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3] -+ -. To add a dividing line between buttons that appear on the same side of the -screen, select *toolbarseparator*, and click *-->A*. -+ -image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4] -+ -. At the bottom of the screen, choose the owner of this toolbar. -If you click *Owning Org Unit*, then the owning org unit that you specify will display this -toolbar. Select the owning org unit from the drop down menu. The rule of -parental inheritance applies, so all child units will inherit the toolbars of -their parental units. -If you click *Owning Workstation*, then the workstation to which you are logged -in when you created the toolbar will display this toolbar. -If you select *Owning User*, then your login has access to that toolbar. - . When you are finished creating the toolbar, click *Save Toolbar*. Any -toolbar to which you have access displays under *Admin -> Workstation -Administration -> Toolbars -> Current*. - -*Permissions* - -ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars +Customizing the Staff Client +---------------------------- + +Customizable Toolbar +~~~~~~~~~~~~~~~~~~~~ + + +By default, two toolbars are available in the staff client: circulation and +cataloging. This feature enables you to customize toolbars in the staff client. +You can create toolbars for specific org unit(s), workstation(s), or login(s). + + +Configure Toolbar +^^^^^^^^^^^^^^^^^ + +. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure +Toolbars*. +. Click *New Toolbar*. +. *Enter label for toolbar*. ++ +image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1] ++ +. Click *Ok*. +.Select one of the buttons in the *Available* panel. The *Button ID* describes +that action that the button will take, and the *Label* will display in the +toolbar. +. Click the *--> A* button to add the selected function to the +*Selected* panel on the bottom right side of the screen. To remove a button, +click the *<--R* button. ++ +image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2] ++ +. Continue adding buttons if desired. The buttons will display in the order that you add +them. If you want to reorder the buttons, click the *Up* or *Down* buttons. +. To separate buttons onto left and right sides of the screen on the same +toolbar, select *toolbarspacer*, and click *--> A*. ++ +image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3] ++ +. To add a dividing line between buttons that appear on the same side of the +screen, select *toolbarseparator*, and click *-->A*. ++ +image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4] ++ +. At the bottom of the screen, choose the owner of this toolbar. +If you click *Owning Org Unit*, then the owning org unit that you specify will display this +toolbar. Select the owning org unit from the drop down menu. The rule of +parental inheritance applies, so all child units will inherit the toolbars of +their parental units. +If you click *Owning Workstation*, then the workstation to which you are logged +in when you created the toolbar will display this toolbar. +If you select *Owning User*, then your login has access to that toolbar. + . When you are finished creating the toolbar, click *Save Toolbar*. Any +toolbar to which you have access displays under *Admin -> Workstation +Administration -> Toolbars -> Current*. + +*Permissions* + +ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars diff --git a/docs/admin/recent_staff_searches.txt b/docs/admin/recent_staff_searches.txt index b297b8d065..bd2be10a96 100644 --- a/docs/admin/recent_staff_searches.txt +++ b/docs/admin/recent_staff_searches.txt @@ -1,49 +1,49 @@ -Recent Staff Searches ---------------------- - -This feature enables you to view your recent searches as you perform them in the staff client. The number of searches that you can view is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC. - -*Administrative Settings* - -By default, ten searches will be saved as you search the staff client. If you want to change the number of saved searches, then you can configure the number of searches that you wish to save through the *Library Settings Editor* in the *Admin* module. - -To configure the number of recent staff searches: - -1. Click *Admin -> Local Administration -> Library Settings Editor.* - -2. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages* - -3. Click *Edit*. - -4. Select a *Context* from the drop down menu. - -5. Enter the number of searches that you wish to save in the *Value* field. - -6. Click *Update Setting* - -image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21] - - -NOTE: To retain this setting, the system administrator must restart the web server. - - -If you do not want to save any searches, then you can turn off this feature. - -To deactivate this feature: - -1. Follow steps 1-4 (one through four) as listed in the previous section. - -2. In the *value* field, enter 0 (zero). - -3. Click *Update Setting.* This will prevent you from viewing any saved searches. - - -*Recent Staff Searches* - -Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches: - -1. Enter a search term in either the basic or advanced search fields. - -2. Your search results for the current search will appear in the middle of the screen. The most recent searches will appear on the left side of the screen. - -image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22] +Recent Staff Searches +--------------------- + +This feature enables you to view your recent searches as you perform them in the staff client. The number of searches that you can view is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC. + +*Administrative Settings* + +By default, ten searches will be saved as you search the staff client. If you want to change the number of saved searches, then you can configure the number of searches that you wish to save through the *Library Settings Editor* in the *Admin* module. + +To configure the number of recent staff searches: + +1. Click *Admin -> Local Administration -> Library Settings Editor.* + +2. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages* + +3. Click *Edit*. + +4. Select a *Context* from the drop down menu. + +5. Enter the number of searches that you wish to save in the *Value* field. + +6. Click *Update Setting* + +image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21] + + +NOTE: To retain this setting, the system administrator must restart the web server. + + +If you do not want to save any searches, then you can turn off this feature. + +To deactivate this feature: + +1. Follow steps 1-4 (one through four) as listed in the previous section. + +2. In the *value* field, enter 0 (zero). + +3. Click *Update Setting.* This will prevent you from viewing any saved searches. + + +*Recent Staff Searches* + +Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches: + +1. Enter a search term in either the basic or advanced search fields. + +2. Your search results for the current search will appear in the middle of the screen. The most recent searches will appear on the left side of the screen. + +image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22] diff --git a/docs/admin/restrict_Z39.50_sources_by_perm_group.txt b/docs/admin/restrict_Z39.50_sources_by_perm_group.txt index 2977cc3649..c9667ba79f 100644 --- a/docs/admin/restrict_Z39.50_sources_by_perm_group.txt +++ b/docs/admin/restrict_Z39.50_sources_by_perm_group.txt @@ -1,49 +1,49 @@ -Restrict Z39.50 Sources by Permission Group -------------------------------------------- - -In Evergreen versions preceeding 2.2, all users with cataloging privileges could view all of the Z39.50 servers that were available for use in the staff client. In Evergreen version 2.2, you can use a permission to restrict users' access to Z39.50 servers. You can apply a permission to the Z39.50 servers to restrict access to that server, and then assign that permission to users or groups so that they can access the restricted servers. - -Administrative Settings -~~~~~~~~~~~~~~~~~~~~~~~ - -You can add a permission to limit use of Z39.50 servers, or you can use an existing permission. - -NOTE: You must be authorized to add permission types at the database level to add a new permission. - -Add a new permission: - -1) Create a permission at the database level. - -2) Click *Admin -> Server Administration -> Permissions* to add a permission to the staff client. - -3) In the *New Permission* field, enter the text that describes the new permission. - -image::media/Restrict_Z39_50_Sources_by_Permission_Group1.jpg[] - -4) Click *Add*. - -5) The new permission appears in the list of permissions. - - - -Restrict Z39.50 Sources by Permission Group -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1) Click *Admin -> Server Administration -> Z39.50 Servers* - -2) Click *New Z39.50 Server*, or double click on an existing Z39.50 server to restrict its use. - -3) Select the permission that you added to restrict Z39.50 use from the drop down menu. - -image::media/Restrict_Z39_50_Sources_by_Permission_Group2.jpg[] - -4) Click *Save*. - -5) Add the permission that you created to a user or user group so that they can access the restricted server. - - -image::media/Restrict_Z39_50_Sources_by_Permission_Group3.jpg[] - -6) Users that log in to the staff client and have that permission will be able to see the restricted Z39.50 server. - -NOTE: As an alternative to creating a new permission to restrict use, you can use a preexisting permission. For example, your library uses a permission group called SuperCat, and only members in this group should have access to a restricted Z39.50 source. Identify a permission that is unique to the SuperCat group (e.g. CREATE_MARC) and apply that permission to the restricted Z39.50 server. Because these users are in the only group with the permission, they will be the only group w/ access to the restricted server. +Restrict Z39.50 Sources by Permission Group +------------------------------------------- + +In Evergreen versions preceeding 2.2, all users with cataloging privileges could view all of the Z39.50 servers that were available for use in the staff client. In Evergreen version 2.2, you can use a permission to restrict users' access to Z39.50 servers. You can apply a permission to the Z39.50 servers to restrict access to that server, and then assign that permission to users or groups so that they can access the restricted servers. + +Administrative Settings +~~~~~~~~~~~~~~~~~~~~~~~ + +You can add a permission to limit use of Z39.50 servers, or you can use an existing permission. + +NOTE: You must be authorized to add permission types at the database level to add a new permission. + +Add a new permission: + +1) Create a permission at the database level. + +2) Click *Admin -> Server Administration -> Permissions* to add a permission to the staff client. + +3) In the *New Permission* field, enter the text that describes the new permission. + +image::media/Restrict_Z39_50_Sources_by_Permission_Group1.jpg[] + +4) Click *Add*. + +5) The new permission appears in the list of permissions. + + + +Restrict Z39.50 Sources by Permission Group +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1) Click *Admin -> Server Administration -> Z39.50 Servers* + +2) Click *New Z39.50 Server*, or double click on an existing Z39.50 server to restrict its use. + +3) Select the permission that you added to restrict Z39.50 use from the drop down menu. + +image::media/Restrict_Z39_50_Sources_by_Permission_Group2.jpg[] + +4) Click *Save*. + +5) Add the permission that you created to a user or user group so that they can access the restricted server. + + +image::media/Restrict_Z39_50_Sources_by_Permission_Group3.jpg[] + +6) Users that log in to the staff client and have that permission will be able to see the restricted Z39.50 server. + +NOTE: As an alternative to creating a new permission to restrict use, you can use a preexisting permission. For example, your library uses a permission group called SuperCat, and only members in this group should have access to a restricted Z39.50 source. Identify a permission that is unique to the SuperCat group (e.g. CREATE_MARC) and apply that permission to the restricted Z39.50 server. Because these users are in the only group with the permission, they will be the only group w/ access to the restricted server. diff --git a/docs/admin/staff_client-double_clicking.txt b/docs/admin/staff_client-double_clicking.txt index f08b00917c..46dba84afc 100644 --- a/docs/admin/staff_client-double_clicking.txt +++ b/docs/admin/staff_client-double_clicking.txt @@ -1,23 +1,23 @@ -New Options for Double Clicking -------------------------------- - -Double Click to Retrieve a Patron's Record -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -. Click *Search -> Search for Patrons* to access a patron's record -. Enter search terms. -. Retrieve a list of possible matches. Double click on the record that you want to open. - -image::media/Double_Click1.jpg[Double_Click1] - - -Double Click to Retrieve Item Attributes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -. Enter search terms to retrieve a bibliographic record. -. Click *Actions for this Record* -> *Holdings Maintenance*. -. Double click on an item. -+ -image::media/Double_Click3.jpg[Double_Click3] -+ -. The copy information will appear in a new tab. +New Options for Double Clicking +------------------------------- + +Double Click to Retrieve a Patron's Record +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +. Click *Search -> Search for Patrons* to access a patron's record +. Enter search terms. +. Retrieve a list of possible matches. Double click on the record that you want to open. + +image::media/Double_Click1.jpg[Double_Click1] + + +Double Click to Retrieve Item Attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +. Enter search terms to retrieve a bibliographic record. +. Click *Actions for this Record* -> *Holdings Maintenance*. +. Double click on an item. ++ +image::media/Double_Click3.jpg[Double_Click3] ++ +. The copy information will appear in a new tab. diff --git a/docs/admin/staff_client-recent_searches.txt b/docs/admin/staff_client-recent_searches.txt index fd1f87bbc4..d727970aa8 100644 --- a/docs/admin/staff_client-recent_searches.txt +++ b/docs/admin/staff_client-recent_searches.txt @@ -1,42 +1,42 @@ -Recent Staff Searches ---------------------- - -This feature enables you to view your recent searches as you perform them in the staff client. The number of searches that you can view is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC. - -Administrative Settings -~~~~~~~~~~~~~~~~~~~~~~~ - -By default, ten searches will be saved as you search the staff client. If you want to change the number of saved searches, then you can configure the number of searches that you wish to save through the *Library Settings Editor* in the *Admin* module. - -To configure the number of recent staff searches: - -. Click *Admin -> Local Administration -> Library Settings Editor.* -. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages* -. Click *Edit*. -. Select a *Context* from the drop down menu. -. Enter the number of searches that you wish to save in the *Value* field. -. Click *Update Setting* - -image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21] - - -NOTE: To retain this setting, the system administrator must restart the web server. - -If you do not want to save any searches, then you can turn off this feature. - -To deactivate this feature: - -. Follow steps 1-4 (one through four) as listed in the previous section. -. In the *value* field, enter 0 (zero). -. Click *Update Setting.* This will prevent you from viewing any saved searches. - - -Recent Staff Searches -~~~~~~~~~~~~~~~~~~~~~ - -Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches: - -. Enter a search term in either the basic or advanced search fields. -. Your search results for the current search will appear in the middle of the screen. The most recent searches will appear on the left side of the screen. - -image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22] +Recent Staff Searches +--------------------- + +This feature enables you to view your recent searches as you perform them in the staff client. The number of searches that you can view is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC. + +Administrative Settings +~~~~~~~~~~~~~~~~~~~~~~~ + +By default, ten searches will be saved as you search the staff client. If you want to change the number of saved searches, then you can configure the number of searches that you wish to save through the *Library Settings Editor* in the *Admin* module. + +To configure the number of recent staff searches: + +. Click *Admin -> Local Administration -> Library Settings Editor.* +. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages* +. Click *Edit*. +. Select a *Context* from the drop down menu. +. Enter the number of searches that you wish to save in the *Value* field. +. Click *Update Setting* + +image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21] + + +NOTE: To retain this setting, the system administrator must restart the web server. + +If you do not want to save any searches, then you can turn off this feature. + +To deactivate this feature: + +. Follow steps 1-4 (one through four) as listed in the previous section. +. In the *value* field, enter 0 (zero). +. Click *Update Setting.* This will prevent you from viewing any saved searches. + + +Recent Staff Searches +~~~~~~~~~~~~~~~~~~~~~ + +Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches: + +. Enter a search term in either the basic or advanced search fields. +. Your search results for the current search will appear in the middle of the screen. The most recent searches will appear on the left side of the screen. + +image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22] diff --git a/docs/admin/staff_client-return_to_results_from_marc.txt b/docs/admin/staff_client-return_to_results_from_marc.txt index 1e6efc53b3..b54106fee2 100644 --- a/docs/admin/staff_client-return_to_results_from_marc.txt +++ b/docs/admin/staff_client-return_to_results_from_marc.txt @@ -1,6 +1,6 @@ -Return to Search Results from MARC Record ------------------------------------------ - -This feature enables you to return to your title search results directly from any view of the MARC record, including the OPAC View, MARC Record, MARC Edit, and Holdings Maintenance. You can use this feature to page through records in the MARC Record View or Edit interfaces. You do not have to return to the OPAC View to access title results. - -image::media/Search_Results1.jpg[Search_Results1] +Return to Search Results from MARC Record +----------------------------------------- + +This feature enables you to return to your title search results directly from any view of the MARC record, including the OPAC View, MARC Record, MARC Edit, and Holdings Maintenance. You can use this feature to page through records in the MARC Record View or Edit interfaces. You do not have to return to the OPAC View to access title results. + +image::media/Search_Results1.jpg[Search_Results1] diff --git a/docs/admin/staff_client-sorting_columns.txt b/docs/admin/staff_client-sorting_columns.txt index 1f0e355d3d..d9f60fa77d 100644 --- a/docs/admin/staff_client-sorting_columns.txt +++ b/docs/admin/staff_client-sorting_columns.txt @@ -1,59 +1,59 @@ -Sorting Columns ---------------- - -This feature enables you to sort display columns so that you can find easily the -information that you need on a screen that contains multiple columns. You can -sort display columns on any screen that is built on a grid, such as the Check In -screen or the On Shelf Pull List. - -You can also sort the columns on the following Administration screens: -Circulation Policies, Hold Policies, Circulation Limit Sets, Barcode Completion, -Acquisitions User Request List, and Vandelay Import Errors. - -You can sort items in an ascending or descending order, and you can prioritize -the order in which columns will sort. The following use cases illustrate how to -sort items within the Circulation and Administration interfaces. - -Sorting the On Shelf Pull List -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You want to capture items that are on the shelf to fill current holds. To -simplify this process, you will sort the items on the On Shelf Pull List by Copy -Location and Call Number. - -. Click *Circulation* -> *Pull List for Hold Requests*. -. The first column that you want to sort is the column, Current Copy Location. Right click the column header, Current Copy Location. -. Click *Sort First (Descending)*. -+ -image::media/Sorting_Columns3.jpg[Sorting_Columns3] -+ -. The next column that you want to sort is the column, Call Number. Right click the column header, Call Number. -. Click *Sort Next (Ascending)*. -+ -image::media/Sorting_Columns4.jpg[Sorting_Columns4] -+ -. The pull list has now been sorted by copy location and call number. - -image::media/Sorting_Columns5.jpg[Sorting_Columns5] - -NOTE: If you wanted to sort more columns, you could continue the process by clicking *Sort Next* for any subsequent columns. - - -Sorting Circulation Policies -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You want to sort the display of circulation policies in your staff client. - -. Click *Administration* -> *Local Administration* -> *Circulation Policies*. -. Right click on any column header. -. A pop-up box appears. -+ -image::media/Sorting_Columns2.jpg[Sorting_Columns2] -+ -. Check the *Display* box if you want to display a column in the staff client. -. Check the *Auto Width* box if you want the width of the columns to adjust to fit the staff client. -. Select a sort priority. -.. A sort priority of "0" indicates that no sorting has been applied. Columns will display in their default order. -.. A sort priority of "1" indicates that ascending sorting should be applied to this column first. Subsequent sorts will be applied as you continue to enter increasing numbers. -.. A sort priority of "-1" indicates that descending sorting should be applied to this column. -. Click *Save*. The circulation policies will now sort according to your selections each time that you log into the staff client. +Sorting Columns +--------------- + +This feature enables you to sort display columns so that you can find easily the +information that you need on a screen that contains multiple columns. You can +sort display columns on any screen that is built on a grid, such as the Check In +screen or the On Shelf Pull List. + +You can also sort the columns on the following Administration screens: +Circulation Policies, Hold Policies, Circulation Limit Sets, Barcode Completion, +Acquisitions User Request List, and Vandelay Import Errors. + +You can sort items in an ascending or descending order, and you can prioritize +the order in which columns will sort. The following use cases illustrate how to +sort items within the Circulation and Administration interfaces. + +Sorting the On Shelf Pull List +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You want to capture items that are on the shelf to fill current holds. To +simplify this process, you will sort the items on the On Shelf Pull List by Copy +Location and Call Number. + +. Click *Circulation* -> *Pull List for Hold Requests*. +. The first column that you want to sort is the column, Current Copy Location. Right click the column header, Current Copy Location. +. Click *Sort First (Descending)*. ++ +image::media/Sorting_Columns3.jpg[Sorting_Columns3] ++ +. The next column that you want to sort is the column, Call Number. Right click the column header, Call Number. +. Click *Sort Next (Ascending)*. ++ +image::media/Sorting_Columns4.jpg[Sorting_Columns4] ++ +. The pull list has now been sorted by copy location and call number. + +image::media/Sorting_Columns5.jpg[Sorting_Columns5] + +NOTE: If you wanted to sort more columns, you could continue the process by clicking *Sort Next* for any subsequent columns. + + +Sorting Circulation Policies +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You want to sort the display of circulation policies in your staff client. + +. Click *Administration* -> *Local Administration* -> *Circulation Policies*. +. Right click on any column header. +. A pop-up box appears. ++ +image::media/Sorting_Columns2.jpg[Sorting_Columns2] ++ +. Check the *Display* box if you want to display a column in the staff client. +. Check the *Auto Width* box if you want the width of the columns to adjust to fit the staff client. +. Select a sort priority. +.. A sort priority of "0" indicates that no sorting has been applied. Columns will display in their default order. +.. A sort priority of "1" indicates that ascending sorting should be applied to this column first. Subsequent sorts will be applied as you continue to enter increasing numbers. +.. A sort priority of "-1" indicates that descending sorting should be applied to this column. +. Click *Save*. The circulation policies will now sort according to your selections each time that you log into the staff client. diff --git a/docs/admin/staff_client-tab_buttons.txt b/docs/admin/staff_client-tab_buttons.txt index 34797f78b1..e3daa2718d 100644 --- a/docs/admin/staff_client-tab_buttons.txt +++ b/docs/admin/staff_client-tab_buttons.txt @@ -1,6 +1,6 @@ -Tab Buttons ------------ - -This feature enables you to add a new tab to the Evergreen staff client by clicking the + sign adjacent to the tab that you currently have opened. As in previous versions, you can also add new tabs by clicking *File -> New Tab*, or use the hotkey, Ctrl+T. - -image::media/New_Tab_Button1.jpg[New_Tab_Button1] +Tab Buttons +----------- + +This feature enables you to add a new tab to the Evergreen staff client by clicking the + sign adjacent to the tab that you currently have opened. As in previous versions, you can also add new tabs by clicking *File -> New Tab*, or use the hotkey, Ctrl+T. + +image::media/New_Tab_Button1.jpg[New_Tab_Button1] diff --git a/docs/admin/user_activity_type.txt b/docs/admin/user_activity_type.txt index 979f4798b1..162cb57237 100644 --- a/docs/admin/user_activity_type.txt +++ b/docs/admin/user_activity_type.txt @@ -1,32 +1,32 @@ -User Activity Types -------------------- - -The User Activity Types feature enables you to specify the user activity that you want to record in the database. You can use this feature for reporting purposes. This function will also display a last activity date in a user's account. - -Enabling this Feature -~~~~~~~~~~~~~~~~~~~~~ - -Click *Admin* -> *Server Administration* -> *User Activity Types* to access the default set of user activity types and to add new ones. The default set of user activity types records user logins to the Evergreen ILS and to third party products that communicate with Evergreen. - -The *Label* is a free text field that enables you to describe the activity that you are tracking. - -The *Event Caller* describes the third party software or Evergreen interface that interacts with the Evergreen database and is responsible for managing the communication between the parties. - -The *Event Type* describes the type of activity that Evergreen is tracking. Currently, this feature only tracks user authentication. - -The *Event Mechanism* describes the framework for communication between the third party software or OPAC and the database. Enter an event mechanism if you want to track the means by which the software communicates with the database. If you do not want to track how the softwares communicate, then leave this field empty. - -The *Enabled* field allows you to specify which types of user activity that you would like to track. - -The *Transient* column enables you to decide how many actions you want to track. If you want to track only the last activity, then enter *True.* If you want to trace all activity by the user, enter *False*. - -image::media/User_Activity_Types1A.jpg[User_Activity_Types1A] - - -Using this Feature -~~~~~~~~~~~~~~~~~~ - -The last activty date for user logins appears in the patron's summary. - -image::media/User_Activity_Types2A.jpg[User_Activity_Types2A] - +User Activity Types +------------------- + +The User Activity Types feature enables you to specify the user activity that you want to record in the database. You can use this feature for reporting purposes. This function will also display a last activity date in a user's account. + +Enabling this Feature +~~~~~~~~~~~~~~~~~~~~~ + +Click *Admin* -> *Server Administration* -> *User Activity Types* to access the default set of user activity types and to add new ones. The default set of user activity types records user logins to the Evergreen ILS and to third party products that communicate with Evergreen. + +The *Label* is a free text field that enables you to describe the activity that you are tracking. + +The *Event Caller* describes the third party software or Evergreen interface that interacts with the Evergreen database and is responsible for managing the communication between the parties. + +The *Event Type* describes the type of activity that Evergreen is tracking. Currently, this feature only tracks user authentication. + +The *Event Mechanism* describes the framework for communication between the third party software or OPAC and the database. Enter an event mechanism if you want to track the means by which the software communicates with the database. If you do not want to track how the softwares communicate, then leave this field empty. + +The *Enabled* field allows you to specify which types of user activity that you would like to track. + +The *Transient* column enables you to decide how many actions you want to track. If you want to track only the last activity, then enter *True.* If you want to trace all activity by the user, enter *False*. + +image::media/User_Activity_Types1A.jpg[User_Activity_Types1A] + + +Using this Feature +~~~~~~~~~~~~~~~~~~ + +The last activty date for user logins appears in the patron's summary. + +image::media/User_Activity_Types2A.jpg[User_Activity_Types2A] + diff --git a/docs/cataloging/batch_importing_MARC.txt b/docs/cataloging/batch_importing_MARC.txt index 906af8cf5e..f58e82d760 100644 --- a/docs/cataloging/batch_importing_MARC.txt +++ b/docs/cataloging/batch_importing_MARC.txt @@ -1,214 +1,214 @@ -Batch Importing MARC Records ----------------------------- - -The cataloging module in version 2.2 includes an enhanced MARC Batch Import interface. This interface features improved matching of records and managing of your import queue. In 2.2, you will be able to specify match points between incoming and existing records. You will also be able to apply filters to your queue that enable you to generate any errors that may have occurred during import. You will also be able to print your queue, email your queue, or export your queue as a CSV file. - -Permissions -~~~~~~~~~~~ - -To use match sets to import records, you will need the following permission: - -ADMIN_IMPORT_MATCH_SET - - -Record Display Attributes -~~~~~~~~~~~~~~~~~~~~~~~~~ - -This feature enables you to specify the tags and subfields that will display in records that appear in the import queue. - - -*Record Match Sets* - -This feature enables you to create custom match points that you can use to accurately match incoming records with existing catalog records. - - -In this example, to demonstrate matching on record attributes and MARC tags and subfields, we will create a record match set that defines a match based on the title of the record, in either the 240 or 245, and the fixed field, Lang. You can add multiple record attributes and MARC tags to customize a record match set. - - -1) Click *Cataloging -> MARC Batch Import/Export*. - -2) Create a new record match set. Click *Record Match Sets -> New Match Set*. - -3) Enter a name for the record match set. - -4) Select an *Owning Library* from the drop down menu. Staff with permissions at this location will be able to use this record match set. - -5) Select a *Match Set Type* from the drop down menu. You can create a match set for authority records or bibliographic records. - -6) Click *Save*. - - -image::media/Batch_Importing_MARC_Records1.jpg[Batch_Importing_MARC_Records1] - - -7) The screen will refresh to list the record match set that you created. Click the link to the record match set. - -8) Create an expression that will define the match points for the incoming record. You can choose from two areas to create a match: *Record Attribute* or *MARC Tag and Subfield*. You can use the Boolean operators AND and OR to combine these elements to create a match set. - -9) Select a *Record Attribute* from the drop-down menu. - -10) Enter a *Match Score.* The *Match Score* indicates the relative importance of that match point as Evergreen evaluates an incoming record against an existing record. You can enter any integer into this field. The number that you enter is only important as it relates to other match points. Recommended practice is that you create a match score of one (1) for the least important match point and assign increasing match points to the power of 2 to working points in increasing importance. - -11) Check the *Negate?* box if you want to negate the match point. Checking this box would be the equivalent of applying a Boolean operator of NOT to the match point. - - - -image::media/Batch_Importing_MARC_Records2.jpg[Batch_Importing_MARC_Records2] - - - -12) Click *Ok.* - -13) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree. - - - -image::media/Batch_Importing_MARC_Records3.jpg[Batch_Importing_MARC_Records3] - - -The match point will nest underneath the folder in the Expression tree. - - -image::media/Batch_Importing_MARC_Records4.jpg[Batch_Importing_MARC_Records4] - - -14) Enter another *Boolean Operator* to further refine your match set. - -15) Click *Boolean Operator*. - -16) Select the *OR* operator from the drop down menu. - -17) Click *Ok*. - -18) Drag the operator to the expression tree. - - -image::media/Batch_Importing_MARC_Records5.jpg[Batch_Importing_MARC_Records5] - - -19) Click *MARC Tag and Subfield*. - -20) Enter a *MARC tag* on which you want the records to match. - -21) Enter a *subfield* on which you want the records to match. - -22) Enter a *Match Score.* The *Match Score* indicates the relative importance of that match point as Evergreen evaluates an incoming record against an existing record. You can enter any integer into this field. The number that you enter is only important as it relates to other match points. Recommended practice is that you create a match score of one (1) for the least important match point and assign increasing match points to the power of 2 to working points in increasing importance. - -23) Check the *Negate?* box if you want to negate the match point. Checking this box would be the equivalent of applying a Boolean operator of NOT to the match point. - - -24) Click *Ok.* - - -image::media/Batch_Importing_MARC_Records6.jpg[Batch_Importing_MARC_Records6] - - -25) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree. The Expression will build across the top of the screen. - -26) Add additional MARC tags or record attributes to build the expression tree. - -27) Click *Save Changes to Expression*. - - -image::media/Batch_Importing_MARC_Records7.jpg[Batch_Importing_MARC_Records7] - - -*Replace Mode* - -Replace Mode enables you to replace an existing part of the expression tree with a new record attribute, MARC tag, or Boolean operator. For example, if the top of the tree is AND, in replace mode, you could change that to an OR. - - -1) Create a working match point. - -2) Click *Enter replace mode*. - -3) Highlight the piece of the tree that you want to replace. - -4) Drag the replacement piece over the highlighted piece. - -5) Click *Exit Replace Mode*. - - -*Quality Metrics* - - -1) Set the *Quality Metrics for this Match Set*. Quality metrics are used to determine the overall quality of a record. Each metric is given a weight and the total quality value for a record is equal to the sum of all metrics that apply to that record. For example, a record that has been cataloged thoroughly and contains accurate data would be more valuable than one of poor quality. You may want to ensure that the incoming record is of the same or better quality than the record that currently exists in your catalog; otherwise, you may want the match to fail. The quality metric is optional. - -2) You can create quality metrics based on the record attribute or the MARC Tag and Subfield. - -3) Click *Record Attribute.* - -4) Select an attribute from the drop down menu. - -5) Enter a value for the attribute. - -6.) Enter a match score. You can enter any integer into this field. The number that you enter is only important as it relates to other quality values for the current configuration. Higher scores would indicate increasing quality of incoming records. You can, as in the expression match score, increase the quality points by increasing subsequent records by a power of 2 (two). - -7) Click *Ok*. - - -image::media/Batch_Importing_MARC_Records8.jpg[Batch_Importing_MARC_Records8] - - - -*Import Records* - -The *Import Records* interface incorporates record match sets, quality metrics, more merging options, and improved ways to manage your queue. In this example, we will import a batch of records. One of the records in the queue will contain a matching record in the catalog that is of lower quality than the incoming record. We will import the record according to the guidelines set by our record match set, quality metrics, and merge/overlay choices that we will select. - - -1) Select a *Record Type* from the drop down menu. - -2) Create a queue to which you can upload your records, or add you records to an existing queue. Queues are linked to match sets and a holdings import profile. You cannot change a holdings import or record match set for a queue. - -3) Select a *Record Match Set* from the drop down menu. - -4) Select a *Holdings Import Profile* if you want to import holdings that are attached to your records. - -5) Select a *Record Source* from the drop down menu. - -6) Select a *Merge Profile*. Merge profiles enable you to specify which tags should be removed or preserved in incoming records. - -7) Choose one of the following import options if you want to auto-import records: - -a. *Merge on Single Match* - Using the Record Match Set, Evergreen will only attempt to perform the merge/overlay action if only one match was found in the catalog. - -b. *Merge on Best Match* - If more than one match is found in the catalog for a given record, Evergreen will attempt to perform the merge/overlay action with the best match as defined by the match score and quality metric. - -NOTE: Quality ratio affects only the *Merge on Single Match* and *Merge on Best Match* options. - -8) Enter a *Best/Single Match Minimum Quality Ratio.* Divide the incoming record quality score by the record quality score of the best match that might exist in the catalog. By default, Evergreen will assign any record a quality score of 1 (one). If you want to ensure that the inbound record is only imported when it has a higher quality than the best match, then you must enter a ratio that is higher than 1. For example, if you want the incoming record to have twice the quality of an existing record, then you should enter a 2 (two) in this field. If you want to bypass all quality restraints, enter a 0 (zero) in this field. - - -9) Select an *Insufficient Quality Fall-Through Profile* if desired. This field enables you to indicate that if the inbound record doees not meet the configured quality standards, then you may still import the record using an alternate merge profile. This field is typically used for selecting a merge profile that allows -the user to import holdings attached to a lower quality record without replacing the existing (target) record with the incoming record. This field is optional. - -10) *Browse* to find the appropriate file, and click *Upload*. The files will be uploaded to a queue. - - -image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9] - -11) The screen will display records that have been uploaded to your queue. - -image::media/Batch_Importing_MARC_Records15.jpg[Batch_Importing_MARC_Records15] - - -12) If Evergreen indicates that matching records exist, then click the *Matches* link to view the matching records. Check the box adjacent to the existing record that you want to merge with the incoming record. - -image::media/Batch_Importing_MARC_Records10.jpg[Batch_Importing_MARC_Records10] - -13) Click *Back to Import Queue*. - -14) Check the boxes of the records that you want to import, and click *Import Selected Records*, or click *Import All Records*. - -15) A pop up window will offer you the same import choices that were present on the *Import Records* screen. You can choose one of the import options, or click *Import*. - -image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9] - -16) The screen will refresh. The *Queue Summary* indicates that the record was imported. The *Import Time* column records the date that the record was imported. - -image::media/Batch_Importing_MARC_Records12.jpg[Batch_Importing_MARC_Records12] - -17) Search the catalog to confirm that the record was imported. - -image::media/Batch_Importing_MARC_Records14.jpg[Batch_Importing_MARC_Records14] - +Batch Importing MARC Records +---------------------------- + +The cataloging module in version 2.2 includes an enhanced MARC Batch Import interface. This interface features improved matching of records and managing of your import queue. In 2.2, you will be able to specify match points between incoming and existing records. You will also be able to apply filters to your queue that enable you to generate any errors that may have occurred during import. You will also be able to print your queue, email your queue, or export your queue as a CSV file. + +Permissions +~~~~~~~~~~~ + +To use match sets to import records, you will need the following permission: + +ADMIN_IMPORT_MATCH_SET + + +Record Display Attributes +~~~~~~~~~~~~~~~~~~~~~~~~~ + +This feature enables you to specify the tags and subfields that will display in records that appear in the import queue. + + +*Record Match Sets* + +This feature enables you to create custom match points that you can use to accurately match incoming records with existing catalog records. + + +In this example, to demonstrate matching on record attributes and MARC tags and subfields, we will create a record match set that defines a match based on the title of the record, in either the 240 or 245, and the fixed field, Lang. You can add multiple record attributes and MARC tags to customize a record match set. + + +1) Click *Cataloging -> MARC Batch Import/Export*. + +2) Create a new record match set. Click *Record Match Sets -> New Match Set*. + +3) Enter a name for the record match set. + +4) Select an *Owning Library* from the drop down menu. Staff with permissions at this location will be able to use this record match set. + +5) Select a *Match Set Type* from the drop down menu. You can create a match set for authority records or bibliographic records. + +6) Click *Save*. + + +image::media/Batch_Importing_MARC_Records1.jpg[Batch_Importing_MARC_Records1] + + +7) The screen will refresh to list the record match set that you created. Click the link to the record match set. + +8) Create an expression that will define the match points for the incoming record. You can choose from two areas to create a match: *Record Attribute* or *MARC Tag and Subfield*. You can use the Boolean operators AND and OR to combine these elements to create a match set. + +9) Select a *Record Attribute* from the drop-down menu. + +10) Enter a *Match Score.* The *Match Score* indicates the relative importance of that match point as Evergreen evaluates an incoming record against an existing record. You can enter any integer into this field. The number that you enter is only important as it relates to other match points. Recommended practice is that you create a match score of one (1) for the least important match point and assign increasing match points to the power of 2 to working points in increasing importance. + +11) Check the *Negate?* box if you want to negate the match point. Checking this box would be the equivalent of applying a Boolean operator of NOT to the match point. + + + +image::media/Batch_Importing_MARC_Records2.jpg[Batch_Importing_MARC_Records2] + + + +12) Click *Ok.* + +13) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree. + + + +image::media/Batch_Importing_MARC_Records3.jpg[Batch_Importing_MARC_Records3] + + +The match point will nest underneath the folder in the Expression tree. + + +image::media/Batch_Importing_MARC_Records4.jpg[Batch_Importing_MARC_Records4] + + +14) Enter another *Boolean Operator* to further refine your match set. + +15) Click *Boolean Operator*. + +16) Select the *OR* operator from the drop down menu. + +17) Click *Ok*. + +18) Drag the operator to the expression tree. + + +image::media/Batch_Importing_MARC_Records5.jpg[Batch_Importing_MARC_Records5] + + +19) Click *MARC Tag and Subfield*. + +20) Enter a *MARC tag* on which you want the records to match. + +21) Enter a *subfield* on which you want the records to match. + +22) Enter a *Match Score.* The *Match Score* indicates the relative importance of that match point as Evergreen evaluates an incoming record against an existing record. You can enter any integer into this field. The number that you enter is only important as it relates to other match points. Recommended practice is that you create a match score of one (1) for the least important match point and assign increasing match points to the power of 2 to working points in increasing importance. + +23) Check the *Negate?* box if you want to negate the match point. Checking this box would be the equivalent of applying a Boolean operator of NOT to the match point. + + +24) Click *Ok.* + + +image::media/Batch_Importing_MARC_Records6.jpg[Batch_Importing_MARC_Records6] + + +25) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree. The Expression will build across the top of the screen. + +26) Add additional MARC tags or record attributes to build the expression tree. + +27) Click *Save Changes to Expression*. + + +image::media/Batch_Importing_MARC_Records7.jpg[Batch_Importing_MARC_Records7] + + +*Replace Mode* + +Replace Mode enables you to replace an existing part of the expression tree with a new record attribute, MARC tag, or Boolean operator. For example, if the top of the tree is AND, in replace mode, you could change that to an OR. + + +1) Create a working match point. + +2) Click *Enter replace mode*. + +3) Highlight the piece of the tree that you want to replace. + +4) Drag the replacement piece over the highlighted piece. + +5) Click *Exit Replace Mode*. + + +*Quality Metrics* + + +1) Set the *Quality Metrics for this Match Set*. Quality metrics are used to determine the overall quality of a record. Each metric is given a weight and the total quality value for a record is equal to the sum of all metrics that apply to that record. For example, a record that has been cataloged thoroughly and contains accurate data would be more valuable than one of poor quality. You may want to ensure that the incoming record is of the same or better quality than the record that currently exists in your catalog; otherwise, you may want the match to fail. The quality metric is optional. + +2) You can create quality metrics based on the record attribute or the MARC Tag and Subfield. + +3) Click *Record Attribute.* + +4) Select an attribute from the drop down menu. + +5) Enter a value for the attribute. + +6.) Enter a match score. You can enter any integer into this field. The number that you enter is only important as it relates to other quality values for the current configuration. Higher scores would indicate increasing quality of incoming records. You can, as in the expression match score, increase the quality points by increasing subsequent records by a power of 2 (two). + +7) Click *Ok*. + + +image::media/Batch_Importing_MARC_Records8.jpg[Batch_Importing_MARC_Records8] + + + +*Import Records* + +The *Import Records* interface incorporates record match sets, quality metrics, more merging options, and improved ways to manage your queue. In this example, we will import a batch of records. One of the records in the queue will contain a matching record in the catalog that is of lower quality than the incoming record. We will import the record according to the guidelines set by our record match set, quality metrics, and merge/overlay choices that we will select. + + +1) Select a *Record Type* from the drop down menu. + +2) Create a queue to which you can upload your records, or add you records to an existing queue. Queues are linked to match sets and a holdings import profile. You cannot change a holdings import or record match set for a queue. + +3) Select a *Record Match Set* from the drop down menu. + +4) Select a *Holdings Import Profile* if you want to import holdings that are attached to your records. + +5) Select a *Record Source* from the drop down menu. + +6) Select a *Merge Profile*. Merge profiles enable you to specify which tags should be removed or preserved in incoming records. + +7) Choose one of the following import options if you want to auto-import records: + +a. *Merge on Single Match* - Using the Record Match Set, Evergreen will only attempt to perform the merge/overlay action if only one match was found in the catalog. + +b. *Merge on Best Match* - If more than one match is found in the catalog for a given record, Evergreen will attempt to perform the merge/overlay action with the best match as defined by the match score and quality metric. + +NOTE: Quality ratio affects only the *Merge on Single Match* and *Merge on Best Match* options. + +8) Enter a *Best/Single Match Minimum Quality Ratio.* Divide the incoming record quality score by the record quality score of the best match that might exist in the catalog. By default, Evergreen will assign any record a quality score of 1 (one). If you want to ensure that the inbound record is only imported when it has a higher quality than the best match, then you must enter a ratio that is higher than 1. For example, if you want the incoming record to have twice the quality of an existing record, then you should enter a 2 (two) in this field. If you want to bypass all quality restraints, enter a 0 (zero) in this field. + + +9) Select an *Insufficient Quality Fall-Through Profile* if desired. This field enables you to indicate that if the inbound record doees not meet the configured quality standards, then you may still import the record using an alternate merge profile. This field is typically used for selecting a merge profile that allows +the user to import holdings attached to a lower quality record without replacing the existing (target) record with the incoming record. This field is optional. + +10) *Browse* to find the appropriate file, and click *Upload*. The files will be uploaded to a queue. + + +image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9] + +11) The screen will display records that have been uploaded to your queue. + +image::media/Batch_Importing_MARC_Records15.jpg[Batch_Importing_MARC_Records15] + + +12) If Evergreen indicates that matching records exist, then click the *Matches* link to view the matching records. Check the box adjacent to the existing record that you want to merge with the incoming record. + +image::media/Batch_Importing_MARC_Records10.jpg[Batch_Importing_MARC_Records10] + +13) Click *Back to Import Queue*. + +14) Check the boxes of the records that you want to import, and click *Import Selected Records*, or click *Import All Records*. + +15) A pop up window will offer you the same import choices that were present on the *Import Records* screen. You can choose one of the import options, or click *Import*. + +image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9] + +16) The screen will refresh. The *Queue Summary* indicates that the record was imported. The *Import Time* column records the date that the record was imported. + +image::media/Batch_Importing_MARC_Records12.jpg[Batch_Importing_MARC_Records12] + +17) Search the catalog to confirm that the record was imported. + +image::media/Batch_Importing_MARC_Records14.jpg[Batch_Importing_MARC_Records14] + diff --git a/docs/cataloging/monograph_parts.txt b/docs/cataloging/monograph_parts.txt index 122fcaea38..8f9780d96c 100644 --- a/docs/cataloging/monograph_parts.txt +++ b/docs/cataloging/monograph_parts.txt @@ -1,57 +1,57 @@ -Monograph Parts ---------------- - -*Monograph Parts* enables you to differentiate between parts of monographs or other multi-part items. This feature enables catalogers to describe items more precisely by labeling the parts of an item. For example, catalogers might identify the parts of a monograph or the discs of a DVD set. This feature also allows patrons more flexibility when placing holds on multi-part items. A patron could place a hold on a specific disc of a DVD set if they want to access a specific season or episode rather than an entire series. - -Four new permissions are used by this functionality: CREATE_MONOGRAPH_PART, UPDATE_MONOGRAPH_PART, DELETE_MONOGRAPH_PART and MAP_MONOGRAPH_PART. Thes -e permissions should be assigned at the consorial level to those groups or users that will make use of the features described below. - - -Add a monograph part to an existing record -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To add a monograph part to an existing record in the catalog: - -1) Retrieve a record. - -2) Click *Actions for this Record -> Manage Parts* - - -image::media/monograph_parts1.jpg[monograph_parts1] - - -3) Click *New Monograph Part* - -4) Enter the *label* that you want to appear to the user in the catalog, and click *Save*. This will create a list of monograph parts from which you can choose when you create a volume and copy. - - -image::media/monograph_parts2.jpg[monograph_parts2] - - -5) Add a volume and copy. To add a volume and copy to your workstation library, click the *Add Volumes* link in the *Record Summary* at the top of the bibliographic record, or click *Actions for this Record -> Add Volumes*. - -To add a volume and copy to your workstation library or other libraries, click *Actions for this Record -> Holdings Maintenance -> Add Volumes*. - - -image::media/monograph_parts3.jpg[monograph_parts3] - - -6) The *Unified Volume/Copy Creator* opens. Enter the number of volumes that you want to add to the catalog and the volume description. - -7) Enter the number of copies and barcode(s) of each item. - -8) Select the *part designation* from the drop down menu adjacent to the barcode field. - -9) Apply a template to the copies, or edit fields in the *Copy Editor*. - - -image::media/monograph_parts4.jpg[monograph_parts4] - - -10) Click *Create Volumes/Items*. - -11) The *Holdings Maintenance* screen will refresh to demonstrate the addition of the volume, copy, and part. These fields also appear in the OPAC View. - - -image::media/monograph_parts5.jpg[monograph_parts5] - +Monograph Parts +--------------- + +*Monograph Parts* enables you to differentiate between parts of monographs or other multi-part items. This feature enables catalogers to describe items more precisely by labeling the parts of an item. For example, catalogers might identify the parts of a monograph or the discs of a DVD set. This feature also allows patrons more flexibility when placing holds on multi-part items. A patron could place a hold on a specific disc of a DVD set if they want to access a specific season or episode rather than an entire series. + +Four new permissions are used by this functionality: CREATE_MONOGRAPH_PART, UPDATE_MONOGRAPH_PART, DELETE_MONOGRAPH_PART and MAP_MONOGRAPH_PART. Thes +e permissions should be assigned at the consorial level to those groups or users that will make use of the features described below. + + +Add a monograph part to an existing record +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To add a monograph part to an existing record in the catalog: + +1) Retrieve a record. + +2) Click *Actions for this Record -> Manage Parts* + + +image::media/monograph_parts1.jpg[monograph_parts1] + + +3) Click *New Monograph Part* + +4) Enter the *label* that you want to appear to the user in the catalog, and click *Save*. This will create a list of monograph parts from which you can choose when you create a volume and copy. + + +image::media/monograph_parts2.jpg[monograph_parts2] + + +5) Add a volume and copy. To add a volume and copy to your workstation library, click the *Add Volumes* link in the *Record Summary* at the top of the bibliographic record, or click *Actions for this Record -> Add Volumes*. + +To add a volume and copy to your workstation library or other libraries, click *Actions for this Record -> Holdings Maintenance -> Add Volumes*. + + +image::media/monograph_parts3.jpg[monograph_parts3] + + +6) The *Unified Volume/Copy Creator* opens. Enter the number of volumes that you want to add to the catalog and the volume description. + +7) Enter the number of copies and barcode(s) of each item. + +8) Select the *part designation* from the drop down menu adjacent to the barcode field. + +9) Apply a template to the copies, or edit fields in the *Copy Editor*. + + +image::media/monograph_parts4.jpg[monograph_parts4] + + +10) Click *Create Volumes/Items*. + +11) The *Holdings Maintenance* screen will refresh to demonstrate the addition of the volume, copy, and part. These fields also appear in the OPAC View. + + +image::media/monograph_parts5.jpg[monograph_parts5] + diff --git a/docs/cataloging/overlay_record_3950_import.txt b/docs/cataloging/overlay_record_3950_import.txt index 73c63f1427..733b47adbb 100644 --- a/docs/cataloging/overlay_record_3950_import.txt +++ b/docs/cataloging/overlay_record_3950_import.txt @@ -1,55 +1,55 @@ -Overlay Existing Catalog Record via Z39.50 Import -------------------------------------------------- - -This feature enables you to replace a catalog record with a record obtained through a Z39.50 search. No new permissions or administrative settings are needed to use this feature. - -*To Overlay an Existing Record via Z39.50 Import:* - -1) Click *Cataloging -> Import Record from Z39.50* - -2) Select at least one *Service* in addition to the *Local Catalog* in the *Service and Credentials* window in the top right panel. - -3) Enter search terms in the *Query* window in the top left panel. - -4) Click *Search*. - -image::media/Overlay_Existing_Record_via_Z39_50_Import1.jpg[] - -5) The results will appear in the lower window. - -6) Select the record in the local catalog that you wish to overlay. - -7) Click *Mark Local Result as Overlay Target* - - -image::media/Overlay_Existing_Record_via_Z39_50_Import2.jpg[] - - -8) A confirmation message appears. Click *OK*. - -9) Select the record that you want to replace the existing catalog record. - -10) Click *Overlay.* - - -image::media/Overlay_Existing_Record_via_Z39_50_Import3.jpg[] - - -11) The record that you selected will open in the MARC Editor. Make any desired changes to the record, and click *Overlay Record*. - -image::media/Overlay_Existing_Record_via_Z39_50_Import4.jpg[] - - -12) The catalog record that you want to overlay will appear in a new window. Review the MARC record to verify that you are overlaying the correct catalog record. - -13) If the correct record appears, click *Overlay*. - - -image::media/Overlay_Existing_Record_via_Z39_50_Import5.jpg[] - -14) A confirmation message will appear to confirm that you have overlaid the record. Click *Ok*. - -15) The screen will refresh in the OPAC View to show that the record has been overlaid. - - -image::media/Overlay_Existing_Record_via_Z39_50_Import6.jpg[] +Overlay Existing Catalog Record via Z39.50 Import +------------------------------------------------- + +This feature enables you to replace a catalog record with a record obtained through a Z39.50 search. No new permissions or administrative settings are needed to use this feature. + +*To Overlay an Existing Record via Z39.50 Import:* + +1) Click *Cataloging -> Import Record from Z39.50* + +2) Select at least one *Service* in addition to the *Local Catalog* in the *Service and Credentials* window in the top right panel. + +3) Enter search terms in the *Query* window in the top left panel. + +4) Click *Search*. + +image::media/Overlay_Existing_Record_via_Z39_50_Import1.jpg[] + +5) The results will appear in the lower window. + +6) Select the record in the local catalog that you wish to overlay. + +7) Click *Mark Local Result as Overlay Target* + + +image::media/Overlay_Existing_Record_via_Z39_50_Import2.jpg[] + + +8) A confirmation message appears. Click *OK*. + +9) Select the record that you want to replace the existing catalog record. + +10) Click *Overlay.* + + +image::media/Overlay_Existing_Record_via_Z39_50_Import3.jpg[] + + +11) The record that you selected will open in the MARC Editor. Make any desired changes to the record, and click *Overlay Record*. + +image::media/Overlay_Existing_Record_via_Z39_50_Import4.jpg[] + + +12) The catalog record that you want to overlay will appear in a new window. Review the MARC record to verify that you are overlaying the correct catalog record. + +13) If the correct record appears, click *Overlay*. + + +image::media/Overlay_Existing_Record_via_Z39_50_Import5.jpg[] + +14) A confirmation message will appear to confirm that you have overlaid the record. Click *Ok*. + +15) The screen will refresh in the OPAC View to show that the record has been overlaid. + + +image::media/Overlay_Existing_Record_via_Z39_50_Import6.jpg[] diff --git a/docs/circulation/booking.txt b/docs/circulation/booking.txt index 730b890569..880b796661 100644 --- a/docs/circulation/booking.txt +++ b/docs/circulation/booking.txt @@ -1,272 +1,272 @@ -Booking Module --------------- - -Creating a Booking Reservation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Only staff members may create reservations. A reservation can be started from a patron record, or a booking resource. To reserve catalogued items, you may start from searching the catalogue, if you do not know the booking item's barcode. - -To create a reservation from a patron record -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Retrieve the patron’s record. - -2) Select Other --> Booking --> Create or Cancel Reservations. This takes you to the Reservations Screen. - -image::media/booking-create-1.png[] - -3) For non-catalogued items, choose a Bookable Resource Type and click Next. For catalogued items, enter the barcode in Enter the barcode of a catalogued, bookable resource box, then click Next beside the box. - -image::media/booking-create-2.png[] - -4) For non-catalogued resources, the Bookable Resource Type and the items associated with the type will appear. - -image::media/booking-create-3.png[] - -For catalogued items, the title and the item will display in the box. - -5) Select the date and time for the reservation in I need this resource... area. Click the date field. A calendar widget will be displayed for you to choose a date. Click the time field to choose time from the dropdown list. - -image::media/booking-create-4.png[] - -[NOTE] -If incorrect date and time is selected, the date/time boxes will appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. There must be at least 15 minutes between the creation of the reservation and the start time of the reservation. - -6) For non-catalogued resources, patrons may specify special feature(s), if any, of the resource. With these attributes: allows you to do so. For example, if a patron is booking a laptop he/she can choose between PC and Mac and even choose a specific operating system if they need to. Click the drop down arrow to select your option from the list. - -image::media/booking-create-5.png[] - -7) Select the pickup location from the dropdown list. - -image::media/booking-create-6.png[] - -8) If there are multiple copies of the resource and any item listed is acceptable, click Reserve Any. To choose a specific item, select it -and then click Reserve Selected. - -image::media/booking-create-7.png[] - -9) A message will confirm that the action succeeded. Click OK on the prompt. - -10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen. - -image::media/booking-create-9.png[] - -To create a reservation from a booking resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You need to know the barcode of the patron when you create a reservation for him/her from a booking resource. - -1) From the Booking menu, select Create Reservations - -image::media/booking-create-module-1.png[] - -2) Choose a Bookable Resource Type and click Next or enter the barcode of a catalogued resource and click Next. - -image::media/booking-create-module-2.png[] - -3) For non-catalogued resources, a screen showing the Bookable Resource Type and the items associated with the type will appear. - -image::media/booking-create-module-3.png[] - -For catalogued resources, the title and item will appear. - -4) Enter the user’s barcode in the Reserve to patron barcode box. The user’s existing reservations, if any, will appear at the bottom of the screen. - -image::media/booking-create-module-4.png[] - -5) Select the date and time for the reservation in I need this resource... area. Click the date field. A calendar widget will be displayed for you to choose a date. Click the time field to choose time from the dropdown list. - -image::media/booking-create-4.png[] - -[NOTE] -If incorrect date and time is selected, the date/time boxes will appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. The times must be set correctly for the reservation to be created. There must be at least 15 minutes between the creation of the reservation and the start time of the reservation. - - -6) For non-catalogued resources, patrons may specify special feature(s), if any, of the resource. The With these attributes: allows you to do so. For example, if a patron is booking a laptop they can choose between PC and Mac and even choose a specific operating system if they need to. Click the dropdown arrow to select your option from the list. - -image::media/booking-create-5.png[] - -7) Select the pickup location from the dropdown list. - -image::media/booking-create-6.png[] - -8) If there are multiple copies of the resource and any item listed is acceptable, click Reserve Any. To choose a specific item, select it and then click Reserve Selected. - -image::media/booking-create-7.png[] - -9) A message will confirm that the action succeeded. Click OK on the prompt. - -10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen. - -image::media/booking-create-9.png[] - - -Search the catalogue to create a reservation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you would like to reserve a catalogued item but do not know the item barcode, you may start with a catalogue search. - -1) In the staff client, select Cataloguing --> Search the Catalogue or keyboard shortcut F3 to search for the item you wish to reserve. You may search by any bibliographic information. - -2) Click the title to display the record summary. In the Copy Summary, select Copy Details in Actions column. - -3) The Copy Details will appear in a new row. In the barcode column, click the book now link. - -4) A screen showing the title and barcodes of available copies will appear. - -5) Enter the user’s barcode in the Reserve to patron barcode box. The user’s existing reservations, if any, will appear at the bottom of the screen. - -6) Select the date and time in I need this resource... section. If the date and time set is incorrect the boxes appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. - -7) Select pickup location. If there are multiple copies and any of the listed items is acceptable, click Reserve Any. To choose a specific item, select it and then click Reserve Selected. - -8) A message will confirm that the action succeeded. Click OK on the prompt. - -9) The screen will refresh, and the reservation will appear below the user’s name. - -[NOTE] -Reservations on catalogued items can be created on Item Status (F5) screen. Select the item, then Actions for Selected Items → Book Item Now. - -Reservation Pull List -~~~~~~~~~~~~~~~~~~~~~ - -Reservation pull list can be generated dynamically on the Staff Client. - -1) To create a pull list, select Booking --> Pull List. - -image::media/booking-pull-1.png[] - -2) You can decide how many days in advance you would like to pull reserved items. Enter the number of days in the box adjacent to Generate list for this many days hence. For example, if you would like to pull items that are needed today, you can enter 1 in the box, and you will retrieve items that need to be pulled today. - -3) Click Fetch to retrieve the pull list. - -image::media/booking-pull-2.png[] - -4) The pull list will appear. Click Print to print the pull list. - -image::media/booking-pull-3.png[] - -Capturing Items for Reservations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Reservations must be captured before they are ready to be picked up by the patron. - -[CAUTION] -Always capture reservations in Booking Module. Check In function in Circulation does not function the same as Capture Resources. - -1) In the staff client, select Booking --> Capture Resources. - -image::media/booking-capture-1.png[] - -2) Scan the item barcode or type the barcode then click Capture. - -image::media/booking-capture-2.png[] - -3) The message Capture succeeded will appear to the right. Information about the item will appear below the message. Click Print button to print a slip for the reservation. - -image::media/booking-capture-3.png[] - - -Picking Up Reservations -~~~~~~~~~~~~~~~~~~~~~~~ - -[CAUTION] -Always use the dedicated Booking Module interfaces for tasks related to reservations. Items that have been captured for a reservation cannot be checked out using the Check Out interface, even if the patron is the reservation recipient. - -1) Ready-for-pickup reservations can be listed from Other --> Booking --> Pick Up Reservations within a patron record or Booking --> Pick Up Reservations. - - -image::media/booking-pickup-1.png[] - -image::media/booking-pickup-module-1.png[] - - -2) Scan the patron barcode if using Booking --> Pick Up Reservations. - -3) The reservation(s) available for pickup will display. Select those you want to pick up and click Pick Up. - -image::media/booking-pickup-2.png[] - -4) The screen will refresh to show that the patron has picked up the reservation(s). - -image::media/booking-pickup-3.png[] - - -Returning Reservations -~~~~~~~~~~~~~~~~~~~~~~ - -[CAUTION] -When a reserved item is brought back, staff must use the Booking Module to return the reservation. - -1) To return reservations, select Booking --> Return Reservations - -image::media/booking-return-module-1.png[] - -2) You can return the item by patron or item barcode. Here we choose Resource to return by item barcode. Scan or enter the barcode, and click Go. - -image::media/booking-return-module-2.png[] - -3) A pop up box will tell you that the item was returned. Click OK on the prompt. - -4) If we select Patron on the above screen, after scanning the patron's barcode, reservations currently out to that patron are displayed. Highlight the reservations you want to return, and click Return. - -image::media/booking-return-2.png[] - -5) The screen will refresh to show any resources that remain out and the reservations that have been returned. - -image::media/booking-return-module-4.png[] - -[NOTE] -Reservations can be returned from within patron records by selecting Other --> Booking --> Return Reservations - -Cancelling a Reservation -~~~~~~~~~~~~~~~~~~~~~~~~ - -A reservation can be cancelled in a patron’s record or reservation creation screen. - -Cancel a reservation from the patron record -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Retrieve the patron's record. - -2) Select Other --> Booking --> Create or Cancel Reservations. - -image::media/booking-create-1.png[] - -3) The existing reservations will appear at the bottom of the screen. - -image::media/booking-cancel-1.png[] - -4) Highlight the reservation that you want to cancel. Click Cancel Selected. - -image::media/booking-cancel-2.png[] - -[NOTE] -Use Shift or Ctrl on keyboard and mouse click to select multiple reservations if needed. - -5) A pop-up window will confirm the cancellation. Click OK on the prompt. - -6) The screen will refresh, and the cancelled reservation(s) will disappear. - -image::media/booking-cancel-4.png[] - -Cancel a reservation on reservation creation screen -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Access the reservation creation screen by selecting Booking --> Create Reservations. - -2) Select any Bookable Resource Type, then click Next. - -3) Scan or type in the patron barcode in Reserve to Patron box then hit Enter. - -4) Patron's existing reservations will display at the bottom of the screen. - -5) Select those that you want to cancel, then click Cancel Selected. - - - - - - - - +Booking Module +-------------- + +Creating a Booking Reservation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Only staff members may create reservations. A reservation can be started from a patron record, or a booking resource. To reserve catalogued items, you may start from searching the catalogue, if you do not know the booking item's barcode. + +To create a reservation from a patron record +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Retrieve the patron’s record. + +2) Select Other --> Booking --> Create or Cancel Reservations. This takes you to the Reservations Screen. + +image::media/booking-create-1.png[] + +3) For non-catalogued items, choose a Bookable Resource Type and click Next. For catalogued items, enter the barcode in Enter the barcode of a catalogued, bookable resource box, then click Next beside the box. + +image::media/booking-create-2.png[] + +4) For non-catalogued resources, the Bookable Resource Type and the items associated with the type will appear. + +image::media/booking-create-3.png[] + +For catalogued items, the title and the item will display in the box. + +5) Select the date and time for the reservation in I need this resource... area. Click the date field. A calendar widget will be displayed for you to choose a date. Click the time field to choose time from the dropdown list. + +image::media/booking-create-4.png[] + +[NOTE] +If incorrect date and time is selected, the date/time boxes will appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. There must be at least 15 minutes between the creation of the reservation and the start time of the reservation. + +6) For non-catalogued resources, patrons may specify special feature(s), if any, of the resource. With these attributes: allows you to do so. For example, if a patron is booking a laptop he/she can choose between PC and Mac and even choose a specific operating system if they need to. Click the drop down arrow to select your option from the list. + +image::media/booking-create-5.png[] + +7) Select the pickup location from the dropdown list. + +image::media/booking-create-6.png[] + +8) If there are multiple copies of the resource and any item listed is acceptable, click Reserve Any. To choose a specific item, select it +and then click Reserve Selected. + +image::media/booking-create-7.png[] + +9) A message will confirm that the action succeeded. Click OK on the prompt. + +10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen. + +image::media/booking-create-9.png[] + +To create a reservation from a booking resource +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You need to know the barcode of the patron when you create a reservation for him/her from a booking resource. + +1) From the Booking menu, select Create Reservations + +image::media/booking-create-module-1.png[] + +2) Choose a Bookable Resource Type and click Next or enter the barcode of a catalogued resource and click Next. + +image::media/booking-create-module-2.png[] + +3) For non-catalogued resources, a screen showing the Bookable Resource Type and the items associated with the type will appear. + +image::media/booking-create-module-3.png[] + +For catalogued resources, the title and item will appear. + +4) Enter the user’s barcode in the Reserve to patron barcode box. The user’s existing reservations, if any, will appear at the bottom of the screen. + +image::media/booking-create-module-4.png[] + +5) Select the date and time for the reservation in I need this resource... area. Click the date field. A calendar widget will be displayed for you to choose a date. Click the time field to choose time from the dropdown list. + +image::media/booking-create-4.png[] + +[NOTE] +If incorrect date and time is selected, the date/time boxes will appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. The times must be set correctly for the reservation to be created. There must be at least 15 minutes between the creation of the reservation and the start time of the reservation. + + +6) For non-catalogued resources, patrons may specify special feature(s), if any, of the resource. The With these attributes: allows you to do so. For example, if a patron is booking a laptop they can choose between PC and Mac and even choose a specific operating system if they need to. Click the dropdown arrow to select your option from the list. + +image::media/booking-create-5.png[] + +7) Select the pickup location from the dropdown list. + +image::media/booking-create-6.png[] + +8) If there are multiple copies of the resource and any item listed is acceptable, click Reserve Any. To choose a specific item, select it and then click Reserve Selected. + +image::media/booking-create-7.png[] + +9) A message will confirm that the action succeeded. Click OK on the prompt. + +10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen. + +image::media/booking-create-9.png[] + + +Search the catalogue to create a reservation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you would like to reserve a catalogued item but do not know the item barcode, you may start with a catalogue search. + +1) In the staff client, select Cataloguing --> Search the Catalogue or keyboard shortcut F3 to search for the item you wish to reserve. You may search by any bibliographic information. + +2) Click the title to display the record summary. In the Copy Summary, select Copy Details in Actions column. + +3) The Copy Details will appear in a new row. In the barcode column, click the book now link. + +4) A screen showing the title and barcodes of available copies will appear. + +5) Enter the user’s barcode in the Reserve to patron barcode box. The user’s existing reservations, if any, will appear at the bottom of the screen. + +6) Select the date and time in I need this resource... section. If the date and time set is incorrect the boxes appear in red. For example, if the time for which the reservation is set has already passed, the boxes will appear in red. + +7) Select pickup location. If there are multiple copies and any of the listed items is acceptable, click Reserve Any. To choose a specific item, select it and then click Reserve Selected. + +8) A message will confirm that the action succeeded. Click OK on the prompt. + +9) The screen will refresh, and the reservation will appear below the user’s name. + +[NOTE] +Reservations on catalogued items can be created on Item Status (F5) screen. Select the item, then Actions for Selected Items → Book Item Now. + +Reservation Pull List +~~~~~~~~~~~~~~~~~~~~~ + +Reservation pull list can be generated dynamically on the Staff Client. + +1) To create a pull list, select Booking --> Pull List. + +image::media/booking-pull-1.png[] + +2) You can decide how many days in advance you would like to pull reserved items. Enter the number of days in the box adjacent to Generate list for this many days hence. For example, if you would like to pull items that are needed today, you can enter 1 in the box, and you will retrieve items that need to be pulled today. + +3) Click Fetch to retrieve the pull list. + +image::media/booking-pull-2.png[] + +4) The pull list will appear. Click Print to print the pull list. + +image::media/booking-pull-3.png[] + +Capturing Items for Reservations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Reservations must be captured before they are ready to be picked up by the patron. + +[CAUTION] +Always capture reservations in Booking Module. Check In function in Circulation does not function the same as Capture Resources. + +1) In the staff client, select Booking --> Capture Resources. + +image::media/booking-capture-1.png[] + +2) Scan the item barcode or type the barcode then click Capture. + +image::media/booking-capture-2.png[] + +3) The message Capture succeeded will appear to the right. Information about the item will appear below the message. Click Print button to print a slip for the reservation. + +image::media/booking-capture-3.png[] + + +Picking Up Reservations +~~~~~~~~~~~~~~~~~~~~~~~ + +[CAUTION] +Always use the dedicated Booking Module interfaces for tasks related to reservations. Items that have been captured for a reservation cannot be checked out using the Check Out interface, even if the patron is the reservation recipient. + +1) Ready-for-pickup reservations can be listed from Other --> Booking --> Pick Up Reservations within a patron record or Booking --> Pick Up Reservations. + + +image::media/booking-pickup-1.png[] + +image::media/booking-pickup-module-1.png[] + + +2) Scan the patron barcode if using Booking --> Pick Up Reservations. + +3) The reservation(s) available for pickup will display. Select those you want to pick up and click Pick Up. + +image::media/booking-pickup-2.png[] + +4) The screen will refresh to show that the patron has picked up the reservation(s). + +image::media/booking-pickup-3.png[] + + +Returning Reservations +~~~~~~~~~~~~~~~~~~~~~~ + +[CAUTION] +When a reserved item is brought back, staff must use the Booking Module to return the reservation. + +1) To return reservations, select Booking --> Return Reservations + +image::media/booking-return-module-1.png[] + +2) You can return the item by patron or item barcode. Here we choose Resource to return by item barcode. Scan or enter the barcode, and click Go. + +image::media/booking-return-module-2.png[] + +3) A pop up box will tell you that the item was returned. Click OK on the prompt. + +4) If we select Patron on the above screen, after scanning the patron's barcode, reservations currently out to that patron are displayed. Highlight the reservations you want to return, and click Return. + +image::media/booking-return-2.png[] + +5) The screen will refresh to show any resources that remain out and the reservations that have been returned. + +image::media/booking-return-module-4.png[] + +[NOTE] +Reservations can be returned from within patron records by selecting Other --> Booking --> Return Reservations + +Cancelling a Reservation +~~~~~~~~~~~~~~~~~~~~~~~~ + +A reservation can be cancelled in a patron’s record or reservation creation screen. + +Cancel a reservation from the patron record +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Retrieve the patron's record. + +2) Select Other --> Booking --> Create or Cancel Reservations. + +image::media/booking-create-1.png[] + +3) The existing reservations will appear at the bottom of the screen. + +image::media/booking-cancel-1.png[] + +4) Highlight the reservation that you want to cancel. Click Cancel Selected. + +image::media/booking-cancel-2.png[] + +[NOTE] +Use Shift or Ctrl on keyboard and mouse click to select multiple reservations if needed. + +5) A pop-up window will confirm the cancellation. Click OK on the prompt. + +6) The screen will refresh, and the cancelled reservation(s) will disappear. + +image::media/booking-cancel-4.png[] + +Cancel a reservation on reservation creation screen +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Access the reservation creation screen by selecting Booking --> Create Reservations. + +2) Select any Bookable Resource Type, then click Next. + +3) Scan or type in the patron barcode in Reserve to Patron box then hit Enter. + +4) Patron's existing reservations will display at the bottom of the screen. + +5) Select those that you want to cancel, then click Cancel Selected. + + + + + + + + diff --git a/docs/circulation/circulating_items.txt b/docs/circulation/circulating_items.txt index 51d653e66c..c41b1acdab 100644 --- a/docs/circulation/circulating_items.txt +++ b/docs/circulation/circulating_items.txt @@ -1,327 +1,327 @@ -Circulating Items ------------------ - -Check Out (F1) -~~~~~~~~~~~~~~ - -Regular Items -^^^^^^^^^^^^^ - -1) To check out an item press *F1*, click *Check Out* on the Circulation toolbar, or select *Circulation* -> *Check Out Items*. - -image::media/checkout_menu.png[] - -2) Scan or enter patron's barcode and click *Submit* if entering barcode manually. If scanning, number is submitted automatically. - -image::media/retrieve_patron.png[] - -3) Scan or enter item barcode manually, clicking *Submit* if manual. - -image::media/checkout_item_barcode.png[] - -4) Due date is now displayed. - -image::media/due_date_display.png[] - -5) When all items are scanned, hit the *F1* key or click the *Check Out* button on the Circulation toolbar to generate slip receipt or to exit patron record if not printing slip receipts. - -Pre-cataloged Items -^^^^^^^^^^^^^^^^^^^ - -1) Go to patron's *Check Out* screen by clicking *Circulation* -> *Check Out Items*. - -2) Scan the item barcode. - -3) At prompt, click *Pre-Cataloged*. - -image::media/pre_cat_alert.png[] - -4) Enter required information and click *Check Out*. - -image::media/precat.png[] - -[TIP] -On check-in, Evergreen will prompt staff to re-route the item to cataloging. - -Due Dates -^^^^^^^^^ - -Circulation periods are pre-set. When items are checked out, due dates are automatically calculated and inserted into circulation records if the *Specific Due Date* checkbox is not selected on the Check Out screen. The *Specific Due Date* checkbox allows you to set a different due date to override the pre-set loan period. - -Before you scan the item, select the *Specific Due Date* checkbox. Use the calendar widget to select a date. Or click in day, month or year, then use the up or down arrows to make the change or simply delete the data, then enter again. Time is used for hourly loan only. This date applies to all items until you change the date, de-select the *Specific Due Date* checkbox, or quit the patron record. - -image::media/specify_due_date1.png[] - -image::media/specify_due_date2.png[] - -Check In (F2) -~~~~~~~~~~~~~ - -Regular check in -^^^^^^^^^^^^^^^^ - -1) To check in an item, select *Circulation -> Check In Items*, click *Check In* on the Circulation toolbar, or press *F2*. - -image::media/check_in_menu.png[] - -2) Scan item barcode or enter manually and click *Submit*. - -image::media/checkin_barcode.png[] - -3) If there is an overdue fine associated with the checkin, an alert will appear at the top of the screen with a fine tally for the current checkin session. To immediately handle fine payment, click the alert to jump to the patron's bill record. - -image::media/overdue_checkin.png[] - -Backdated check in -^^^^^^^^^^^^^^^^^^ - -This is useful for clearing a book drop. - -1) To change effective check-in date, select *Circulation* -> *Check In Items*, or press *F2*. Use the calendar widget to choose the effective date. - -image::media/backdate_checkin.png[] - -2) The top green bar changes to red. The new effective date is now displayed in the header. - -image::media/backdate_red.png[] - -3) Move the cursor to the *Barcode* field. Scan the items. When finishing backdated check-in, change the *Effective Date* back to today's date. - -Backdate Post-Checkin -^^^^^^^^^^^^^^^^^^^^^ - -After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date. - -1) Select the item on the Check In screen, click Actions for Selected Items -> Backdate Post-Checkin. - -image::media/backdate_post_checkin.png[] - -2) Use the calendar widget to select an effective check-in date. Click Apply. Overdue fines, if any, will be adjusted according to the new effective check-in date. - -image::media/backdate_post_date.png[] - -[TIP] -Checkin Modifiers -=================================================== -At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are: - -- Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloging with Cataloging status. -- Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status. -- Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans). -- Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation. - -These options may be selected simultaneously. The selected option is displayed in the header area. - -image::media/checkin_options.png[] - -==================================================== - -Renewal and Editing the Item's Due Date -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Checked-out items can be renewed if your library's policy allows it. The new due date is calculated from the renewal date. Existing loans can also be extended to a specific date by editing the due date or renewing with a specific due date. - -Renewing via a Patron's Account -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1) Retrieve the patron record and go to the *Items Out* screen. - -image::media/items_out_click.png[] - -2) Select the item you want to renew. *Click on Actions for Selected Items* -> *Renew*. If you want to renew all items in the account, click *Renew All* instead. - -image::media/renew_action.png[] - -3) If you want to specify the due date, click *Renew with Specific Due Date*. You will be prompted to select a due date. Once done, click *Apply*. - -image::media/renew_specific_date.png[] - -[TIP] -Renewal can also be done on the *Item Status* screen. See the section called <> for more information. - -Renewing by Item Barcode -^^^^^^^^^^^^^^^^^^^^^^^^ -1) To renew items by barcode, select *Circulation* -> *Renew Items* or press *CTRL-F2*. - -2) Scan or manually entire the item barcode. - -image::media/renew_item.png[] - -3) If you want to specify the due date, click *Specific Due Date* and select a new due date from the calendar. - -image::media/renew_item_calendar.png[] - -Editing Due Date -^^^^^^^^^^^^^^^^ - -1) Retrieve the patron record and go to the *Items Out* screen. - -2) Select the item you want to renew. Click on *Actions for Selected Items* -> *Edit Due Date*. - -image::media/edit_due_date_action.png[] - -3) Select a new due date in the pop-up window, then click *Apply*. - -[TIP] -You can select multiple items by pressing down the CTRL key on your keyboard and clicking each items you want to edit. - -[NOTE] -Editing a due date is not included in the renewal count. - -Marking Items Lost and Claimed Returned -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Lost Items -^^^^^^^^^^ -1) To mark items Lost, retrieve patron record and click *Items Out*. - -2) Select the item. Click on *Actions for Selected Items* -> *Mark Lost (by Patron)*. - -image::media/mark_lost.png[] - -3) The lost item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record. - -image::media/lost_cr_section.png[] - -4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. - -image::media/patron_summary_checkouts.jpg[] - -[NOTE] -Lost Item Billing -======================== -- Marking an item Lost will automatically bill the patron the replacement cost of the item as recorded in the price field in the item record, and a processing fee as determined by your local policy. If the lost item has overdue charges, the overdue charges may be voided or retained based on local policy. -- A lost-then-returned item will disappear from the Items Out screen only when all bills linked to this particular circulation have been resolved. Bills may include replacement charges, processing fees, and manual charges added to the existing bills. -- The replacement fee and processing fee for lost-then-returned items may be voided if set by local policy. Overdue fines may be reinstated on lost-then-returned items if set by local policy. -========================== - -Refunds for Lost Items -^^^^^^^^^^^^^^^^^^^^^^^ - -If an item is returned after a lost bill has been paid and the library's policy is to void the replacement fee for lost-then-returned items, there will be a negative balance in the bill. A refund needs to be made to close the bill and the circulation record. Once the outstanding amount has been refunded, the bill and circulation record will be closed and the item will disappear from the Items Out screen. - -If you need to balance a bill with a negative amount and close the linked lost circulation record without making a refund (removing the item from the *Lost, Claimed Returned, Long Overdue, Has Unpaid Bills* panel on the *Items Out* screen), you need to add two dummy bills to the existing bills. The first one can be of any amount (e.g. $0.01), while the second should be of the absolute value of the negative amount. Then you need to void the first dummy bill. The reason for using a dummy bill is that Evergreen will check and close the circulation record only when payment is applied or bills are voided. - -Claimed Returned Items -^^^^^^^^^^^^^^^^^^^^^^^ - -1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen. - -2) Select the item, then select *Actions for Selected Items* -> *Mark Claimed Returned* from the dropdown menu. - -image::media/mark_claims_returned.png[] - -3) Select a date and click *Apply*. - -image::media/claimed_date.png[] - -4) The Claimed Returned item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record. - -image::media/lost_cr_section.png[] - -5) The Claimed Returned item adds to the count of Check Outs that are Claimed Returned in the patron summary on the left (or top) of the screen. It also adds to the total *Claims-returned Count* (including those that are current Check Outs and those that have since been returned) that is displayed when editing the patron's record. - -image::media/patron_summary_checkouts.jpg[] - -[NOTE] -More on Claimed Returned Items -==================================== -- The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly. -- When a Claimed Returned item is returned, if there is an outstanding bill associated with it, the item will not disappear from the *Items Out* screen. It will disappear when the outstanding bills are resolved. -- When an item is marked Claimed Returned, the value in *Claims-returned Count* field in the patron record is automatically increased. Staff can manually adjust this count by editing the patron record. -==================================== - -In-house Use (F6) -~~~~~~~~~~~~~~~~~ -1) To record in-house use, select *Circulation* -> *Record-In House Use*, click *Check Out* -> *Record In-House Use* on the circulation toolbar , or press *F6*. - -image::media/record_in_house_action.png[] - -2) To record in-house use for cataloged items, enter number of uses, scan barcode or type barcode and click *Submit*. - -image::media/in_house_use.png[] - -[NOTE] -The statistics of in-house use are separated from circulation statistics. The in-house use count of cataloged items is not included in the items' total use count. - -[[itemstatus]] -Item Status (F5) -~~~~~~~~~~~~~~~~ - -The Item Status screen is very useful. Many actions can be taken by either circulation staff or catalogers on this screen. Here we will cover some circulation-related functions, namely checking item status, viewing past circulations, inserting item alert messages, marking items missing or damaged, etc. - -Checking item status -^^^^^^^^^^^^^^^^^^^^ - -1) To check the status of an item, select *Search* -> *Search for copies by Barcode* or *Circulation* -> *Show Item Status by Barcode*; click the *Item Status button* on the circulation or cataloging toolbar; or press *F5*. - -image::media/item_status_menu.png[] - -2) Scan the barcode or type it and click *Submit*. The current status of the item is displayed with selected other fields. You can use the column picker to select more fields to view. - -image::media/item_status_barcode.png[] - -3) Click the *Alternate View* button, and the item summary and circulation history will be displayed. - -image::media/item_status_altview.png[] - -4) Click *List View* to go back. - -image::media/item_status_list_view.png[] - -[NOTE] -If the item's status is "Available", the displayed due date refers to the previous circulation's due date. - -[TIP] -Upload From File allows you to load multiple items saved in a file on your local computer. The file contains a list of the barcodes in text format. To ensure smooth uploading and further processing on the items, it is recommended that the list contains no more than 100 items. - -Viewing past circulations -^^^^^^^^^^^^^^^^^^^^^^^^^^ -1) To view past circulations, retrieve the item on the *Item Status* screen as described above. - -2) Select *Actions for Selected Items* -> *Show Last Few Circulations*. - -image::media/last_few_circs_action.png[] - -3) The item's recent circulation history is displayed. - -image::media/last_few_circs_display.png[] - -4) To retrieve the patron(s) of the last circulations, click the *Retrieve Last Patron* or the *Retrieve All These Patrons* button at the bottom of the above screen. Patron record(s) will be displayed in new tab(s). - -[TIP] -The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*. - -[NOTE] -You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen. - -Marking items damaged or missing and other functions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -1) To mark items damaged or missing, retrieve the item on the *Item Status* screen. - -2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*. - -image::media/mark_missing_damaged.png[] - -[NOTE} -Depending on the library's policy, when marking an item damaged, bills (cost and/or processing fee) may be inserted into the last borrower's account. - -3) Following the above procedure, you can check in and renew items by using the *Check in Items* and *Renew Items* on the dropdown menu. - -Item alerts -^^^^^^^^^^^ - -The *Edit Item Attributes* function on the *Actions for Selected Items* dropdown list allows you to edit item records. Here, we will show you how to insert item alert messages by this function. See cataloging instructions for more information on item editing. -1) Retrieve record on *Item Status* screen. - -2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*. - -3) The item record is displayed in the *Copy Editor*. - -image::media/copy_edit_alert.png[] - -4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. - -image::media/copy_alert_message.png[] - -5) Click *Modify Copies*, then confirm the action. +Circulating Items +----------------- + +Check Out (F1) +~~~~~~~~~~~~~~ + +Regular Items +^^^^^^^^^^^^^ + +1) To check out an item press *F1*, click *Check Out* on the Circulation toolbar, or select *Circulation* -> *Check Out Items*. + +image::media/checkout_menu.png[] + +2) Scan or enter patron's barcode and click *Submit* if entering barcode manually. If scanning, number is submitted automatically. + +image::media/retrieve_patron.png[] + +3) Scan or enter item barcode manually, clicking *Submit* if manual. + +image::media/checkout_item_barcode.png[] + +4) Due date is now displayed. + +image::media/due_date_display.png[] + +5) When all items are scanned, hit the *F1* key or click the *Check Out* button on the Circulation toolbar to generate slip receipt or to exit patron record if not printing slip receipts. + +Pre-cataloged Items +^^^^^^^^^^^^^^^^^^^ + +1) Go to patron's *Check Out* screen by clicking *Circulation* -> *Check Out Items*. + +2) Scan the item barcode. + +3) At prompt, click *Pre-Cataloged*. + +image::media/pre_cat_alert.png[] + +4) Enter required information and click *Check Out*. + +image::media/precat.png[] + +[TIP] +On check-in, Evergreen will prompt staff to re-route the item to cataloging. + +Due Dates +^^^^^^^^^ + +Circulation periods are pre-set. When items are checked out, due dates are automatically calculated and inserted into circulation records if the *Specific Due Date* checkbox is not selected on the Check Out screen. The *Specific Due Date* checkbox allows you to set a different due date to override the pre-set loan period. + +Before you scan the item, select the *Specific Due Date* checkbox. Use the calendar widget to select a date. Or click in day, month or year, then use the up or down arrows to make the change or simply delete the data, then enter again. Time is used for hourly loan only. This date applies to all items until you change the date, de-select the *Specific Due Date* checkbox, or quit the patron record. + +image::media/specify_due_date1.png[] + +image::media/specify_due_date2.png[] + +Check In (F2) +~~~~~~~~~~~~~ + +Regular check in +^^^^^^^^^^^^^^^^ + +1) To check in an item, select *Circulation -> Check In Items*, click *Check In* on the Circulation toolbar, or press *F2*. + +image::media/check_in_menu.png[] + +2) Scan item barcode or enter manually and click *Submit*. + +image::media/checkin_barcode.png[] + +3) If there is an overdue fine associated with the checkin, an alert will appear at the top of the screen with a fine tally for the current checkin session. To immediately handle fine payment, click the alert to jump to the patron's bill record. + +image::media/overdue_checkin.png[] + +Backdated check in +^^^^^^^^^^^^^^^^^^ + +This is useful for clearing a book drop. + +1) To change effective check-in date, select *Circulation* -> *Check In Items*, or press *F2*. Use the calendar widget to choose the effective date. + +image::media/backdate_checkin.png[] + +2) The top green bar changes to red. The new effective date is now displayed in the header. + +image::media/backdate_red.png[] + +3) Move the cursor to the *Barcode* field. Scan the items. When finishing backdated check-in, change the *Effective Date* back to today's date. + +Backdate Post-Checkin +^^^^^^^^^^^^^^^^^^^^^ + +After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date. + +1) Select the item on the Check In screen, click Actions for Selected Items -> Backdate Post-Checkin. + +image::media/backdate_post_checkin.png[] + +2) Use the calendar widget to select an effective check-in date. Click Apply. Overdue fines, if any, will be adjusted according to the new effective check-in date. + +image::media/backdate_post_date.png[] + +[TIP] +Checkin Modifiers +=================================================== +At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are: + +- Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloging with Cataloging status. +- Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status. +- Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans). +- Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation. + +These options may be selected simultaneously. The selected option is displayed in the header area. + +image::media/checkin_options.png[] + +==================================================== + +Renewal and Editing the Item's Due Date +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Checked-out items can be renewed if your library's policy allows it. The new due date is calculated from the renewal date. Existing loans can also be extended to a specific date by editing the due date or renewing with a specific due date. + +Renewing via a Patron's Account +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1) Retrieve the patron record and go to the *Items Out* screen. + +image::media/items_out_click.png[] + +2) Select the item you want to renew. *Click on Actions for Selected Items* -> *Renew*. If you want to renew all items in the account, click *Renew All* instead. + +image::media/renew_action.png[] + +3) If you want to specify the due date, click *Renew with Specific Due Date*. You will be prompted to select a due date. Once done, click *Apply*. + +image::media/renew_specific_date.png[] + +[TIP] +Renewal can also be done on the *Item Status* screen. See the section called <> for more information. + +Renewing by Item Barcode +^^^^^^^^^^^^^^^^^^^^^^^^ +1) To renew items by barcode, select *Circulation* -> *Renew Items* or press *CTRL-F2*. + +2) Scan or manually entire the item barcode. + +image::media/renew_item.png[] + +3) If you want to specify the due date, click *Specific Due Date* and select a new due date from the calendar. + +image::media/renew_item_calendar.png[] + +Editing Due Date +^^^^^^^^^^^^^^^^ + +1) Retrieve the patron record and go to the *Items Out* screen. + +2) Select the item you want to renew. Click on *Actions for Selected Items* -> *Edit Due Date*. + +image::media/edit_due_date_action.png[] + +3) Select a new due date in the pop-up window, then click *Apply*. + +[TIP] +You can select multiple items by pressing down the CTRL key on your keyboard and clicking each items you want to edit. + +[NOTE] +Editing a due date is not included in the renewal count. + +Marking Items Lost and Claimed Returned +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Lost Items +^^^^^^^^^^ +1) To mark items Lost, retrieve patron record and click *Items Out*. + +2) Select the item. Click on *Actions for Selected Items* -> *Mark Lost (by Patron)*. + +image::media/mark_lost.png[] + +3) The lost item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record. + +image::media/lost_cr_section.png[] + +4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. + +image::media/patron_summary_checkouts.jpg[] + +[NOTE] +Lost Item Billing +======================== +- Marking an item Lost will automatically bill the patron the replacement cost of the item as recorded in the price field in the item record, and a processing fee as determined by your local policy. If the lost item has overdue charges, the overdue charges may be voided or retained based on local policy. +- A lost-then-returned item will disappear from the Items Out screen only when all bills linked to this particular circulation have been resolved. Bills may include replacement charges, processing fees, and manual charges added to the existing bills. +- The replacement fee and processing fee for lost-then-returned items may be voided if set by local policy. Overdue fines may be reinstated on lost-then-returned items if set by local policy. +========================== + +Refunds for Lost Items +^^^^^^^^^^^^^^^^^^^^^^^ + +If an item is returned after a lost bill has been paid and the library's policy is to void the replacement fee for lost-then-returned items, there will be a negative balance in the bill. A refund needs to be made to close the bill and the circulation record. Once the outstanding amount has been refunded, the bill and circulation record will be closed and the item will disappear from the Items Out screen. + +If you need to balance a bill with a negative amount and close the linked lost circulation record without making a refund (removing the item from the *Lost, Claimed Returned, Long Overdue, Has Unpaid Bills* panel on the *Items Out* screen), you need to add two dummy bills to the existing bills. The first one can be of any amount (e.g. $0.01), while the second should be of the absolute value of the negative amount. Then you need to void the first dummy bill. The reason for using a dummy bill is that Evergreen will check and close the circulation record only when payment is applied or bills are voided. + +Claimed Returned Items +^^^^^^^^^^^^^^^^^^^^^^^ + +1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen. + +2) Select the item, then select *Actions for Selected Items* -> *Mark Claimed Returned* from the dropdown menu. + +image::media/mark_claims_returned.png[] + +3) Select a date and click *Apply*. + +image::media/claimed_date.png[] + +4) The Claimed Returned item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record. + +image::media/lost_cr_section.png[] + +5) The Claimed Returned item adds to the count of Check Outs that are Claimed Returned in the patron summary on the left (or top) of the screen. It also adds to the total *Claims-returned Count* (including those that are current Check Outs and those that have since been returned) that is displayed when editing the patron's record. + +image::media/patron_summary_checkouts.jpg[] + +[NOTE] +More on Claimed Returned Items +==================================== +- The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly. +- When a Claimed Returned item is returned, if there is an outstanding bill associated with it, the item will not disappear from the *Items Out* screen. It will disappear when the outstanding bills are resolved. +- When an item is marked Claimed Returned, the value in *Claims-returned Count* field in the patron record is automatically increased. Staff can manually adjust this count by editing the patron record. +==================================== + +In-house Use (F6) +~~~~~~~~~~~~~~~~~ +1) To record in-house use, select *Circulation* -> *Record-In House Use*, click *Check Out* -> *Record In-House Use* on the circulation toolbar , or press *F6*. + +image::media/record_in_house_action.png[] + +2) To record in-house use for cataloged items, enter number of uses, scan barcode or type barcode and click *Submit*. + +image::media/in_house_use.png[] + +[NOTE] +The statistics of in-house use are separated from circulation statistics. The in-house use count of cataloged items is not included in the items' total use count. + +[[itemstatus]] +Item Status (F5) +~~~~~~~~~~~~~~~~ + +The Item Status screen is very useful. Many actions can be taken by either circulation staff or catalogers on this screen. Here we will cover some circulation-related functions, namely checking item status, viewing past circulations, inserting item alert messages, marking items missing or damaged, etc. + +Checking item status +^^^^^^^^^^^^^^^^^^^^ + +1) To check the status of an item, select *Search* -> *Search for copies by Barcode* or *Circulation* -> *Show Item Status by Barcode*; click the *Item Status button* on the circulation or cataloging toolbar; or press *F5*. + +image::media/item_status_menu.png[] + +2) Scan the barcode or type it and click *Submit*. The current status of the item is displayed with selected other fields. You can use the column picker to select more fields to view. + +image::media/item_status_barcode.png[] + +3) Click the *Alternate View* button, and the item summary and circulation history will be displayed. + +image::media/item_status_altview.png[] + +4) Click *List View* to go back. + +image::media/item_status_list_view.png[] + +[NOTE] +If the item's status is "Available", the displayed due date refers to the previous circulation's due date. + +[TIP] +Upload From File allows you to load multiple items saved in a file on your local computer. The file contains a list of the barcodes in text format. To ensure smooth uploading and further processing on the items, it is recommended that the list contains no more than 100 items. + +Viewing past circulations +^^^^^^^^^^^^^^^^^^^^^^^^^^ +1) To view past circulations, retrieve the item on the *Item Status* screen as described above. + +2) Select *Actions for Selected Items* -> *Show Last Few Circulations*. + +image::media/last_few_circs_action.png[] + +3) The item's recent circulation history is displayed. + +image::media/last_few_circs_display.png[] + +4) To retrieve the patron(s) of the last circulations, click the *Retrieve Last Patron* or the *Retrieve All These Patrons* button at the bottom of the above screen. Patron record(s) will be displayed in new tab(s). + +[TIP] +The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*. + +[NOTE] +You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen. + +Marking items damaged or missing and other functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +1) To mark items damaged or missing, retrieve the item on the *Item Status* screen. + +2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*. + +image::media/mark_missing_damaged.png[] + +[NOTE} +Depending on the library's policy, when marking an item damaged, bills (cost and/or processing fee) may be inserted into the last borrower's account. + +3) Following the above procedure, you can check in and renew items by using the *Check in Items* and *Renew Items* on the dropdown menu. + +Item alerts +^^^^^^^^^^^ + +The *Edit Item Attributes* function on the *Actions for Selected Items* dropdown list allows you to edit item records. Here, we will show you how to insert item alert messages by this function. See cataloging instructions for more information on item editing. +1) Retrieve record on *Item Status* screen. + +2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*. + +3) The item record is displayed in the *Copy Editor*. + +image::media/copy_edit_alert.png[] + +4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. + +image::media/copy_alert_message.png[] + +5) Click *Modify Copies*, then confirm the action. diff --git a/docs/installation/edi_setup.txt b/docs/installation/edi_setup.txt index ececa1564f..61f2b914ef 100644 --- a/docs/installation/edi_setup.txt +++ b/docs/installation/edi_setup.txt @@ -1,212 +1,212 @@ -Setting Up EDI Acquisitions ---------------------------- - -Introduction -~~~~~~~~~~~~ - -Electronic Data Interchange (EDI) is used to exchange information between -participating vendors and Evergreen. This chapter contains technical -information for installation and configuration of the components necessary -to run EDI Acquisitions for Evergreen. - -Installation -~~~~~~~~~~~~ - -Install EDI Translator -^^^^^^^^^^^^^^^^^^^^^^ - -The EDI Translator is used to convert data into EDI format. It runs -on localhost and listens on port 9191 by default. This is controlled via -the edi_webrick.cnf file located in the edi_translator directory. It should -not be necessary to edit this configuration if you install EDI Translator -on the same server used for running Action/Triggers events. - -[NOTE] -If you are running Evergreen with a multi-server configuration, make sure -to install EDI Translator on the same server used for Action/Trigger event -generation. - -.Steps for Installing - -1. As the *opensrf* user, copy the EDI Translator code found in - Open-ILS/src/edi_translator to somewhere accessible - (for example, /openils/var/edi): -+ -[source, bash] --------------------------------------------------- -cp -r Open-ILS/src/edi_translator /openils/var/edi --------------------------------------------------- -2. Navigate to where you have saved the code to begin next step: -+ -[source, bash] -------------------- -cd /openils/var/edi -------------------- -3. Next, as the *root* user (or a user with sudo rights), install the - dependencies, via "install.sh". This will perform some apt-get routines - to install the code needed for the EDI translator to function. - (Note: subversion must be installed first) -+ -[source, bash] ------------ -./install.sh ------------ -4. Now, we're ready to start "edi_webrick.bash" which is the script that calls - the "Ruby" code to translate EDI. This script needs to be started in - order for EDI to function so please take appropriate measures to ensure this - starts following reboots/upgrades/etc. As the *opensrf* user: -+ -[source, bash] ------------------ -./edi_webrick.bash ------------------ -5. You can check to see if EDI translator is running. - * Using the command "ps aux | grep edi" should show you something similar - if the script is running properly: -+ -[source, bash] ------------------------------------------------------------------------------------------- -root 30349 0.8 0.1 52620 10824 pts/0 S 13:04 0:00 ruby ./edi_webrick.rb ------------------------------------------------------------------------------------------- - * To shutdown EDI Translator you can use something like pkill (assuming - no other ruby processes are running on that server): -+ -[source, bash] ------------------------ -kill -INT $(pgrep ruby) ------------------------ - -Install EDI Scripts -^^^^^^^^^^^^^^^^^^^ - -The EDI scripts are "edi_pusher.pl" and "edi_fetcher.pl" and are used to -"push" and "fetch" EDI messages for configured EDI accounts. - -1. As the *opensrf* user, copy edi_pusher.pl and edi_fetcher.pl from - Open-ILS/src/support-scripts into /openils/bin: -+ -[source, bash] --------------------------------------------------- -cp Open-ILS/src/support-scripts/edi_pusher.pl /openils/bin -cp Open-ILS/src/support-scripts/edi_fetcher.pl /openils/bin --------------------------------------------------- -2. Setup the edi_pusher.pl and edi_fetcher.pl scripts to run as cron jobs - in order to regularly push and receive EDI messages. - * Add to the opensrf user's crontab the following entries: -+ -[source, bash] ------------------------------------------------------------------------ -10 * * * * cd /openils/bin && /usr/bin/perl ./edi_pusher.pl > /dev/null -0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null ------------------------------------------------------------------------ - * The example for edi_pusher.pl sets the script to run at - 10 minutes past the hour, every hour. - * The example for edi_fetcher.pl sets the script to run at - 1 AM every night. - -[NOTE] -You may choose to run the EDI scripts more or less frequently based on the -necessary response times from your vendors. - -Configuration -~~~~~~~~~~~~~ - -Configuring Providers -^^^^^^^^^^^^^^^^^^^^^ - -Look in Admin > Server Administration > Acquisitions > Providers - -[options="header"] -|====================================================================================== -|Column |Description/Notes -|Provider Name |A unique name to identify the provider -|Code |A unique code to identify the provider -|Owner |The org unit who will "own" the provider. -|Currency |The currency format the provider accepts -|Active |Whether or not the Provider is "active" for use -|Default Claim Policy|?? -|EDI Default |The default "EDI Account" to use (see EDI Accounts Configuration) -|Email |The email address for the provider -|Fax Phone |A fax number for the provider -|Holdings Tag |The holdings tag to be utilized (usually 852, for Evergreen) -|Phone |A phone number for the provider -|Prepayment Required |Whether or not prepayment is required -|SAN |The vendor provided, org unit specific SAN code -|URL |The vendor website -|====================================================================================== - -Configuring EDI Accounts -^^^^^^^^^^^^^^^^^^^^^^^^ - -Look in Admin > Server Administration > Acquisitions > EDI Accounts - -[options="header"] -|=============================================================================================================== -|Column |Description/Notes -|Label |A unique name to identify the provider -|Host |FTP/SFTP/SSH hostname - vendor assigned -|Username |FTP/SFTP/SSH username - vendor assigned -|Password |FTP/SFTP/SSH password - vendor assigned -|Account |Vendor assigned account number associated with your organization -|Owner |The organizational unit who owns the EDI account -|Last Activity |The date of last activity for the account -|Provider |This is a link to one of the "codes" in the "Providers" interface -|Path |The path on the vendor's server where Evergreen will send it's outgoing .epo files -|Incoming Directory |The path on the vendor's server where "incoming" .epo files are stored -|Vendor Account Number|Vendor assigned account number. -|Vendor Assigned Code |Usually a sub-account designation. Can be used with or without the Vendor Account Number. -|=============================================================================================================== - -Configuring Organizational Unit SAN code -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Look in Admin > Server Settings > Organizational Units - -This interface allows a library to configure their SAN, alongside -their address, phone, etc. - -Troubleshooting -~~~~~~~~~~~~~~~ - -PO JEDI Template Issues -^^^^^^^^^^^^^^^^^^^^^^^ - -Some libraries may run into issues with the action/trigger (PO JEDI). -The template has to be modified to handle different vendor codes that -may be used. For instance, if you use "ingra" instead of INGRAM this -may cause a problem because they are hardcoded in the template. The -following is an example of one modification that seems to work. - -.Original template has: - -[source, bash] ----------------------------------------------------------------------------------------------------------------------------------------------- -"buyer":[ - [% IF target.provider.edi_default.vendcode && (target.provider.code == 'BT' || target.provider.name.match('(?i)^BAKER & TAYLOR')) -%] - {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} - [%- ELSIF target.provider.edi_default.vendcode && target.provider.code == 'INGRAM' -%] - {"id":"[% target.ordering_agency.mailing_address.san %]"}, - {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"} - [%- ELSE -%] - {"id":"[% target.ordering_agency.mailing_address.san %]"} - [%- END -%] -], ----------------------------------------------------------------------------------------------------------------------------------------------- - -.Modified template has the following where it matches on provider SAN instead of code: - -[source, bash] ------------------------------------------------------------------------------------------------------------------------------------------- -"buyer":[ - [% IF target.provider.edi_default.vendcode && (target.provider.san == '1556150') -%] - {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} - {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} - [%- ELSIF target.provider.edi_default.vendcode && (target.provider.san == '1697978') -%] - {"id":"[% target.ordering_agency.mailing_address.san %]"}, - {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"} - [%- ELSE -%] - {"id":"[% target.ordering_agency.mailing_address.san %]"} - [%- END -%] -], ------------------------------------------------------------------------------------------------------------------------------------------- - +Setting Up EDI Acquisitions +--------------------------- + +Introduction +~~~~~~~~~~~~ + +Electronic Data Interchange (EDI) is used to exchange information between +participating vendors and Evergreen. This chapter contains technical +information for installation and configuration of the components necessary +to run EDI Acquisitions for Evergreen. + +Installation +~~~~~~~~~~~~ + +Install EDI Translator +^^^^^^^^^^^^^^^^^^^^^^ + +The EDI Translator is used to convert data into EDI format. It runs +on localhost and listens on port 9191 by default. This is controlled via +the edi_webrick.cnf file located in the edi_translator directory. It should +not be necessary to edit this configuration if you install EDI Translator +on the same server used for running Action/Triggers events. + +[NOTE] +If you are running Evergreen with a multi-server configuration, make sure +to install EDI Translator on the same server used for Action/Trigger event +generation. + +.Steps for Installing + +1. As the *opensrf* user, copy the EDI Translator code found in + Open-ILS/src/edi_translator to somewhere accessible + (for example, /openils/var/edi): ++ +[source, bash] +-------------------------------------------------- +cp -r Open-ILS/src/edi_translator /openils/var/edi +-------------------------------------------------- +2. Navigate to where you have saved the code to begin next step: ++ +[source, bash] +------------------- +cd /openils/var/edi +------------------- +3. Next, as the *root* user (or a user with sudo rights), install the + dependencies, via "install.sh". This will perform some apt-get routines + to install the code needed for the EDI translator to function. + (Note: subversion must be installed first) ++ +[source, bash] +----------- +./install.sh +----------- +4. Now, we're ready to start "edi_webrick.bash" which is the script that calls + the "Ruby" code to translate EDI. This script needs to be started in + order for EDI to function so please take appropriate measures to ensure this + starts following reboots/upgrades/etc. As the *opensrf* user: ++ +[source, bash] +----------------- +./edi_webrick.bash +----------------- +5. You can check to see if EDI translator is running. + * Using the command "ps aux | grep edi" should show you something similar + if the script is running properly: ++ +[source, bash] +------------------------------------------------------------------------------------------ +root 30349 0.8 0.1 52620 10824 pts/0 S 13:04 0:00 ruby ./edi_webrick.rb +------------------------------------------------------------------------------------------ + * To shutdown EDI Translator you can use something like pkill (assuming + no other ruby processes are running on that server): ++ +[source, bash] +----------------------- +kill -INT $(pgrep ruby) +----------------------- + +Install EDI Scripts +^^^^^^^^^^^^^^^^^^^ + +The EDI scripts are "edi_pusher.pl" and "edi_fetcher.pl" and are used to +"push" and "fetch" EDI messages for configured EDI accounts. + +1. As the *opensrf* user, copy edi_pusher.pl and edi_fetcher.pl from + Open-ILS/src/support-scripts into /openils/bin: ++ +[source, bash] +-------------------------------------------------- +cp Open-ILS/src/support-scripts/edi_pusher.pl /openils/bin +cp Open-ILS/src/support-scripts/edi_fetcher.pl /openils/bin +-------------------------------------------------- +2. Setup the edi_pusher.pl and edi_fetcher.pl scripts to run as cron jobs + in order to regularly push and receive EDI messages. + * Add to the opensrf user's crontab the following entries: ++ +[source, bash] +----------------------------------------------------------------------- +10 * * * * cd /openils/bin && /usr/bin/perl ./edi_pusher.pl > /dev/null +0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null +----------------------------------------------------------------------- + * The example for edi_pusher.pl sets the script to run at + 10 minutes past the hour, every hour. + * The example for edi_fetcher.pl sets the script to run at + 1 AM every night. + +[NOTE] +You may choose to run the EDI scripts more or less frequently based on the +necessary response times from your vendors. + +Configuration +~~~~~~~~~~~~~ + +Configuring Providers +^^^^^^^^^^^^^^^^^^^^^ + +Look in Admin > Server Administration > Acquisitions > Providers + +[options="header"] +|====================================================================================== +|Column |Description/Notes +|Provider Name |A unique name to identify the provider +|Code |A unique code to identify the provider +|Owner |The org unit who will "own" the provider. +|Currency |The currency format the provider accepts +|Active |Whether or not the Provider is "active" for use +|Default Claim Policy|?? +|EDI Default |The default "EDI Account" to use (see EDI Accounts Configuration) +|Email |The email address for the provider +|Fax Phone |A fax number for the provider +|Holdings Tag |The holdings tag to be utilized (usually 852, for Evergreen) +|Phone |A phone number for the provider +|Prepayment Required |Whether or not prepayment is required +|SAN |The vendor provided, org unit specific SAN code +|URL |The vendor website +|====================================================================================== + +Configuring EDI Accounts +^^^^^^^^^^^^^^^^^^^^^^^^ + +Look in Admin > Server Administration > Acquisitions > EDI Accounts + +[options="header"] +|=============================================================================================================== +|Column |Description/Notes +|Label |A unique name to identify the provider +|Host |FTP/SFTP/SSH hostname - vendor assigned +|Username |FTP/SFTP/SSH username - vendor assigned +|Password |FTP/SFTP/SSH password - vendor assigned +|Account |Vendor assigned account number associated with your organization +|Owner |The organizational unit who owns the EDI account +|Last Activity |The date of last activity for the account +|Provider |This is a link to one of the "codes" in the "Providers" interface +|Path |The path on the vendor's server where Evergreen will send it's outgoing .epo files +|Incoming Directory |The path on the vendor's server where "incoming" .epo files are stored +|Vendor Account Number|Vendor assigned account number. +|Vendor Assigned Code |Usually a sub-account designation. Can be used with or without the Vendor Account Number. +|=============================================================================================================== + +Configuring Organizational Unit SAN code +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Look in Admin > Server Settings > Organizational Units + +This interface allows a library to configure their SAN, alongside +their address, phone, etc. + +Troubleshooting +~~~~~~~~~~~~~~~ + +PO JEDI Template Issues +^^^^^^^^^^^^^^^^^^^^^^^ + +Some libraries may run into issues with the action/trigger (PO JEDI). +The template has to be modified to handle different vendor codes that +may be used. For instance, if you use "ingra" instead of INGRAM this +may cause a problem because they are hardcoded in the template. The +following is an example of one modification that seems to work. + +.Original template has: + +[source, bash] +---------------------------------------------------------------------------------------------------------------------------------------------- +"buyer":[ + [% IF target.provider.edi_default.vendcode && (target.provider.code == 'BT' || target.provider.name.match('(?i)^BAKER & TAYLOR')) -%] + {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} + [%- ELSIF target.provider.edi_default.vendcode && target.provider.code == 'INGRAM' -%] + {"id":"[% target.ordering_agency.mailing_address.san %]"}, + {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"} + [%- ELSE -%] + {"id":"[% target.ordering_agency.mailing_address.san %]"} + [%- END -%] +], +---------------------------------------------------------------------------------------------------------------------------------------------- + +.Modified template has the following where it matches on provider SAN instead of code: + +[source, bash] +------------------------------------------------------------------------------------------------------------------------------------------ +"buyer":[ + [% IF target.provider.edi_default.vendcode && (target.provider.san == '1556150') -%] + {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} + {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"} + [%- ELSIF target.provider.edi_default.vendcode && (target.provider.san == '1697978') -%] + {"id":"[% target.ordering_agency.mailing_address.san %]"}, + {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"} + [%- ELSE -%] + {"id":"[% target.ordering_agency.mailing_address.san %]"} + [%- END -%] +], +------------------------------------------------------------------------------------------------------------------------------------------ + diff --git a/docs/opac/my_lists.txt b/docs/opac/my_lists.txt index c6b848e868..0e018e3aa5 100644 --- a/docs/opac/my_lists.txt +++ b/docs/opac/my_lists.txt @@ -1,63 +1,63 @@ -My Lists 2.2 ------------- - -The *My Lists* feature replaces the bookbag feature that was available in versions proior to 2.2. The *My Lists* feature is a part of the Template Toolkit OPAC that is available in version 2.2. This feature enables you to create temporary and permanent lists; create and edit notes for items in lists; place holds on items in lists; and share lists via RSS feeds and CSV files. - - -*Create New Lists* - -1) Log in to your account in the OPAC. - -2) Search for titles. - -3) Choose a title to add to your list. Click *Add to My List*. - -image::media/My_Lists1.jpg[My_Lists1] - -4) Scroll up to the gray row on top of the *Search Results*. Click *View My List* - -5) Items are added to a temporary list. Your temporary list appears at the bottom of the screen. - -6) The *Actions for these items* menu on the right side of the screen demonstrates the actions that you can apply to this list. You can place holds on items in your temporary list; remove items from the list; or move selected items to a permanent list. - -To place a hold or remove items from the list, check the box adjacent to the title of the item, and select the desired function. - -To move selected items into an existing list, check the box adjacent to the title, and highlight the list in which you will store the item. - -image::media/My_Lists3.jpg[My_Lists3] - -7) If you do not want to place the item into an existing list, you can create a new list to contain the item. Enter the name of the new list, and, if desired, enter a description. - -image::media/My_Lists4.jpg[My_Lists4] - -8) Click *Submit*. - -9) The new list appears beneath the temporary list. - -10) Select the title(s) of the items that you want to add to the list, and click *Actions for these items*. Select the permanent list that you created from the drop down menu. - -image::media/My_Lists5.jpg[My_Lists5] - -11) Click *Go*. - -12) Your existing lists appear. Click on a list to view the items in the list. You can sort the items in the permanent list. You can also add, edit, and remove notes. - -13) Click *Edit* to add or edit a note. - -14). Enter desired notes, and click *Save Notes*. - -image::media/My_Lists6.jpg[My_Lists6] - -15) You can keep your list private, or you can share it. To share your list, click *Share*, and click the orange RSS icon to share through an RSS reader. You can also click *HTML View* to share your list as an HTML link. - -You can also download your list into a CSV file by clicking *Download CSV*. - -image::media/My_Lists7.jpg[My_Lists7] - - -16) When you no longer need a list, click *Delete List*. - - - - - +My Lists 2.2 +------------ + +The *My Lists* feature replaces the bookbag feature that was available in versions proior to 2.2. The *My Lists* feature is a part of the Template Toolkit OPAC that is available in version 2.2. This feature enables you to create temporary and permanent lists; create and edit notes for items in lists; place holds on items in lists; and share lists via RSS feeds and CSV files. + + +*Create New Lists* + +1) Log in to your account in the OPAC. + +2) Search for titles. + +3) Choose a title to add to your list. Click *Add to My List*. + +image::media/My_Lists1.jpg[My_Lists1] + +4) Scroll up to the gray row on top of the *Search Results*. Click *View My List* + +5) Items are added to a temporary list. Your temporary list appears at the bottom of the screen. + +6) The *Actions for these items* menu on the right side of the screen demonstrates the actions that you can apply to this list. You can place holds on items in your temporary list; remove items from the list; or move selected items to a permanent list. + +To place a hold or remove items from the list, check the box adjacent to the title of the item, and select the desired function. + +To move selected items into an existing list, check the box adjacent to the title, and highlight the list in which you will store the item. + +image::media/My_Lists3.jpg[My_Lists3] + +7) If you do not want to place the item into an existing list, you can create a new list to contain the item. Enter the name of the new list, and, if desired, enter a description. + +image::media/My_Lists4.jpg[My_Lists4] + +8) Click *Submit*. + +9) The new list appears beneath the temporary list. + +10) Select the title(s) of the items that you want to add to the list, and click *Actions for these items*. Select the permanent list that you created from the drop down menu. + +image::media/My_Lists5.jpg[My_Lists5] + +11) Click *Go*. + +12) Your existing lists appear. Click on a list to view the items in the list. You can sort the items in the permanent list. You can also add, edit, and remove notes. + +13) Click *Edit* to add or edit a note. + +14). Enter desired notes, and click *Save Notes*. + +image::media/My_Lists6.jpg[My_Lists6] + +15) You can keep your list private, or you can share it. To share your list, click *Share*, and click the orange RSS icon to share through an RSS reader. You can also click *HTML View* to share your list as an HTML link. + +You can also download your list into a CSV file by clicking *Download CSV*. + +image::media/My_Lists7.jpg[My_Lists7] + + +16) When you no longer need a list, click *Delete List*. + + + + + diff --git a/docs/root.txt b/docs/root.txt index 5c03084abc..a60641be4e 100644 --- a/docs/root.txt +++ b/docs/root.txt @@ -1,320 +1,320 @@ -Evergreen Documentation -======================= -Documentation Interest Group -:doctype: book -:toc: -:numbered: - -Introduction -============ - -About This Documentation ------------------------- - -This guide was produced by the Evergreen Documentation Interest Group (DIG), -consisting of numerous volunteers from many different organizations. The DIG -has drawn together, edited, and supplemented pre-existing documentation -contributed by libraries and consortia running Evergreen that were kind enough -to release their documentation into the creative commons. Please see the -<> section for a full list of authors and -contributing organizations. Just like the software it describes, this guide is -a work in progress, continually revised to meet the needs of its users, so if -you find errors or omissions, please let us know, by contacting the DIG -facilitators at docs@evergreen-ils.org. - -This guide to Evergreen is intended to meet the needs of front-line library -staff, catalogers, library administrators, system administrators, and software -developers. It is organized into Parts, Chapters, and Sections addressing key -aspects of the software, beginning with the topics of broadest interest to the -largest groups of users and progressing to some of the more specialized and -technical topics of interest to smaller numbers of users. - -Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/. - -About Evergreen ---------------- - -Evergreen is an open source library automation software designed to meet the -needs of the very smallest to the very largest libraries and consortia. Through -its staff interface, it facilitates the management, cataloging, and circulation -of library materials, and through its online public access interface it helps -patrons find those materials. - -The Evergreen software is freely licensed under the GNU General Public License, -meaning that it is free to download, use, view, modify, and share. It has an -active development and user community, as well as several companies offering -migration, support, hosting, and development services. - -The community’s development requirements state that Evergreen must be: - -* Stable, even under extreme load. -* Robust, and capable of handling a high volume of transactions and simultaneous users. -* Flexible, to accommodate the varied needs of libraries. -* Secure, to protect our patrons’ privacy and data. -* User-friendly, to facilitate patron and staff use of the system. - -Evergreen, which first launched in 2006 now powers over 544 libraries of every -type – public, academic, special, school, and even tribal and home libraries – -in over a dozen countries worldwide. - -// Push titles down one level. -:leveloffset: 1 - -include::RELEASE_NOTES_2_2.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -Software Installation -===================== - - -Introduction ------------- - -This part will guide you through the installation steps installation or -upgrading your Evergreen system. It is intended for system administrators. - - -include::installation/system_requirements.txt[] - -// Push titles down one level. -:leveloffset: 1 - -include::installation/server_installation.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -include::installation/server_upgrade.txt[] - -include::installation/edi_setup.txt[] - -// include::staff_client_installation.txt[] -// include::org_unit_structure_initialization.txt[] -// include::loading_data.txt[] - - -System Configuration and Customization -====================================== - -Introduction ------------- - -The Evergreen system allows a free range of customizations to every aspect of -the system. Use this part of the documentation to become familiar with the tools -for configuring the system as well as customizing the OPAC and staff client. - -// include::global_system_configuration.txt[] -// include::opac_customization.txt[] - -include::admin/template_toolkit.txt[] - -include::admin/auto_suggest_search.txt[] - -include::admin/customize_staff_client.txt[] - -// include::backing_up.txt[] - - - -Using the Staff Client -====================== - - -Introduction ------------- - -This part of the documentation deals with general Staff Client usage including -logging in, navigation and shortcuts. - - -include::admin/staff_client-tab_buttons.txt[] - -include::admin/staff_client-double_clicking.txt[] - -include::admin/staff_client-sorting_columns.txt[] - -include::admin/staff_client-recent_searches.txt[] - -include::admin/staff_client-return_to_results_from_marc.txt[] - -System Administration From the Staff Client -=========================================== - -Introduction ------------- - -This part deals with the options in the Server Administration menu found in the -staff client. - -// Follow structure from staff client system admin menu. - -include::admin/acquisitions_admin.txt[] - -include::admin/authorities.txt[] - -include::admin/cn_prefixes_and_suffixes.txt[] - -include::admin/restrict_Z39.50_sources_by_perm_group.txt[] - -include::admin/booking-admin.txt[] - -include::admin/SMS_messaging.txt[] - -include::admin/user_activity_type.txt[] - - -Local Administration -==================== - -Introduction ------------- - -This part covers the options in the Local Administration menu found in the staff -client. - -// Follow structure from staff client local admin menu. - -// Push titles down one level. -:leveloffset: 1 - -include::admin/hold_driven_recalls.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -include::admin/recent_staff_searches.txt[] - -include::admin/lsa-library_settings_editor.txt[] - -include::admin/lsa-statcat.txt[] - - -Acquisitions -=========== - -include::acquisitions/introduction.txt[] - -include::acquisitions/selection_lists_po.txt[] - -include::acquisitions/receive_items_from_invoice.txt[] - -include::acquisitions/vandelay_acquisitions_integration.txt[] - - -Cataloging -========== - -Introduction ------------- - -Cataloguers should use this part for understanding the cataloguing procedures -used in Evergreen. - -include::cataloging/batch_importing_MARC.txt[] - -include::cataloging/overlay_record_3950_import.txt[] - -include::cataloging/monograph_parts.txt[] - -include::cataloging/conjoined_items.txt[] - - -Serials -======= - -include::serials/A-intro.txt[] - -include::serials/B-copy_template.txt[] - -include::serials/C-subscription-SCV.txt[] - -include::serials/D-subscription-ASCV.txt[] - -include::serials/E-edit_subscriptions.txt[] - -include::serials/F-Receiving.txt[] - -include::serials/G-Special_issue.txt[] - -include::serials/H-holdings_statements.txt[] - - -Circulation -=========== - -Introduction ------------- - -Use this section for understanding the circulation procedures in the Evergreen -system. - -include::circulation/circulating_items.txt[] - -include::circulation/booking.txt[] - -Reports -======= - -Introduction ------------- - -Learn how to create and use reports in Evergreen. - -Using the Public Access Catalog -=============================== - -Introduction ------------- - -Use this part for information about searching the Evergreen public access catalog. - -include::opac/my_lists.txt[] - -Developer Resources -=================== - -Introduction ------------- - -Developers can use this part to learn more about the programming languages, -communication protocols and standards used in Evergreen. - -// Push titles down one level. -:leveloffset: 1 - -include::development/updating_translations_launchpad.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -[appendix] - -include::attributions.txt[] - -include::licensing.txt[] - -Admonitions -=========== - -Images used for Admonitions ---------------------------- - -* Note - -image::media/note.png[] - -* warning - -image::media/warning.png[] - -* caution - -image::media/caution.png[] - -* tip - -image::media/tip.png[] - - +Evergreen Documentation +======================= +Documentation Interest Group +:doctype: book +:toc: +:numbered: + +Introduction +============ + +About This Documentation +------------------------ + +This guide was produced by the Evergreen Documentation Interest Group (DIG), +consisting of numerous volunteers from many different organizations. The DIG +has drawn together, edited, and supplemented pre-existing documentation +contributed by libraries and consortia running Evergreen that were kind enough +to release their documentation into the creative commons. Please see the +<> section for a full list of authors and +contributing organizations. Just like the software it describes, this guide is +a work in progress, continually revised to meet the needs of its users, so if +you find errors or omissions, please let us know, by contacting the DIG +facilitators at docs@evergreen-ils.org. + +This guide to Evergreen is intended to meet the needs of front-line library +staff, catalogers, library administrators, system administrators, and software +developers. It is organized into Parts, Chapters, and Sections addressing key +aspects of the software, beginning with the topics of broadest interest to the +largest groups of users and progressing to some of the more specialized and +technical topics of interest to smaller numbers of users. + +Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/. + +About Evergreen +--------------- + +Evergreen is an open source library automation software designed to meet the +needs of the very smallest to the very largest libraries and consortia. Through +its staff interface, it facilitates the management, cataloging, and circulation +of library materials, and through its online public access interface it helps +patrons find those materials. + +The Evergreen software is freely licensed under the GNU General Public License, +meaning that it is free to download, use, view, modify, and share. It has an +active development and user community, as well as several companies offering +migration, support, hosting, and development services. + +The community’s development requirements state that Evergreen must be: + +* Stable, even under extreme load. +* Robust, and capable of handling a high volume of transactions and simultaneous users. +* Flexible, to accommodate the varied needs of libraries. +* Secure, to protect our patrons’ privacy and data. +* User-friendly, to facilitate patron and staff use of the system. + +Evergreen, which first launched in 2006 now powers over 544 libraries of every +type – public, academic, special, school, and even tribal and home libraries – +in over a dozen countries worldwide. + +// Push titles down one level. +:leveloffset: 1 + +include::RELEASE_NOTES_2_2.txt[] + +// Return to normal title levels. +:leveloffset: 0 + +Software Installation +===================== + + +Introduction +------------ + +This part will guide you through the installation steps installation or +upgrading your Evergreen system. It is intended for system administrators. + + +include::installation/system_requirements.txt[] + +// Push titles down one level. +:leveloffset: 1 + +include::installation/server_installation.txt[] + +// Return to normal title levels. +:leveloffset: 0 + +include::installation/server_upgrade.txt[] + +include::installation/edi_setup.txt[] + +// include::staff_client_installation.txt[] +// include::org_unit_structure_initialization.txt[] +// include::loading_data.txt[] + + +System Configuration and Customization +====================================== + +Introduction +------------ + +The Evergreen system allows a free range of customizations to every aspect of +the system. Use this part of the documentation to become familiar with the tools +for configuring the system as well as customizing the OPAC and staff client. + +// include::global_system_configuration.txt[] +// include::opac_customization.txt[] + +include::admin/template_toolkit.txt[] + +include::admin/auto_suggest_search.txt[] + +include::admin/customize_staff_client.txt[] + +// include::backing_up.txt[] + + + +Using the Staff Client +====================== + + +Introduction +------------ + +This part of the documentation deals with general Staff Client usage including +logging in, navigation and shortcuts. + + +include::admin/staff_client-tab_buttons.txt[] + +include::admin/staff_client-double_clicking.txt[] + +include::admin/staff_client-sorting_columns.txt[] + +include::admin/staff_client-recent_searches.txt[] + +include::admin/staff_client-return_to_results_from_marc.txt[] + +System Administration From the Staff Client +=========================================== + +Introduction +------------ + +This part deals with the options in the Server Administration menu found in the +staff client. + +// Follow structure from staff client system admin menu. + +include::admin/acquisitions_admin.txt[] + +include::admin/authorities.txt[] + +include::admin/cn_prefixes_and_suffixes.txt[] + +include::admin/restrict_Z39.50_sources_by_perm_group.txt[] + +include::admin/booking-admin.txt[] + +include::admin/SMS_messaging.txt[] + +include::admin/user_activity_type.txt[] + + +Local Administration +==================== + +Introduction +------------ + +This part covers the options in the Local Administration menu found in the staff +client. + +// Follow structure from staff client local admin menu. + +// Push titles down one level. +:leveloffset: 1 + +include::admin/hold_driven_recalls.txt[] + +// Return to normal title levels. +:leveloffset: 0 + +include::admin/recent_staff_searches.txt[] + +include::admin/lsa-library_settings_editor.txt[] + +include::admin/lsa-statcat.txt[] + + +Acquisitions +=========== + +include::acquisitions/introduction.txt[] + +include::acquisitions/selection_lists_po.txt[] + +include::acquisitions/receive_items_from_invoice.txt[] + +include::acquisitions/vandelay_acquisitions_integration.txt[] + + +Cataloging +========== + +Introduction +------------ + +Cataloguers should use this part for understanding the cataloguing procedures +used in Evergreen. + +include::cataloging/batch_importing_MARC.txt[] + +include::cataloging/overlay_record_3950_import.txt[] + +include::cataloging/monograph_parts.txt[] + +include::cataloging/conjoined_items.txt[] + + +Serials +======= + +include::serials/A-intro.txt[] + +include::serials/B-copy_template.txt[] + +include::serials/C-subscription-SCV.txt[] + +include::serials/D-subscription-ASCV.txt[] + +include::serials/E-edit_subscriptions.txt[] + +include::serials/F-Receiving.txt[] + +include::serials/G-Special_issue.txt[] + +include::serials/H-holdings_statements.txt[] + + +Circulation +=========== + +Introduction +------------ + +Use this section for understanding the circulation procedures in the Evergreen +system. + +include::circulation/circulating_items.txt[] + +include::circulation/booking.txt[] + +Reports +======= + +Introduction +------------ + +Learn how to create and use reports in Evergreen. + +Using the Public Access Catalog +=============================== + +Introduction +------------ + +Use this part for information about searching the Evergreen public access catalog. + +include::opac/my_lists.txt[] + +Developer Resources +=================== + +Introduction +------------ + +Developers can use this part to learn more about the programming languages, +communication protocols and standards used in Evergreen. + +// Push titles down one level. +:leveloffset: 1 + +include::development/updating_translations_launchpad.txt[] + +// Return to normal title levels. +:leveloffset: 0 + +[appendix] + +include::attributions.txt[] + +include::licensing.txt[] + +Admonitions +=========== + +Images used for Admonitions +--------------------------- + +* Note + +image::media/note.png[] + +* warning + +image::media/warning.png[] + +* caution + +image::media/caution.png[] + +* tip + +image::media/tip.png[] + + -- 2.43.2