configure
depcomp
docs/RELEASE_NOTES_2_2.html
+docs/root.html
+docs/root.pdf
install-sh
libtool
ltmain.sh
+++ /dev/null
-Acquisitions\r
-------------\r
-\r
-This section is intended for those who are responsible for managing and processing acquisitions.\r
-\r
-Before beginning to use Acquisitions, the following must be configured by an administrator:\r
-\r
-* Cancel/Suspend Reasons (optional)\r
-* Claiming (optional)\r
-* Currency Types (defaults exist)\r
-* Distribution Formulas (optional)\r
-* EDI Accounts (optional) (see link:../installation/edi_setup.txt[Setting Up EDI Acquisitions] under Software Installation)\r
-* Exchange Rates (defaults exist)\r
-* Funds and Fund Sources\r
-* Invoice Types (defaults exist) and Invoice Payment Methods\r
-* Line Item Features (optional)\r
-* Merge Overlay Profiles and Record Match Sets (see link:../cataloging/batch_importing_MARC.txt[Batch Importing MARC Records] in Cataloging)\r
-* Providers\r
-\r
-Acquisitons Workflow\r
-~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-image::media/acq_workflow.jpg[workflow diagram]\r
+++ /dev/null
-Receive Items From an Invoice\r
------------------------------\r
-\r
-This feature enables users to receive items from an invoice. Staff can receive individual copies, or they can receive items in batch.\r
-\r
-Receive Items in Batch (List Mode)\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-1) Retrieve a purchase order.\r
-\r
-2) Click *Create Invoice*.\r
-\r
-image::media/Receive_Items_From_an_Invoice1.jpg[Receive_Items_From_an_Invoice1]\r
-\r
-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.\r
-\r
-\r
-image::media/Receive_Items_From_an_Invoice2.jpg[Receive_Items_From_an_Invoice2]\r
-\r
-\r
-4) Click *Save*. You must choose a save option before you can receive items.\r
-\r
-\r
-5) The screen refreshes. In the top right corner of the screen, click *Receive Items*.\r
-\r
-\r
-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. \r
-\r
-\r
-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.\r
-\r
-\r
-NOTE: You cannot receive fewer items than 0 (zero) or more items than the number that you ordered.\r
-\r
-\r
-8) Click *Receive Selected Copies*.\r
-\r
-\r
-image::media/Receive_Items_From_an_Invoice4.jpg[Receive_Items_From_an_Invoice4]\r
-\r
-\r
-9) When you are finished receiving items, close the screen. You can repeat this process as you receive more copies.\r
-\r
-\r
-\r
-Receive Specific Copies (Numeric Mode)\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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. \r
-\r
-\r
-1) Complete steps 1-5 in the previous section.\r
-\r
-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.\r
-\r
-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.\r
-\r
-4) Click *Receive Selected Copies*. \r
-\r
-image::media/Receive_Items_From_an_Invoice5.jpg[Receive_Items_From_an_Invoice5]\r
-\r
-\r
-The screen will refresh. Copies that have not yet been received remain on the screen so that you can receive them when they arrive.\r
-\r
-\r
-5) When all copies on an invoice have been received, a message confirms that no copies remain to be received.\r
-\r
-6) The purchase order records that all items have been received.\r
-\r
-image::media/Receive_Items_From_an_Invoice7.jpg[Receive_Items_From_an_Invoice7]\r
-\r
+++ /dev/null
-Selection Lists and Purchase Orders\r
------------------------------------\r
-\r
-Selection Lists\r
-~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a selection list\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-Selection lists can also be created through the My Selection Lists interface:\r
-\r
-. Click Acquisitions -> My Selection Lists.\r
-. Click the New Selection List drop down arrow.\r
-. Enter the name of the selection list in the box that appears.\r
-. Click Create.\r
-\r
-image::media/acq_selection_create.png[create selection list]\r
-\r
-Add items to a selection list\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-Clone selection lists\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. Click Acquisitions -> My Selection Lists.\r
-. Check the box adjacent to the list that you want to clone.\r
-. Click Clone Selected.\r
-. Enter a name into the box that appears, and click Clone.\r
-\r
-image::media/acq_selection_clone.png[clone selection list]\r
-\r
-Merge selection lists\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-You can merge two or more selection lists into one selection list.\r
-\r
-\r
-. Click Acquisitions -> My Selection Lists.\r
-. Check the boxes adjacent to the selection lists that you want to merge, and click Merge Selected.\r
-. 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.\r
-. Click Merge.\r
-\r
-image::media/acq_selection_merge.png[merge selection list]\r
-\r
-Delete selection lists\r
-^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-\r
-. Click Acquisitions -> My Selection Lists.\r
-. Check the box adjacent to the selection list(s) that you want to delete.\r
-. Click Delete Selected.\r
-\r
-Mark Ready for Selector\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-\r
-. 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.\r
-. Click Actions -> Mark Ready for Selector.\r
-. A pop up box will appear. Choose to mark the selected line items or all line items.\r
-. Click Go.\r
-. The screen will refresh. The marked line item(s) will be highlighted pink, and the status changes to selector~ready.\r
-\r
-image::media/acq_selection_mark_ready.png[mark ready]\r
-\r
-Convert selection list to purchase order\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Use the Actions menu to convert a selection list to a purchase order.\r
-\r
-\r
-. From a selection list, click Actions ~> Create Purchase Order.\r
-. A pop up box will appear.\r
-. Select the ordering agency from the drop down menu.\r
-. Enter the provider.\r
-. Check the box adjacent to prepayment required if prepayment is required.\r
-. Choose if you will add All Lineitems or Selected Lineitems to your purchase order.\r
-. Check the box if you want to Import Bibs and Create Copies in the catalog.\r
-. Click Submit.\r
-\r
-Brief Records\r
-~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Add brief records to a selection list\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. 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.\r
-. Choose a selection list from the drop down menu, or enter the name of a new selection list.\r
-. Enter bibliographic information in the desired fields.\r
-. Click Save Record.\r
-\r
-image::media/acq_brief_record.png[]\r
-\r
-Add brief records to purchase orders\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-You can add brief records to new or existing purchase orders.\r
-\r
-. Open or create a purchase order. See the section on link:03~PO.txt[purchase orders] for more information.\r
-. Click Add Brief Record.\r
-. Enter bibliographic information in the desired fields. Notice that the record is added to the purchase order that you just created.\r
-. Click Save Record.\r
-\r
-image::media/acq_brief_record-2.png[]\r
-\r
-MARC Federated Search\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source.\r
-\r
-. Click Acquisitions -> MARC Federated Search.\r
-. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit.\r
-+\r
-----\r
-image::media/acq_marc_search.png[search form]\r
-----\r
-+\r
-. 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.\r
-. 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.\r
-. Enter a price in the "Estimated Price" field.\r
-. 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.\r
-\r
-image::media/acq_marc_search-2.png[line item]\r
+++ /dev/null
-Vandelay Integration into Acquisitions\r
---------------------------------------\r
-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. \r
-\r
-The purpose of this documentation is to describe the interaction between Vandelay and the Acquisitions MARC Batch Upload interface. For detailed instructions on\r
- using the Acquisitions MARC Batch Upload interface, see the Evergreen Documentation Interest Group's Book of Evergreen, 2.1 documentation, Chapter 5, Load MARC \r
-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, \r
-2.2 documentation, Chapter 7, Batch Importing MARC Records.\r
-\r
-*Use Cases for Vandelay Integration into Acquisitions*\r
-\r
-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.\r
-\r
-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.\r
-\r
-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. \r
-A cataloger will later view the queue, edit the records, and import them into the catalog.\r
-\r
-. Click *Acquisitions -> Load MARC Order Records*\r
-. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired.\r
-. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill.\r
-. 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.\r
-. 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.\r
-. Create a new record queue in Vandelay, or upload the records to an existing queue.\r
-. Select a *Record Match Set*.\r
-. Browse your computer to find the MARC file, and click *Upload*.\r
-+\r
-image::media/Vandelay_Integration_into_Acquisitions1.jpg[Vandelay_Integration_into_Acquisitions1]\r
-+\r
-. The processed items appear at the bottom of the screen.\r
-+\r
-image::media/Vandelay_Integration_into_Acquisitions2.jpg[Vandelay_Integration_into_Acquisitions2]\r
-. You can click the link(s) to access the selection list or the import queue. Click the link to *View Selection List*.\r
-. 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.\r
-+\r
-image::media/Vandelay_Integration_into_Acquisitions3.jpg[Vandelay_Integration_into_Acquisitions3]\r
-. 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.\r
-\r
-image::media/Vandelay_Integration_into_Acquisitions4.jpg[Vandelay_Integration_into_Acquisitions4]\r
-\r
-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.\r
-\r
-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.\r
-\r
-. Click *Acquisitions* -> *Load MARC Order Records*\r
-. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired.\r
-. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill.\r
-. 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.\r
-. 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.\r
-. Create a new record queue in Vandelay, or upload the records to an existing queue.\r
-. Select a *Record Match Set*.\r
-. Select *Merge Profile* -> *Match-Only Merge*.\r
-. Check the box adjacent to *Merge on Best Match*.\r
-. Browse your computer to find the MARC file, and click *Upload*.\r
-+\r
-image::media/Vandelay_Integration_into_Acquisitions5.jpg[Vandelay_Integration_into_Acquisitions5]\r
-+\r
-. 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*.\r
-+\r
-image::/media/Vandelay_Integration_into_Acquisitions6.jpg[Vandelay_Integration_into_Acquisitions6]\r
-+\r
-. Click the *catalog* link to view the line item in the catalog.\r
-\r
-*Permissions to use this Feature*\r
-\r
-IMPORT_MARC - Using Vandelay to create new bib records now requres the IMPORT_MARC\r
-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\r
-\r
-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. \r
+++ /dev/null
-SMS Text Messaging
-------------------
-
-The SMS Text Messaging feature enables users to receive hold notices via text message. Users can opt-in to this hold notification as their default setting for all holds, or they
-can receive specific hold notifications via text message. Users can also send call numbers and copy locations via text message.
-
-Administrative Setup
-~~~~~~~~~~~~~~~~~~~~
-
-You cannot receive text messages from Evergreen by default. You must enable this feature to receive hold notices and copy information from Evergreen via text message.
-
-Enable Text Messages
-^^^^^^^^^^^^^^^^^^^^
-
-. Click *Admin* -> *Local Admin* -> *Library Settings Editor.*
-. Select the setting, *Enable features that send SMS text messages.*
-. Set the value to *True,* and click *Update Setting.*
-
-image::media/SMS_Text_Messaging1.jpg[SMS_Text_Messaging1]
-
-Authenticate Patrons
-^^^^^^^^^^^^^^^^^^^^
-
-By default, you must be logged into your OPAC account to send a text message from Evergreen. However, if you disable this setting, you can text message copy information without having
-to login to your OPAC account.
-
-To disable the patron login requirmement:
-
-. Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
-. Select the setting, *Disable auth requirement for texting call numbers*.
-. Set the value to *True,* and click *Update Setting.*
-
-image::media/SMS_Text_Messaging2.jpg[SMS_Text_Messaging2]
-
-Configure SMS Carriers
-^^^^^^^^^^^^^^^^^^^^^^
-
-A list of SMS carriers that can transmit text messages to users is available in the staff client. Library staff can edit this list, or add new carriers.
-
-To add or edit SMS carriers:
-
-. Click *Admin* -> *Server Administration* -> *SMS Carriers*.
-. To add a new carrier, click the *New Carrier* button in the top right corner of the screen. To edit an existing carrier, double click in any white space in the carrier's row.
-+
-image::media/SMS_Text_Messaging3.jpg[SMS_Text_Messaging3]
-+
-. Enter a (geographical) *Region*.
-. Enter the carrier's *Name*.
-. Enter an *Email Gateway.* The SMS carrier can provide you with the content for this field. The $number field is converted to the user's phone number when the text message is generated.
-. Check the *Active* box to use this SMS Carrier.
-
-image::media/SMS_Text_Messaging4.jpg[SMS_Text_Messaging4]
-
-Configure Text Message Templates
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Library staff control the content and format of text messages through the templates in Notifications/Action Triggers. Patrons cannot add free text to their text messages.
-
-To configure the text of the SMS text message:
-
-. Click *Admin* -> *Local Administration* -> *Notifications/Action Triggers.*
-. Create a new A/T and template, or use or modify an existing template. For example, a default template, "Hold Ready for Pickup SMS Notification," notifies users that the hold is ready for pickup.
-+
-image::media/SMS_Text_Messaging5.jpg[SMS_Text_Messaging5]
-+
-. You can use the default template, or you can edit the template and add content specific to your library. Click the hyperlinked name to view and/or edit the hold notice.
-
-image::media/SMS_Text_Messaging6.jpg[SMS_Text_Messaging6]
-
-Receiving Holds Notices via Text Message
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can receive notification that your hold is ready for pickup from a text message that is sent to your mobile phone.
-
-. Login to your account.
-+
-image::media/SMS_Text_Messaging12.jpg[SMS_Text_Messaging12]
-+
-. Search the catalog.
-. Retrieve a record, and click the *Place Hold* link.
-. Select the option to retrieve hold notification via text message.
-. Choose an SMS Carrier from the drop down menu. NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six.
-. Enter a phone number.
-. Click *Submit.*
-
-image::media/SMS_Text_Messaging13.jpg[SMS_Text_Messaging13]
-
-Sending Copy Locations via Text Message
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-You can search the catalog for an item, and, after retrieving results for the item, click a hyperlink to send the copy location in a text message.
-
-. Login to your account in the OPAC. NOTE: If you have disabled the setting that requires patron login, then you do not have to login to their accounts to send text messages.
-See *Administrative Setup* for more information.
-+
-image::media/SMS_Text_Messaging7.jpg[SMS_Text_Messaging7]
-+
-. Search the catalog, and retrieve a title with copies.
-. Click the *Text* link adjacent to the call number.
-+
-image::media/SMS_Text_Messaging8.jpg[SMS_Text_Messaging8]
-+
-. The text of the SMS Text Message appears.
-+
-image::media/SMS_Text_Messaging9.jpg[SMS_Text_Messaging9]
-+
-. Choose an SMS Carrier from the drop down menu. NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six.
-. Enter a phone number.
-+
-image::media/SMS_Text_Messaging10.jpg[SMS_Text_Messaging10]
-+
-. Click *Submit*.
-. The number and carrier are converted to an email address, and the text message is sent to your mobile phone.
-
-image::media/SMS_Text_Messaging11.jpg[SMS_Text_Messaging11]
-
-*Permissions to use this Feature*
-
-ADMIN_SMS_CARRIER - Enables users to add/create/delete SMS Carrier entries.
-
-
+++ /dev/null
-Acquisitions Administration\r
----------------------------\r
-\r
-Acquisitions Permissions in the Admin module\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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_.\r
-\r
-* 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.\r
-* Default circulation modifier - This modifier would be applied to items that are created in the acquisitions module\r
-* Default copy location - This copy location would be applied to items that are created in the acquisitions module\r
-* 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.\r
-* 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.\r
-* Temporary barcode prefix - Temporary barcode prefix for items that are created in the acquisitions module\r
-* Temporary call number prefix - Temporary call number prefix for items that are created in the acquisitions module\r
-\r
-Cancel/Suspend reasons\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a cancel/suspend reason\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To add a new cancel reason, click _Administration -> Server Administration -> Acquisitions -> Cancel reasons_.\r
-\r
-. Click _New Cancel Reason_.\r
-\r
-. 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.)\r
-\r
-. Create a label for the cancel reason. This label will appear when you select a cancel reason on an item or a PO.\r
-\r
-. Create a description of the cancel reason. This is a free text field and can be comprised of any text of your choosing.\r
-\r
-. If you want to retain the debits associated with the cancelled purchase, click the box adjacent to Keep Debits->\r
-\r
-. Click _Save_.\r
-\r
-Claiming\r
-~~~~~~~~\r
-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.\r
-\r
-Create a claim policy\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-The claim policy link enables you to name the claim policy and specify the organization that owns it.\r
-\r
-. To create a claim policy, click _Admin -> Server Administration -> Acquisitions -> Claim Policies_.\r
-. Create a claim policy name. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
-. Click _Save_.\r
-\r
-Create a claim type\r
-^^^^^^^^^^^^^^^^^^^\r
-\r
-The claim type link enables you to specify the reason for a type of claim.\r
-\r
-. To create a claim type, click _Admin -> Server Administration -> Acquisitions -> Claim types_.\r
-. Create a claim type. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
-. Click _Save_.\r
-\r
-Create a claim event type\r
-^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To access the claim event types, click _Admin -> Server Administration -> Acquisitions ->Claim event type_.\r
-. Enter a code for the claim event type. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
-. If this claim is initiated by the user, then check the box adjacent to Library Initiated.\r
-+\r
-[NOTE]\r
-Currently, all claims are initiated by a user. The ILS cannot automatically claim an issue.\r
-+\r
-. Click _Save_.\r
-\r
-Create a claim policy action\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-The claim policy action enables you to specify how long a user should wait before claiming the item.\r
-\r
-. To access claim policy actions, click _Admin -> Server Administration -> Acquisitions ->Claim Policy Actions_.\r
-\r
-. Select an Action (Event Type) from the drop down menu.\r
-\r
-. Enter an action interval. This field indicates how long a user should wait before claiming the item.\r
-\r
-. In the Claim Policy ID field, select a claim policy from the drop down menu.\r
-\r
-. Click _Save_.\r
-\r
-[NOTE]\r
-You can create claim cycles by adding multiple claim policy actions to a claim policy.\r
-\r
-Currency Types\r
-~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a currency type\r
-^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To create a new currency type, click _Admin -> Server Administration -> Acquisitions -> Currency types_.\r
-\r
-. Enter the currency code. No limits exist on the number of characters that can be entered in this field.\r
-\r
-. 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.\r
-\r
-. Click Save.\r
-\r
-Edit a currency type\r
-^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To edit a currency type, click your cursor in the row that you want to edit. The row will turn blue.\r
-\r
-. Double~click. The pop~up box will appear, and you can edit the fields.\r
-\r
-. After making changes, click Save.\r
-\r
-[NOTE]\r
-From the currency types interface, you can delete currencies that have never been applied to funds or used to make purchases.\r
-\r
-Distribution Formulas\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a distribution formula\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. Click _Admin -> Server Administration -> Acquisitions ->Distribution Formulas_.\r
-. Click _New Formula_.\r
-. Enter a Formula Name. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. Ignore the Skip Count field which is currently not used.\r
-. Click _Save_.\r
-. Click _New Entry_.\r
-. 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_).\r
-. Select a Shelving Location from the drop down menu.\r
-. 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.\r
-. Click _Apply Changes_. The screen will reload.\r
-. 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.\r
-\r
-[NOTE]\r
-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.\r
-\r
-Edit a distribution formula\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-To edit a distribution formula, click the hyperlinked title of the formula.\r
-\r
-EDI\r
-~~~\r
-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.\r
-\r
-The following fields are required to create an EDI account: \r
-\r
-[NOTE]\r
-host, username, password, path, and incoming directory.\r
-\r
-EDI Accounts\r
-^^^^^^^^^^^^\r
-\r
-Create EDI Accounts to communicate electronically with providers.\r
-\r
-. 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.\r
-. Enter a host. Your provider will provide you with the requisite FTP or SCP information.\r
-. Enter the username that has been supplied by your provider.\r
-. Enter the password that has been supplied by your provider.\r
-. 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.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. The Last Activity updates automatically with any inbound or outbound communication.\r
-. Select a provider from the drop down menu to whom this account belongs.\r
-. Enter a path. The path indicates the remote location on the server from which files are pulled in to the ILS.\r
-. Enter the incoming directory. This directory indicates the location on your local network to which the files download.\r
-. Enter the vendor account number supplied by your provider.\r
-. Enter the vendor account code supplied by your provider.\r
-. Click Save.\r
-\r
-EDI Messages\r
-^^^^^^^^^^^^\r
-\r
-The EDI messages screen displays all incoming and outgoing messages between the library and the vendor.\r
-\r
-Exchange Rates\r
-~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create an exchange rate\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To create a new exchange rate, click _Admin -> Server Administration -> Acquisitions -> Exchange Rates_.\r
-\r
-. Click New Exchange Rate.\r
-\r
-. Enter the From Currency from the drop down menu populated by the currency types.\r
-\r
-. Enter the To Currency from the drop down menu populated by the currency types.\r
-\r
-. Enter the exchange Ratio.\r
-\r
-. Click _Save_.\r
-\r
-Edit an Exchange Rate\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Edit an exchange rate just as you would edit a currency type.\r
-\r
-MARC Federated Search\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source.\r
-\r
-. Click _Acquisitions -> MARC Federated Search_.\r
-. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit.\r
-+\r
-image::media/acq_marc_search.png[search form]\r
-+\r
-. 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.\r
-. 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.\r
-. Enter a price in the _Estimated Price_ field.\r
-. 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_.\r
-\r
-image::media/acq_marc_search-2.png[line item]\r
-\r
-Fund Tags\r
-~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a Fund Tag\r
-\r
-. To create a fund tag, click _Admin -> Server Administration -> Acquisitions -> Fund Tags_.\r
-. Click _New Fund Tag_. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list.\r
-+\r
-. Enter a Fund Tag Name. No limits exist on the number of characters that can be entered in this field.\r
-. Click _Save_.\r
-\r
-Funding Sources\r
-~~~~~~~~~~~~~~~\r
-\r
-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 ammounts for accounts in your general ledger. You can then use funds to track spending and purchases for specific collections.\r
-\r
-Create a funding source\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To create a new funding source, click _Admin -> Server Administration -> Acquisitions -> Funding Source_.\r
-. Enter a funding source name. No limits exist on the number of characters that can be entered in this field.\r
-. 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).\r
-+\r
-[NOTE]\r
-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.\r
-+\r
-. Create a code for the source. No limits exist on the number of characters that can be entered in this field.\r
-. Select a currency from the drop down menu. This menu is populated from the choices in the Currency Types interface.\r
-. Click _Save_.\r
-\r
-Allocate Credits to Funding Sources\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. Apply a credit to this funding source.\r
-\r
-. 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.\r
-\r
-. To apply a credit, click on the hyperlinked name of the funding source. The Funding Source Details will appear.\r
-\r
-. Click _Apply Credit_.\r
-\r
-. Enter an amount to apply to this funding source.\r
-\r
-. Enter a note. This field is optional.\r
-\r
-. Click _Apply_.\r
-\r
-Allocate credits to funds\r
-^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To allocate credits to funds, click _Allocate to Fund_.\r
-\r
-. Enter the amount that you want to allocate.\r
-\r
-. Enter a note. This field is optional.\r
-\r
-. Click _Apply_.\r
-\r
-Track Debits and Credits\r
-^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-Funds\r
-~~~~~\r
-\r
-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.\r
-\r
-Create a fund\r
-^^^^^^^^^^^^^\r
-\r
-. To create a new fund, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
-. Enter a name for the fund. No limits exist on the number of characters that can be entered in this field.\r
-. Create a code for the fund. No limits exist on the number of characters that can be entered in this field.\r
-. Enter a year for the fund. This can be a fiscal year or a calendar year. The format of the year is YYYY.\r
-. 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).\r
-+\r
-[NOTE]\r
-The rule of parental inheritance applies to this list. See section\r
-+\r
-. 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.\r
-. Click the Active box to activate this fund. You cannot make purchases from this fund if it is not active.\r
-. 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.\r
-. 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.\r
-. Check the Propagate box to propagate funds. When you propagate a fund, the ILS will create a new fund for the following fisca 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.\r
-. Check the Rollover box if you want to roll over remaining funds into the same fund next year.\r
-. Click _Save_.\r
-\r
-Allocate Credits from Funding Sources to Funds\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
-\r
-. Click the hyperlinked name of the fund.\r
-\r
-. To add a credit to the fund, click the Create Allocation tab.\r
-\r
-. Choose a Funding Source from the drop down menu.\r
-\r
-. Enter an amount that you want to apply to the fund from the funding source.\r
-\r
-. Enter a note. This field is optional.\r
-\r
-. Click _Apply_.\r
-\r
-Transfer credits between funds\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
-\r
-. Click the hyperlinked name of the originating fund.\r
-\r
-. The Fund Details screen appears. Click Transfer Money.\r
-\r
-. Enter the amount that you would like to transfer.\r
-\r
-. From the drop down menu, select the destination fund.\r
-\r
-. Add a note. This field is optional.\r
-\r
-. Click _Transfer_.\r
-\r
-Track Balances and Expenditures\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To access the fund details, click on the hyperlinked name of the fund that you created.\r
-\r
-. The Summary allows you to track the following:\r
-\r
-. Balance - The balance is calculated by subtracting both items that have been invoiced and encumbrances from the total allocated to the fund.\r
-. Total Allocated - This amount is the total amount allocated from the Funding Source.\r
-. 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.\r
-. Total Debits - The total debits are calculated by adding the cost of items that have been invoiced and encumbrances.\r
-. Total Spent - The total spent is calculated by adding the cost of items that have been invoiced. It does not include encumbrances.\r
-. Total Encumbered - The total encumbered is calculated by adding all encumbrances.\r
-\r
-Edit a Fund\r
-^^^^^^^^^^^\r
-\r
-Edit a fund just as you would edit a currency type.\r
-\r
-Perform Year End Closeout Operation\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To access the year end closeout of a fund, click Admin -> Server Administration -> Acquisitions -> Funds.\r
-\r
-. Click _Fund Propagation and Rollover_.\r
-\r
-. Check the box adjacent to _Perform Fiscal Year Close~Out Operation_.\r
-\r
-. Notice that the context org unit reflects the context org unit that you selected at the top of the Funds screen.\r
-\r
-. 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.\r
-\r
-. 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.\r
-\r
-. Click _Process_.\r
-\r
-. Evergreen will begin the propagation process. Evergreen will make a clone of each fund, but it will increment the year by .\r
-\r
-Invoice menus\r
-~~~~~~~~~~~~~\r
-\r
-Invoice menus allow you to create drop down menus that appear on invoices. You can create an invoice item type or invoice payment method.\r
-\r
-Invoice item type\r
-^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To create a new charge type, click _Admin -> Server Administration -> Acquisitions -> Invoice Item Type_.\r
-\r
-. Click _New Invoice Item Type_.\r
-\r
-. Create a code for the charge type. No limits exist on the number of characters that can be entered in this field.\r
-\r
-. 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.\r
-\r
-. 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.\r
-\r
-. Click _Save_.\r
-\r
-Invoice payment method\r
-^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-. To create a new invoice payment method, click _Admin -> Server Administration -> Acquisitions -> Invoice Payment Method_.\r
-\r
-. Click _New Invoice Payment Method_.\r
-\r
-. Create a code for the invoice payment method. No limits exist on the number of characters that can be entered in this field.\r
-\r
-. 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.\r
-\r
-. Click _Save_.\r
-\r
-Payment methods can be deleted from this screen.\r
-\r
-Line item features\r
-~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Create a line item alert\r
-^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-. To create a line item alert, click _Administration -> Server Administration -> Acquisitions -> Line Item Alerts_.\r
-\r
-. Click _New Line Item Alert Text_.\r
-\r
-. Create a code for the text. No limits exist on the number of characters that can be entered in this field.\r
-\r
-. Create a description for the text. No limits exist on the number of characters that can be entered in this field.\r
-\r
-. 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).\r
-\r
-. Click _Save_.\r
-\r
-Line Item MARC Attribute Definitions\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
+++ /dev/null
-Authorities
------------
-
-Authority Control Sets
-~~~~~~~~~~~~~~~~~~~~~~
-
-
-The tags and subfields that display in authority records in Evergreen are
-proscribed by control sets. The Library of Congress control set is the default
-control set in Evergreen. In Evergreen release 2.2, you can create customized
-control sets for authority records. Also, you can define thesauri and authority
-fields for these control sets.
-
-Patrons and staff will be able to browse authorities in the OPAC. The following
-fields are browsable by default: author, series, subject, title, and topic. You
-will be able to add custom browse axes in addition to these default fields.
-
-Control Sets
-^^^^^^^^^^^^
-
-You can specify the MARC tags and subfields that an authority record should
-contain. The Library of Congress control set exists in the staff client by
-default. The control sets feature enables librarians to add or customize new
-control sets.
-
-To access existing control sets, click *Admin* -> *Server Administration* ->
-*Authorities* -> *Control Sets*.
-
-To add a *control set*:
-
-. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*.
-. Click *New Control Set*. . Add a *Name* to the control set. Enter any number
-of characters. . Add a *Description* of the control set. Enter any number of
-characters. . Click *Save*.
-
-image::media/Authority_Control_Sets1.jpg[Authority_Control_Sets1]
-
-Thesauri
-~~~~~~~~
-
-A thesaurus describes the semantic rules that govern the meaning of words in a
-MARC record. The thesaurus code, which indicates the specific thesarus that
-should control a MARC record, is encoded in a fixed field using the mnemonic
-Subj in the authority record. Eleven thesauri associated with the Library of
-Congress control set exist by default in the staff client.
-
-To access an existing thesaurus, click *Admin* -> *Server Administration* ->
-*Authorities* -> *Control Sets*, and choose the hyperlinked thesaurus that you
-want to access, or click *Admin* -> *Server Administration* -> *Authorities* ->
-*Thesauri*.
-
-
-To add a *Thesaurus*:
-
-. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*,
-and choose the hyperlinked thesaurus that you want to access, or click *Admin*
--> *Server Administration* -> *Authorities* -> *Thesauri*. . Click *New
-Thesaurus*. . Add a *Thesaurus Code*. Enter any single, upper case character.
-This character will be entered in the fixed fields of the MARC record. . Add a
-*Name* to the thesaurus. Enter any number of characters. . Add a *Description*
-of the thesaurus. Enter any number of characters.
-
-image::media/Authority_Control_Sets2.jpg[Authority_Control_Sets2]
-
-Authority Fields
-~~~~~~~~~~~~~~~~
-
-
-Authority fields indicate the tags and subfields that should be entered in the
-authority record. Authority fields also enable you to specify the type of data
-that should be entered in a tag. For example, in an authority record governed
-by a Library of Congress control set, the 100 tag would contain a "Heading -
-Personal Name." Authority fields also enable you to create the corresponding
-tag in the bibliographic record that would contain the same data.
-
-To create an *Authority Field*:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*.
-. Click *Authority Fields*. The number in parentheses indicates the number of
-authority fields that have been created for the control set.
-. Click *New Authority Field*.
-. Add a *Name* to the authority field. Enter any number of characters.
-. Add a *Description* to describe the type of data that should be entered in
-this tag. Enter any number of characters.
-. Select a *Main Entry* if you are linking the tag(s) to another entry.
-. Add a tag in the authority record.
-. Add a subfield in the authority record. Multiple subfields should be entered
-without commas or spaces.
-. Click *Save*.
-+
-image::media/Authority_Control_Sets3.jpg[Authority_Control_Sets3]
-+
-.Create the corresponding tag in the bibliographic record that should contain
-this information. Click the *None* link in the *Controlled Bib Fields* column.
-. Click *New Control Set Bib Field*.
-. Add the corresponding tag in the bibiographic record.
-. Click *Save*.
-
-image::media/Authority_Control_Sets4.jpg[Authority_Control_Sets4]
-
-
-
-Browse Axes
-~~~~~~~~~~~
-
-Authority records can be browsed, by default, along five axes: author, series,
-subject, title, and topic. Use the *Browse Axes* feature to create additional
-axes.
-
-
-Create a new *Browse Axis*:
-
-. Click *Admin* -> *Server Administration* -> *Authorities* -> *Browse Axes*
-. Click *New Browse Axis*.
-. Add a *code*. Do not enter any spaces.
-. Add a *name* to the axis that will appear in the OPAC. Enter any number of
-characters.
-. Add a *description* of the axis. Enter any number of characters.
-. Add a *sorter attribute*. The sorter attribute indicates the order in which
-the results will be displayed.
-+
-image::media/Authority_Control_Sets5.jpg[Authority_Control_Sets5]
-. Assign the axis to an authority so that users can find the authority record
-when browsing authorities. Click *Admin* -> *Server Administration* ->
-*Authorities* -> *Control Sets*.
-. Choose the control set to which you will add the axis. Click *Authority
-Fields*
-. Click the link in the *Axes* column of the tag of your choice.
-. Click *New Browse Axis-Authority Field Map*.
-. Select an *Axis* from the drop down menu.
-. Click *Save*.
-
-image::media/Authority_Control_Sets6.jpg[Authority_Control_Sets6]
-
-
-OPAC Searching of Authorities
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Patrons and librarians can browse authorities through the OPAC.
-
-
-To search for *Authorities*:
-
-. Click *Advanced Search* in the OPAC.
-. Find the *Authority Browse* column in the left side of the screen.
-. Select a browse axis, and enter a keyword. The terms in the middle of the
-results list should yield the best match.
-+
-image::media/Authority_Control_Sets7.jpg[Authority_Control_Sets7]
-. Click *Submit*.
-. A list of results will appear. The authorities with bibliographic records
-attached will be listed in bold with the number of attached bibliographic
-records in parentheses.
-+
-image::media/Authority_Control_Sets8.jpg[Authority_Control_Sets8]
-+
-. Click on the bolded text to view bibliographic records.
-
-image::media/Authority_Control_Sets9.jpg[Authority_Control_Sets9]
-
-
-*Permissions to use this Feature*
-
-
-To use authority control sets, you will need the following permissions:
-
-* CREATE_AUTHORITY_CONTROL_SET UPDATE_AUTHORITY_CONTROL_SET
-* DELETE_AUTHORITY_CONTROL_SET
-
+++ /dev/null
-Auto Suggest in Catalog Search\r
-------------------------------\r
-\r
-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 \r
-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 \r
-this suggestion. This feature is not turned on by default. You must turn it on in the Admin module.\r
-\r
-\r
-Enabling this Feature\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-. To enable this feature, click *Admin* -> *Server Administration* -> *Global Flags*.\r
-. Scroll down to item 10, OPAC.\r
-. Double click anywhere in the row to edit the fields.\r
-. Check the box adjacent to *Enabled* to turn on the feature.\r
-. 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.\r
-+\r
-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 \r
-there are matching MARC records with copies within your search scope. For example, it will suggest MARC records with copies at your branch.\r
-+\r
-. Click *Save.*\r
-\r
-image::media/Auto_Suggest_in_Catalog_Search2.jpg[Auto_Suggest_in_Catalog_Search2]\r
-\r
-Using this Feature\r
-~~~~~~~~~~~~~~~~~~\r
-\r
-. Enter search terms into the basic search field. Evergreen will automatically suggest search terms.\r
-. Select a suggestion to view records that are linked to this suggestion. \r
-\r
-image::media/Auto_Suggest_in_Catalog_Search1.jpg[Auto_Suggest_in_Catalog_Search1]\r
-\r
+++ /dev/null
-Booking Module Administration\r
------------------------------\r
-\r
-Creating Bookable Non-Bibliographic Resources\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms.\r
-\r
-The following pieces make up a non-bibliographic resource:\r
-\r
-* Resource Type\r
-* Resource Attribute\r
-* Resource Attribute Values\r
-* Resource\r
-* Resource Attribute Map\r
-\r
-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.\r
-\r
-Create New Resource Type\r
-^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Select Admin --> Server Administration --> Booking --> Resource Types.\r
-\r
-image::media/booking-create-resourcetype-1.png[]\r
-\r
-2) A list of current resource types will appear. Use Back and Next buttons to browse the whole list.\r
-\r
-image::media/booking-create-resourcetype-2.png[]\r
-\r
-[NOTE]\r
-You may also see cataloged items in the list. Those items have been marked bookable or booked before.\r
-\r
-\r
-3) To create a new resource type, click New Resource Type in the top right corner, .\r
-\r
-image::media/booking-create-resourcetype-3.png[]\r
-\r
-4) A box will appear in which you create your new type of resource.\r
-\r
-image::media/booking-create-bookable-1.png[]\r
-\r
-* Resource Type Name - Give your resource a name.\r
-* Fine Interval - How often will fines be charged? This period can be input in several ways:\r
-\r
-[NOTE]\r
-====================================================================\r
-** second(s), minute(s), hour(s), day(s), week(s), month(s), year(s)\r
-** sec(s), min(s)\r
-** s, m, h\r
-** 00:00:30, 00:01:00, 01:00:00\r
-===================================================================\r
-\r
-* Fine Amount - The amount that will be charged at each Fine Interval.\r
-* Owning Library - The home library of the resource.\r
-* Catalog Item - (Function not currently available.)\r
-* Transferable - This allows the item to be transferred between libraries.\r
-* 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.\r
-* Max Fine Amount - The amount at which fines will stop generating.\r
-\r
-5) Click Save when you have entered the needed information.\r
-\r
-image::media/booking-create-resourcetype-4.png[]\r
-\r
-6) The new resource type will appear in the list.\r
-\r
-image::media/booking-create-resourcetype-5.png[]\r
-\r
-Create New Resource Attribute\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Select Server Administration --> Booking --> Resource Attributes.\r
-\r
-2) Click New Resource Attribute in the top right corner.\r
-\r
-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.\r
-\r
-image::media/booking-create-bookable-2.png[]\r
-\r
-* Resource Attribute Name - Give your attribute a name.\r
-* Owning Library - The home library of the resource.\r
-* Resource Type - Type in the first letter to list then choose the Resource Type to which the Attribute is applicable.\r
-* Is Required - (Function not currently available.)\r
-\r
-4) Click Save when the necessary information has been entered.\r
-\r
-5) The added attribute will appear in the list.\r
-\r
-[NOTE]\r
-One resource type may have multiple attributes. You may repeat the above procedure to add more.\r
-\r
-Create New Resource Attribute Value\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) One resource attribute may have multiple values. To add new attribute value, select Server Administration → Booking → Resource Attribute Values.\r
-\r
-2) Click New Resource Attribute Value in the top right corner.\r
-\r
-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.\r
-\r
-image::media/booking-create-bookable-3.png[]\r
-\r
-* Owning Library - The home library of the resource.\r
-* Resource Attribute - The attribute you wish to assign the value to.\r
-* Valid Value - Enter the value for your attribute.\r
-\r
-4) Click Save when the required information has been added.\r
-\r
-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.\r
-\r
-Create New Resource\r
-^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Add items to a resource type. Click Admin → Server Administration → Booking → Resources.\r
-\r
-2) Click New Resource in the top right corner.\r
-\r
-3) A box will appear. Add information for the resource.\r
-\r
-image::media/booking-create-bookable-4.png[]\r
-\r
-* Owning Library - The home library of the resource.\r
-* Resource Type - Type in the first letter of the resource type's name to list then select the resource type for your item.\r
-* Barcode - Barcode for the resource.\r
-* Overbook - This allows a single item to be reserved, picked up, and returned by multiple patrons during overlapping or identical time periods.\r
-* Is Deposit Required - (Function not currently available.)\r
-* Deposit Amount - (Function not currently available.)\r
-* User Fee - (Function not currently available.)\r
-\r
-4) Click Save when the required information has been added.\r
-\r
-5) The resource will appear in the list.\r
-\r
-[NOTE]\r
-One resource type may have multiple resources attached.\r
-\r
-Map Resource Attributes and Values to Resources\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Admin → Server Administration → Booking → Resource Attribute Maps.\r
-\r
-2) Click New Resource Attribute Map in the right top corner.\r
-\r
-3) A box will appear in which you will map your attributes and values to your resources.\r
-\r
-image::media/booking-create-bookable-5.png[]\r
-\r
-* Resource - Enter the barcode of your resource.\r
-* Resource Attribute - Select an attribute that belongs to the Resource Type.\r
-* 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.\r
-\r
-4) Click Save once you have entered the required information.\r
-\r
-[NOTE] \r
-A resource may have multiple attributes and values. Repeat the above steps to map all.\r
-\r
-5) The resource attribute map will appear in the list.\r
-\r
-Once all attributes have been mapped your resource will be part of a hierarchy similar to the example below.\r
-\r
-image::media/booking-create-bookable-6.png[]\r
-\r
-\r
-Editing Non-Bibliographic Resources\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Editing Resource Types\r
-^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Bring up your list of resource types. Select Admin --> Server Administration --> Booking --> Resource Types.\r
-\r
-2) A list of current resource types will appear.\r
-\r
-3) Double click anywhere on the line of the resource type you would like to edit.\r
-\r
-4) The resource type box will appear. Make your changes and click Save.\r
-\r
-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.\r
-\r
-\r
-\r
-\r
-Deleting Non-bibliographic Resources\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-1) To delete a booking resource, go to Admin → Server Administration → Booking → Resources.\r
-\r
-2) Select the checkbox in front the resource you want to delete. Click Delete Selected. The resource will disappear from the list.\r
-\r
-Following the same procedure you may delete Resource Attributes Maps.\r
-\r
-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.\r
-\r
-This is the deletion order: Resource Attribut Map/Resources --> Resource Attribute Values --> Resource Attributes --> Resource Types. \r
-\r
-\r
-\r
-\r
+++ /dev/null
-Call Number Prefixes and Suffixes\r
----------------------------------\r
-\r
-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.\r
-\r
-\r
-Configure call number prefixes\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Call number prefixes are codes that precede a call number.\r
-\r
-To configure call number prefixes:\r
-\r
-1. Select *Admin -> Server Administration -> Call Number Prefixes*.\r
-2. Click *New Prefix*.\r
-3. Enter the *call number label* that will appear on the item.\r
-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.\r
-5. Click *Save*.\r
-\r
-\r
-\r
-image::media/Call_Number_Prefixes_and_Suffixes_2_21.jpg[Call_Number_Prefixes_and_Suffixes_2_21]\r
-\r
-\r
-\r
-Configure call number suffixes\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Call number suffixes are codes that succeed a call number.\r
-\r
-To configure call number suffixes:\r
-\r
-1. Select *Admin -> Server Administration -> Call Number Suffixes*.\r
-2. Click *New Suffix*.\r
-3. Enter the *call number label* that will appear on the item.\r
-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.\r
-5. Click *Save*.\r
-\r
-\r
-image::media/Call_Number_Prefixes_and_Suffixes_2_22.jpg[Call_Number_Prefixes_and_Suffixes_2_22]\r
-\r
-\r
-Apply Call Number Prefixes and Suffixes\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
+++ /dev/null
-Customizing the Staff Client\r
-----------------------------\r
-\r
-Customizable Toolbar\r
-~~~~~~~~~~~~~~~~~~~~\r
-\r
-\r
-By default, two toolbars are available in the staff client: circulation and\r
-cataloging. This feature enables you to customize toolbars in the staff client.\r
-You can create toolbars for specific org unit(s), workstation(s), or login(s). \r
-\r
-\r
-Configure Toolbar \r
-^^^^^^^^^^^^^^^^^\r
-\r
-. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure\r
-Toolbars*. \r
-. Click *New Toolbar*. \r
-. *Enter label for toolbar*. \r
-+\r
-image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1] \r
-+ \r
-. Click *Ok*. \r
-.Select one of the buttons in the *Available* panel. The *Button ID* describes\r
-that action that the button will take, and the *Label* will display in the\r
-toolbar. \r
-. Click the *--> A* button to add the selected function to the\r
-*Selected* panel on the bottom right side of the screen. To remove a button,\r
-click the *<--R* button. \r
-+\r
-image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2] \r
-+ \r
-. Continue adding buttons if desired. The buttons will display in the order that you add\r
-them. If you want to reorder the buttons, click the *Up* or *Down* buttons. \r
-. To separate buttons onto left and right sides of the screen on the same\r
-toolbar, select *toolbarspacer*, and click *--> A*.\r
-+\r
-image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3]\r
-+\r
-. To add a dividing line between buttons that appear on the same side of the\r
-screen, select *toolbarseparator*, and click *-->A*.\r
-+\r
-image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4]\r
-+\r
-. At the bottom of the screen, choose the owner of this toolbar. \r
-If you click *Owning Org Unit*, then the owning org unit that you specify will display this\r
-toolbar. Select the owning org unit from the drop down menu. The rule of\r
-parental inheritance applies, so all child units will inherit the toolbars of\r
-their parental units. \r
-If you click *Owning Workstation*, then the workstation to which you are logged\r
-in when you created the toolbar will display this toolbar. \r
-If you select *Owning User*, then your login has access to that toolbar.\r
- . When you are finished creating the toolbar, click *Save Toolbar*. Any\r
-toolbar to which you have access displays under *Admin -> Workstation\r
-Administration -> Toolbars -> Current*.\r
-\r
-*Permissions*\r
-\r
-ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars\r
+++ /dev/null
-Hold-driven recalls
-===================
-
-indexterm:[hold-driven recalls]
-indexterm:[circulation, recalls, hold-driven]
-
-_Added in Evergreen 2.1_
-
-In academic libraries, it is common for groups like faculty and graduate
-students to have extended loan periods (for example, 120 days), while
-others have more common loan periods such as 3 weeks. In these environments,
-it is desirable to have a hold placed on an item that has been loaned out
-for an extended period to trigger a 'recall', which:
-
- . Truncates the loan period
- . Sets the remaining available renewals to 0
- . 'Optionally': Changes the fines associated with overdues for the new due
- date
- . 'Optionally': Notifies the current patron of the recall, including the
- new due date and fine level
-
-Enabling hold-driven recalls
-----------------------------
-
-By default, holds do not trigger recalls. To enable hold-driven recalls
-of circulating items, library settings must be changed as follows:
-
- . Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
- . Set the *Recalls: Circulation duration that triggers a recall
- (recall threshold)* setting. The recall threshold is specified as an
- interval (for example, "21 days"); any items with a loan duration of
- less that this interval are not considered for a recall.
- . Set the *Recalls: Truncated loan period (return interval)* setting.
- The return interval is specified as an interval (for example, "7 days").
- The due date on the recalled item is changed to be the greater of either
- the recall threshold or the return interval.
- . 'Optionally': Set the *Recalls: An array of fine amount, fine interval,
- and maximum fine* setting. If set, this applies the specified fine rules
- to the current circulation period for the recalled item.
-
-When a hold is placed and no available copies are found by the hold targeter,
-the recall logic checks to see if the recall threshold and return interval
-settings are set; if so, then the hold targeter checks the currently
-checked-out copies to determine if any of the currently circulating items at
-the designated pickup library have a loan duration longer than the recall
-threshold. If so, then the eligible item with the due date nearest to the
-current date is recalled.
-
-Editing the item recall notification email template
----------------------------------------------------
-The template for the item recall notification email is contained in the
-'Item Recall Email Notice' template, found under *Admin* -> *Local
-Administration* -> *Notifications / Action Triggers*.
+++ /dev/null
-Library Settings Editor
------------------------
-
-Fine Accrual on Closed Dates
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-By default, fines accrue only on dates that the library is open. This feature enables you to charge patrons fines on dates the library is closed. Fines accrue during scheduled closings as well as during normal weekly closed dates.
-
-To enable this feature:
-
-. Click *Admin* -> *Local Administration* -> *Library Settings* -> *Charge fines on overdue circulations when closed*
-. Click *Edit*.
-. Set the value to *True*.
-. Click *Update Setting*.
-
-
-Target Copies for Holds at Closed Libraries
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-By default, when a patron places a hold on a title, the hold targeter will search for copies to fill the hold only at circulating libraries that are open. Copies at closed libraries
-are not targeted to fill holds. When turned on, this feature enables Evergreen to target copies that have closed circulating libraries to fill holds. Two new org unit settings control this feature.
-
-Use the following setting to target copies for holds at closed circulating libraries:
-
-. Click *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Target copies for a hold even if copy's circ lib is closed*
-. Set the value to *True* if you want to target copies for holds at closed circulating libraries. Set the value to *False*, or leave it unset, if you do not want to enable this feature.
-. Click *Update Setting*.
-
-image::media/Target_Pickup_Lib1.jpg[Target_Pickup_Lib1]
-
-Use the following setting to target copies for holds IF AND ONLY IF the circulating library is the hold's pickup library.
-
-. Click *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Target copies for a hold even if copy's circ lib is closed IF the circ lib is the hold's pickup lib*
-. Set the value to *True* if you want to target copies for holds at closed circulating libraries when the circulating library of the item and the pickup library of the hold are
-the same. Set the value to *False*, or leave it unset, if you do not want to enable this feature.
-. Click *Update Setting*.
-
-image::media/Target_Pickup_Lib2.jpg[Target_Pickup_Lib2]
+++ /dev/null
-Statistical Categories Editor
------------------------------
-
-This is where you configure your statistical categories (stat cats). Stat cats are a way to save and report on additional information that doesn’t fit elsewhere in Evergreen's default records. It is possible to have stat cats for copies or patrons.
-
-1. Click *Admin -> Local Administration -> Statistical Categories Editor.*
-
-2. To create a new stat cat, enter the name of the category and select either _patron_ or _copy_ from the *Type* dropdown menu. Each category type has a number of options you may set.
-
-*Copy Statistical Categories*
-
-Copy stat cats appear in the _Copy Editor_, also known as the _Edit Item Attributes_ screen. You might use copy stat cats to track books you have bought from a specific vendor, or donations.
-
-An example of the _Create a new statistical category_ controls for copies:
-
-image::media/lsa-statcat-1.png[Create copy stat cat]
-
-* _OPAC Visibility_: Should the category be displayed in the OPAC?
-* _Required_: Must the category be assigned a value when editing the item attributes?
-* _Archive with Circs_: Should the category and its values for the copy be archived with aged circulation data?
-* _SIP Field_: Select the SIP field identifier that will contain the category and its value
-* _SIP Format_: Specify the SIP format string
-
-Some sample copy stat cats:
-
-image::media/lsa-statcat-2.png[Sample copy stat cats]
-
-To add an entry, select _Add_. To edit an entry, select the entry you wish to edit from the drop-down list for the category.
-
-This is how the copy stat cats appear in the _Copy Editor_:
-
-image::media/lsa-statcat-3.png[Stat cats in Copy Editor]
-
-*Patron Statistical Categories*
-
-Patron stat cats can be used to keep track of information such as the high school a patron attends, or the home library for a consortium patron, e.g. Interlink, or patron preferences. They appear in the fifth section of the _Patron Registration_ or _Edit Patron_ screen.
-
-An example of the _Create a new statistical category_ controls for patrons:
-
-image::media/lsa-statcat-4.png[Create patron stat cat]
-
-* _OPAC Visibility_: Should the category be displayed in the OPAC?
-* _Required_: Must the category be assigned a value when registering a new patron or editing an existing one?
-* _Archive with Circs_: Should the category and its values for the patron be archived with aged circulation data?
-* _Allow Free Text_: May the person registering/editing the patron information supply their own value for the category?
-* _Show in Summary_: Display the category and its value in the patron summary view?
-* _SIP Field_: Select the SIP field identifier that will contain the category and its value
-* _SIP Format_: Specify the SIP format string
-
-[WARNING]
-.WARNING
-=====================================
-If you make a category *required* and also *disallow free text*, make sure that you populate an entry list for the category so that the user may select a value. Failure to do so will result in an unsubmittable patron registration/edit form!
-=====================================
-
-Some sample patron stat cats:
-
-image::media/lsa-statcat-5.png[Sample patron stat cats]
-
-To add an entry, click on _Add_ in the category row under the _Add Entry_ column:
-
-image::media/lsa-statcat-6.png[Add patron category entry]
-
-To edit an entry, select the entry you wish to edit from the drop-down list for the category:
-
-image::media/lsa-statcat-7.png[Edit patron category entry]
-
-An *organizational unit* (consortium, library system branch library, sub library, etc.) may create their own categories and entries, or supplement categories defined by a higher-level org unit with their own entries.
-
-An entry can be set as the *default* entry for a category and for an org unit. If an entry is set as the default, it will be automatically selected in the patron edit screen, provided no other value has been previously set for the patron. Only one default may be set per category for any given org unit.
-
-Lower-level org unit defaults override defaults set for higher-level org units; but in the absence of a default set for a given org unit, the nearest parent org unit default will be selected.
-
-Default entries for the focus location org unit are marked with an asterisk in the entry dropdowns.
-
-This is how patron stat cats appear in the patron registration/edit screen:
-
-image::media/lsa-statcat-8.png[Patron stat cats in registration screen]
-
+++ /dev/null
-Recent Staff Searches\r
----------------------\r
-\r
-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. \r
-\r
-*Administrative Settings*\r
-\r
-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.\r
-\r
-To configure the number of recent staff searches:\r
-\r
-1. Click *Admin -> Local Administration -> Library Settings Editor.*\r
-\r
-2. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages*\r
-\r
-3. Click *Edit*.\r
-\r
-4. Select a *Context* from the drop down menu.\r
-\r
-5. Enter the number of searches that you wish to save in the *Value* field. \r
-\r
-6. Click *Update Setting*\r
-\r
-image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21]\r
-\r
-\r
-NOTE: To retain this setting, the system administrator must restart the web server.\r
-\r
-\r
-If you do not want to save any searches, then you can turn off this feature.\r
-\r
-To deactivate this feature:\r
-\r
-1. Follow steps 1-4 (one through four) as listed in the previous section.\r
-\r
-2. In the *value* field, enter 0 (zero).\r
-\r
-3. Click *Update Setting.* This will prevent you from viewing any saved searches.\r
-\r
-\r
-*Recent Staff Searches*\r
-\r
-Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches:\r
-\r
-1. Enter a search term in either the basic or advanced search fields.\r
-\r
-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.\r
-\r
-image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22]\r
+++ /dev/null
-Restrict Z39.50 Sources by Permission Group\r
--------------------------------------------\r
-\r
-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.\r
-\r
-Administrative Settings\r
-~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-You can add a permission to limit use of Z39.50 servers, or you can use an existing permission.\r
-\r
-NOTE: You must be authorized to add permission types at the database level to add a new permission.\r
-\r
-Add a new permission:\r
-\r
-1) Create a permission at the database level.\r
-\r
-2) Click *Admin -> Server Administration -> Permissions* to add a permission to the staff client.\r
-\r
-3) In the *New Permission* field, enter the text that describes the new permission.\r
-\r
-image::media/Restrict_Z39_50_Sources_by_Permission_Group1.jpg[]\r
-\r
-4) Click *Add*.\r
-\r
-5) The new permission appears in the list of permissions.\r
-\r
-\r
-\r
-Restrict Z39.50 Sources by Permission Group\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-1) Click *Admin -> Server Administration -> Z39.50 Servers*\r
-\r
-2) Click *New Z39.50 Server*, or double click on an existing Z39.50 server to restrict its use.\r
-\r
-3) Select the permission that you added to restrict Z39.50 use from the drop down menu.\r
-\r
-image::media/Restrict_Z39_50_Sources_by_Permission_Group2.jpg[]\r
-\r
-4) Click *Save*.\r
-\r
-5) Add the permission that you created to a user or user group so that they can access the restricted server.\r
-\r
-\r
-image::media/Restrict_Z39_50_Sources_by_Permission_Group3.jpg[]\r
-\r
-6) Users that log in to the staff client and have that permission will be able to see the restricted Z39.50 server. \r
-\r
-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.\r
+++ /dev/null
-New Options for Double Clicking\r
--------------------------------\r
-\r
-Double Click to Retrieve a Patron's Record\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-. Click *Search -> Search for Patrons* to access a patron's record\r
-. Enter search terms.\r
-. Retrieve a list of possible matches. Double click on the record that you want to open.\r
-\r
-image::media/Double_Click1.jpg[Double_Click1]\r
-\r
-\r
-Double Click to Retrieve Item Attributes\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-. Enter search terms to retrieve a bibliographic record.\r
-. Click *Actions for this Record* -> *Holdings Maintenance*.\r
-. Double click on an item.\r
-+\r
-image::media/Double_Click3.jpg[Double_Click3]\r
-+\r
-. The copy information will appear in a new tab.\r
+++ /dev/null
-Recent Staff Searches\r
----------------------\r
-\r
-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. \r
-\r
-Administrative Settings\r
-~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-To configure the number of recent staff searches:\r
-\r
-. Click *Admin -> Local Administration -> Library Settings Editor.*\r
-. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages*\r
-. Click *Edit*.\r
-. Select a *Context* from the drop down menu.\r
-. Enter the number of searches that you wish to save in the *Value* field. \r
-. Click *Update Setting*\r
-\r
-image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21]\r
-\r
-\r
-NOTE: To retain this setting, the system administrator must restart the web server.\r
-\r
-If you do not want to save any searches, then you can turn off this feature.\r
-\r
-To deactivate this feature:\r
-\r
-. Follow steps 1-4 (one through four) as listed in the previous section.\r
-. In the *value* field, enter 0 (zero).\r
-. Click *Update Setting.* This will prevent you from viewing any saved searches.\r
-\r
-\r
-Recent Staff Searches\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches:\r
-\r
-. Enter a search term in either the basic or advanced search fields.\r
-. 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.\r
-\r
-image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22]\r
+++ /dev/null
-Return to Search Results from MARC Record\r
------------------------------------------\r
-\r
-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.\r
-\r
-image::media/Search_Results1.jpg[Search_Results1]\r
+++ /dev/null
-Sorting Columns\r
----------------\r
-\r
-This feature enables you to sort display columns so that you can find easily the\r
-information that you need on a screen that contains multiple columns. You can\r
-sort display columns on any screen that is built on a grid, such as the Check In\r
-screen or the On Shelf Pull List. \r
-\r
-You can also sort the columns on the following Administration screens:\r
-Circulation Policies, Hold Policies, Circulation Limit Sets, Barcode Completion,\r
-Acquisitions User Request List, and Vandelay Import Errors.\r
-\r
-You can sort items in an ascending or descending order, and you can prioritize\r
-the order in which columns will sort. The following use cases illustrate how to\r
-sort items within the Circulation and Administration interfaces.\r
-\r
-Sorting the On Shelf Pull List\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-You want to capture items that are on the shelf to fill current holds. To\r
-simplify this process, you will sort the items on the On Shelf Pull List by Copy\r
-Location and Call Number.\r
-\r
-. Click *Circulation* -> *Pull List for Hold Requests*.\r
-. The first column that you want to sort is the column, Current Copy Location. Right click the column header, Current Copy Location. \r
-. Click *Sort First (Descending)*.\r
-+\r
-image::media/Sorting_Columns3.jpg[Sorting_Columns3]\r
-+\r
-. The next column that you want to sort is the column, Call Number. Right click the column header, Call Number. \r
-. Click *Sort Next (Ascending)*.\r
-+\r
-image::media/Sorting_Columns4.jpg[Sorting_Columns4]\r
-+\r
-. The pull list has now been sorted by copy location and call number.\r
-\r
-image::media/Sorting_Columns5.jpg[Sorting_Columns5]\r
-\r
-NOTE: If you wanted to sort more columns, you could continue the process by clicking *Sort Next* for any subsequent columns.\r
-\r
-\r
-Sorting Circulation Policies\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-You want to sort the display of circulation policies in your staff client. \r
-\r
-. Click *Administration* -> *Local Administration* -> *Circulation Policies*.\r
-. Right click on any column header.\r
-. A pop-up box appears.\r
-+\r
-image::media/Sorting_Columns2.jpg[Sorting_Columns2]\r
-+\r
-. Check the *Display* box if you want to display a column in the staff client.\r
-. Check the *Auto Width* box if you want the width of the columns to adjust to fit the staff client.\r
-. Select a sort priority. \r
-.. A sort priority of "0" indicates that no sorting has been applied. Columns will display in their default order.\r
-.. 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.\r
-.. A sort priority of "-1" indicates that descending sorting should be applied to this column.\r
-. Click *Save*. The circulation policies will now sort according to your selections each time that you log into the staff client.\r
+++ /dev/null
-Tab Buttons\r
------------\r
-\r
-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. \r
-\r
-image::media/New_Tab_Button1.jpg[New_Tab_Button1]\r
+++ /dev/null
-TPac Configuration and Customization
-------------------------------------
-
-Template toolkit documentation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-For more general information about template toolkit see: http://template-toolkit.org/docs/index.html[official
-documentation].
-
-The purpose of this chapter is to focus on the
-Evergreen-specific uses of Template Toolkit ('TT') in the OPAC.
-
-TPAC URL
-~~~~~~~
-
-The URL for the TPAC on a default Evergreen system is
-http://localhost/eg/opac/home (adjust `localhost` to match your hostname or IP
-address, naturally!)
-
-Perl modules used directly by TPAC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader.pm`
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Account.pm`
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Container.pm`
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Record.pm`
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Search.pm`
- * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Util.pm`
-
-Default templates
-~~~~~~~~~~~~~~~~
-
-The source template files are found in `Open-ILS/src/templates/opac`.
-
-These template files are installed in `/openils/var/templates/opac`.
-
-.NOTE
-You should generally avoid touching the installed default template files,
-unless you are contributing changes that you want Evergreen to adopt as a new
-default. Even then, while you are developing your changes, consider using
-template overrides rather than touching the installed templates until you are
-ready to commit the changes to a branch. See below for information on template
-overrides.
-
-Apache configuration files
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The base Evergreen configuration file on Debian-based systems can be found in
-`/etc/apache2/sites-enabled/eg.conf`. This file defines the basic virtual host
-configuration for Evergreen (hostnames and ports), then single-sources the
-bulk of the configuration for each virtual host by including
-`/etc/apache2/eg_vhost.conf`.
-
-TPAC CSS and media files
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The CSS files used by the default TPAC templates are stored in the repo in
-`Open-ILS/web/css/skin/default/opac/` and installed in
-`/openils/var/web/css/skin/default/opac/`.
-
-The media files--mostly PNG images--used by the default TPAC templates are
-stored in the repo in `Open-ILS/web/images/` and installed in
-`/openils/var/web/images/`.
-
-Mapping templates to URLs
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The mapping for templates to URLs is straightforward. Following are a few
-examples, where `<templates>` is a placeholder for one or more directories
-that will be searched for a match:
-
- * `http://localhost/eg/opac/home` => `/openils/var/<templates>/opac/home.tt2`
- * `http://localhost/eg/opac/advanced` => `/openils/var/<templates>/opac/advanced.tt2`
- * `http://localhost/eg/opac/results` => `/openils/var/<templates>/opac/results.tt2`
-
-The template files themselves can process, be wrapped by, or include other
-template files. For example, the `home.tt2` template currently involves a
-number of other template files to generate a single HTML file:
-
-.Example Template Toolkit file: opac/home.tt2
-[source, html]
-------------------------------------------------------------------------------
-[% PROCESS "opac/parts/header.tt2";
- WRAPPER "opac/parts/base.tt2";
- INCLUDE "opac/parts/topnav.tt2";
- ctx.page_title = l("Home") %]
- <div id="search-wrapper">
- [% INCLUDE "opac/parts/searchbar.tt2" %]
- </div>
- <div id="content-wrapper">
- <div id="main-content-home">
- <div class="common-full-pad"></div>
- [% INCLUDE "opac/parts/homesearch.tt2" %]
- <div class="common-full-pad"></div>
- </div>
- </div>
-[% END %]
-------------------------------------------------------------------------------
-
-We will dissect this example in some more detail later, but the important
-thing to note is that the file references are relative to the top of the
-template directory.
-
-How to override templates
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Overrides for templates go in a directory that parallels the structure of the
-default templates directory. The overrides then get pulled in via the Apache
-configuration.
-
-In the following example, we demonstrate how to create a file that overrides
-the default "Advanced search page" (`advanced.tt2`) by adding a new templates
-directory and editing the new file in that directory.
-
-.Adding an override for the Advanced search page (example)
-[source, bash]
-------------------------------------------------------------------------------
-bash$ mkdir -p /openils/var/templates_custom/opac
-bash$ cp /openils/var/templates/opac/advanced.tt2 \
- /openils/var/templates_custom/opac/.
-bash$ vim /openils/var/templates_custom/opac/advanced.tt2
-------------------------------------------------------------------------------
-
-We now need to teach Apache about the new templates directory. Open `eg.conf`
-and add the following `<Location /eg>` element to each of the `<VirtualHost>`
-elements in which you want to include the overrides. The default Evergreen
-configuration includes a `VirtualHost` directive for port 80 (HTTP) and another
-one for port 443 (HTTPS); you probably want to edit both, unless you want the
-HTTP user experience to be different from the HTTPS user experience.
-
-.Configuring the custom templates directory in Apache's eg.conf
-[source,xml]
-------------------------------------------------------------------------------
-<VirtualHost *:80>
- # <snip>
-
- # - absorb the shared virtual host settings
- Include eg_vhost.conf
- <Location /eg>
- PerlAddVar OILSWebTemplatePath "/openils/var/templates_algoma"
- </Location>
-
- # <snip>
-</VirtualHost>
-------------------------------------------------------------------------------
-
-Finally, reload the Apache configuration to pick up the changes:
-
-.Reloading the Apache configuration
-[source,bash]
-------------------------------------------------------------------------------
-bash# /etc/init.d/apache2 reload
-------------------------------------------------------------------------------
-
-You should now be able to see your change at http://localhost/eg/opac/advanced
-
-Defining multiple layers of overrides
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can define multiple layers of overrides, so if you want every library in
-your consortium to have the same basic customizations, and then apply
-library-specific customizations, you can define two template directories for
-each library.
-
-In the following example, we define the `template_CONS` directory as the set of
-customizations to apply to all libraries, and `template_BR#` as the set of
-customizations to apply to library BR1 and BR2.
-
-As the consortial customizations apply to all libraries, we can add the
-extra template directory directly to `eg_vhost.conf`:
-
-.Apache configuration for all libraries (eg_vhost.conf)
-[source,xml]
-------------------------------------------------------------------------------
-# Templates will be loaded from the following paths in reverse order.
-PerlAddVar OILSWebTemplatePath "/openils/var/templates"
-PerlAddVar OILSWebTemplatePath "/openils/var/templates_CONS"
-------------------------------------------------------------------------------
-
-Then we define a virtual host for each library to add the second layer of
-customized templates on a per-library basis. Note that for the sake of brevity
-we only show the configuration for port 80.
-
-.Apache configuration for each virtual host (eg.conf)
-[source,xml]
-------------------------------------------------------------------------------
-<VirtualHost *:80>
- ServerName br1.concat.ca
- DocumentRoot /openils/var/web/
- DirectoryIndex index.xml index.html index.xhtml
- Include eg_vhost.conf
- <Location /eg>
- PerlAddVar OILSWebTemplatePath "/openils/var/templates_BR1"
- </Location>
-</VirtualHost>
-
-<VirtualHost *:80>
- ServerName br2.concat.ca
- DocumentRoot /openils/var/web/
- DirectoryIndex index.xml index.html index.xhtml
- Include eg_vhost.conf
- <Location /eg>
- PerlAddVar OILSWebTemplatePath "/openils/var/templates_BR2"
- </Location>
-</VirtualHost>
-------------------------------------------------------------------------------
-
-Changing some text in the TPAC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Out of the box, the TPAC includes a number of placeholder text and links. For
-example, there is a set of links cleverly named 'Link 1', 'Link 2', and so on
-in the header and footer of every page in the TPAC. Let's customize that for
-our `templates_BR1` skin.
-
-To begin with, we need to find the page(s) that contain the text in question.
-The simplest way to do that is with the handly utility `ack`, which is much
-like `grep` but with built-in recursion and other tricks. On Debian-based
-systems, the command is `ack-grep` as `ack` conflicts with an existing utility.
-In the following example, we search for files that contain the text "Link 1":
-
-.Searching for text matching "Link 1"
-[source,bash]
-------------------------------------------------------------------------------
-bash$ ack-grep "Link 1" /openils/var/templates/opac
-/openils/var/templates/opac/parts/topnav_links.tt2
-4: <a href="http://example.com">[% l('Link 1') %]</a>
-------------------------------------------------------------------------------
-
-Next, we copy the file into our overrides directory and edit it with `vim`:
-
-.Copying the links file into the overrides directory
-[source,bash]
-------------------------------------------------------------------------------
-bash$ cp /openils/var/templates/opac/parts/topnav_links.tt2 \
- /openils/var/templates_BR1/opac/parts/topnav_links.tt2
-bash$ vim /openils/var/templates_BR1/opac/parts/topnav_links.tt2
-------------------------------------------------------------------------------
-
-Finally, we edit the link text in `opac/parts/header.tt2`.
-
-.Content of the opac/parts/header.tt2 file
-[source,html]
-------------------------------------------------------------------------------
-<div id="gold-links-holder">
- <div id="gold-links">
- <div id="header-links">
- <a href="http://example.com">[% l('Link 1') %]</a>
- <a href="http://example.com">[% l('Link 2') %]</a>
- <a href="http://example.com">[% l('Link 3') %]</a>
- <a href="http://example.com">[% l('Link 4') %]</a>
- <a href="http://example.com">[% l('Link 5') %]</a>
- </div>
- </div>
-</div>
-------------------------------------------------------------------------------
-
-For the most part, the page looks like regular HTML, but note the `[%_("`
-`")%]` that surrounds the text of each link. The `[% ... %]` signifies a TT
-block, which can contain one or more TT processing instructions. `l(" ... ");`
-is a function that marks text for localization (translation); a separate
-process can subsequently extract localized text as GNU gettext-formatted PO
-files.
-
-.NOTE
-As Evergreen supports multiple languages, any customizations to Evergreen's
-default text must use the localization function. Also, note that the
-localization function supports placeholders such as `[_1]`, `[_2]` in the text;
-these are replaced by the contents of variables passed as extra arguments to
-the `l()` function.
-
-Once we have edited the link and link text to our satisfaction, we can load
-the page in our Web browser and see the live changes immediately (assuming
-we are looking at the BR1 overrides, of course).
-
-Troubleshooting
-~~~~~~~~~~~~~~~
-
-If there is a problem such as a TT syntax error, it generally shows up as a
-an ugly server failure page. If you check the Apache error logs, you will
-probably find some solid clues about the reason for the failure. For example,
-in the following example the error message identifies the file in which the
-problem occurred as well as the relevant line numbers:
-
-.Example error message in Apache error logs
-[source,bash]
-------------------------------------------------------------------------------
-bash# grep "template error" /var/log/apache2/error_log
-[Tue Dec 06 02:12:09 2011] [warn] [client 127.0.0.1] egweb: template error:
- file error - parse error - opac/parts/record/summary.tt2 line 112-121:
- unexpected token (!=)\n [% last_cn = 0;\n FOR copy_info IN
- ctx.copies;\n callnum = copy_info.call_number_label;\n
-------------------------------------------------------------------------------
-
+++ /dev/null
-User Activity Types\r
--------------------\r
-\r
-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.\r
-\r
-Enabling this Feature\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-The *Label* is a free text field that enables you to describe the activity that you are tracking.\r
-\r
-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.\r
-\r
-The *Event Type* describes the type of activity that Evergreen is tracking. Currently, this feature only tracks user authentication. \r
-\r
-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.\r
-\r
-The *Enabled* field allows you to specify which types of user activity that you would like to track.\r
-\r
-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*.\r
-\r
-image::media/User_Activity_Types1A.jpg[User_Activity_Types1A]\r
-\r
-\r
-Using this Feature\r
-~~~~~~~~~~~~~~~~~~\r
-\r
-The last activty date for user logins appears in the patron's summary.\r
-\r
-image::media/User_Activity_Types2A.jpg[User_Activity_Types2A]\r
- \r
+++ /dev/null
-[[attributions]]
-Attributions
-============
-
-Copyright © 2009-2012 Evergreen DIG
-
-Copyright © 2007-2012 Equinox
-
-Copyright © 2007-2012 Dan Scott
-
-Copyright © 2009-2012 BC Libraries Cooperative (SITKA)
-
-Copyright © 2008-2012 King County Library System
-
-Copyright © 2009-2012 Pioneer Library System
-
-Copyright © 2009-2012 PALS
-
-Copyright © 2009-2012 Georgia Public Library Service
-
-Copyright © 2008-2012 Project Conifer
-
-Copyright © 2009-2012 Bibliomation
-
-Copyright © 2008-2012 Evergreen Indiana
-
-Copyright © 2008-2012 SC LENDS
-
-
-
-*Current DIG Members*
-
-* Hilary Caws-Elwitt, Susquehanna County Library
-* Karen Collier, Kent County Public Library
-* George Duimovich, NRCan Library
-* Sally Fortin, Equinox Software
-* Wolf Halton, Lyrasis
-* June Rayner, eiNetwork
-* Steve Sheppard
-* Ben Shum, Bibliomation
-* Roni Shwaish, eiNetwork
-* Robert Soulliere, Mohawk College
-* Tim Spindler, C/W MARS
-* Lindsay Stratton, Pioneer Library System
-* Yamil Suarez, Berklee College of Music
-* Jenny Turner, PALS
+++ /dev/null
-Batch Importing MARC Records\r
-----------------------------\r
-\r
-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. \r
-\r
-Permissions\r
-~~~~~~~~~~~\r
-\r
-To use match sets to import records, you will need the following permission:\r
-\r
-ADMIN_IMPORT_MATCH_SET\r
-\r
-\r
-Record Display Attributes\r
-~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-This feature enables you to specify the tags and subfields that will display in records that appear in the import queue. \r
-\r
-\r
-*Record Match Sets*\r
-\r
-This feature enables you to create custom match points that you can use to accurately match incoming records with existing catalog records. \r
- \r
-\r
-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.\r
- \r
-\r
-1) Click *Cataloging -> MARC Batch Import/Export*.\r
-\r
-2) Create a new record match set. Click *Record Match Sets -> New Match Set*.\r
-\r
-3) Enter a name for the record match set.\r
-\r
-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.\r
-\r
-5) Select a *Match Set Type* from the drop down menu. You can create a match set for authority records or bibliographic records.\r
-\r
-6) Click *Save*.\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records1.jpg[Batch_Importing_MARC_Records1]\r
-\r
-\r
-7) The screen will refresh to list the record match set that you created. Click the link to the record match set.\r
-\r
-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.\r
-\r
-9) Select a *Record Attribute* from the drop-down menu.\r
-\r
-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.\r
-\r
-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.\r
-\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records2.jpg[Batch_Importing_MARC_Records2]\r
-\r
-\r
-\r
-12) Click *Ok.*\r
-\r
-13) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree.\r
-\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records3.jpg[Batch_Importing_MARC_Records3]\r
-\r
-\r
-The match point will nest underneath the folder in the Expression tree.\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records4.jpg[Batch_Importing_MARC_Records4]\r
-\r
-\r
-14) Enter another *Boolean Operator* to further refine your match set.\r
-\r
-15) Click *Boolean Operator*.\r
-\r
-16) Select the *OR* operator from the drop down menu.\r
-\r
-17) Click *Ok*.\r
-\r
-18) Drag the operator to the expression tree.\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records5.jpg[Batch_Importing_MARC_Records5]\r
-\r
-\r
-19) Click *MARC Tag and Subfield*.\r
-\r
-20) Enter a *MARC tag* on which you want the records to match.\r
-\r
-21) Enter a *subfield* on which you want the records to match.\r
-\r
-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.\r
-\r
-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.\r
-\r
-\r
-24) Click *Ok.*\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records6.jpg[Batch_Importing_MARC_Records6]\r
-\r
-\r
-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.\r
-\r
-26) Add additional MARC tags or record attributes to build the expression tree.\r
-\r
-27) Click *Save Changes to Expression*.\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records7.jpg[Batch_Importing_MARC_Records7]\r
-\r
-\r
-*Replace Mode*\r
-\r
-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.\r
-\r
-\r
-1) Create a working match point.\r
-\r
-2) Click *Enter replace mode*.\r
-\r
-3) Highlight the piece of the tree that you want to replace.\r
-\r
-4) Drag the replacement piece over the highlighted piece.\r
-\r
-5) Click *Exit Replace Mode*.\r
-\r
-\r
-*Quality Metrics*\r
-\r
-\r
-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.\r
-\r
-2) You can create quality metrics based on the record attribute or the MARC Tag and Subfield.\r
-\r
-3) Click *Record Attribute.*\r
-\r
-4) Select an attribute from the drop down menu.\r
-\r
-5) Enter a value for the attribute.\r
-\r
-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).\r
-\r
-7) Click *Ok*. \r
- \r
-\r
-image::media/Batch_Importing_MARC_Records8.jpg[Batch_Importing_MARC_Records8]\r
-\r
-\r
-\r
-*Import Records*\r
-\r
-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.\r
-\r
-\r
-1) Select a *Record Type* from the drop down menu.\r
-\r
-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.\r
-\r
-3) Select a *Record Match Set* from the drop down menu.\r
-\r
-4) Select a *Holdings Import Profile* if you want to import holdings that are attached to your records.\r
-\r
-5) Select a *Record Source* from the drop down menu.\r
-\r
-6) Select a *Merge Profile*. Merge profiles enable you to specify which tags should be removed or preserved in incoming records.\r
-\r
-7) Choose one of the following import options if you want to auto-import records:\r
-\r
-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.\r
-\r
-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.\r
-\r
-NOTE: Quality ratio affects only the *Merge on Single Match* and *Merge on Best Match* options.\r
-\r
-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.\r
-\r
-\r
-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\r
-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. \r
-\r
-10) *Browse* to find the appropriate file, and click *Upload*. The files will be uploaded to a queue.\r
-\r
-\r
-image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9]\r
-\r
-11) The screen will display records that have been uploaded to your queue.\r
- \r
-image::media/Batch_Importing_MARC_Records15.jpg[Batch_Importing_MARC_Records15]\r
-\r
-\r
-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. \r
-\r
-image::media/Batch_Importing_MARC_Records10.jpg[Batch_Importing_MARC_Records10]\r
-\r
-13) Click *Back to Import Queue*.\r
-\r
-14) Check the boxes of the records that you want to import, and click *Import Selected Records*, or click *Import All Records*.\r
-\r
-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*.\r
-\r
-image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9]\r
-\r
-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.\r
-\r
-image::media/Batch_Importing_MARC_Records12.jpg[Batch_Importing_MARC_Records12] \r
-\r
-17) Search the catalog to confirm that the record was imported.\r
-\r
-image::media/Batch_Importing_MARC_Records14.jpg[Batch_Importing_MARC_Records14] \r
-\r
+++ /dev/null
-Conjoined Items
----------------
-
-Prior to Evergreen version 2.1, items could be attached to only one bibliographic record. The Conjoined Items feature in Evergreen 2.1 enables catalogers to link items to multiple bibliographic records. This feature will enable more precise cataloging. For example, catalogers will be able to indicate items that are printed back to back, are bilingual, are part of a bound volume, are part of a set, or are available as an e-reader pre-load. This feature will also help the user retrieve more relevant search results. For example, a librarian catalogs a multi-volume festschrift. She can create a bibliographic record for the festschrift and a record for each volume. She can link the items on each volume to the festschrift record so that a patron could search for a volume or the festschrift and retrieve information about both works.
-
-In the example below, a librarian has created a bibliographic record for two bestselling items. These books are available as physical copies in the library, and they are available as e-reader downloads. The librarian will link the copy of the Kindle to the bibliographic records that are available on the e-reader.
-
-Using the Conjoined Items Feature
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The Conjoined Items feature was designed so that you can link items between bibliographic records when you have the item in hand, or when the item is not physically present. Both processes are described here. The steps are fewer if you have the item in hand, but both processes accomplish the same task. This documentalso demonstrates the process to edit or delete links between items and bibliographic records. Finally, the permission a cataloger needs to use this feature is listed.
-
-.Scenario 1: I want to link an item to another bibliographic record, but I do not have the item in hand
-
-1) Retrieve the bibliographic record to which you would like to link an item.
-
-2) Click *Actions for this Record -> Mark as Target for Conjoined Items.*
-
-
-image::media/conj1.jpg[conj1]
-
-
-3) A confirmation message will appear. Click *OK.*
-
-4) In a new tab, retrieve the bibliographic record with the item that you want to link to the other record.
-
-5) Click *Actions for this Record -> Holdings Maintenance.*
-
-6) Select the copy that you want to link to the other bibliographic record. Right-click, or click *Actions for Selected Rows -> Link as Conjoined Items to Previously Marked Bib Record.*
-
-image::media/conj2.jpg[conj2]
-
-
-7) The *Manage Conjoined Items* interface opens in a new tab. This interface enables you to confirm the success of the link, and to change the peer type if desired. The *Result* column indicates that you created a successful link between the item and the bib record.
-
-image::media/conj3.jpg[conj3]
-
-The default peer type, *Back-to-back*, was set as the peer type for our item. To change a peer type after the link has been created, right-click or click *Actions for Selected Items -> Change Peer Type*. A drop down menu will appear. Select the desired peer type, and click *OK.*
-
-
-image::media/conj4.jpg[conj4]
-
-
-8) The *Result* column will indicate that the *Peer Type* [has been] *Updated.*
-
-
-image::media/conj5.jpg[conj5]
-
-
-9) To confirm the link between the item and the desired bib record, reload the tab containing the bib record to which you linked the item. Click the link for *Linked Titles.*
-
-
-image::media/conj6.jpg[conj6]
-
-
-10) To view the copy details, including the peer type, click *Copy Details.*
-
-
-image::media/conj7.jpg[conj7]
-
-
-Items can be linked to multiple bibliographic records simultaneously. If you click the linked titles button in the copy details, then you will retrieve a list of bibliographic records to which this item is linked.
-
-
-image::media/conj8.jpg[conj8]
-
-
-.Scenario 2: I want to link an item to another bibliographic record, and I do have the item in hand
-
-1) Retrieve the bibliographic record to which you would like to add the item.
-
-2) Click *Actions for this Record -> Manage Conjoined Items.*
-
-
-image::media/conj9.jpg[conj9]
-
-
-3) A note in the bottom left corner of the screen will confirm that the record was targeted for linkage with conjoined items, and the *Manage Conjoined Items* screen will appear.
-
-4) Select the peer type from the drop down menu, and scan in the barcode of the item that you want to link to this record.
-
-5) Click *Link to Bib (Submit).*
-
-
-image::media/conj10.jpg[conj10]
-
-
-6) The linked item will appear in the screen. The *Result* column indicates Success.
-
-7) To confirm the linkage, click *Actions for this Record -> OPAC View.*
-
-8) When the bibliographic record appears, click *Reload. Linked Titles* will show the linked title and item.
-
-
-.Scenario 3: I want to edit or break the link between a copy and a bibliographic record
-
-1) Retrieve the bibliographic record that has a copy linked to it.
-
-2) Click *Actions for this Record -> Manage Conjoined Items.*
-
-3) Select the copy that you want to edit, and right-click or click *Actions for Selected Items.*
-
-4) Make any changes, and click *OK.*
-
-
-UPDATE_COPY - Link items to bibliographic records
+++ /dev/null
-Monograph Parts\r
----------------\r
-\r
-*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.\r
-\r
-Four new permissions are used by this functionality: CREATE_MONOGRAPH_PART, UPDATE_MONOGRAPH_PART, DELETE_MONOGRAPH_PART and MAP_MONOGRAPH_PART. Thes\r
-e permissions should be assigned at the consorial level to those groups or users that will make use of the features described below.\r
-\r
-\r
-Add a monograph part to an existing record\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-To add a monograph part to an existing record in the catalog: \r
-\r
-1) Retrieve a record.\r
-\r
-2) Click *Actions for this Record -> Manage Parts*\r
-\r
-\r
-image::media/monograph_parts1.jpg[monograph_parts1]\r
-\r
-\r
-3) Click *New Monograph Part*\r
-\r
-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. \r
-\r
-\r
-image::media/monograph_parts2.jpg[monograph_parts2]\r
-\r
-\r
-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*. \r
-\r
-To add a volume and copy to your workstation library or other libraries, click *Actions for this Record -> Holdings Maintenance -> Add Volumes*. \r
-\r
-\r
-image::media/monograph_parts3.jpg[monograph_parts3]\r
-\r
-\r
-6) The *Unified Volume/Copy Creator* opens. Enter the number of volumes that you want to add to the catalog and the volume description. \r
-\r
-7) Enter the number of copies and barcode(s) of each item.\r
-\r
-8) Select the *part designation* from the drop down menu adjacent to the barcode field.\r
-\r
-9) Apply a template to the copies, or edit fields in the *Copy Editor*.\r
-\r
-\r
-image::media/monograph_parts4.jpg[monograph_parts4]\r
-\r
-\r
-10) Click *Create Volumes/Items*.\r
-\r
-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.\r
-\r
-\r
-image::media/monograph_parts5.jpg[monograph_parts5]\r
-\r
+++ /dev/null
-Overlay Existing Catalog Record via Z39.50 Import\r
--------------------------------------------------\r
-\r
-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.\r
-\r
-*To Overlay an Existing Record via Z39.50 Import:*\r
-\r
-1) Click *Cataloging -> Import Record from Z39.50*\r
-\r
-2) Select at least one *Service* in addition to the *Local Catalog* in the *Service and Credentials* window in the top right panel.\r
-\r
-3) Enter search terms in the *Query* window in the top left panel.\r
-\r
-4) Click *Search*.\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import1.jpg[]\r
-\r
-5) The results will appear in the lower window.\r
-\r
-6) Select the record in the local catalog that you wish to overlay.\r
-\r
-7) Click *Mark Local Result as Overlay Target*\r
-\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import2.jpg[]\r
-\r
-\r
-8) A confirmation message appears. Click *OK*.\r
-\r
-9) Select the record that you want to replace the existing catalog record.\r
-\r
-10) Click *Overlay.*\r
-\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import3.jpg[]\r
-\r
-\r
-11) The record that you selected will open in the MARC Editor. Make any desired changes to the record, and click *Overlay Record*.\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import4.jpg[]\r
-\r
-\r
-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.\r
-\r
-13) If the correct record appears, click *Overlay*.\r
-\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import5.jpg[]\r
-\r
-14) A confirmation message will appear to confirm that you have overlaid the record. Click *Ok*.\r
-\r
-15) The screen will refresh in the OPAC View to show that the record has been overlaid.\r
-\r
-\r
-image::media/Overlay_Existing_Record_via_Z39_50_Import6.jpg[]\r
+++ /dev/null
-Booking Module\r
---------------\r
-\r
-Creating a Booking Reservation\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-To create a reservation from a patron record\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Retrieve the patron’s record.\r
-\r
-2) Select Other --> Booking --> Create or Cancel Reservations. This takes you to the Reservations Screen.\r
-\r
-image::media/booking-create-1.png[]\r
-\r
-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.\r
-\r
-image::media/booking-create-2.png[]\r
-\r
-4) For non-catalogued resources, the Bookable Resource Type and the items associated with the type will appear.\r
-\r
-image::media/booking-create-3.png[]\r
-\r
-For catalogued items, the title and the item will display in the box.\r
-\r
-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.\r
-\r
-image::media/booking-create-4.png[]\r
-\r
-[NOTE]\r
-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.\r
-\r
-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.\r
-\r
-image::media/booking-create-5.png[]\r
-\r
-7) Select the pickup location from the dropdown list.\r
-\r
-image::media/booking-create-6.png[]\r
-\r
-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 \r
-and then click Reserve Selected.\r
-\r
-image::media/booking-create-7.png[]\r
-\r
-9) A message will confirm that the action succeeded. Click OK on the prompt.\r
-\r
-10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen.\r
-\r
-image::media/booking-create-9.png[]\r
-\r
-To create a reservation from a booking resource\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-You need to know the barcode of the patron when you create a reservation for him/her from a booking resource.\r
-\r
-1) From the Booking menu, select Create Reservations\r
-\r
-image::media/booking-create-module-1.png[]\r
-\r
-2) Choose a Bookable Resource Type and click Next or enter the barcode of a catalogued resource and click Next.\r
-\r
-image::media/booking-create-module-2.png[]\r
-\r
-3) For non-catalogued resources, a screen showing the Bookable Resource Type and the items associated with the type will appear.\r
-\r
-image::media/booking-create-module-3.png[]\r
-\r
-For catalogued resources, the title and item will appear.\r
-\r
-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.\r
-\r
-image::media/booking-create-module-4.png[]\r
-\r
-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.\r
-\r
-image::media/booking-create-4.png[]\r
-\r
-[NOTE]\r
-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.\r
-\r
-\r
-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.\r
-\r
-image::media/booking-create-5.png[]\r
-\r
-7) Select the pickup location from the dropdown list.\r
-\r
-image::media/booking-create-6.png[]\r
-\r
-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.\r
-\r
-image::media/booking-create-7.png[]\r
-\r
-9) A message will confirm that the action succeeded. Click OK on the prompt.\r
-\r
-10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen.\r
-\r
-image::media/booking-create-9.png[]\r
-\r
-\r
-Search the catalogue to create a reservation\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-If you would like to reserve a catalogued item but do not know the item barcode, you may start with a catalogue search.\r
-\r
-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.\r
-\r
-2) Click the title to display the record summary. In the Copy Summary, select Copy Details in Actions column.\r
-\r
-3) The Copy Details will appear in a new row. In the barcode column, click the book now link.\r
-\r
-4) A screen showing the title and barcodes of available copies will appear.\r
-\r
-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.\r
-\r
-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.\r
-\r
-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.\r
-\r
-8) A message will confirm that the action succeeded. Click OK on the prompt.\r
-\r
-9) The screen will refresh, and the reservation will appear below the user’s name.\r
-\r
-[NOTE]\r
-Reservations on catalogued items can be created on Item Status (F5) screen. Select the item, then Actions for Selected Items → Book Item Now.\r
-\r
-Reservation Pull List\r
-~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Reservation pull list can be generated dynamically on the Staff Client.\r
-\r
-1) To create a pull list, select Booking --> Pull List.\r
-\r
-image::media/booking-pull-1.png[]\r
-\r
-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.\r
-\r
-3) Click Fetch to retrieve the pull list.\r
-\r
-image::media/booking-pull-2.png[]\r
-\r
-4) The pull list will appear. Click Print to print the pull list.\r
-\r
-image::media/booking-pull-3.png[]\r
-\r
-Capturing Items for Reservations\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Reservations must be captured before they are ready to be picked up by the patron.\r
-\r
-[CAUTION]\r
-Always capture reservations in Booking Module. Check In function in Circulation does not function the same as Capture Resources.\r
-\r
-1) In the staff client, select Booking --> Capture Resources.\r
-\r
-image::media/booking-capture-1.png[]\r
-\r
-2) Scan the item barcode or type the barcode then click Capture.\r
-\r
-image::media/booking-capture-2.png[]\r
-\r
-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.\r
-\r
-image::media/booking-capture-3.png[]\r
-\r
- \r
-Picking Up Reservations\r
-~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-[CAUTION]\r
-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.\r
-\r
-1) Ready-for-pickup reservations can be listed from Other --> Booking --> Pick Up Reservations within a patron record or Booking --> Pick Up Reservations.\r
-\r
-\r
-image::media/booking-pickup-1.png[]\r
-\r
-image::media/booking-pickup-module-1.png[]\r
-\r
-\r
-2) Scan the patron barcode if using Booking --> Pick Up Reservations.\r
-\r
-3) The reservation(s) available for pickup will display. Select those you want to pick up and click Pick Up.\r
-\r
-image::media/booking-pickup-2.png[]\r
-\r
-4) The screen will refresh to show that the patron has picked up the reservation(s).\r
-\r
-image::media/booking-pickup-3.png[]\r
-\r
-\r
-Returning Reservations\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-[CAUTION]\r
-When a reserved item is brought back, staff must use the Booking Module to return the reservation.\r
-\r
-1) To return reservations, select Booking --> Return Reservations\r
-\r
-image::media/booking-return-module-1.png[]\r
-\r
-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.\r
-\r
-image::media/booking-return-module-2.png[]\r
-\r
-3) A pop up box will tell you that the item was returned. Click OK on the prompt.\r
-\r
-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.\r
-\r
-image::media/booking-return-2.png[]\r
-\r
-5) The screen will refresh to show any resources that remain out and the reservations that have been returned.\r
-\r
-image::media/booking-return-module-4.png[]\r
-\r
-[NOTE]\r
-Reservations can be returned from within patron records by selecting Other --> Booking --> Return Reservations\r
-\r
-Cancelling a Reservation\r
-~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-A reservation can be cancelled in a patron’s record or reservation creation screen.\r
-\r
-Cancel a reservation from the patron record\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Retrieve the patron's record.\r
-\r
-2) Select Other --> Booking --> Create or Cancel Reservations.\r
-\r
-image::media/booking-create-1.png[]\r
-\r
-3) The existing reservations will appear at the bottom of the screen.\r
-\r
-image::media/booking-cancel-1.png[]\r
-\r
-4) Highlight the reservation that you want to cancel. Click Cancel Selected.\r
-\r
-image::media/booking-cancel-2.png[]\r
-\r
-[NOTE]\r
-Use Shift or Ctrl on keyboard and mouse click to select multiple reservations if needed.\r
-\r
-5) A pop-up window will confirm the cancellation. Click OK on the prompt.\r
-\r
-6) The screen will refresh, and the cancelled reservation(s) will disappear.\r
-\r
-image::media/booking-cancel-4.png[]\r
-\r
-Cancel a reservation on reservation creation screen\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Access the reservation creation screen by selecting Booking --> Create Reservations.\r
-\r
-2) Select any Bookable Resource Type, then click Next.\r
-\r
-3) Scan or type in the patron barcode in Reserve to Patron box then hit Enter.\r
-\r
-4) Patron's existing reservations will display at the bottom of the screen.\r
-\r
-5) Select those that you want to cancel, then click Cancel Selected.\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
+++ /dev/null
-Circulating Items\r
------------------\r
-\r
-Check Out (F1)\r
-~~~~~~~~~~~~~~\r
-\r
-Regular Items\r
-^^^^^^^^^^^^^\r
-\r
-1) To check out an item press *F1*, click *Check Out* on the Circulation toolbar, or select *Circulation* -> *Check Out Items*.\r
-\r
-image::media/checkout_menu.png[]\r
-\r
-2) Scan or enter patron's barcode and click *Submit* if entering barcode manually. If scanning, number is submitted automatically.\r
-\r
-image::media/retrieve_patron.png[]\r
-\r
-3) Scan or enter item barcode manually, clicking *Submit* if manual.\r
-\r
-image::media/checkout_item_barcode.png[] \r
-\r
-4) Due date is now displayed.\r
-\r
-image::media/due_date_display.png[]\r
- \r
-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. \r
-\r
-Pre-cataloged Items\r
-^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Go to patron's *Check Out* screen by clicking *Circulation* -> *Check Out Items*.\r
-\r
-2) Scan the item barcode.\r
-\r
-3) At prompt, click *Pre-Cataloged*. \r
-\r
-image::media/pre_cat_alert.png[]\r
-\r
-4) Enter required information and click *Check Out*.\r
-\r
-image::media/precat.png[]\r
- \r
-[TIP]\r
-On check-in, Evergreen will prompt staff to re-route the item to cataloging.\r
-\r
-Due Dates\r
-^^^^^^^^^\r
-\r
-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.\r
-\r
-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.\r
-\r
-image::media/specify_due_date1.png[]\r
-\r
-image::media/specify_due_date2.png[]\r
- \r
-Check In (F2)\r
-~~~~~~~~~~~~~\r
-\r
-Regular check in\r
-^^^^^^^^^^^^^^^^\r
-\r
-1) To check in an item, select *Circulation -> Check In Items*, click *Check In* on the Circulation toolbar, or press *F2*.\r
-\r
-image::media/check_in_menu.png[]\r
-\r
-2) Scan item barcode or enter manually and click *Submit*.\r
-\r
-image::media/checkin_barcode.png[]\r
- \r
-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.\r
-\r
-image::media/overdue_checkin.png[]\r
-\r
-Backdated check in\r
-^^^^^^^^^^^^^^^^^^\r
-\r
-This is useful for clearing a book drop.\r
-\r
-1) To change effective check-in date, select *Circulation* -> *Check In Items*, or press *F2*. Use the calendar widget to choose the effective date.\r
-\r
-image::media/backdate_checkin.png[]\r
-\r
-2) The top green bar changes to red. The new effective date is now displayed in the header.\r
-\r
-image::media/backdate_red.png[]\r
-\r
-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.\r
- \r
-Backdate Post-Checkin\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date.\r
-\r
-1) Select the item on the Check In screen, click Actions for Selected Items -> Backdate Post-Checkin.\r
-\r
-image::media/backdate_post_checkin.png[]\r
-\r
-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.\r
-\r
-image::media/backdate_post_date.png[]\r
-\r
-[TIP]\r
-Checkin Modifiers\r
-===================================================\r
-At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are:\r
-\r
-- Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloging with Cataloging status.\r
-- Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.\r
-- Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans).\r
-- Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation.\r
-\r
-These options may be selected simultaneously. The selected option is displayed in the header area.\r
-\r
-image::media/checkin_options.png[]\r
-\r
-====================================================\r
- \r
-Renewal and Editing the Item's Due Date\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Renewing via a Patron's Account\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) Retrieve the patron record and go to the *Items Out* screen.\r
-\r
-image::media/items_out_click.png[]\r
-\r
-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.\r
-\r
-image::media/renew_action.png[]\r
-\r
-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*.\r
-\r
-image::media/renew_specific_date.png[]\r
- \r
-[TIP]\r
-Renewal can also be done on the *Item Status* screen. See the section called <<itemstatus,Item Status (F5)>> for more information.\r
-\r
-Renewing by Item Barcode\r
-^^^^^^^^^^^^^^^^^^^^^^^^\r
-1) To renew items by barcode, select *Circulation* -> *Renew Items* or press *CTRL-F2*.\r
-\r
-2) Scan or manually entire the item barcode.\r
-\r
-image::media/renew_item.png[]\r
-\r
-3) If you want to specify the due date, click *Specific Due Date* and select a new due date from the calendar.\r
-\r
-image::media/renew_item_calendar.png[]\r
-\r
-Editing Due Date\r
-^^^^^^^^^^^^^^^^\r
-\r
-1) Retrieve the patron record and go to the *Items Out* screen.\r
-\r
-2) Select the item you want to renew. Click on *Actions for Selected Items* -> *Edit Due Date*.\r
-\r
-image::media/edit_due_date_action.png[]\r
-\r
-3) Select a new due date in the pop-up window, then click *Apply*.\r
-\r
-[TIP]\r
-You can select multiple items by pressing down the CTRL key on your keyboard and clicking each items you want to edit.\r
-\r
-[NOTE]\r
-Editing a due date is not included in the renewal count.\r
-\r
-Marking Items Lost and Claimed Returned\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-Lost Items\r
-^^^^^^^^^^\r
-1) To mark items Lost, retrieve patron record and click *Items Out*.\r
-\r
-2) Select the item. Click on *Actions for Selected Items* -> *Mark Lost (by Patron)*.\r
-\r
-image::media/mark_lost.png[]\r
-\r
-3) The lost item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record.\r
-\r
-image::media/lost_cr_section.png[]\r
-\r
-4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. \r
-\r
-image::media/patron_summary_checkouts.jpg[]\r
-\r
-[NOTE]\r
-Lost Item Billing\r
-========================\r
-- 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.\r
-- 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. \r
-- 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.\r
-==========================\r
-\r
-Refunds for Lost Items\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-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.\r
-\r
-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.\r
-\r
-Claimed Returned Items\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen.\r
-\r
-2) Select the item, then select *Actions for Selected Items* -> *Mark Claimed Returned* from the dropdown menu.\r
-\r
-image::media/mark_claims_returned.png[]\r
-\r
-3) Select a date and click *Apply*.\r
-\r
-image::media/claimed_date.png[]\r
-\r
-4) The Claimed Returned item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record.\r
-\r
-image::media/lost_cr_section.png[]\r
-\r
-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. \r
-\r
-image::media/patron_summary_checkouts.jpg[]\r
-\r
-[NOTE]\r
-More on Claimed Returned Items\r
-====================================\r
-- The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly.\r
-- 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.\r
-- 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.\r
-====================================\r
-\r
-In-house Use (F6)\r
-~~~~~~~~~~~~~~~~~\r
-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*. \r
-\r
-image::media/record_in_house_action.png[]\r
- \r
-2) To record in-house use for cataloged items, enter number of uses, scan barcode or type barcode and click *Submit*.\r
-\r
-image::media/in_house_use.png[]\r
-\r
-[NOTE] \r
-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.\r
-\r
-[[itemstatus]]\r
-Item Status (F5)\r
-~~~~~~~~~~~~~~~~\r
-\r
-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.\r
-\r
-Checking item status\r
-^^^^^^^^^^^^^^^^^^^^\r
-\r
-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*.\r
-\r
-image::media/item_status_menu.png[]\r
-\r
-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.\r
-\r
-image::media/item_status_barcode.png[]\r
-\r
-3) Click the *Alternate View* button, and the item summary and circulation history will be displayed.\r
-\r
-image::media/item_status_altview.png[]\r
-\r
-4) Click *List View* to go back.\r
-\r
-image::media/item_status_list_view.png[]\r
-\r
-[NOTE]\r
-If the item's status is "Available", the displayed due date refers to the previous circulation's due date.\r
-\r
-[TIP]\r
-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.\r
-\r
-Viewing past circulations\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-1) To view past circulations, retrieve the item on the *Item Status* screen as described above.\r
-\r
-2) Select *Actions for Selected Items* -> *Show Last Few Circulations*.\r
-\r
-image::media/last_few_circs_action.png[]\r
-\r
-3) The item's recent circulation history is displayed.\r
-\r
-image::media/last_few_circs_display.png[]\r
-\r
-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).\r
-\r
-[TIP]\r
-The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*.\r
-\r
-[NOTE]\r
-You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen.\r
-\r
-Marking items damaged or missing and other functions\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-1) To mark items damaged or missing, retrieve the item on the *Item Status* screen.\r
-\r
-2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*.\r
-\r
-image::media/mark_missing_damaged.png[]\r
-\r
-[NOTE}\r
-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. \r
-\r
-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.\r
-\r
-Item alerts\r
-^^^^^^^^^^^\r
-\r
-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.\r
-1) Retrieve record on *Item Status* screen.\r
-\r
-2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*.\r
-\r
-3) The item record is displayed in the *Copy Editor*.\r
-\r
-image::media/copy_edit_alert.png[]\r
-\r
-4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. \r
-\r
-image::media/copy_alert_message.png[]\r
-\r
-5) Click *Modify Copies*, then confirm the action.\r
+++ /dev/null
-Updating translations using Launchpad
-=====================================
-
-This document describes how to update the translations in an Evergreen branch
-by pulling them from Launchpad, as well as update the files to be translated
-in Launchpad by updating the POT files in the Evergreen master branch.
-
-Prerequisites
--------------
-You must install all of the Python prerequisites required for building
-translations, per
-http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n
-
-* https://bitbucket.org/izi/polib/wiki/Home[polib]
-* http://translate.sourceforge.net[translate-toolkit]
-* http://pypi.python.org/pypi/python-Levenshtein/[levenshtein]
-* http://pypi.python.org/pypi/setuptools[setuptools]
-* http://pypi.python.org/pypi/simplejson/[simplejson]
-* http://lxml.de/[lxml]
-
-Updating the translations
--------------------------
-
-. Check out the latest translations from Launchpad by branching the Bazaar
-repository:
-+
-[source,bash]
-------------------------------------------------------------------------------
-bzr branch lp:~denials/evergreen/translation-export
-------------------------------------------------------------------------------
-+
-This creates a directory called "translation-export".
-+
-. Ensure you have an updated Evergreen release branch.
-. Run the `build/i18n/scripts/update_pofiles` script to copy the translations
- into the right place and avoid any updates that are purely metadata (dates
- generated, etc).
-. Commit the lot! And backport to whatever release branches need the updates.
-. Build updated POT files:
-+
-[source,bash]
-------------------------------------------------------------------------------
-cd build/i18n
-make newpot
-------------------------------------------------------------------------------
-+
-This will extract all of the strings from the latest version of the files in
-Evergreen.
-+
-. (This part needs automation): Then, via the magic of `git diff` and `git add`,
-go through all of the changed files and determine which ones actually have
-string changes. Recommended approach is to re-run `git diff` after each
-`git add`.
-. Commit the updated POT files and backport to the pertinent release branches.
Auto Suggest in Catalog Search
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The auto suggest feature suggests the completion of search terms as the user
-enters his query. By default, the user will see ten suggestions although this
+The
+http://docs.evergreen-ils.org/2.2/_auto_suggest_in_catalog_search_2.html[auto
+suggest feature] suggests the completion of search terms as the user enters his
+query. By default, the user will see ten suggestions although this
number 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.
-Documentation for this feature is available in the Book of Evergreen
-at http://docs.evergreen-ils.org/2.2/
-
Copy Location Groups
^^^^^^^^^^^^^^^^^^^^
This feature allows staff to create and name sets of copy locations to use as
--- /dev/null
+Acquisitions\r
+------------\r
+\r
+This section is intended for those who are responsible for managing and processing acquisitions.\r
+\r
+Before beginning to use Acquisitions, the following must be configured by an administrator:\r
+\r
+* Cancel/Suspend Reasons (optional)\r
+* Claiming (optional)\r
+* Currency Types (defaults exist)\r
+* Distribution Formulas (optional)\r
+* EDI Accounts (optional) (see link:../installation/edi_setup.txt[Setting Up EDI Acquisitions] under Software Installation)\r
+* Exchange Rates (defaults exist)\r
+* Funds and Fund Sources\r
+* Invoice Types (defaults exist) and Invoice Payment Methods\r
+* Line Item Features (optional)\r
+* Merge Overlay Profiles and Record Match Sets (see link:../cataloging/batch_importing_MARC.txt[Batch Importing MARC Records] in Cataloging)\r
+* Providers\r
+\r
+Acquisitons Workflow\r
+~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+image::media/acq_workflow.jpg[workflow diagram]\r
--- /dev/null
+Receive Items From an Invoice\r
+-----------------------------\r
+\r
+This feature enables users to receive items from an invoice. Staff can receive individual copies, or they can receive items in batch.\r
+\r
+Receive Items in Batch (List Mode)\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+1) Retrieve a purchase order.\r
+\r
+2) Click *Create Invoice*.\r
+\r
+image::media/Receive_Items_From_an_Invoice1.jpg[Receive_Items_From_an_Invoice1]\r
+\r
+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.\r
+\r
+\r
+image::media/Receive_Items_From_an_Invoice2.jpg[Receive_Items_From_an_Invoice2]\r
+\r
+\r
+4) Click *Save*. You must choose a save option before you can receive items.\r
+\r
+\r
+5) The screen refreshes. In the top right corner of the screen, click *Receive Items*.\r
+\r
+\r
+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. \r
+\r
+\r
+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.\r
+\r
+\r
+NOTE: You cannot receive fewer items than 0 (zero) or more items than the number that you ordered.\r
+\r
+\r
+8) Click *Receive Selected Copies*.\r
+\r
+\r
+image::media/Receive_Items_From_an_Invoice4.jpg[Receive_Items_From_an_Invoice4]\r
+\r
+\r
+9) When you are finished receiving items, close the screen. You can repeat this process as you receive more copies.\r
+\r
+\r
+\r
+Receive Specific Copies (Numeric Mode)\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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. \r
+\r
+\r
+1) Complete steps 1-5 in the previous section.\r
+\r
+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.\r
+\r
+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.\r
+\r
+4) Click *Receive Selected Copies*. \r
+\r
+image::media/Receive_Items_From_an_Invoice5.jpg[Receive_Items_From_an_Invoice5]\r
+\r
+\r
+The screen will refresh. Copies that have not yet been received remain on the screen so that you can receive them when they arrive.\r
+\r
+\r
+5) When all copies on an invoice have been received, a message confirms that no copies remain to be received.\r
+\r
+6) The purchase order records that all items have been received.\r
+\r
+image::media/Receive_Items_From_an_Invoice7.jpg[Receive_Items_From_an_Invoice7]\r
+\r
--- /dev/null
+Selection Lists and Purchase Orders\r
+-----------------------------------\r
+\r
+Selection Lists\r
+~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a selection list\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+Selection lists can also be created through the My Selection Lists interface:\r
+\r
+. Click Acquisitions -> My Selection Lists.\r
+. Click the New Selection List drop down arrow.\r
+. Enter the name of the selection list in the box that appears.\r
+. Click Create.\r
+\r
+image::media/acq_selection_create.png[create selection list]\r
+\r
+Add items to a selection list\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+Clone selection lists\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. Click Acquisitions -> My Selection Lists.\r
+. Check the box adjacent to the list that you want to clone.\r
+. Click Clone Selected.\r
+. Enter a name into the box that appears, and click Clone.\r
+\r
+image::media/acq_selection_clone.png[clone selection list]\r
+\r
+Merge selection lists\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+You can merge two or more selection lists into one selection list.\r
+\r
+\r
+. Click Acquisitions -> My Selection Lists.\r
+. Check the boxes adjacent to the selection lists that you want to merge, and click Merge Selected.\r
+. 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.\r
+. Click Merge.\r
+\r
+image::media/acq_selection_merge.png[merge selection list]\r
+\r
+Delete selection lists\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+\r
+. Click Acquisitions -> My Selection Lists.\r
+. Check the box adjacent to the selection list(s) that you want to delete.\r
+. Click Delete Selected.\r
+\r
+Mark Ready for Selector\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+\r
+. 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.\r
+. Click Actions -> Mark Ready for Selector.\r
+. A pop up box will appear. Choose to mark the selected line items or all line items.\r
+. Click Go.\r
+. The screen will refresh. The marked line item(s) will be highlighted pink, and the status changes to selector~ready.\r
+\r
+image::media/acq_selection_mark_ready.png[mark ready]\r
+\r
+Convert selection list to purchase order\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Use the Actions menu to convert a selection list to a purchase order.\r
+\r
+\r
+. From a selection list, click Actions ~> Create Purchase Order.\r
+. A pop up box will appear.\r
+. Select the ordering agency from the drop down menu.\r
+. Enter the provider.\r
+. Check the box adjacent to prepayment required if prepayment is required.\r
+. Choose if you will add All Lineitems or Selected Lineitems to your purchase order.\r
+. Check the box if you want to Import Bibs and Create Copies in the catalog.\r
+. Click Submit.\r
+\r
+Brief Records\r
+~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Add brief records to a selection list\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. 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.\r
+. Choose a selection list from the drop down menu, or enter the name of a new selection list.\r
+. Enter bibliographic information in the desired fields.\r
+. Click Save Record.\r
+\r
+image::media/acq_brief_record.png[]\r
+\r
+Add brief records to purchase orders\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+You can add brief records to new or existing purchase orders.\r
+\r
+. Open or create a purchase order. See the section on link:03~PO.txt[purchase orders] for more information.\r
+. Click Add Brief Record.\r
+. Enter bibliographic information in the desired fields. Notice that the record is added to the purchase order that you just created.\r
+. Click Save Record.\r
+\r
+image::media/acq_brief_record-2.png[]\r
+\r
+MARC Federated Search\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source.\r
+\r
+. Click Acquisitions -> MARC Federated Search.\r
+. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit.\r
++\r
+----\r
+image::media/acq_marc_search.png[search form]\r
+----\r
++\r
+. 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.\r
+. 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.\r
+. Enter a price in the "Estimated Price" field.\r
+. 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.\r
+\r
+image::media/acq_marc_search-2.png[line item]\r
--- /dev/null
+Vandelay Integration into Acquisitions\r
+--------------------------------------\r
+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. \r
+\r
+The purpose of this documentation is to describe the interaction between Vandelay and the Acquisitions MARC Batch Upload interface. For detailed instructions on\r
+ using the Acquisitions MARC Batch Upload interface, see the Evergreen Documentation Interest Group's Book of Evergreen, 2.1 documentation, Chapter 5, Load MARC \r
+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, \r
+2.2 documentation, Chapter 7, Batch Importing MARC Records.\r
+\r
+*Use Cases for Vandelay Integration into Acquisitions*\r
+\r
+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.\r
+\r
+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.\r
+\r
+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. \r
+A cataloger will later view the queue, edit the records, and import them into the catalog.\r
+\r
+. Click *Acquisitions -> Load MARC Order Records*\r
+. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired.\r
+. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill.\r
+. 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.\r
+. 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.\r
+. Create a new record queue in Vandelay, or upload the records to an existing queue.\r
+. Select a *Record Match Set*.\r
+. Browse your computer to find the MARC file, and click *Upload*.\r
++\r
+image::media/Vandelay_Integration_into_Acquisitions1.jpg[Vandelay_Integration_into_Acquisitions1]\r
++\r
+. The processed items appear at the bottom of the screen.\r
++\r
+image::media/Vandelay_Integration_into_Acquisitions2.jpg[Vandelay_Integration_into_Acquisitions2]\r
+. You can click the link(s) to access the selection list or the import queue. Click the link to *View Selection List*.\r
+. 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.\r
++\r
+image::media/Vandelay_Integration_into_Acquisitions3.jpg[Vandelay_Integration_into_Acquisitions3]\r
+. 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.\r
+\r
+image::media/Vandelay_Integration_into_Acquisitions4.jpg[Vandelay_Integration_into_Acquisitions4]\r
+\r
+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.\r
+\r
+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.\r
+\r
+. Click *Acquisitions* -> *Load MARC Order Records*\r
+. Add MARC order records to a *Selection list* and/or a *Purchase Order.* Check the box to create a purchase order if desired.\r
+. Select a *Provider* from the drop down menu, or begin typing the code for the provider, and the field will auto-fill.\r
+. 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.\r
+. 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.\r
+. Create a new record queue in Vandelay, or upload the records to an existing queue.\r
+. Select a *Record Match Set*.\r
+. Select *Merge Profile* -> *Match-Only Merge*.\r
+. Check the box adjacent to *Merge on Best Match*.\r
+. Browse your computer to find the MARC file, and click *Upload*.\r
++\r
+image::media/Vandelay_Integration_into_Acquisitions5.jpg[Vandelay_Integration_into_Acquisitions5]\r
++\r
+. 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*.\r
++\r
+image::/media/Vandelay_Integration_into_Acquisitions6.jpg[Vandelay_Integration_into_Acquisitions6]\r
++\r
+. Click the *catalog* link to view the line item in the catalog.\r
+\r
+*Permissions to use this Feature*\r
+\r
+IMPORT_MARC - Using Vandelay to create new bib records now requres the IMPORT_MARC\r
+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\r
+\r
+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. \r
--- /dev/null
+SMS Text Messaging
+------------------
+
+The SMS Text Messaging feature enables users to receive hold notices via text message. Users can opt-in to this hold notification as their default setting for all holds, or they
+can receive specific hold notifications via text message. Users can also send call numbers and copy locations via text message.
+
+Administrative Setup
+~~~~~~~~~~~~~~~~~~~~
+
+You cannot receive text messages from Evergreen by default. You must enable this feature to receive hold notices and copy information from Evergreen via text message.
+
+Enable Text Messages
+^^^^^^^^^^^^^^^^^^^^
+
+. Click *Admin* -> *Local Admin* -> *Library Settings Editor.*
+. Select the setting, *Enable features that send SMS text messages.*
+. Set the value to *True,* and click *Update Setting.*
+
+image::media/SMS_Text_Messaging1.jpg[SMS_Text_Messaging1]
+
+Authenticate Patrons
+^^^^^^^^^^^^^^^^^^^^
+
+By default, you must be logged into your OPAC account to send a text message from Evergreen. However, if you disable this setting, you can text message copy information without having
+to login to your OPAC account.
+
+To disable the patron login requirmement:
+
+. Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
+. Select the setting, *Disable auth requirement for texting call numbers*.
+. Set the value to *True,* and click *Update Setting.*
+
+image::media/SMS_Text_Messaging2.jpg[SMS_Text_Messaging2]
+
+Configure SMS Carriers
+^^^^^^^^^^^^^^^^^^^^^^
+
+A list of SMS carriers that can transmit text messages to users is available in the staff client. Library staff can edit this list, or add new carriers.
+
+To add or edit SMS carriers:
+
+. Click *Admin* -> *Server Administration* -> *SMS Carriers*.
+. To add a new carrier, click the *New Carrier* button in the top right corner of the screen. To edit an existing carrier, double click in any white space in the carrier's row.
++
+image::media/SMS_Text_Messaging3.jpg[SMS_Text_Messaging3]
++
+. Enter a (geographical) *Region*.
+. Enter the carrier's *Name*.
+. Enter an *Email Gateway.* The SMS carrier can provide you with the content for this field. The $number field is converted to the user's phone number when the text message is generated.
+. Check the *Active* box to use this SMS Carrier.
+
+image::media/SMS_Text_Messaging4.jpg[SMS_Text_Messaging4]
+
+Configure Text Message Templates
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Library staff control the content and format of text messages through the templates in Notifications/Action Triggers. Patrons cannot add free text to their text messages.
+
+To configure the text of the SMS text message:
+
+. Click *Admin* -> *Local Administration* -> *Notifications/Action Triggers.*
+. Create a new A/T and template, or use or modify an existing template. For example, a default template, "Hold Ready for Pickup SMS Notification," notifies users that the hold is ready for pickup.
++
+image::media/SMS_Text_Messaging5.jpg[SMS_Text_Messaging5]
++
+. You can use the default template, or you can edit the template and add content specific to your library. Click the hyperlinked name to view and/or edit the hold notice.
+
+image::media/SMS_Text_Messaging6.jpg[SMS_Text_Messaging6]
+
+Receiving Holds Notices via Text Message
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can receive notification that your hold is ready for pickup from a text message that is sent to your mobile phone.
+
+. Login to your account.
++
+image::media/SMS_Text_Messaging12.jpg[SMS_Text_Messaging12]
++
+. Search the catalog.
+. Retrieve a record, and click the *Place Hold* link.
+. Select the option to retrieve hold notification via text message.
+. Choose an SMS Carrier from the drop down menu. NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six.
+. Enter a phone number.
+. Click *Submit.*
+
+image::media/SMS_Text_Messaging13.jpg[SMS_Text_Messaging13]
+
+Sending Copy Locations via Text Message
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+You can search the catalog for an item, and, after retrieving results for the item, click a hyperlink to send the copy location in a text message.
+
+. Login to your account in the OPAC. NOTE: If you have disabled the setting that requires patron login, then you do not have to login to their accounts to send text messages.
+See *Administrative Setup* for more information.
++
+image::media/SMS_Text_Messaging7.jpg[SMS_Text_Messaging7]
++
+. Search the catalog, and retrieve a title with copies.
+. Click the *Text* link adjacent to the call number.
++
+image::media/SMS_Text_Messaging8.jpg[SMS_Text_Messaging8]
++
+. The text of the SMS Text Message appears.
++
+image::media/SMS_Text_Messaging9.jpg[SMS_Text_Messaging9]
++
+. Choose an SMS Carrier from the drop down menu. NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six.
+. Enter a phone number.
++
+image::media/SMS_Text_Messaging10.jpg[SMS_Text_Messaging10]
++
+. Click *Submit*.
+. The number and carrier are converted to an email address, and the text message is sent to your mobile phone.
+
+image::media/SMS_Text_Messaging11.jpg[SMS_Text_Messaging11]
+
+*Permissions to use this Feature*
+
+ADMIN_SMS_CARRIER - Enables users to add/create/delete SMS Carrier entries.
+
+
--- /dev/null
+Acquisitions Administration\r
+---------------------------\r
+\r
+Acquisitions Permissions in the Admin module\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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_.\r
+\r
+* 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.\r
+* Default circulation modifier - This modifier would be applied to items that are created in the acquisitions module\r
+* Default copy location - This copy location would be applied to items that are created in the acquisitions module\r
+* 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.\r
+* 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.\r
+* Temporary barcode prefix - Temporary barcode prefix for items that are created in the acquisitions module\r
+* Temporary call number prefix - Temporary call number prefix for items that are created in the acquisitions module\r
+\r
+Cancel/Suspend reasons\r
+~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a cancel/suspend reason\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To add a new cancel reason, click _Administration -> Server Administration -> Acquisitions -> Cancel reasons_.\r
+\r
+. Click _New Cancel Reason_.\r
+\r
+. 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.)\r
+\r
+. Create a label for the cancel reason. This label will appear when you select a cancel reason on an item or a PO.\r
+\r
+. Create a description of the cancel reason. This is a free text field and can be comprised of any text of your choosing.\r
+\r
+. If you want to retain the debits associated with the cancelled purchase, click the box adjacent to Keep Debits->\r
+\r
+. Click _Save_.\r
+\r
+Claiming\r
+~~~~~~~~\r
+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.\r
+\r
+Create a claim policy\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+The claim policy link enables you to name the claim policy and specify the organization that owns it.\r
+\r
+. To create a claim policy, click _Admin -> Server Administration -> Acquisitions -> Claim Policies_.\r
+. Create a claim policy name. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
+. Click _Save_.\r
+\r
+Create a claim type\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+The claim type link enables you to specify the reason for a type of claim.\r
+\r
+. To create a claim type, click _Admin -> Server Administration -> Acquisitions -> Claim types_.\r
+. Create a claim type. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
+. Click _Save_.\r
+\r
+Create a claim event type\r
+^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To access the claim event types, click _Admin -> Server Administration -> Acquisitions ->Claim event type_.\r
+. Enter a code for the claim event type. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. Enter a description. No limits exist on the number of characters that can be entered in this field.\r
+. If this claim is initiated by the user, then check the box adjacent to Library Initiated.\r
++\r
+[NOTE]\r
+Currently, all claims are initiated by a user. The ILS cannot automatically claim an issue.\r
++\r
+. Click _Save_.\r
+\r
+Create a claim policy action\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+The claim policy action enables you to specify how long a user should wait before claiming the item.\r
+\r
+. To access claim policy actions, click _Admin -> Server Administration -> Acquisitions ->Claim Policy Actions_.\r
+\r
+. Select an Action (Event Type) from the drop down menu.\r
+\r
+. Enter an action interval. This field indicates how long a user should wait before claiming the item.\r
+\r
+. In the Claim Policy ID field, select a claim policy from the drop down menu.\r
+\r
+. Click _Save_.\r
+\r
+[NOTE]\r
+You can create claim cycles by adding multiple claim policy actions to a claim policy.\r
+\r
+Currency Types\r
+~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a currency type\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To create a new currency type, click _Admin -> Server Administration -> Acquisitions -> Currency types_.\r
+\r
+. Enter the currency code. No limits exist on the number of characters that can be entered in this field.\r
+\r
+. 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.\r
+\r
+. Click Save.\r
+\r
+Edit a currency type\r
+^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To edit a currency type, click your cursor in the row that you want to edit. The row will turn blue.\r
+\r
+. Double~click. The pop~up box will appear, and you can edit the fields.\r
+\r
+. After making changes, click Save.\r
+\r
+[NOTE]\r
+From the currency types interface, you can delete currencies that have never been applied to funds or used to make purchases.\r
+\r
+Distribution Formulas\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a distribution formula\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. Click _Admin -> Server Administration -> Acquisitions ->Distribution Formulas_.\r
+. Click _New Formula_.\r
+. Enter a Formula Name. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. Ignore the Skip Count field which is currently not used.\r
+. Click _Save_.\r
+. Click _New Entry_.\r
+. 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_).\r
+. Select a Shelving Location from the drop down menu.\r
+. 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.\r
+. Click _Apply Changes_. The screen will reload.\r
+. 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.\r
+\r
+[NOTE]\r
+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.\r
+\r
+Edit a distribution formula\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+To edit a distribution formula, click the hyperlinked title of the formula.\r
+\r
+EDI\r
+~~~\r
+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.\r
+\r
+The following fields are required to create an EDI account: \r
+\r
+[NOTE]\r
+host, username, password, path, and incoming directory.\r
+\r
+EDI Accounts\r
+^^^^^^^^^^^^\r
+\r
+Create EDI Accounts to communicate electronically with providers.\r
+\r
+. 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.\r
+. Enter a host. Your provider will provide you with the requisite FTP or SCP information.\r
+. Enter the username that has been supplied by your provider.\r
+. Enter the password that has been supplied by your provider.\r
+. 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.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. The Last Activity updates automatically with any inbound or outbound communication.\r
+. Select a provider from the drop down menu to whom this account belongs.\r
+. Enter a path. The path indicates the remote location on the server from which files are pulled in to the ILS.\r
+. Enter the incoming directory. This directory indicates the location on your local network to which the files download.\r
+. Enter the vendor account number supplied by your provider.\r
+. Enter the vendor account code supplied by your provider.\r
+. Click Save.\r
+\r
+EDI Messages\r
+^^^^^^^^^^^^\r
+\r
+The EDI messages screen displays all incoming and outgoing messages between the library and the vendor.\r
+\r
+Exchange Rates\r
+~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create an exchange rate\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To create a new exchange rate, click _Admin -> Server Administration -> Acquisitions -> Exchange Rates_.\r
+\r
+. Click New Exchange Rate.\r
+\r
+. Enter the From Currency from the drop down menu populated by the currency types.\r
+\r
+. Enter the To Currency from the drop down menu populated by the currency types.\r
+\r
+. Enter the exchange Ratio.\r
+\r
+. Click _Save_.\r
+\r
+Edit an Exchange Rate\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Edit an exchange rate just as you would edit a currency type.\r
+\r
+MARC Federated Search\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source.\r
+\r
+. Click _Acquisitions -> MARC Federated Search_.\r
+. Check the boxes of Z39.50 services that you want to search. Your local Evergreen Catalog is checked by default. Click Submit.\r
++\r
+image::media/acq_marc_search.png[search form]\r
++\r
+. 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.\r
+. 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.\r
+. Enter a price in the _Estimated Price_ field.\r
+. 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_.\r
+\r
+image::media/acq_marc_search-2.png[line item]\r
+\r
+Fund Tags\r
+~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a Fund Tag\r
+\r
+. To create a fund tag, click _Admin -> Server Administration -> Acquisitions -> Fund Tags_.\r
+. Click _New Fund Tag_. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list.\r
++\r
+. Enter a Fund Tag Name. No limits exist on the number of characters that can be entered in this field.\r
+. Click _Save_.\r
+\r
+Funding Sources\r
+~~~~~~~~~~~~~~~\r
+\r
+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 ammounts for accounts in your general ledger. You can then use funds to track spending and purchases for specific collections.\r
+\r
+Create a funding source\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To create a new funding source, click _Admin -> Server Administration -> Acquisitions -> Funding Source_.\r
+. Enter a funding source name. No limits exist on the number of characters that can be entered in this field.\r
+. 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).\r
++\r
+[NOTE]\r
+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.\r
++\r
+. Create a code for the source. No limits exist on the number of characters that can be entered in this field.\r
+. Select a currency from the drop down menu. This menu is populated from the choices in the Currency Types interface.\r
+. Click _Save_.\r
+\r
+Allocate Credits to Funding Sources\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. Apply a credit to this funding source.\r
+\r
+. 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.\r
+\r
+. To apply a credit, click on the hyperlinked name of the funding source. The Funding Source Details will appear.\r
+\r
+. Click _Apply Credit_.\r
+\r
+. Enter an amount to apply to this funding source.\r
+\r
+. Enter a note. This field is optional.\r
+\r
+. Click _Apply_.\r
+\r
+Allocate credits to funds\r
+^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To allocate credits to funds, click _Allocate to Fund_.\r
+\r
+. Enter the amount that you want to allocate.\r
+\r
+. Enter a note. This field is optional.\r
+\r
+. Click _Apply_.\r
+\r
+Track Debits and Credits\r
+^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+Funds\r
+~~~~~\r
+\r
+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.\r
+\r
+Create a fund\r
+^^^^^^^^^^^^^\r
+\r
+. To create a new fund, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
+. Enter a name for the fund. No limits exist on the number of characters that can be entered in this field.\r
+. Create a code for the fund. No limits exist on the number of characters that can be entered in this field.\r
+. Enter a year for the fund. This can be a fiscal year or a calendar year. The format of the year is YYYY.\r
+. 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).\r
++\r
+[NOTE]\r
+The rule of parental inheritance applies to this list. See section\r
++\r
+. 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.\r
+. Click the Active box to activate this fund. You cannot make purchases from this fund if it is not active.\r
+. 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.\r
+. 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.\r
+. Check the Propagate box to propagate funds. When you propagate a fund, the ILS will create a new fund for the following fisca 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.\r
+. Check the Rollover box if you want to roll over remaining funds into the same fund next year.\r
+. Click _Save_.\r
+\r
+Allocate Credits from Funding Sources to Funds\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
+\r
+. Click the hyperlinked name of the fund.\r
+\r
+. To add a credit to the fund, click the Create Allocation tab.\r
+\r
+. Choose a Funding Source from the drop down menu.\r
+\r
+. Enter an amount that you want to apply to the fund from the funding source.\r
+\r
+. Enter a note. This field is optional.\r
+\r
+. Click _Apply_.\r
+\r
+Transfer credits between funds\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To access funds, click _Admin -> Server Administration -> Acquisitions -> Funds_.\r
+\r
+. Click the hyperlinked name of the originating fund.\r
+\r
+. The Fund Details screen appears. Click Transfer Money.\r
+\r
+. Enter the amount that you would like to transfer.\r
+\r
+. From the drop down menu, select the destination fund.\r
+\r
+. Add a note. This field is optional.\r
+\r
+. Click _Transfer_.\r
+\r
+Track Balances and Expenditures\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To access the fund details, click on the hyperlinked name of the fund that you created.\r
+\r
+. The Summary allows you to track the following:\r
+\r
+. Balance - The balance is calculated by subtracting both items that have been invoiced and encumbrances from the total allocated to the fund.\r
+. Total Allocated - This amount is the total amount allocated from the Funding Source.\r
+. 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.\r
+. Total Debits - The total debits are calculated by adding the cost of items that have been invoiced and encumbrances.\r
+. Total Spent - The total spent is calculated by adding the cost of items that have been invoiced. It does not include encumbrances.\r
+. Total Encumbered - The total encumbered is calculated by adding all encumbrances.\r
+\r
+Edit a Fund\r
+^^^^^^^^^^^\r
+\r
+Edit a fund just as you would edit a currency type.\r
+\r
+Perform Year End Closeout Operation\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To access the year end closeout of a fund, click Admin -> Server Administration -> Acquisitions -> Funds.\r
+\r
+. Click _Fund Propagation and Rollover_.\r
+\r
+. Check the box adjacent to _Perform Fiscal Year Close~Out Operation_.\r
+\r
+. Notice that the context org unit reflects the context org unit that you selected at the top of the Funds screen.\r
+\r
+. 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.\r
+\r
+. 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.\r
+\r
+. Click _Process_.\r
+\r
+. Evergreen will begin the propagation process. Evergreen will make a clone of each fund, but it will increment the year by .\r
+\r
+Invoice menus\r
+~~~~~~~~~~~~~\r
+\r
+Invoice menus allow you to create drop down menus that appear on invoices. You can create an invoice item type or invoice payment method.\r
+\r
+Invoice item type\r
+^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To create a new charge type, click _Admin -> Server Administration -> Acquisitions -> Invoice Item Type_.\r
+\r
+. Click _New Invoice Item Type_.\r
+\r
+. Create a code for the charge type. No limits exist on the number of characters that can be entered in this field.\r
+\r
+. 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.\r
+\r
+. 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.\r
+\r
+. Click _Save_.\r
+\r
+Invoice payment method\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+. To create a new invoice payment method, click _Admin -> Server Administration -> Acquisitions -> Invoice Payment Method_.\r
+\r
+. Click _New Invoice Payment Method_.\r
+\r
+. Create a code for the invoice payment method. No limits exist on the number of characters that can be entered in this field.\r
+\r
+. 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.\r
+\r
+. Click _Save_.\r
+\r
+Payment methods can be deleted from this screen.\r
+\r
+Line item features\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Create a line item alert\r
+^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+. To create a line item alert, click _Administration -> Server Administration -> Acquisitions -> Line Item Alerts_.\r
+\r
+. Click _New Line Item Alert Text_.\r
+\r
+. Create a code for the text. No limits exist on the number of characters that can be entered in this field.\r
+\r
+. Create a description for the text. No limits exist on the number of characters that can be entered in this field.\r
+\r
+. 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).\r
+\r
+. Click _Save_.\r
+\r
+Line Item MARC Attribute Definitions\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
--- /dev/null
+Authorities
+-----------
+
+Authority Control Sets
+~~~~~~~~~~~~~~~~~~~~~~
+
+
+The tags and subfields that display in authority records in Evergreen are
+proscribed by control sets. The Library of Congress control set is the default
+control set in Evergreen. In Evergreen release 2.2, you can create customized
+control sets for authority records. Also, you can define thesauri and authority
+fields for these control sets.
+
+Patrons and staff will be able to browse authorities in the OPAC. The following
+fields are browsable by default: author, series, subject, title, and topic. You
+will be able to add custom browse axes in addition to these default fields.
+
+Control Sets
+^^^^^^^^^^^^
+
+You can specify the MARC tags and subfields that an authority record should
+contain. The Library of Congress control set exists in the staff client by
+default. The control sets feature enables librarians to add or customize new
+control sets.
+
+To access existing control sets, click *Admin* -> *Server Administration* ->
+*Authorities* -> *Control Sets*.
+
+To add a *control set*:
+
+. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*.
+. Click *New Control Set*. . Add a *Name* to the control set. Enter any number
+of characters. . Add a *Description* of the control set. Enter any number of
+characters. . Click *Save*.
+
+image::media/Authority_Control_Sets1.jpg[Authority_Control_Sets1]
+
+Thesauri
+~~~~~~~~
+
+A thesaurus describes the semantic rules that govern the meaning of words in a
+MARC record. The thesaurus code, which indicates the specific thesarus that
+should control a MARC record, is encoded in a fixed field using the mnemonic
+Subj in the authority record. Eleven thesauri associated with the Library of
+Congress control set exist by default in the staff client.
+
+To access an existing thesaurus, click *Admin* -> *Server Administration* ->
+*Authorities* -> *Control Sets*, and choose the hyperlinked thesaurus that you
+want to access, or click *Admin* -> *Server Administration* -> *Authorities* ->
+*Thesauri*.
+
+
+To add a *Thesaurus*:
+
+. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*,
+and choose the hyperlinked thesaurus that you want to access, or click *Admin*
+-> *Server Administration* -> *Authorities* -> *Thesauri*. . Click *New
+Thesaurus*. . Add a *Thesaurus Code*. Enter any single, upper case character.
+This character will be entered in the fixed fields of the MARC record. . Add a
+*Name* to the thesaurus. Enter any number of characters. . Add a *Description*
+of the thesaurus. Enter any number of characters.
+
+image::media/Authority_Control_Sets2.jpg[Authority_Control_Sets2]
+
+Authority Fields
+~~~~~~~~~~~~~~~~
+
+
+Authority fields indicate the tags and subfields that should be entered in the
+authority record. Authority fields also enable you to specify the type of data
+that should be entered in a tag. For example, in an authority record governed
+by a Library of Congress control set, the 100 tag would contain a "Heading -
+Personal Name." Authority fields also enable you to create the corresponding
+tag in the bibliographic record that would contain the same data.
+
+To create an *Authority Field*:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+. Click *Admin* -> *Server Administration* -> *Authorities* -> *Control Sets*.
+. Click *Authority Fields*. The number in parentheses indicates the number of
+authority fields that have been created for the control set.
+. Click *New Authority Field*.
+. Add a *Name* to the authority field. Enter any number of characters.
+. Add a *Description* to describe the type of data that should be entered in
+this tag. Enter any number of characters.
+. Select a *Main Entry* if you are linking the tag(s) to another entry.
+. Add a tag in the authority record.
+. Add a subfield in the authority record. Multiple subfields should be entered
+without commas or spaces.
+. Click *Save*.
++
+image::media/Authority_Control_Sets3.jpg[Authority_Control_Sets3]
++
+.Create the corresponding tag in the bibliographic record that should contain
+this information. Click the *None* link in the *Controlled Bib Fields* column.
+. Click *New Control Set Bib Field*.
+. Add the corresponding tag in the bibiographic record.
+. Click *Save*.
+
+image::media/Authority_Control_Sets4.jpg[Authority_Control_Sets4]
+
+
+
+Browse Axes
+~~~~~~~~~~~
+
+Authority records can be browsed, by default, along five axes: author, series,
+subject, title, and topic. Use the *Browse Axes* feature to create additional
+axes.
+
+
+Create a new *Browse Axis*:
+
+. Click *Admin* -> *Server Administration* -> *Authorities* -> *Browse Axes*
+. Click *New Browse Axis*.
+. Add a *code*. Do not enter any spaces.
+. Add a *name* to the axis that will appear in the OPAC. Enter any number of
+characters.
+. Add a *description* of the axis. Enter any number of characters.
+. Add a *sorter attribute*. The sorter attribute indicates the order in which
+the results will be displayed.
++
+image::media/Authority_Control_Sets5.jpg[Authority_Control_Sets5]
+. Assign the axis to an authority so that users can find the authority record
+when browsing authorities. Click *Admin* -> *Server Administration* ->
+*Authorities* -> *Control Sets*.
+. Choose the control set to which you will add the axis. Click *Authority
+Fields*
+. Click the link in the *Axes* column of the tag of your choice.
+. Click *New Browse Axis-Authority Field Map*.
+. Select an *Axis* from the drop down menu.
+. Click *Save*.
+
+image::media/Authority_Control_Sets6.jpg[Authority_Control_Sets6]
+
+
+OPAC Searching of Authorities
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Patrons and librarians can browse authorities through the OPAC.
+
+
+To search for *Authorities*:
+
+. Click *Advanced Search* in the OPAC.
+. Find the *Authority Browse* column in the left side of the screen.
+. Select a browse axis, and enter a keyword. The terms in the middle of the
+results list should yield the best match.
++
+image::media/Authority_Control_Sets7.jpg[Authority_Control_Sets7]
+. Click *Submit*.
+. A list of results will appear. The authorities with bibliographic records
+attached will be listed in bold with the number of attached bibliographic
+records in parentheses.
++
+image::media/Authority_Control_Sets8.jpg[Authority_Control_Sets8]
++
+. Click on the bolded text to view bibliographic records.
+
+image::media/Authority_Control_Sets9.jpg[Authority_Control_Sets9]
+
+
+*Permissions to use this Feature*
+
+
+To use authority control sets, you will need the following permissions:
+
+* CREATE_AUTHORITY_CONTROL_SET UPDATE_AUTHORITY_CONTROL_SET
+* DELETE_AUTHORITY_CONTROL_SET
+
--- /dev/null
+Auto Suggest in Catalog Search\r
+------------------------------\r
+\r
+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 \r
+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 \r
+this suggestion. This feature is not turned on by default. You must turn it on in the Admin module.\r
+\r
+\r
+Enabling this Feature\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+. To enable this feature, click *Admin* -> *Server Administration* -> *Global Flags*.\r
+. Scroll down to item 10, OPAC.\r
+. Double click anywhere in the row to edit the fields.\r
+. Check the box adjacent to *Enabled* to turn on the feature.\r
+. 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.\r
++\r
+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 \r
+there are matching MARC records with copies within your search scope. For example, it will suggest MARC records with copies at your branch.\r
++\r
+. Click *Save.*\r
+\r
+image::media/Auto_Suggest_in_Catalog_Search2.jpg[Auto_Suggest_in_Catalog_Search2]\r
+\r
+Using this Feature\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+. Enter search terms into the basic search field. Evergreen will automatically suggest search terms.\r
+. Select a suggestion to view records that are linked to this suggestion. \r
+\r
+image::media/Auto_Suggest_in_Catalog_Search1.jpg[Auto_Suggest_in_Catalog_Search1]\r
+\r
--- /dev/null
+Booking Module Administration\r
+-----------------------------\r
+\r
+Creating Bookable Non-Bibliographic Resources\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms.\r
+\r
+The following pieces make up a non-bibliographic resource:\r
+\r
+* Resource Type\r
+* Resource Attribute\r
+* Resource Attribute Values\r
+* Resource\r
+* Resource Attribute Map\r
+\r
+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.\r
+\r
+Create New Resource Type\r
+^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Select Admin --> Server Administration --> Booking --> Resource Types.\r
+\r
+image::media/booking-create-resourcetype-1.png[]\r
+\r
+2) A list of current resource types will appear. Use Back and Next buttons to browse the whole list.\r
+\r
+image::media/booking-create-resourcetype-2.png[]\r
+\r
+[NOTE]\r
+You may also see cataloged items in the list. Those items have been marked bookable or booked before.\r
+\r
+\r
+3) To create a new resource type, click New Resource Type in the top right corner, .\r
+\r
+image::media/booking-create-resourcetype-3.png[]\r
+\r
+4) A box will appear in which you create your new type of resource.\r
+\r
+image::media/booking-create-bookable-1.png[]\r
+\r
+* Resource Type Name - Give your resource a name.\r
+* Fine Interval - How often will fines be charged? This period can be input in several ways:\r
+\r
+[NOTE]\r
+====================================================================\r
+** second(s), minute(s), hour(s), day(s), week(s), month(s), year(s)\r
+** sec(s), min(s)\r
+** s, m, h\r
+** 00:00:30, 00:01:00, 01:00:00\r
+===================================================================\r
+\r
+* Fine Amount - The amount that will be charged at each Fine Interval.\r
+* Owning Library - The home library of the resource.\r
+* Catalog Item - (Function not currently available.)\r
+* Transferable - This allows the item to be transferred between libraries.\r
+* 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.\r
+* Max Fine Amount - The amount at which fines will stop generating.\r
+\r
+5) Click Save when you have entered the needed information.\r
+\r
+image::media/booking-create-resourcetype-4.png[]\r
+\r
+6) The new resource type will appear in the list.\r
+\r
+image::media/booking-create-resourcetype-5.png[]\r
+\r
+Create New Resource Attribute\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Select Server Administration --> Booking --> Resource Attributes.\r
+\r
+2) Click New Resource Attribute in the top right corner.\r
+\r
+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.\r
+\r
+image::media/booking-create-bookable-2.png[]\r
+\r
+* Resource Attribute Name - Give your attribute a name.\r
+* Owning Library - The home library of the resource.\r
+* Resource Type - Type in the first letter to list then choose the Resource Type to which the Attribute is applicable.\r
+* Is Required - (Function not currently available.)\r
+\r
+4) Click Save when the necessary information has been entered.\r
+\r
+5) The added attribute will appear in the list.\r
+\r
+[NOTE]\r
+One resource type may have multiple attributes. You may repeat the above procedure to add more.\r
+\r
+Create New Resource Attribute Value\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) One resource attribute may have multiple values. To add new attribute value, select Server Administration → Booking → Resource Attribute Values.\r
+\r
+2) Click New Resource Attribute Value in the top right corner.\r
+\r
+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.\r
+\r
+image::media/booking-create-bookable-3.png[]\r
+\r
+* Owning Library - The home library of the resource.\r
+* Resource Attribute - The attribute you wish to assign the value to.\r
+* Valid Value - Enter the value for your attribute.\r
+\r
+4) Click Save when the required information has been added.\r
+\r
+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.\r
+\r
+Create New Resource\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Add items to a resource type. Click Admin → Server Administration → Booking → Resources.\r
+\r
+2) Click New Resource in the top right corner.\r
+\r
+3) A box will appear. Add information for the resource.\r
+\r
+image::media/booking-create-bookable-4.png[]\r
+\r
+* Owning Library - The home library of the resource.\r
+* Resource Type - Type in the first letter of the resource type's name to list then select the resource type for your item.\r
+* Barcode - Barcode for the resource.\r
+* Overbook - This allows a single item to be reserved, picked up, and returned by multiple patrons during overlapping or identical time periods.\r
+* Is Deposit Required - (Function not currently available.)\r
+* Deposit Amount - (Function not currently available.)\r
+* User Fee - (Function not currently available.)\r
+\r
+4) Click Save when the required information has been added.\r
+\r
+5) The resource will appear in the list.\r
+\r
+[NOTE]\r
+One resource type may have multiple resources attached.\r
+\r
+Map Resource Attributes and Values to Resources\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Admin → Server Administration → Booking → Resource Attribute Maps.\r
+\r
+2) Click New Resource Attribute Map in the right top corner.\r
+\r
+3) A box will appear in which you will map your attributes and values to your resources.\r
+\r
+image::media/booking-create-bookable-5.png[]\r
+\r
+* Resource - Enter the barcode of your resource.\r
+* Resource Attribute - Select an attribute that belongs to the Resource Type.\r
+* 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.\r
+\r
+4) Click Save once you have entered the required information.\r
+\r
+[NOTE] \r
+A resource may have multiple attributes and values. Repeat the above steps to map all.\r
+\r
+5) The resource attribute map will appear in the list.\r
+\r
+Once all attributes have been mapped your resource will be part of a hierarchy similar to the example below.\r
+\r
+image::media/booking-create-bookable-6.png[]\r
+\r
+\r
+Editing Non-Bibliographic Resources\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Editing Resource Types\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Bring up your list of resource types. Select Admin --> Server Administration --> Booking --> Resource Types.\r
+\r
+2) A list of current resource types will appear.\r
+\r
+3) Double click anywhere on the line of the resource type you would like to edit.\r
+\r
+4) The resource type box will appear. Make your changes and click Save.\r
+\r
+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.\r
+\r
+\r
+\r
+\r
+Deleting Non-bibliographic Resources\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+1) To delete a booking resource, go to Admin → Server Administration → Booking → Resources.\r
+\r
+2) Select the checkbox in front the resource you want to delete. Click Delete Selected. The resource will disappear from the list.\r
+\r
+Following the same procedure you may delete Resource Attributes Maps.\r
+\r
+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.\r
+\r
+This is the deletion order: Resource Attribut Map/Resources --> Resource Attribute Values --> Resource Attributes --> Resource Types. \r
+\r
+\r
+\r
+\r
--- /dev/null
+Call Number Prefixes and Suffixes\r
+---------------------------------\r
+\r
+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.\r
+\r
+\r
+Configure call number prefixes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Call number prefixes are codes that precede a call number.\r
+\r
+To configure call number prefixes:\r
+\r
+1. Select *Admin -> Server Administration -> Call Number Prefixes*.\r
+2. Click *New Prefix*.\r
+3. Enter the *call number label* that will appear on the item.\r
+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.\r
+5. Click *Save*.\r
+\r
+\r
+\r
+image::media/Call_Number_Prefixes_and_Suffixes_2_21.jpg[Call_Number_Prefixes_and_Suffixes_2_21]\r
+\r
+\r
+\r
+Configure call number suffixes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Call number suffixes are codes that succeed a call number.\r
+\r
+To configure call number suffixes:\r
+\r
+1. Select *Admin -> Server Administration -> Call Number Suffixes*.\r
+2. Click *New Suffix*.\r
+3. Enter the *call number label* that will appear on the item.\r
+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.\r
+5. Click *Save*.\r
+\r
+\r
+image::media/Call_Number_Prefixes_and_Suffixes_2_22.jpg[Call_Number_Prefixes_and_Suffixes_2_22]\r
+\r
+\r
+Apply Call Number Prefixes and Suffixes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
--- /dev/null
+Customizing the Staff Client\r
+----------------------------\r
+\r
+Customizable Toolbar\r
+~~~~~~~~~~~~~~~~~~~~\r
+\r
+\r
+By default, two toolbars are available in the staff client: circulation and\r
+cataloging. This feature enables you to customize toolbars in the staff client.\r
+You can create toolbars for specific org unit(s), workstation(s), or login(s). \r
+\r
+\r
+Configure Toolbar \r
+^^^^^^^^^^^^^^^^^\r
+\r
+. Click *Admin* -> *Workstation Administration* -> *Toolbars* -> *Configure\r
+Toolbars*. \r
+. Click *New Toolbar*. \r
+. *Enter label for toolbar*. \r
++\r
+image::media/Customizable_Toolbar1.jpg[Customizable_Toolbar1] \r
++ \r
+. Click *Ok*. \r
+.Select one of the buttons in the *Available* panel. The *Button ID* describes\r
+that action that the button will take, and the *Label* will display in the\r
+toolbar. \r
+. Click the *--> A* button to add the selected function to the\r
+*Selected* panel on the bottom right side of the screen. To remove a button,\r
+click the *<--R* button. \r
++\r
+image::media/Customizable_Toolbar2.jpg[Customizable_Toolbar2] \r
++ \r
+. Continue adding buttons if desired. The buttons will display in the order that you add\r
+them. If you want to reorder the buttons, click the *Up* or *Down* buttons. \r
+. To separate buttons onto left and right sides of the screen on the same\r
+toolbar, select *toolbarspacer*, and click *--> A*.\r
++\r
+image::media/Customizable_Toolbar3.jpg[Customizable_Toolbar3]\r
++\r
+. To add a dividing line between buttons that appear on the same side of the\r
+screen, select *toolbarseparator*, and click *-->A*.\r
++\r
+image::media/Customizable_Toolbar4.jpg[Customizable_Toolbar4]\r
++\r
+. At the bottom of the screen, choose the owner of this toolbar. \r
+If you click *Owning Org Unit*, then the owning org unit that you specify will display this\r
+toolbar. Select the owning org unit from the drop down menu. The rule of\r
+parental inheritance applies, so all child units will inherit the toolbars of\r
+their parental units. \r
+If you click *Owning Workstation*, then the workstation to which you are logged\r
+in when you created the toolbar will display this toolbar. \r
+If you select *Owning User*, then your login has access to that toolbar.\r
+ . When you are finished creating the toolbar, click *Save Toolbar*. Any\r
+toolbar to which you have access displays under *Admin -> Workstation\r
+Administration -> Toolbars -> Current*.\r
+\r
+*Permissions*\r
+\r
+ADMIN_TOOLBAR - Allow a user to create, edit, and delete custom toolbars\r
--- /dev/null
+Hold-driven recalls
+===================
+
+indexterm:[hold-driven recalls]
+indexterm:[circulation, recalls, hold-driven]
+
+_Added in Evergreen 2.1_
+
+In academic libraries, it is common for groups like faculty and graduate
+students to have extended loan periods (for example, 120 days), while
+others have more common loan periods such as 3 weeks. In these environments,
+it is desirable to have a hold placed on an item that has been loaned out
+for an extended period to trigger a 'recall', which:
+
+ . Truncates the loan period
+ . Sets the remaining available renewals to 0
+ . 'Optionally': Changes the fines associated with overdues for the new due
+ date
+ . 'Optionally': Notifies the current patron of the recall, including the
+ new due date and fine level
+
+Enabling hold-driven recalls
+----------------------------
+
+By default, holds do not trigger recalls. To enable hold-driven recalls
+of circulating items, library settings must be changed as follows:
+
+ . Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
+ . Set the *Recalls: Circulation duration that triggers a recall
+ (recall threshold)* setting. The recall threshold is specified as an
+ interval (for example, "21 days"); any items with a loan duration of
+ less that this interval are not considered for a recall.
+ . Set the *Recalls: Truncated loan period (return interval)* setting.
+ The return interval is specified as an interval (for example, "7 days").
+ The due date on the recalled item is changed to be the greater of either
+ the recall threshold or the return interval.
+ . 'Optionally': Set the *Recalls: An array of fine amount, fine interval,
+ and maximum fine* setting. If set, this applies the specified fine rules
+ to the current circulation period for the recalled item.
+
+When a hold is placed and no available copies are found by the hold targeter,
+the recall logic checks to see if the recall threshold and return interval
+settings are set; if so, then the hold targeter checks the currently
+checked-out copies to determine if any of the currently circulating items at
+the designated pickup library have a loan duration longer than the recall
+threshold. If so, then the eligible item with the due date nearest to the
+current date is recalled.
+
+Editing the item recall notification email template
+---------------------------------------------------
+The template for the item recall notification email is contained in the
+'Item Recall Email Notice' template, found under *Admin* -> *Local
+Administration* -> *Notifications / Action Triggers*.
--- /dev/null
+Library Settings Editor
+-----------------------
+
+Fine Accrual on Closed Dates
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, fines accrue only on dates that the library is open. This feature enables you to charge patrons fines on dates the library is closed. Fines accrue during scheduled closings as well as during normal weekly closed dates.
+
+To enable this feature:
+
+. Click *Admin* -> *Local Administration* -> *Library Settings* -> *Charge fines on overdue circulations when closed*
+. Click *Edit*.
+. Set the value to *True*.
+. Click *Update Setting*.
+
+
+Target Copies for Holds at Closed Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, when a patron places a hold on a title, the hold targeter will search for copies to fill the hold only at circulating libraries that are open. Copies at closed libraries
+are not targeted to fill holds. When turned on, this feature enables Evergreen to target copies that have closed circulating libraries to fill holds. Two new org unit settings control this feature.
+
+Use the following setting to target copies for holds at closed circulating libraries:
+
+. Click *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Target copies for a hold even if copy's circ lib is closed*
+. Set the value to *True* if you want to target copies for holds at closed circulating libraries. Set the value to *False*, or leave it unset, if you do not want to enable this feature.
+. Click *Update Setting*.
+
+image::media/Target_Pickup_Lib1.jpg[Target_Pickup_Lib1]
+
+Use the following setting to target copies for holds IF AND ONLY IF the circulating library is the hold's pickup library.
+
+. Click *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Target copies for a hold even if copy's circ lib is closed IF the circ lib is the hold's pickup lib*
+. Set the value to *True* if you want to target copies for holds at closed circulating libraries when the circulating library of the item and the pickup library of the hold are
+the same. Set the value to *False*, or leave it unset, if you do not want to enable this feature.
+. Click *Update Setting*.
+
+image::media/Target_Pickup_Lib2.jpg[Target_Pickup_Lib2]
--- /dev/null
+Statistical Categories Editor
+-----------------------------
+
+This is where you configure your statistical categories (stat cats). Stat cats are a way to save and report on additional information that doesn’t fit elsewhere in Evergreen's default records. It is possible to have stat cats for copies or patrons.
+
+1. Click *Admin -> Local Administration -> Statistical Categories Editor.*
+
+2. To create a new stat cat, enter the name of the category and select either _patron_ or _copy_ from the *Type* dropdown menu. Each category type has a number of options you may set.
+
+*Copy Statistical Categories*
+
+Copy stat cats appear in the _Copy Editor_, also known as the _Edit Item Attributes_ screen. You might use copy stat cats to track books you have bought from a specific vendor, or donations.
+
+An example of the _Create a new statistical category_ controls for copies:
+
+image::media/lsa-statcat-1.png[Create copy stat cat]
+
+* _OPAC Visibility_: Should the category be displayed in the OPAC?
+* _Required_: Must the category be assigned a value when editing the item attributes?
+* _Archive with Circs_: Should the category and its values for the copy be archived with aged circulation data?
+* _SIP Field_: Select the SIP field identifier that will contain the category and its value
+* _SIP Format_: Specify the SIP format string
+
+Some sample copy stat cats:
+
+image::media/lsa-statcat-2.png[Sample copy stat cats]
+
+To add an entry, select _Add_. To edit an entry, select the entry you wish to edit from the drop-down list for the category.
+
+This is how the copy stat cats appear in the _Copy Editor_:
+
+image::media/lsa-statcat-3.png[Stat cats in Copy Editor]
+
+*Patron Statistical Categories*
+
+Patron stat cats can be used to keep track of information such as the high school a patron attends, or the home library for a consortium patron, e.g. Interlink, or patron preferences. They appear in the fifth section of the _Patron Registration_ or _Edit Patron_ screen.
+
+An example of the _Create a new statistical category_ controls for patrons:
+
+image::media/lsa-statcat-4.png[Create patron stat cat]
+
+* _OPAC Visibility_: Should the category be displayed in the OPAC?
+* _Required_: Must the category be assigned a value when registering a new patron or editing an existing one?
+* _Archive with Circs_: Should the category and its values for the patron be archived with aged circulation data?
+* _Allow Free Text_: May the person registering/editing the patron information supply their own value for the category?
+* _Show in Summary_: Display the category and its value in the patron summary view?
+* _SIP Field_: Select the SIP field identifier that will contain the category and its value
+* _SIP Format_: Specify the SIP format string
+
+[WARNING]
+.WARNING
+=====================================
+If you make a category *required* and also *disallow free text*, make sure that you populate an entry list for the category so that the user may select a value. Failure to do so will result in an unsubmittable patron registration/edit form!
+=====================================
+
+Some sample patron stat cats:
+
+image::media/lsa-statcat-5.png[Sample patron stat cats]
+
+To add an entry, click on _Add_ in the category row under the _Add Entry_ column:
+
+image::media/lsa-statcat-6.png[Add patron category entry]
+
+To edit an entry, select the entry you wish to edit from the drop-down list for the category:
+
+image::media/lsa-statcat-7.png[Edit patron category entry]
+
+An *organizational unit* (consortium, library system branch library, sub library, etc.) may create their own categories and entries, or supplement categories defined by a higher-level org unit with their own entries.
+
+An entry can be set as the *default* entry for a category and for an org unit. If an entry is set as the default, it will be automatically selected in the patron edit screen, provided no other value has been previously set for the patron. Only one default may be set per category for any given org unit.
+
+Lower-level org unit defaults override defaults set for higher-level org units; but in the absence of a default set for a given org unit, the nearest parent org unit default will be selected.
+
+Default entries for the focus location org unit are marked with an asterisk in the entry dropdowns.
+
+This is how patron stat cats appear in the patron registration/edit screen:
+
+image::media/lsa-statcat-8.png[Patron stat cats in registration screen]
+
--- /dev/null
+Recent Staff Searches\r
+---------------------\r
+\r
+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. \r
+\r
+*Administrative Settings*\r
+\r
+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.\r
+\r
+To configure the number of recent staff searches:\r
+\r
+1. Click *Admin -> Local Administration -> Library Settings Editor.*\r
+\r
+2. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages*\r
+\r
+3. Click *Edit*.\r
+\r
+4. Select a *Context* from the drop down menu.\r
+\r
+5. Enter the number of searches that you wish to save in the *Value* field. \r
+\r
+6. Click *Update Setting*\r
+\r
+image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21]\r
+\r
+\r
+NOTE: To retain this setting, the system administrator must restart the web server.\r
+\r
+\r
+If you do not want to save any searches, then you can turn off this feature.\r
+\r
+To deactivate this feature:\r
+\r
+1. Follow steps 1-4 (one through four) as listed in the previous section.\r
+\r
+2. In the *value* field, enter 0 (zero).\r
+\r
+3. Click *Update Setting.* This will prevent you from viewing any saved searches.\r
+\r
+\r
+*Recent Staff Searches*\r
+\r
+Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches:\r
+\r
+1. Enter a search term in either the basic or advanced search fields.\r
+\r
+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.\r
+\r
+image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22]\r
--- /dev/null
+Restrict Z39.50 Sources by Permission Group\r
+-------------------------------------------\r
+\r
+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.\r
+\r
+Administrative Settings\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+You can add a permission to limit use of Z39.50 servers, or you can use an existing permission.\r
+\r
+NOTE: You must be authorized to add permission types at the database level to add a new permission.\r
+\r
+Add a new permission:\r
+\r
+1) Create a permission at the database level.\r
+\r
+2) Click *Admin -> Server Administration -> Permissions* to add a permission to the staff client.\r
+\r
+3) In the *New Permission* field, enter the text that describes the new permission.\r
+\r
+image::media/Restrict_Z39_50_Sources_by_Permission_Group1.jpg[]\r
+\r
+4) Click *Add*.\r
+\r
+5) The new permission appears in the list of permissions.\r
+\r
+\r
+\r
+Restrict Z39.50 Sources by Permission Group\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+1) Click *Admin -> Server Administration -> Z39.50 Servers*\r
+\r
+2) Click *New Z39.50 Server*, or double click on an existing Z39.50 server to restrict its use.\r
+\r
+3) Select the permission that you added to restrict Z39.50 use from the drop down menu.\r
+\r
+image::media/Restrict_Z39_50_Sources_by_Permission_Group2.jpg[]\r
+\r
+4) Click *Save*.\r
+\r
+5) Add the permission that you created to a user or user group so that they can access the restricted server.\r
+\r
+\r
+image::media/Restrict_Z39_50_Sources_by_Permission_Group3.jpg[]\r
+\r
+6) Users that log in to the staff client and have that permission will be able to see the restricted Z39.50 server. \r
+\r
+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.\r
--- /dev/null
+New Options for Double Clicking\r
+-------------------------------\r
+\r
+Double Click to Retrieve a Patron's Record\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+. Click *Search -> Search for Patrons* to access a patron's record\r
+. Enter search terms.\r
+. Retrieve a list of possible matches. Double click on the record that you want to open.\r
+\r
+image::media/Double_Click1.jpg[Double_Click1]\r
+\r
+\r
+Double Click to Retrieve Item Attributes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+. Enter search terms to retrieve a bibliographic record.\r
+. Click *Actions for this Record* -> *Holdings Maintenance*.\r
+. Double click on an item.\r
++\r
+image::media/Double_Click3.jpg[Double_Click3]\r
++\r
+. The copy information will appear in a new tab.\r
--- /dev/null
+Recent Staff Searches\r
+---------------------\r
+\r
+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. \r
+\r
+Administrative Settings\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+To configure the number of recent staff searches:\r
+\r
+. Click *Admin -> Local Administration -> Library Settings Editor.*\r
+. Scroll to *OPAC: Number of staff client saved searches to display on left side of results and record details pages*\r
+. Click *Edit*.\r
+. Select a *Context* from the drop down menu.\r
+. Enter the number of searches that you wish to save in the *Value* field. \r
+. Click *Update Setting*\r
+\r
+image::media/Saved_Catalog_Searches_2_21.jpg[Saved_Catalog_Searches_2_21]\r
+\r
+\r
+NOTE: To retain this setting, the system administrator must restart the web server.\r
+\r
+If you do not want to save any searches, then you can turn off this feature.\r
+\r
+To deactivate this feature:\r
+\r
+. Follow steps 1-4 (one through four) as listed in the previous section.\r
+. In the *value* field, enter 0 (zero).\r
+. Click *Update Setting.* This will prevent you from viewing any saved searches.\r
+\r
+\r
+Recent Staff Searches\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Evergreen will save staff searches that are entered through either the basic or advanced search fields. To view recent staff searches:\r
+\r
+. Enter a search term in either the basic or advanced search fields.\r
+. 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.\r
+\r
+image::media/Saved_Catalog_Searches_2_22.jpg[Saved_Catalog_Searches_2_22]\r
--- /dev/null
+Return to Search Results from MARC Record\r
+-----------------------------------------\r
+\r
+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.\r
+\r
+image::media/Search_Results1.jpg[Search_Results1]\r
--- /dev/null
+Sorting Columns\r
+---------------\r
+\r
+This feature enables you to sort display columns so that you can find easily the\r
+information that you need on a screen that contains multiple columns. You can\r
+sort display columns on any screen that is built on a grid, such as the Check In\r
+screen or the On Shelf Pull List. \r
+\r
+You can also sort the columns on the following Administration screens:\r
+Circulation Policies, Hold Policies, Circulation Limit Sets, Barcode Completion,\r
+Acquisitions User Request List, and Vandelay Import Errors.\r
+\r
+You can sort items in an ascending or descending order, and you can prioritize\r
+the order in which columns will sort. The following use cases illustrate how to\r
+sort items within the Circulation and Administration interfaces.\r
+\r
+Sorting the On Shelf Pull List\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+You want to capture items that are on the shelf to fill current holds. To\r
+simplify this process, you will sort the items on the On Shelf Pull List by Copy\r
+Location and Call Number.\r
+\r
+. Click *Circulation* -> *Pull List for Hold Requests*.\r
+. The first column that you want to sort is the column, Current Copy Location. Right click the column header, Current Copy Location. \r
+. Click *Sort First (Descending)*.\r
++\r
+image::media/Sorting_Columns3.jpg[Sorting_Columns3]\r
++\r
+. The next column that you want to sort is the column, Call Number. Right click the column header, Call Number. \r
+. Click *Sort Next (Ascending)*.\r
++\r
+image::media/Sorting_Columns4.jpg[Sorting_Columns4]\r
++\r
+. The pull list has now been sorted by copy location and call number.\r
+\r
+image::media/Sorting_Columns5.jpg[Sorting_Columns5]\r
+\r
+NOTE: If you wanted to sort more columns, you could continue the process by clicking *Sort Next* for any subsequent columns.\r
+\r
+\r
+Sorting Circulation Policies\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+You want to sort the display of circulation policies in your staff client. \r
+\r
+. Click *Administration* -> *Local Administration* -> *Circulation Policies*.\r
+. Right click on any column header.\r
+. A pop-up box appears.\r
++\r
+image::media/Sorting_Columns2.jpg[Sorting_Columns2]\r
++\r
+. Check the *Display* box if you want to display a column in the staff client.\r
+. Check the *Auto Width* box if you want the width of the columns to adjust to fit the staff client.\r
+. Select a sort priority. \r
+.. A sort priority of "0" indicates that no sorting has been applied. Columns will display in their default order.\r
+.. 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.\r
+.. A sort priority of "-1" indicates that descending sorting should be applied to this column.\r
+. Click *Save*. The circulation policies will now sort according to your selections each time that you log into the staff client.\r
--- /dev/null
+Tab Buttons\r
+-----------\r
+\r
+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. \r
+\r
+image::media/New_Tab_Button1.jpg[New_Tab_Button1]\r
--- /dev/null
+TPac Configuration and Customization
+------------------------------------
+
+Template toolkit documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For more general information about template toolkit see: http://template-toolkit.org/docs/index.html[official
+documentation].
+
+The purpose of this chapter is to focus on the
+Evergreen-specific uses of Template Toolkit ('TT') in the OPAC.
+
+TPAC URL
+~~~~~~~
+
+The URL for the TPAC on a default Evergreen system is
+http://localhost/eg/opac/home (adjust `localhost` to match your hostname or IP
+address, naturally!)
+
+Perl modules used directly by TPAC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader.pm`
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Account.pm`
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Container.pm`
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Record.pm`
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Search.pm`
+ * `Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Util.pm`
+
+Default templates
+~~~~~~~~~~~~~~~~
+
+The source template files are found in `Open-ILS/src/templates/opac`.
+
+These template files are installed in `/openils/var/templates/opac`.
+
+.NOTE
+You should generally avoid touching the installed default template files,
+unless you are contributing changes that you want Evergreen to adopt as a new
+default. Even then, while you are developing your changes, consider using
+template overrides rather than touching the installed templates until you are
+ready to commit the changes to a branch. See below for information on template
+overrides.
+
+Apache configuration files
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The base Evergreen configuration file on Debian-based systems can be found in
+`/etc/apache2/sites-enabled/eg.conf`. This file defines the basic virtual host
+configuration for Evergreen (hostnames and ports), then single-sources the
+bulk of the configuration for each virtual host by including
+`/etc/apache2/eg_vhost.conf`.
+
+TPAC CSS and media files
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The CSS files used by the default TPAC templates are stored in the repo in
+`Open-ILS/web/css/skin/default/opac/` and installed in
+`/openils/var/web/css/skin/default/opac/`.
+
+The media files--mostly PNG images--used by the default TPAC templates are
+stored in the repo in `Open-ILS/web/images/` and installed in
+`/openils/var/web/images/`.
+
+Mapping templates to URLs
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The mapping for templates to URLs is straightforward. Following are a few
+examples, where `<templates>` is a placeholder for one or more directories
+that will be searched for a match:
+
+ * `http://localhost/eg/opac/home` => `/openils/var/<templates>/opac/home.tt2`
+ * `http://localhost/eg/opac/advanced` => `/openils/var/<templates>/opac/advanced.tt2`
+ * `http://localhost/eg/opac/results` => `/openils/var/<templates>/opac/results.tt2`
+
+The template files themselves can process, be wrapped by, or include other
+template files. For example, the `home.tt2` template currently involves a
+number of other template files to generate a single HTML file:
+
+.Example Template Toolkit file: opac/home.tt2
+[source, html]
+------------------------------------------------------------------------------
+[% PROCESS "opac/parts/header.tt2";
+ WRAPPER "opac/parts/base.tt2";
+ INCLUDE "opac/parts/topnav.tt2";
+ ctx.page_title = l("Home") %]
+ <div id="search-wrapper">
+ [% INCLUDE "opac/parts/searchbar.tt2" %]
+ </div>
+ <div id="content-wrapper">
+ <div id="main-content-home">
+ <div class="common-full-pad"></div>
+ [% INCLUDE "opac/parts/homesearch.tt2" %]
+ <div class="common-full-pad"></div>
+ </div>
+ </div>
+[% END %]
+------------------------------------------------------------------------------
+
+We will dissect this example in some more detail later, but the important
+thing to note is that the file references are relative to the top of the
+template directory.
+
+How to override templates
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Overrides for templates go in a directory that parallels the structure of the
+default templates directory. The overrides then get pulled in via the Apache
+configuration.
+
+In the following example, we demonstrate how to create a file that overrides
+the default "Advanced search page" (`advanced.tt2`) by adding a new templates
+directory and editing the new file in that directory.
+
+.Adding an override for the Advanced search page (example)
+[source, bash]
+------------------------------------------------------------------------------
+bash$ mkdir -p /openils/var/templates_custom/opac
+bash$ cp /openils/var/templates/opac/advanced.tt2 \
+ /openils/var/templates_custom/opac/.
+bash$ vim /openils/var/templates_custom/opac/advanced.tt2
+------------------------------------------------------------------------------
+
+We now need to teach Apache about the new templates directory. Open `eg.conf`
+and add the following `<Location /eg>` element to each of the `<VirtualHost>`
+elements in which you want to include the overrides. The default Evergreen
+configuration includes a `VirtualHost` directive for port 80 (HTTP) and another
+one for port 443 (HTTPS); you probably want to edit both, unless you want the
+HTTP user experience to be different from the HTTPS user experience.
+
+.Configuring the custom templates directory in Apache's eg.conf
+[source,xml]
+------------------------------------------------------------------------------
+<VirtualHost *:80>
+ # <snip>
+
+ # - absorb the shared virtual host settings
+ Include eg_vhost.conf
+ <Location /eg>
+ PerlAddVar OILSWebTemplatePath "/openils/var/templates_algoma"
+ </Location>
+
+ # <snip>
+</VirtualHost>
+------------------------------------------------------------------------------
+
+Finally, reload the Apache configuration to pick up the changes:
+
+.Reloading the Apache configuration
+[source,bash]
+------------------------------------------------------------------------------
+bash# /etc/init.d/apache2 reload
+------------------------------------------------------------------------------
+
+You should now be able to see your change at http://localhost/eg/opac/advanced
+
+Defining multiple layers of overrides
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can define multiple layers of overrides, so if you want every library in
+your consortium to have the same basic customizations, and then apply
+library-specific customizations, you can define two template directories for
+each library.
+
+In the following example, we define the `template_CONS` directory as the set of
+customizations to apply to all libraries, and `template_BR#` as the set of
+customizations to apply to library BR1 and BR2.
+
+As the consortial customizations apply to all libraries, we can add the
+extra template directory directly to `eg_vhost.conf`:
+
+.Apache configuration for all libraries (eg_vhost.conf)
+[source,xml]
+------------------------------------------------------------------------------
+# Templates will be loaded from the following paths in reverse order.
+PerlAddVar OILSWebTemplatePath "/openils/var/templates"
+PerlAddVar OILSWebTemplatePath "/openils/var/templates_CONS"
+------------------------------------------------------------------------------
+
+Then we define a virtual host for each library to add the second layer of
+customized templates on a per-library basis. Note that for the sake of brevity
+we only show the configuration for port 80.
+
+.Apache configuration for each virtual host (eg.conf)
+[source,xml]
+------------------------------------------------------------------------------
+<VirtualHost *:80>
+ ServerName br1.concat.ca
+ DocumentRoot /openils/var/web/
+ DirectoryIndex index.xml index.html index.xhtml
+ Include eg_vhost.conf
+ <Location /eg>
+ PerlAddVar OILSWebTemplatePath "/openils/var/templates_BR1"
+ </Location>
+</VirtualHost>
+
+<VirtualHost *:80>
+ ServerName br2.concat.ca
+ DocumentRoot /openils/var/web/
+ DirectoryIndex index.xml index.html index.xhtml
+ Include eg_vhost.conf
+ <Location /eg>
+ PerlAddVar OILSWebTemplatePath "/openils/var/templates_BR2"
+ </Location>
+</VirtualHost>
+------------------------------------------------------------------------------
+
+Changing some text in the TPAC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Out of the box, the TPAC includes a number of placeholder text and links. For
+example, there is a set of links cleverly named 'Link 1', 'Link 2', and so on
+in the header and footer of every page in the TPAC. Let's customize that for
+our `templates_BR1` skin.
+
+To begin with, we need to find the page(s) that contain the text in question.
+The simplest way to do that is with the handly utility `ack`, which is much
+like `grep` but with built-in recursion and other tricks. On Debian-based
+systems, the command is `ack-grep` as `ack` conflicts with an existing utility.
+In the following example, we search for files that contain the text "Link 1":
+
+.Searching for text matching "Link 1"
+[source,bash]
+------------------------------------------------------------------------------
+bash$ ack-grep "Link 1" /openils/var/templates/opac
+/openils/var/templates/opac/parts/topnav_links.tt2
+4: <a href="http://example.com">[% l('Link 1') %]</a>
+------------------------------------------------------------------------------
+
+Next, we copy the file into our overrides directory and edit it with `vim`:
+
+.Copying the links file into the overrides directory
+[source,bash]
+------------------------------------------------------------------------------
+bash$ cp /openils/var/templates/opac/parts/topnav_links.tt2 \
+ /openils/var/templates_BR1/opac/parts/topnav_links.tt2
+bash$ vim /openils/var/templates_BR1/opac/parts/topnav_links.tt2
+------------------------------------------------------------------------------
+
+Finally, we edit the link text in `opac/parts/header.tt2`.
+
+.Content of the opac/parts/header.tt2 file
+[source,html]
+------------------------------------------------------------------------------
+<div id="gold-links-holder">
+ <div id="gold-links">
+ <div id="header-links">
+ <a href="http://example.com">[% l('Link 1') %]</a>
+ <a href="http://example.com">[% l('Link 2') %]</a>
+ <a href="http://example.com">[% l('Link 3') %]</a>
+ <a href="http://example.com">[% l('Link 4') %]</a>
+ <a href="http://example.com">[% l('Link 5') %]</a>
+ </div>
+ </div>
+</div>
+------------------------------------------------------------------------------
+
+For the most part, the page looks like regular HTML, but note the `[%_("`
+`")%]` that surrounds the text of each link. The `[% ... %]` signifies a TT
+block, which can contain one or more TT processing instructions. `l(" ... ");`
+is a function that marks text for localization (translation); a separate
+process can subsequently extract localized text as GNU gettext-formatted PO
+files.
+
+.NOTE
+As Evergreen supports multiple languages, any customizations to Evergreen's
+default text must use the localization function. Also, note that the
+localization function supports placeholders such as `[_1]`, `[_2]` in the text;
+these are replaced by the contents of variables passed as extra arguments to
+the `l()` function.
+
+Once we have edited the link and link text to our satisfaction, we can load
+the page in our Web browser and see the live changes immediately (assuming
+we are looking at the BR1 overrides, of course).
+
+Troubleshooting
+~~~~~~~~~~~~~~~
+
+If there is a problem such as a TT syntax error, it generally shows up as a
+an ugly server failure page. If you check the Apache error logs, you will
+probably find some solid clues about the reason for the failure. For example,
+in the following example the error message identifies the file in which the
+problem occurred as well as the relevant line numbers:
+
+.Example error message in Apache error logs
+[source,bash]
+------------------------------------------------------------------------------
+bash# grep "template error" /var/log/apache2/error_log
+[Tue Dec 06 02:12:09 2011] [warn] [client 127.0.0.1] egweb: template error:
+ file error - parse error - opac/parts/record/summary.tt2 line 112-121:
+ unexpected token (!=)\n [% last_cn = 0;\n FOR copy_info IN
+ ctx.copies;\n callnum = copy_info.call_number_label;\n
+------------------------------------------------------------------------------
+
--- /dev/null
+User Activity Types\r
+-------------------\r
+\r
+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.\r
+\r
+Enabling this Feature\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+The *Label* is a free text field that enables you to describe the activity that you are tracking.\r
+\r
+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.\r
+\r
+The *Event Type* describes the type of activity that Evergreen is tracking. Currently, this feature only tracks user authentication. \r
+\r
+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.\r
+\r
+The *Enabled* field allows you to specify which types of user activity that you would like to track.\r
+\r
+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*.\r
+\r
+image::media/User_Activity_Types1A.jpg[User_Activity_Types1A]\r
+\r
+\r
+Using this Feature\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+The last activty date for user logins appears in the patron's summary.\r
+\r
+image::media/User_Activity_Types2A.jpg[User_Activity_Types2A]\r
+ \r
--- /dev/null
+[[attributions]]
+Attributions
+============
+
+Copyright © 2009-2012 Evergreen DIG
+
+Copyright © 2007-2012 Equinox
+
+Copyright © 2007-2012 Dan Scott
+
+Copyright © 2009-2012 BC Libraries Cooperative (SITKA)
+
+Copyright © 2008-2012 King County Library System
+
+Copyright © 2009-2012 Pioneer Library System
+
+Copyright © 2009-2012 PALS
+
+Copyright © 2009-2012 Georgia Public Library Service
+
+Copyright © 2008-2012 Project Conifer
+
+Copyright © 2009-2012 Bibliomation
+
+Copyright © 2008-2012 Evergreen Indiana
+
+Copyright © 2008-2012 SC LENDS
+
+
+
+*Current DIG Members*
+
+* Hilary Caws-Elwitt, Susquehanna County Library
+* Karen Collier, Kent County Public Library
+* George Duimovich, NRCan Library
+* Sally Fortin, Equinox Software
+* Wolf Halton, Lyrasis
+* June Rayner, eiNetwork
+* Steve Sheppard
+* Ben Shum, Bibliomation
+* Roni Shwaish, eiNetwork
+* Robert Soulliere, Mohawk College
+* Tim Spindler, C/W MARS
+* Lindsay Stratton, Pioneer Library System
+* Yamil Suarez, Berklee College of Music
+* Jenny Turner, PALS
--- /dev/null
+Batch Importing MARC Records\r
+----------------------------\r
+\r
+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. \r
+\r
+Permissions\r
+~~~~~~~~~~~\r
+\r
+To use match sets to import records, you will need the following permission:\r
+\r
+ADMIN_IMPORT_MATCH_SET\r
+\r
+\r
+Record Display Attributes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+This feature enables you to specify the tags and subfields that will display in records that appear in the import queue. \r
+\r
+\r
+*Record Match Sets*\r
+\r
+This feature enables you to create custom match points that you can use to accurately match incoming records with existing catalog records. \r
+ \r
+\r
+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.\r
+ \r
+\r
+1) Click *Cataloging -> MARC Batch Import/Export*.\r
+\r
+2) Create a new record match set. Click *Record Match Sets -> New Match Set*.\r
+\r
+3) Enter a name for the record match set.\r
+\r
+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.\r
+\r
+5) Select a *Match Set Type* from the drop down menu. You can create a match set for authority records or bibliographic records.\r
+\r
+6) Click *Save*.\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records1.jpg[Batch_Importing_MARC_Records1]\r
+\r
+\r
+7) The screen will refresh to list the record match set that you created. Click the link to the record match set.\r
+\r
+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.\r
+\r
+9) Select a *Record Attribute* from the drop-down menu.\r
+\r
+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.\r
+\r
+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.\r
+\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records2.jpg[Batch_Importing_MARC_Records2]\r
+\r
+\r
+\r
+12) Click *Ok.*\r
+\r
+13) Drag the completed match point under the folder with the appropriately-named Boolean folder under the Expression tree.\r
+\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records3.jpg[Batch_Importing_MARC_Records3]\r
+\r
+\r
+The match point will nest underneath the folder in the Expression tree.\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records4.jpg[Batch_Importing_MARC_Records4]\r
+\r
+\r
+14) Enter another *Boolean Operator* to further refine your match set.\r
+\r
+15) Click *Boolean Operator*.\r
+\r
+16) Select the *OR* operator from the drop down menu.\r
+\r
+17) Click *Ok*.\r
+\r
+18) Drag the operator to the expression tree.\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records5.jpg[Batch_Importing_MARC_Records5]\r
+\r
+\r
+19) Click *MARC Tag and Subfield*.\r
+\r
+20) Enter a *MARC tag* on which you want the records to match.\r
+\r
+21) Enter a *subfield* on which you want the records to match.\r
+\r
+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.\r
+\r
+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.\r
+\r
+\r
+24) Click *Ok.*\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records6.jpg[Batch_Importing_MARC_Records6]\r
+\r
+\r
+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.\r
+\r
+26) Add additional MARC tags or record attributes to build the expression tree.\r
+\r
+27) Click *Save Changes to Expression*.\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records7.jpg[Batch_Importing_MARC_Records7]\r
+\r
+\r
+*Replace Mode*\r
+\r
+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.\r
+\r
+\r
+1) Create a working match point.\r
+\r
+2) Click *Enter replace mode*.\r
+\r
+3) Highlight the piece of the tree that you want to replace.\r
+\r
+4) Drag the replacement piece over the highlighted piece.\r
+\r
+5) Click *Exit Replace Mode*.\r
+\r
+\r
+*Quality Metrics*\r
+\r
+\r
+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.\r
+\r
+2) You can create quality metrics based on the record attribute or the MARC Tag and Subfield.\r
+\r
+3) Click *Record Attribute.*\r
+\r
+4) Select an attribute from the drop down menu.\r
+\r
+5) Enter a value for the attribute.\r
+\r
+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).\r
+\r
+7) Click *Ok*. \r
+ \r
+\r
+image::media/Batch_Importing_MARC_Records8.jpg[Batch_Importing_MARC_Records8]\r
+\r
+\r
+\r
+*Import Records*\r
+\r
+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.\r
+\r
+\r
+1) Select a *Record Type* from the drop down menu.\r
+\r
+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.\r
+\r
+3) Select a *Record Match Set* from the drop down menu.\r
+\r
+4) Select a *Holdings Import Profile* if you want to import holdings that are attached to your records.\r
+\r
+5) Select a *Record Source* from the drop down menu.\r
+\r
+6) Select a *Merge Profile*. Merge profiles enable you to specify which tags should be removed or preserved in incoming records.\r
+\r
+7) Choose one of the following import options if you want to auto-import records:\r
+\r
+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.\r
+\r
+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.\r
+\r
+NOTE: Quality ratio affects only the *Merge on Single Match* and *Merge on Best Match* options.\r
+\r
+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.\r
+\r
+\r
+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\r
+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. \r
+\r
+10) *Browse* to find the appropriate file, and click *Upload*. The files will be uploaded to a queue.\r
+\r
+\r
+image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9]\r
+\r
+11) The screen will display records that have been uploaded to your queue.\r
+ \r
+image::media/Batch_Importing_MARC_Records15.jpg[Batch_Importing_MARC_Records15]\r
+\r
+\r
+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. \r
+\r
+image::media/Batch_Importing_MARC_Records10.jpg[Batch_Importing_MARC_Records10]\r
+\r
+13) Click *Back to Import Queue*.\r
+\r
+14) Check the boxes of the records that you want to import, and click *Import Selected Records*, or click *Import All Records*.\r
+\r
+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*.\r
+\r
+image::media/Batch_Importing_MARC_Records9.jpg[Batch_Importing_MARC_Records9]\r
+\r
+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.\r
+\r
+image::media/Batch_Importing_MARC_Records12.jpg[Batch_Importing_MARC_Records12] \r
+\r
+17) Search the catalog to confirm that the record was imported.\r
+\r
+image::media/Batch_Importing_MARC_Records14.jpg[Batch_Importing_MARC_Records14] \r
+\r
--- /dev/null
+Conjoined Items
+---------------
+
+Prior to Evergreen version 2.1, items could be attached to only one bibliographic record. The Conjoined Items feature in Evergreen 2.1 enables catalogers to link items to multiple bibliographic records. This feature will enable more precise cataloging. For example, catalogers will be able to indicate items that are printed back to back, are bilingual, are part of a bound volume, are part of a set, or are available as an e-reader pre-load. This feature will also help the user retrieve more relevant search results. For example, a librarian catalogs a multi-volume festschrift. She can create a bibliographic record for the festschrift and a record for each volume. She can link the items on each volume to the festschrift record so that a patron could search for a volume or the festschrift and retrieve information about both works.
+
+In the example below, a librarian has created a bibliographic record for two bestselling items. These books are available as physical copies in the library, and they are available as e-reader downloads. The librarian will link the copy of the Kindle to the bibliographic records that are available on the e-reader.
+
+Using the Conjoined Items Feature
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Conjoined Items feature was designed so that you can link items between bibliographic records when you have the item in hand, or when the item is not physically present. Both processes are described here. The steps are fewer if you have the item in hand, but both processes accomplish the same task. This documentalso demonstrates the process to edit or delete links between items and bibliographic records. Finally, the permission a cataloger needs to use this feature is listed.
+
+.Scenario 1: I want to link an item to another bibliographic record, but I do not have the item in hand
+
+1) Retrieve the bibliographic record to which you would like to link an item.
+
+2) Click *Actions for this Record -> Mark as Target for Conjoined Items.*
+
+
+image::media/conj1.jpg[conj1]
+
+
+3) A confirmation message will appear. Click *OK.*
+
+4) In a new tab, retrieve the bibliographic record with the item that you want to link to the other record.
+
+5) Click *Actions for this Record -> Holdings Maintenance.*
+
+6) Select the copy that you want to link to the other bibliographic record. Right-click, or click *Actions for Selected Rows -> Link as Conjoined Items to Previously Marked Bib Record.*
+
+image::media/conj2.jpg[conj2]
+
+
+7) The *Manage Conjoined Items* interface opens in a new tab. This interface enables you to confirm the success of the link, and to change the peer type if desired. The *Result* column indicates that you created a successful link between the item and the bib record.
+
+image::media/conj3.jpg[conj3]
+
+The default peer type, *Back-to-back*, was set as the peer type for our item. To change a peer type after the link has been created, right-click or click *Actions for Selected Items -> Change Peer Type*. A drop down menu will appear. Select the desired peer type, and click *OK.*
+
+
+image::media/conj4.jpg[conj4]
+
+
+8) The *Result* column will indicate that the *Peer Type* [has been] *Updated.*
+
+
+image::media/conj5.jpg[conj5]
+
+
+9) To confirm the link between the item and the desired bib record, reload the tab containing the bib record to which you linked the item. Click the link for *Linked Titles.*
+
+
+image::media/conj6.jpg[conj6]
+
+
+10) To view the copy details, including the peer type, click *Copy Details.*
+
+
+image::media/conj7.jpg[conj7]
+
+
+Items can be linked to multiple bibliographic records simultaneously. If you click the linked titles button in the copy details, then you will retrieve a list of bibliographic records to which this item is linked.
+
+
+image::media/conj8.jpg[conj8]
+
+
+.Scenario 2: I want to link an item to another bibliographic record, and I do have the item in hand
+
+1) Retrieve the bibliographic record to which you would like to add the item.
+
+2) Click *Actions for this Record -> Manage Conjoined Items.*
+
+
+image::media/conj9.jpg[conj9]
+
+
+3) A note in the bottom left corner of the screen will confirm that the record was targeted for linkage with conjoined items, and the *Manage Conjoined Items* screen will appear.
+
+4) Select the peer type from the drop down menu, and scan in the barcode of the item that you want to link to this record.
+
+5) Click *Link to Bib (Submit).*
+
+
+image::media/conj10.jpg[conj10]
+
+
+6) The linked item will appear in the screen. The *Result* column indicates Success.
+
+7) To confirm the linkage, click *Actions for this Record -> OPAC View.*
+
+8) When the bibliographic record appears, click *Reload. Linked Titles* will show the linked title and item.
+
+
+.Scenario 3: I want to edit or break the link between a copy and a bibliographic record
+
+1) Retrieve the bibliographic record that has a copy linked to it.
+
+2) Click *Actions for this Record -> Manage Conjoined Items.*
+
+3) Select the copy that you want to edit, and right-click or click *Actions for Selected Items.*
+
+4) Make any changes, and click *OK.*
+
+
+UPDATE_COPY - Link items to bibliographic records
--- /dev/null
+Monograph Parts\r
+---------------\r
+\r
+*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.\r
+\r
+Four new permissions are used by this functionality: CREATE_MONOGRAPH_PART, UPDATE_MONOGRAPH_PART, DELETE_MONOGRAPH_PART and MAP_MONOGRAPH_PART. Thes\r
+e permissions should be assigned at the consorial level to those groups or users that will make use of the features described below.\r
+\r
+\r
+Add a monograph part to an existing record\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+To add a monograph part to an existing record in the catalog: \r
+\r
+1) Retrieve a record.\r
+\r
+2) Click *Actions for this Record -> Manage Parts*\r
+\r
+\r
+image::media/monograph_parts1.jpg[monograph_parts1]\r
+\r
+\r
+3) Click *New Monograph Part*\r
+\r
+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. \r
+\r
+\r
+image::media/monograph_parts2.jpg[monograph_parts2]\r
+\r
+\r
+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*. \r
+\r
+To add a volume and copy to your workstation library or other libraries, click *Actions for this Record -> Holdings Maintenance -> Add Volumes*. \r
+\r
+\r
+image::media/monograph_parts3.jpg[monograph_parts3]\r
+\r
+\r
+6) The *Unified Volume/Copy Creator* opens. Enter the number of volumes that you want to add to the catalog and the volume description. \r
+\r
+7) Enter the number of copies and barcode(s) of each item.\r
+\r
+8) Select the *part designation* from the drop down menu adjacent to the barcode field.\r
+\r
+9) Apply a template to the copies, or edit fields in the *Copy Editor*.\r
+\r
+\r
+image::media/monograph_parts4.jpg[monograph_parts4]\r
+\r
+\r
+10) Click *Create Volumes/Items*.\r
+\r
+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.\r
+\r
+\r
+image::media/monograph_parts5.jpg[monograph_parts5]\r
+\r
--- /dev/null
+Overlay Existing Catalog Record via Z39.50 Import\r
+-------------------------------------------------\r
+\r
+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.\r
+\r
+*To Overlay an Existing Record via Z39.50 Import:*\r
+\r
+1) Click *Cataloging -> Import Record from Z39.50*\r
+\r
+2) Select at least one *Service* in addition to the *Local Catalog* in the *Service and Credentials* window in the top right panel.\r
+\r
+3) Enter search terms in the *Query* window in the top left panel.\r
+\r
+4) Click *Search*.\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import1.jpg[]\r
+\r
+5) The results will appear in the lower window.\r
+\r
+6) Select the record in the local catalog that you wish to overlay.\r
+\r
+7) Click *Mark Local Result as Overlay Target*\r
+\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import2.jpg[]\r
+\r
+\r
+8) A confirmation message appears. Click *OK*.\r
+\r
+9) Select the record that you want to replace the existing catalog record.\r
+\r
+10) Click *Overlay.*\r
+\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import3.jpg[]\r
+\r
+\r
+11) The record that you selected will open in the MARC Editor. Make any desired changes to the record, and click *Overlay Record*.\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import4.jpg[]\r
+\r
+\r
+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.\r
+\r
+13) If the correct record appears, click *Overlay*.\r
+\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import5.jpg[]\r
+\r
+14) A confirmation message will appear to confirm that you have overlaid the record. Click *Ok*.\r
+\r
+15) The screen will refresh in the OPAC View to show that the record has been overlaid.\r
+\r
+\r
+image::media/Overlay_Existing_Record_via_Z39_50_Import6.jpg[]\r
--- /dev/null
+Booking Module\r
+--------------\r
+\r
+Creating a Booking Reservation\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+To create a reservation from a patron record\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Retrieve the patron’s record.\r
+\r
+2) Select Other --> Booking --> Create or Cancel Reservations. This takes you to the Reservations Screen.\r
+\r
+image::media/booking-create-1.png[]\r
+\r
+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.\r
+\r
+image::media/booking-create-2.png[]\r
+\r
+4) For non-catalogued resources, the Bookable Resource Type and the items associated with the type will appear.\r
+\r
+image::media/booking-create-3.png[]\r
+\r
+For catalogued items, the title and the item will display in the box.\r
+\r
+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.\r
+\r
+image::media/booking-create-4.png[]\r
+\r
+[NOTE]\r
+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.\r
+\r
+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.\r
+\r
+image::media/booking-create-5.png[]\r
+\r
+7) Select the pickup location from the dropdown list.\r
+\r
+image::media/booking-create-6.png[]\r
+\r
+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 \r
+and then click Reserve Selected.\r
+\r
+image::media/booking-create-7.png[]\r
+\r
+9) A message will confirm that the action succeeded. Click OK on the prompt.\r
+\r
+10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen.\r
+\r
+image::media/booking-create-9.png[]\r
+\r
+To create a reservation from a booking resource\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+You need to know the barcode of the patron when you create a reservation for him/her from a booking resource.\r
+\r
+1) From the Booking menu, select Create Reservations\r
+\r
+image::media/booking-create-module-1.png[]\r
+\r
+2) Choose a Bookable Resource Type and click Next or enter the barcode of a catalogued resource and click Next.\r
+\r
+image::media/booking-create-module-2.png[]\r
+\r
+3) For non-catalogued resources, a screen showing the Bookable Resource Type and the items associated with the type will appear.\r
+\r
+image::media/booking-create-module-3.png[]\r
+\r
+For catalogued resources, the title and item will appear.\r
+\r
+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.\r
+\r
+image::media/booking-create-module-4.png[]\r
+\r
+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.\r
+\r
+image::media/booking-create-4.png[]\r
+\r
+[NOTE]\r
+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.\r
+\r
+\r
+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.\r
+\r
+image::media/booking-create-5.png[]\r
+\r
+7) Select the pickup location from the dropdown list.\r
+\r
+image::media/booking-create-6.png[]\r
+\r
+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.\r
+\r
+image::media/booking-create-7.png[]\r
+\r
+9) A message will confirm that the action succeeded. Click OK on the prompt.\r
+\r
+10) The screen will refresh and the reservation will appear below the patron’s name at the bottom of the screen.\r
+\r
+image::media/booking-create-9.png[]\r
+\r
+\r
+Search the catalogue to create a reservation\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+If you would like to reserve a catalogued item but do not know the item barcode, you may start with a catalogue search.\r
+\r
+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.\r
+\r
+2) Click the title to display the record summary. In the Copy Summary, select Copy Details in Actions column.\r
+\r
+3) The Copy Details will appear in a new row. In the barcode column, click the book now link.\r
+\r
+4) A screen showing the title and barcodes of available copies will appear.\r
+\r
+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.\r
+\r
+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.\r
+\r
+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.\r
+\r
+8) A message will confirm that the action succeeded. Click OK on the prompt.\r
+\r
+9) The screen will refresh, and the reservation will appear below the user’s name.\r
+\r
+[NOTE]\r
+Reservations on catalogued items can be created on Item Status (F5) screen. Select the item, then Actions for Selected Items → Book Item Now.\r
+\r
+Reservation Pull List\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Reservation pull list can be generated dynamically on the Staff Client.\r
+\r
+1) To create a pull list, select Booking --> Pull List.\r
+\r
+image::media/booking-pull-1.png[]\r
+\r
+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.\r
+\r
+3) Click Fetch to retrieve the pull list.\r
+\r
+image::media/booking-pull-2.png[]\r
+\r
+4) The pull list will appear. Click Print to print the pull list.\r
+\r
+image::media/booking-pull-3.png[]\r
+\r
+Capturing Items for Reservations\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Reservations must be captured before they are ready to be picked up by the patron.\r
+\r
+[CAUTION]\r
+Always capture reservations in Booking Module. Check In function in Circulation does not function the same as Capture Resources.\r
+\r
+1) In the staff client, select Booking --> Capture Resources.\r
+\r
+image::media/booking-capture-1.png[]\r
+\r
+2) Scan the item barcode or type the barcode then click Capture.\r
+\r
+image::media/booking-capture-2.png[]\r
+\r
+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.\r
+\r
+image::media/booking-capture-3.png[]\r
+\r
+ \r
+Picking Up Reservations\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+[CAUTION]\r
+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.\r
+\r
+1) Ready-for-pickup reservations can be listed from Other --> Booking --> Pick Up Reservations within a patron record or Booking --> Pick Up Reservations.\r
+\r
+\r
+image::media/booking-pickup-1.png[]\r
+\r
+image::media/booking-pickup-module-1.png[]\r
+\r
+\r
+2) Scan the patron barcode if using Booking --> Pick Up Reservations.\r
+\r
+3) The reservation(s) available for pickup will display. Select those you want to pick up and click Pick Up.\r
+\r
+image::media/booking-pickup-2.png[]\r
+\r
+4) The screen will refresh to show that the patron has picked up the reservation(s).\r
+\r
+image::media/booking-pickup-3.png[]\r
+\r
+\r
+Returning Reservations\r
+~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+[CAUTION]\r
+When a reserved item is brought back, staff must use the Booking Module to return the reservation.\r
+\r
+1) To return reservations, select Booking --> Return Reservations\r
+\r
+image::media/booking-return-module-1.png[]\r
+\r
+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.\r
+\r
+image::media/booking-return-module-2.png[]\r
+\r
+3) A pop up box will tell you that the item was returned. Click OK on the prompt.\r
+\r
+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.\r
+\r
+image::media/booking-return-2.png[]\r
+\r
+5) The screen will refresh to show any resources that remain out and the reservations that have been returned.\r
+\r
+image::media/booking-return-module-4.png[]\r
+\r
+[NOTE]\r
+Reservations can be returned from within patron records by selecting Other --> Booking --> Return Reservations\r
+\r
+Cancelling a Reservation\r
+~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+A reservation can be cancelled in a patron’s record or reservation creation screen.\r
+\r
+Cancel a reservation from the patron record\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Retrieve the patron's record.\r
+\r
+2) Select Other --> Booking --> Create or Cancel Reservations.\r
+\r
+image::media/booking-create-1.png[]\r
+\r
+3) The existing reservations will appear at the bottom of the screen.\r
+\r
+image::media/booking-cancel-1.png[]\r
+\r
+4) Highlight the reservation that you want to cancel. Click Cancel Selected.\r
+\r
+image::media/booking-cancel-2.png[]\r
+\r
+[NOTE]\r
+Use Shift or Ctrl on keyboard and mouse click to select multiple reservations if needed.\r
+\r
+5) A pop-up window will confirm the cancellation. Click OK on the prompt.\r
+\r
+6) The screen will refresh, and the cancelled reservation(s) will disappear.\r
+\r
+image::media/booking-cancel-4.png[]\r
+\r
+Cancel a reservation on reservation creation screen\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Access the reservation creation screen by selecting Booking --> Create Reservations.\r
+\r
+2) Select any Bookable Resource Type, then click Next.\r
+\r
+3) Scan or type in the patron barcode in Reserve to Patron box then hit Enter.\r
+\r
+4) Patron's existing reservations will display at the bottom of the screen.\r
+\r
+5) Select those that you want to cancel, then click Cancel Selected.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
--- /dev/null
+Circulating Items\r
+-----------------\r
+\r
+Check Out (F1)\r
+~~~~~~~~~~~~~~\r
+\r
+Regular Items\r
+^^^^^^^^^^^^^\r
+\r
+1) To check out an item press *F1*, click *Check Out* on the Circulation toolbar, or select *Circulation* -> *Check Out Items*.\r
+\r
+image::media/checkout_menu.png[]\r
+\r
+2) Scan or enter patron's barcode and click *Submit* if entering barcode manually. If scanning, number is submitted automatically.\r
+\r
+image::media/retrieve_patron.png[]\r
+\r
+3) Scan or enter item barcode manually, clicking *Submit* if manual.\r
+\r
+image::media/checkout_item_barcode.png[] \r
+\r
+4) Due date is now displayed.\r
+\r
+image::media/due_date_display.png[]\r
+ \r
+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. \r
+\r
+Pre-cataloged Items\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Go to patron's *Check Out* screen by clicking *Circulation* -> *Check Out Items*.\r
+\r
+2) Scan the item barcode.\r
+\r
+3) At prompt, click *Pre-Cataloged*. \r
+\r
+image::media/pre_cat_alert.png[]\r
+\r
+4) Enter required information and click *Check Out*.\r
+\r
+image::media/precat.png[]\r
+ \r
+[TIP]\r
+On check-in, Evergreen will prompt staff to re-route the item to cataloging.\r
+\r
+Due Dates\r
+^^^^^^^^^\r
+\r
+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.\r
+\r
+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.\r
+\r
+image::media/specify_due_date1.png[]\r
+\r
+image::media/specify_due_date2.png[]\r
+ \r
+Check In (F2)\r
+~~~~~~~~~~~~~\r
+\r
+Regular check in\r
+^^^^^^^^^^^^^^^^\r
+\r
+1) To check in an item, select *Circulation -> Check In Items*, click *Check In* on the Circulation toolbar, or press *F2*.\r
+\r
+image::media/check_in_menu.png[]\r
+\r
+2) Scan item barcode or enter manually and click *Submit*.\r
+\r
+image::media/checkin_barcode.png[]\r
+ \r
+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.\r
+\r
+image::media/overdue_checkin.png[]\r
+\r
+Backdated check in\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+This is useful for clearing a book drop.\r
+\r
+1) To change effective check-in date, select *Circulation* -> *Check In Items*, or press *F2*. Use the calendar widget to choose the effective date.\r
+\r
+image::media/backdate_checkin.png[]\r
+\r
+2) The top green bar changes to red. The new effective date is now displayed in the header.\r
+\r
+image::media/backdate_red.png[]\r
+\r
+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.\r
+ \r
+Backdate Post-Checkin\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date.\r
+\r
+1) Select the item on the Check In screen, click Actions for Selected Items -> Backdate Post-Checkin.\r
+\r
+image::media/backdate_post_checkin.png[]\r
+\r
+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.\r
+\r
+image::media/backdate_post_date.png[]\r
+\r
+[TIP]\r
+Checkin Modifiers\r
+===================================================\r
+At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are:\r
+\r
+- Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloging with Cataloging status.\r
+- Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.\r
+- Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans).\r
+- Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation.\r
+\r
+These options may be selected simultaneously. The selected option is displayed in the header area.\r
+\r
+image::media/checkin_options.png[]\r
+\r
+====================================================\r
+ \r
+Renewal and Editing the Item's Due Date\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Renewing via a Patron's Account\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) Retrieve the patron record and go to the *Items Out* screen.\r
+\r
+image::media/items_out_click.png[]\r
+\r
+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.\r
+\r
+image::media/renew_action.png[]\r
+\r
+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*.\r
+\r
+image::media/renew_specific_date.png[]\r
+ \r
+[TIP]\r
+Renewal can also be done on the *Item Status* screen. See the section called <<itemstatus,Item Status (F5)>> for more information.\r
+\r
+Renewing by Item Barcode\r
+^^^^^^^^^^^^^^^^^^^^^^^^\r
+1) To renew items by barcode, select *Circulation* -> *Renew Items* or press *CTRL-F2*.\r
+\r
+2) Scan or manually entire the item barcode.\r
+\r
+image::media/renew_item.png[]\r
+\r
+3) If you want to specify the due date, click *Specific Due Date* and select a new due date from the calendar.\r
+\r
+image::media/renew_item_calendar.png[]\r
+\r
+Editing Due Date\r
+^^^^^^^^^^^^^^^^\r
+\r
+1) Retrieve the patron record and go to the *Items Out* screen.\r
+\r
+2) Select the item you want to renew. Click on *Actions for Selected Items* -> *Edit Due Date*.\r
+\r
+image::media/edit_due_date_action.png[]\r
+\r
+3) Select a new due date in the pop-up window, then click *Apply*.\r
+\r
+[TIP]\r
+You can select multiple items by pressing down the CTRL key on your keyboard and clicking each items you want to edit.\r
+\r
+[NOTE]\r
+Editing a due date is not included in the renewal count.\r
+\r
+Marking Items Lost and Claimed Returned\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+Lost Items\r
+^^^^^^^^^^\r
+1) To mark items Lost, retrieve patron record and click *Items Out*.\r
+\r
+2) Select the item. Click on *Actions for Selected Items* -> *Mark Lost (by Patron)*.\r
+\r
+image::media/mark_lost.png[]\r
+\r
+3) The lost item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record.\r
+\r
+image::media/lost_cr_section.png[]\r
+\r
+4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. \r
+\r
+image::media/patron_summary_checkouts.jpg[]\r
+\r
+[NOTE]\r
+Lost Item Billing\r
+========================\r
+- 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.\r
+- 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. \r
+- 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.\r
+==========================\r
+\r
+Refunds for Lost Items\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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.\r
+\r
+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.\r
+\r
+Claimed Returned Items\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen.\r
+\r
+2) Select the item, then select *Actions for Selected Items* -> *Mark Claimed Returned* from the dropdown menu.\r
+\r
+image::media/mark_claims_returned.png[]\r
+\r
+3) Select a date and click *Apply*.\r
+\r
+image::media/claimed_date.png[]\r
+\r
+4) The Claimed Returned item now displays in the *Lost/Claimed Returned/Long Overdue, Has Unpaid Billings* section of the patron record.\r
+\r
+image::media/lost_cr_section.png[]\r
+\r
+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. \r
+\r
+image::media/patron_summary_checkouts.jpg[]\r
+\r
+[NOTE]\r
+More on Claimed Returned Items\r
+====================================\r
+- The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly.\r
+- 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.\r
+- 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.\r
+====================================\r
+\r
+In-house Use (F6)\r
+~~~~~~~~~~~~~~~~~\r
+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*. \r
+\r
+image::media/record_in_house_action.png[]\r
+ \r
+2) To record in-house use for cataloged items, enter number of uses, scan barcode or type barcode and click *Submit*.\r
+\r
+image::media/in_house_use.png[]\r
+\r
+[NOTE] \r
+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.\r
+\r
+[[itemstatus]]\r
+Item Status (F5)\r
+~~~~~~~~~~~~~~~~\r
+\r
+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.\r
+\r
+Checking item status\r
+^^^^^^^^^^^^^^^^^^^^\r
+\r
+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*.\r
+\r
+image::media/item_status_menu.png[]\r
+\r
+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.\r
+\r
+image::media/item_status_barcode.png[]\r
+\r
+3) Click the *Alternate View* button, and the item summary and circulation history will be displayed.\r
+\r
+image::media/item_status_altview.png[]\r
+\r
+4) Click *List View* to go back.\r
+\r
+image::media/item_status_list_view.png[]\r
+\r
+[NOTE]\r
+If the item's status is "Available", the displayed due date refers to the previous circulation's due date.\r
+\r
+[TIP]\r
+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.\r
+\r
+Viewing past circulations\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+1) To view past circulations, retrieve the item on the *Item Status* screen as described above.\r
+\r
+2) Select *Actions for Selected Items* -> *Show Last Few Circulations*.\r
+\r
+image::media/last_few_circs_action.png[]\r
+\r
+3) The item's recent circulation history is displayed.\r
+\r
+image::media/last_few_circs_display.png[]\r
+\r
+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).\r
+\r
+[TIP]\r
+The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*.\r
+\r
+[NOTE]\r
+You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen.\r
+\r
+Marking items damaged or missing and other functions\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+1) To mark items damaged or missing, retrieve the item on the *Item Status* screen.\r
+\r
+2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*.\r
+\r
+image::media/mark_missing_damaged.png[]\r
+\r
+[NOTE}\r
+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. \r
+\r
+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.\r
+\r
+Item alerts\r
+^^^^^^^^^^^\r
+\r
+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.\r
+1) Retrieve record on *Item Status* screen.\r
+\r
+2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*.\r
+\r
+3) The item record is displayed in the *Copy Editor*.\r
+\r
+image::media/copy_edit_alert.png[]\r
+\r
+4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. \r
+\r
+image::media/copy_alert_message.png[]\r
+\r
+5) Click *Modify Copies*, then confirm the action.\r
--- /dev/null
+Updating translations using Launchpad
+=====================================
+
+This document describes how to update the translations in an Evergreen branch
+by pulling them from Launchpad, as well as update the files to be translated
+in Launchpad by updating the POT files in the Evergreen master branch.
+
+Prerequisites
+-------------
+You must install all of the Python prerequisites required for building
+translations, per
+http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n
+
+* https://bitbucket.org/izi/polib/wiki/Home[polib]
+* http://translate.sourceforge.net[translate-toolkit]
+* http://pypi.python.org/pypi/python-Levenshtein/[levenshtein]
+* http://pypi.python.org/pypi/setuptools[setuptools]
+* http://pypi.python.org/pypi/simplejson/[simplejson]
+* http://lxml.de/[lxml]
+
+Updating the translations
+-------------------------
+
+. Check out the latest translations from Launchpad by branching the Bazaar
+repository:
++
+[source,bash]
+------------------------------------------------------------------------------
+bzr branch lp:~denials/evergreen/translation-export
+------------------------------------------------------------------------------
++
+This creates a directory called "translation-export".
++
+. Ensure you have an updated Evergreen release branch.
+. Run the `build/i18n/scripts/update_pofiles` script to copy the translations
+ into the right place and avoid any updates that are purely metadata (dates
+ generated, etc).
+. Commit the lot! And backport to whatever release branches need the updates.
+. Build updated POT files:
++
+[source,bash]
+------------------------------------------------------------------------------
+cd build/i18n
+make newpot
+------------------------------------------------------------------------------
++
+This will extract all of the strings from the latest version of the files in
+Evergreen.
++
+. (This part needs automation): Then, via the magic of `git diff` and `git add`,
+go through all of the changed files and determine which ones actually have
+string changes. Recommended approach is to re-run `git diff` after each
+`git add`.
+. Commit the updated POT files and backport to the pertinent release branches.
--- /dev/null
+Setting Up EDI Acquisitions\r
+---------------------------\r
+\r
+Introduction\r
+~~~~~~~~~~~~\r
+\r
+Electronic Data Interchange (EDI) is used to exchange information between \r
+participating vendors and Evergreen. This chapter contains technical \r
+information for installation and configuration of the components necessary \r
+to run EDI Acquisitions for Evergreen.\r
+\r
+Installation\r
+~~~~~~~~~~~~\r
+\r
+Install EDI Translator\r
+^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+The EDI Translator is used to convert data into EDI format. It runs\r
+on localhost and listens on port 9191 by default. This is controlled via \r
+the edi_webrick.cnf file located in the edi_translator directory. It should\r
+not be necessary to edit this configuration if you install EDI Translator \r
+on the same server used for running Action/Triggers events.\r
+\r
+[NOTE]\r
+If you are running Evergreen with a multi-server configuration, make sure\r
+to install EDI Translator on the same server used for Action/Trigger event\r
+generation.\r
+\r
+.Steps for Installing\r
+\r
+1. As the *opensrf* user, copy the EDI Translator code found in \r
+ Open-ILS/src/edi_translator to somewhere accessible \r
+ (for example, /openils/var/edi):\r
++\r
+[source, bash]\r
+--------------------------------------------------\r
+cp -r Open-ILS/src/edi_translator /openils/var/edi\r
+--------------------------------------------------\r
+2. Navigate to where you have saved the code to begin next step:\r
++\r
+[source, bash]\r
+-------------------\r
+cd /openils/var/edi\r
+-------------------\r
+3. Next, as the *root* user (or a user with sudo rights), install the \r
+ dependencies, via "install.sh". This will perform some apt-get routines \r
+ to install the code needed for the EDI translator to function. \r
+ (Note: subversion must be installed first)\r
++\r
+[source, bash]\r
+-----------\r
+./install.sh\r
+-----------\r
+4. Now, we're ready to start "edi_webrick.bash" which is the script that calls \r
+ the "Ruby" code to translate EDI. This script needs to be started in \r
+ order for EDI to function so please take appropriate measures to ensure this \r
+ starts following reboots/upgrades/etc. As the *opensrf* user:\r
++\r
+[source, bash]\r
+-----------------\r
+./edi_webrick.bash\r
+-----------------\r
+5. You can check to see if EDI translator is running.\r
+ * Using the command "ps aux | grep edi" should show you something similar \r
+ if the script is running properly:\r
++\r
+[source, bash]\r
+------------------------------------------------------------------------------------------\r
+root 30349 0.8 0.1 52620 10824 pts/0 S 13:04 0:00 ruby ./edi_webrick.rb\r
+------------------------------------------------------------------------------------------\r
+ * To shutdown EDI Translator you can use something like pkill (assuming \r
+ no other ruby processes are running on that server):\r
++\r
+[source, bash]\r
+-----------------------\r
+kill -INT $(pgrep ruby)\r
+-----------------------\r
+\r
+Install EDI Scripts\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+The EDI scripts are "edi_pusher.pl" and "edi_fetcher.pl" and are used to\r
+"push" and "fetch" EDI messages for configured EDI accounts.\r
+\r
+1. As the *opensrf* user, copy edi_pusher.pl and edi_fetcher.pl from\r
+ Open-ILS/src/support-scripts into /openils/bin:\r
++\r
+[source, bash]\r
+--------------------------------------------------\r
+cp Open-ILS/src/support-scripts/edi_pusher.pl /openils/bin\r
+cp Open-ILS/src/support-scripts/edi_fetcher.pl /openils/bin\r
+--------------------------------------------------\r
+2. Setup the edi_pusher.pl and edi_fetcher.pl scripts to run as cron jobs\r
+ in order to regularly push and receive EDI messages.\r
+ * Add to the opensrf user's crontab the following entries:\r
++\r
+[source, bash]\r
+-----------------------------------------------------------------------\r
+10 * * * * cd /openils/bin && /usr/bin/perl ./edi_pusher.pl > /dev/null\r
+0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null\r
+-----------------------------------------------------------------------\r
+ * The example for edi_pusher.pl sets the script to run at \r
+ 10 minutes past the hour, every hour.\r
+ * The example for edi_fetcher.pl sets the script to run at\r
+ 1 AM every night.\r
+\r
+[NOTE]\r
+You may choose to run the EDI scripts more or less frequently based on the \r
+necessary response times from your vendors.\r
+\r
+Configuration\r
+~~~~~~~~~~~~~\r
+\r
+Configuring Providers\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Look in Admin > Server Administration > Acquisitions > Providers\r
+\r
+[options="header"]\r
+|======================================================================================\r
+|Column |Description/Notes\r
+|Provider Name |A unique name to identify the provider\r
+|Code |A unique code to identify the provider\r
+|Owner |The org unit who will "own" the provider.\r
+|Currency |The currency format the provider accepts\r
+|Active |Whether or not the Provider is "active" for use\r
+|Default Claim Policy|??\r
+|EDI Default |The default "EDI Account" to use (see EDI Accounts Configuration)\r
+|Email |The email address for the provider\r
+|Fax Phone |A fax number for the provider\r
+|Holdings Tag |The holdings tag to be utilized (usually 852, for Evergreen)\r
+|Phone |A phone number for the provider\r
+|Prepayment Required |Whether or not prepayment is required\r
+|SAN |The vendor provided, org unit specific SAN code\r
+|URL |The vendor website\r
+|======================================================================================\r
+\r
+Configuring EDI Accounts\r
+^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Look in Admin > Server Administration > Acquisitions > EDI Accounts\r
+\r
+[options="header"]\r
+|===============================================================================================================\r
+|Column |Description/Notes\r
+|Label |A unique name to identify the provider\r
+|Host |FTP/SFTP/SSH hostname - vendor assigned\r
+|Username |FTP/SFTP/SSH username - vendor assigned\r
+|Password |FTP/SFTP/SSH password - vendor assigned\r
+|Account |Vendor assigned account number associated with your organization\r
+|Owner |The organizational unit who owns the EDI account\r
+|Last Activity |The date of last activity for the account\r
+|Provider |This is a link to one of the "codes" in the "Providers" interface\r
+|Path |The path on the vendor's server where Evergreen will send it's outgoing .epo files\r
+|Incoming Directory |The path on the vendor's server where "incoming" .epo files are stored\r
+|Vendor Account Number|Vendor assigned account number.\r
+|Vendor Assigned Code |Usually a sub-account designation. Can be used with or without the Vendor Account Number.\r
+|===============================================================================================================\r
+\r
+Configuring Organizational Unit SAN code\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Look in Admin > Server Settings > Organizational Units\r
+\r
+This interface allows a library to configure their SAN, alongside \r
+their address, phone, etc.\r
+\r
+Troubleshooting\r
+~~~~~~~~~~~~~~~\r
+\r
+PO JEDI Template Issues\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Some libraries may run into issues with the action/trigger (PO JEDI). \r
+The template has to be modified to handle different vendor codes that \r
+may be used. For instance, if you use "ingra" instead of INGRAM this \r
+may cause a problem because they are hardcoded in the template. The \r
+following is an example of one modification that seems to work.\r
+\r
+.Original template has:\r
+\r
+[source, bash]\r
+----------------------------------------------------------------------------------------------------------------------------------------------\r
+"buyer":[\r
+ [% IF target.provider.edi_default.vendcode && (target.provider.code == 'BT' || target.provider.name.match('(?i)^BAKER & TAYLOR')) -%]\r
+ {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
+ [%- ELSIF target.provider.edi_default.vendcode && target.provider.code == 'INGRAM' -%]\r
+ {"id":"[% target.ordering_agency.mailing_address.san %]"},\r
+ {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"}\r
+ [%- ELSE -%]\r
+ {"id":"[% target.ordering_agency.mailing_address.san %]"}\r
+ [%- END -%]\r
+],\r
+----------------------------------------------------------------------------------------------------------------------------------------------\r
+\r
+.Modified template has the following where it matches on provider SAN instead of code:\r
+\r
+[source, bash]\r
+------------------------------------------------------------------------------------------------------------------------------------------\r
+"buyer":[\r
+ [% IF target.provider.edi_default.vendcode && (target.provider.san == '1556150') -%]\r
+ {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
+ {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
+ [%- ELSIF target.provider.edi_default.vendcode && (target.provider.san == '1697978') -%]\r
+ {"id":"[% target.ordering_agency.mailing_address.san %]"},\r
+ {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"}\r
+ [%- ELSE -%]\r
+ {"id":"[% target.ordering_agency.mailing_address.san %]"}\r
+ [%- END -%]\r
+],\r
+------------------------------------------------------------------------------------------------------------------------------------------\r
+\r
--- /dev/null
+README for Evergreen 2.2
+========================
+:toc:
+:numbered:
+
+Preamble: referenced user accounts
+----------------------------------
+
+In subsequent sections, we will refer to a number of different accounts, as
+follows:
+
+ * Linux user accounts:
+ ** The *user* Linux account is the account that you use to log onto the
+ Linux system as a regular user.
+ ** The *root* Linux account is an account that has system administrator
+ privileges. On Debian and Fedora you can switch to this account from
+ your *user* account by issuing the `su -` command and entering the
+ password for the *root* account when prompted. On Ubuntu you can switch
+ to this account from your *user* account using the `sudo su -` command
+ and entering the password for your *user* account when prompted.
+ ** The *opensrf* Linux account is an account that you create when installing
+ OpenSRF. You can switch to this account from the *root* account by
+ issuing the `su - opensrf` command.
+ ** The *postgres* Linux account is created automatically when you install
+ the PostgreSQL database server. You can switch to this account from the
+ *root* account by issuing the `su - postgres` command.
+ * PostgreSQL user accounts:
+ ** The *evergreen* PostgreSQL account is a superuser account that you will
+ create to connect to the PostgreSQL database server.
+ * Evergreen administrator account:
+ ** The *egadmin* Evergreen account is an administrator account for
+ Evergreen that you will use to test connectivity and configure your
+ Evergreen instance.
+
+Preamble: Developer instructions
+--------------------------------
+
+[NOTE]
+Skip this section if you are using an official release tarball downloaded
+from http://evergreen-ils.org/downloads
+
+Developers working directly with the source code from the Git repository,
+rather than an official release tarball, must install some extra packages
+and perform one step before they can proceed with the `./configure` step.
+
+As the *root* Linux account, install the following packages:
+
+ * autoconf
+ * automake
+ * libtool
+
+As the *user* Linux account, issue the following command in the Evergreen
+source directory to generate the configure script and Makefiles:
+
+[source, bash]
+------------------------------------------------------------------------------
+autoreconf -i
+------------------------------------------------------------------------------
+
+After running `make install`, developers also need to install the Dojo Toolkit
+set of JavaScript libraries. The appropriate version of Dojo is included
+in Evergreen release tarballs. Developers should install the Dojo 1.3.3
+version of Dojo by issuing the following commands as the *opensrf* Linux
+account:
+
+[source, bash]
+------------------------------------------------------------------------------
+wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
+tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
+cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
+------------------------------------------------------------------------------
+
+Installing prerequisites
+------------------------
+
+Evergreen has a number of prerequisite packages that must be installed
+before you can successfully configure, compile, and install Evergreen.
+
+1. Begin by installing the most recent version of OpenSRF (2.1 or later).
+ You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
+2. On many distributions, it is necessary to install PostgreSQL 9 from external
+ repositories.
++
+ * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
+ *root* Linux account and add the following line:
++
+[source, bash]
+------------------------------------------------------------------------------
+deb http://backports.debian.org/debian-backports squeeze-backports main contrib
+------------------------------------------------------------------------------
++
+ * On Ubuntu Lucid, you can use a PPA (personal package archive), which are
+ package sources hosted on Launchpad. The one most commonly used by Evergreen
+ Community members is maintained by Martin Pitt, who also maintains the
+ official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
+ the following commands to add the PPA source:
++
+[source, bash]
+------------------------------------------------------------------------------
+apt-get install python-software-properties
+add-apt-repository ppa:pitti/postgresql
+------------------------------------------------------------------------------
++
+ * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
++
+ * Fedora 16 comes with PostgreSQL 9, so no additional steps are required.
++
+3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
+ retrieve the new packages from the backports repository.
+4. Issue the following commands as the *root* Linux account to install
+ prerequisites using the `Makefile.install` prerequisite installer,
+ substituting `debian-squeeze`, `fedora16`, `ubuntu-lucid`, or
+ `ubuntu-precise` for <osname> below:
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>
+------------------------------------------------------------------------------
++
+5. Add the libdbi-libdbd libraries to the system dynamic library path by
+ issuing the following commands as the *root* Linux account:
++
+[NOTE]
+You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
+target uses libdbd-pgsql from packages.
++
+.Debian / Ubuntu Lucid
+[source, bash]
+------------------------------------------------------------------------------
+echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
+ldconfig
+------------------------------------------------------------------------------
++
+.Fedora
+[source, bash]
+------------------------------------------------------------------------------
+echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
+ldconfig
+------------------------------------------------------------------------------
+
+Configuration and compilation instructions
+------------------------------------------
+
+For the time being, we are still installing everything in the `/openils/`
+directory. From the Evergreen source directory, issue the following commands as
+the *user* Linux account to configure and build Evergreen:
+
+[source, bash]
+------------------------------------------------------------------------------
+./configure --prefix=/openils --sysconfdir=/openils/conf
+make
+------------------------------------------------------------------------------
+
+Installation instructions
+-------------------------
+
+1. Once you have configured and compiled Evergreen, issue the following
+ command as the *root* Linux account to install Evergreen, build the server
+ portion of the staff client, and copy example configuration files to
+ `/openils/conf`.
+ Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
+ of the staff client that you will use to connect to the Evergreen server.
++
+[source, bash]
+------------------------------------------------------------------------------
+make STAFF_CLIENT_STAMP_ID=rel_2_2 install
+------------------------------------------------------------------------------
++
+2. The server portion of the staff client expects `http://hostname/xul/server`
+ to resolve. Issue the following commands as the *root* Linux account to
+ create a symbolic link pointing to the `server` subdirectory of the server
+ portion of the staff client that we just built using the staff client ID
+ 'rel_name':
++
+[source, bash]
+------------------------------------------------------------------------------
+cd /openils/var/web/xul
+ln -sf rel_name/server server
+------------------------------------------------------------------------------
+
+Change ownership of the Evergreen files
+---------------------------------------
+
+All files in the `/openils/` directory and subdirectories must be owned by the
+`opensrf` user. Issue the following command as the *root* Linux account to
+change the ownership on the files:
+
+[source, bash]
+------------------------------------------------------------------------------
+chown -R opensrf:opensrf /openils
+------------------------------------------------------------------------------
+
+Configure the Apache Web server
+-------------------------------
+
+1. Use the example configuration files in `Open-ILS/examples/apache/` to
+configure your Web server for the Evergreen catalog, staff client, Web
+services, and administration interfaces. Issue the following commands as the
+*root* Linux account:
++
+.Debian and Ubuntu
+[source,bash]
+------------------------------------------------------------------------------
+cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
+cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
+cp Open-ILS/examples/apache/startup.pl /etc/apache2/
+# Now set up SSL
+mkdir /etc/apache2/ssl
+cd /etc/apache2/ssl
+------------------------------------------------------------------------------
++
+.Fedora
+[source,bash]
+------------------------------------------------------------------------------
+cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/
+cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
+cp Open-ILS/examples/apache/startup.pl /etc/httpd/
+# Now set up SSL
+mkdir /etc/httpd/ssl
+cd /etc/httpd/ssl
+------------------------------------------------------------------------------
++
+2. The `openssl` command cuts a new SSL key for your Apache server. For a
+production server, you should purchase a signed SSL certificate, but you can
+just use a self-signed certificate and accept the warnings in the staff client
+and browser during testing and development. Create an SSL key for the Apache
+server by issuing the following command as the *root* Linux account:
++
+[source,bash]
+------------------------------------------------------------------------------
+openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
+------------------------------------------------------------------------------
++
+3. As the *root* Linux account, edit the `eg.conf` file that you copied into
+place.
+ a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
+ access to the offline upload / execute interface from any workstation on
+ any network - note that you must secure this for a production instance)
+ b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
+ to `/etc/httpd/`.
+4. Change the user for the Apache server.
+ * (Debian and Ubuntu): As the *root* Linux account, edit
+ `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
+ `export APACHE_RUN_USER=opensrf`.
+ * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
+ Change `User apache` to `User opensrf`.
+5. Configure Apache with performance settings appropriate for Evergreen:
+ * (Debian and Ubuntu): As the *root* Linux account, edit
+ `/etc/apache2/apache2.conf`:
+ * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
+ a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
+ a request timing out unexpectedly, but increase the risk of using up
+ all available Apache child processes.
+ b. 'Optional': Change `MaxKeepAliveRequests` to `100`
+ c. Update the prefork configuration section to suit your environment. The
+ following settings apply to a busy system:
++
+[source,bash]
+------------------------------------------------------------------------------
+<IfModule mpm_prefork_module>
+ StartServers 20
+ MinSpareServers 5
+ MaxSpareServers 15
+ MaxClients 150
+ MaxRequestsPerChild 10000
+</IfModule>
+------------------------------------------------------------------------------
++
+6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
+ file to change references from the non-existent `/etc/apache2/` directory
+ to `/etc/httpd/`.
+7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
++
+[source,bash]
+------------------------------------------------------------------------------
+a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
+a2ensite eg.conf
+------------------------------------------------------------------------------
+
+Configure OpenSRF for the Evergreen application
+-----------------------------------------------
+There are a number of example OpenSRF configuration files in `/openils/conf/`
+that you can use as a template for your Evergreen installation. Issue the
+following commands as the *opensrf* Linux account:
+
+[source, bash]
+------------------------------------------------------------------------------
+cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
+cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+------------------------------------------------------------------------------
+
+When you installed OpenSRF, you created four Jabber users on two
+separate domains and edited the `opensrf_core.xml` file accordingly. Please
+refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
+Evergreen version of the `opensrf_core.xml` file using the same Jabber users
+and domains as you used while installing and testing OpenSRF.
+
+[NOTE]
+The `-b` flag tells the `cp` command to create a backup version of the
+destination file. The backup version of the destination file has a tilde (`~`)
+appended to the file name, so if you have forgotten the Jabber users and
+domains, you can retrieve the settings from the backup version of the files.
+
+`eg_db_config.pl`, described in the following section, sets the database
+connection information in `opensrf.xml` for you.
+
+Creating the Evergreen database
+-------------------------------
+
+By default, the `Makefile.install` prerequisite installer does not install
+the PostgreSQL 9 database server required by every Evergreen system;
+for production use, most libraries install the PostgreSQL database server on a
+dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
+on the machine of your choice using the following commands as the *root*
+Linux account:
+
+.(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
+------------------------------------------------------------------------------
+
+.(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
+------------------------------------------------------------------------------
+
+You can install the packages required by Fedora on the machine of your choice
+using the following commands as the *root* Linux account:
+
+.(Fedora 16) Installing PostgreSQL server packages
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
+postgresql-setup initdb
+------------------------------------------------------------------------------
+
+For a standalone PostgreSQL server, install the following Perl modules as the
+*root* Linux account:
+
+.(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
+[source, bash]
+------------------------------------------------------------------------------
+aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
+cpan Business::ISBN
+cpan JSON::XS
+cpan Library::CallNumber::LC
+cpan MARC::Record
+cpan MARC::File::XML
+cpan UUID::Tiny
+------------------------------------------------------------------------------
+
+.(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
+[source, bash]
+------------------------------------------------------------------------------
+yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
+cpan Library::CallNumber::LC
+cpan MARC::Record
+cpan MARC::File::XML
+cpan UUID::Tiny
+------------------------------------------------------------------------------
+
+You need to create a PostgreSQL superuser to create and access the database.
+Issue the following command as the *postgres* Linux account to create a new
+PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
+password:
+
+[source, bash]
+------------------------------------------------------------------------------
+createuser -s -P evergreen
+------------------------------------------------------------------------------
+
+Once you have created the *evergreen* PostgreSQL account, you also need to
+create the database and schema, and configure your configuration files to point
+at the database server. Issue the following command as the *root* Linux account
+from inside the Evergreen source directory, replacing <user>, <password>,
+<hostname>, <port>, and <dbname> with the appropriate values for your
+PostgreSQL database (where <user> and <password> are for the *evergreen*
+PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
+with the values you want for the *egadmin* Evergreen administrator account:
+
+[source, bash]
+------------------------------------------------------------------------------
+perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
+ --service all --create-database --create-schema --create-offline \
+ --user <user> --password <password> --hostname <hostname> --port <port> \
+ --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
+------------------------------------------------------------------------------
+
+This creates the database and schema and configures all of the services in
+your `/openils/conf/opensrf.xml` configuration file to point to that database.
+It also creates the configuration files required by the Evergreen `cgi-bin`
+administration scripts, and sets the user name and password for the *egadmin*
+Evergreen administrator account to your requested values.
+
+Creating the database on a remote server
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In a production instance of Evergreen, your PostgreSQL server should be
+installed on a dedicated server.
+
+PostgreSQL 9.1 and later
+^^^^^^^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`.
+
+For PostgreSQL 9.0
+^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.0, you can either:
+
+ * Install the PostgreSQL contrib modules on the machine on which you
+ are installing the Evergreen code, and use the `--create-database`
+ option from that machine, or
+ * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
+ PostgreSQL server and invoke it as the *postgres* Linux account:
++
+[source, bash]
+------------------------------------------------------------------------------
+psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
+------------------------------------------------------------------------------
+
+Then you can issue the `eg_db_config.pl` command as above _without_ the
+`--create-database` argument to create your schema and configure your
+configuration files.
+
+Starting Evergreen
+------------------
+1. As the *root* Linux account, start the `memcached` and `ejabberd` services
+(if they aren't already running):
++
+[source, bash]
+------------------------------------------------------------------------------
+/etc/init.d/ejabberd start
+/etc/init.d/memcached start
+------------------------------------------------------------------------------
++
+2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
+following command is only necessary if you want to force Evergreen to treat the
+hostname as `localhost`; if you configured `opensrf.xml` using the real
+hostname of your machine as returned by `perl -ENet::Domain 'print
+Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
++
+[source, bash]
+------------------------------------------------------------------------------
+osrf_ctl.sh -l -a start_all
+------------------------------------------------------------------------------
++
+ ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
+ then your environment variable `PATH` does not include the `/openils/bin`
+ directory; this should have been set in the *opensrf* Linux account's
+ `.bashrc` configuration file. To manually set the `PATH` variable, edit the
+ configuration file `~/.bashrc` as the *opensrf* Linux account and add the
+ following line:
++
+[source, bash]
+------------------------------------------------------------------------------
+export PATH=$PATH:/openils/bin
+------------------------------------------------------------------------------
++
+3. As the *opensrf* Linux account, generate the Web files needed by the staff
+ client and catalogue and update the organization unit proximity (you need to do
+ this the first time you start Evergreen, and after that each time you change
+ the library hierarchy in `config.cgi`):
++
+[source, bash]
+------------------------------------------------------------------------------
+autogen.sh -u
+------------------------------------------------------------------------------
++
+4. As the *root* Linux account, restart the Apache Web server:
++
+[source, bash]
+------------------------------------------------------------------------------
+/etc/init.d/apache2 restart
+------------------------------------------------------------------------------
++
+If the Apache Web server was running when you started the OpenSRF services, you
+might not be able to successfully log in to the OPAC or staff client until the
+Apache Web server is restarted.
+
+Testing connections to Evergreen
+--------------------------------
+
+Once you have installed and started Evergreen, test your connection to
+Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
+commands to start `srfsh` and try to log onto the Evergreen server using the
+*egadmin* Evergreen administrator user name and password that you set using the
+`eg_db_config.pl` command:
+
+[source, bash]
+------------------------------------------------------------------------------
+/openils/bin/srfsh
+srfsh% login <admin-user> <admin-pass>
+------------------------------------------------------------------------------
+
+You should see a result like:
+
+ Received Data: "250bf1518c7527a03249858687714376"
+ ------------------------------------
+ Request Completed Successfully
+ Request Time in seconds: 0.045286
+ ------------------------------------
+
+ Received Data: {
+ "ilsevent":0,
+ "textcode":"SUCCESS",
+ "desc":" ",
+ "pid":21616,
+ "stacktrace":"oils_auth.c:304",
+ "payload":{
+ "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
+ "authtime":420
+ }
+
+ }
+
+ ------------------------------------
+ Request Completed Successfully
+ Request Time in seconds: 1.336568
+ ------------------------------------
+
+If this does not work, it's time to do some troubleshooting.
+
+ * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
+ if it finds any system configuration problems. The script is found at
+ `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
+ tree.
+ * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
+ * If you have faithfully followed the entire set of installation steps
+ listed here, you are probably extremely close to a working system.
+ Gather your configuration files and log files and contact the
+ http://open-ils.org/listserv.php[Evergreen development mailing list]
+ for assistance before making any drastic changes to your system
+ configuration.
+
+Getting help
+------------
+
+Need help installing or using Evergreen? Join the mailing lists at
+http://evergreen-ils.org/listserv.php or contact us on the Freenode
+IRC network on the #evergreen channel.
+
+License
+-------
+This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
+Unported License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
+Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
--- /dev/null
+Upgrading the Evergreen Server
+------------------------------
+Before upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and service interruptions.
+All of the steps in this chapter are to be completed from the command line.
+
+Software Prerequisites:
+~~~~~~~~~~~~~~~~~~~~~~~
+
+ * **PostgreSQL**: Version 9.1 is recommended. The minimum supported version
+ is 9.0.
+ * **Linux**: Evergreen 2.0 has been tested on Debian Squeeze (6.0),
+ Ubuntu Lucid Lynx (10.04) and Ubuntu Precise Pangolin (12.04). If you are
+ running an older version of these distributions, you may want to upgrade
+ before upgrading Evergreen. For instructions on upgrading these
+ distributions, visit the Debian or Ubuntu websites.
+ * **OpenSRF**: The minimum supported version of OpenSRF is 2.1.0.
+
+In the following instructions, you are asked to perform certain steps as either the root or opensrf user.
+
+ * **Debian**: To become the root user, issue the `su` command and enter the password of the root user.
+ * **Ubuntu**: To become the root user, issue the `sudo su` command and enter the password of your current user.
+
+To switch from the root user to a different user, issue the `su - [user]`
+command; for example, `su - opensrf`. Once you have become a non-root user, to
+become the root user again simply issue the `exit` command.
+
+[CAUTION]
+Pay attention to error output as you run these scripts. If you encounter errors
+that you cannot resolve yourself through additional troubleshooting, please
+report the errors to the http://evergreen-ils.org/listserv.php[Evergreen
+Technical Discussion List].
+
+Upgrade the Evergreen database schema
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The upgrade of the Evergreen database schema is the lengthiest part of the
+upgrade process for sites with a significant amount of production data.
+
+Before running the upgrade script against your production Evergreen database,
+back up your database, restore it to a test server, and run the upgrade script
+against the test server. This enables you to determine how long the upgrade
+will take and whether any local customizations present problems for the
+stock upgrade script that require further tailoring of the upgrade script.
+The backup also enables you to cleanly restore your production data if
+anything goes wrong during the upgrade.
+
+Run the following script as a user with the ability to connect to the
+database server. Adjust the arguments to the `psql` command to reflect your
+database server connection information:
+
+[source, bash]
+----------------------------------------------------------
+cd /home/opensrf/Evergreen-ILS-2.1-beta2/Open-ILS/src/sql/Pg
+psql -U evergreen -h localhost -f version_upgrade/2.1-2.2-upgrade-db.sql evergreen
+----------------------------------------------------------
+
+Upgrade the Evergreen code
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+The following steps guide you through a simplistic upgrade of a production
+server. You must adjust these steps to accommodate your customizations such
+as catalogue skins.
+
+. Stop Evergreen and back up your data:
+ .. As root, stop the Apache web server.
+ .. As the opensrf user, stop all Evergreen and OpenSRF services:
++
+[source, bash]
+-----------------------------
+osrf_ctl.sh -l -a stop_all
+-----------------------------
++
+ .. Back up the /openils directory.
+. Upgrade OpenSRF. Download and install the latest version of OpenSRF from
+the http://evergreen-ils.org/opensrf.php[OpenSRF download page].
+. As the opensrf user, download and extract Evergreen 2.2:
++
+[source, bash]
+-----------------------------------------------
+wget http://evergreen-ils.org/downloads/previews/Evergreen-ILS-2.2-beta2.tar.gz
+tar xzf Evergreen-ILS-2.2-beta2.tar.gz
+-----------------------------------------------
++
+[NOTE]
+For the latest edition of Evergreen, check the http://evergreen-ils.org/downloads.php[Evergreen download page] and adjust upgrading instructions accordingly.
++
+. As the root user, install the prerequisites:
++
+[source, bash]
+----------------------------------------------
+cd /home/opensrf/Evergreen-ILS-2.2-beta2
+---------------------------------------------
++
+On the next command, replace `[distribution]` with one of these values for your
+distribution of Debian or Ubuntu:
+
+ * `debian-squeeze` for Debian Squeeze (6.0)
+ * `ubuntu-lucid` for Ubuntu Lucid Lynx (10.04)
+ * `ubuntu-precise` for Ubuntu Precise Pangolin (12.04)
++
+[source, bash]
+------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install [distribution]
+------------------------------------------------------------
++
+. As the opensrf user, configure and compile Evergreen:
++
+[source, bash]
+------------------------------------------------------------
+cd /home/opensrf/Evergreen-ILS-2.2-beta2
+./configure --prefix=/openils --sysconfdir=/openils/conf
+make
+------------------------------------------------------------
++
+. As the root user, install Evergreen:
++
+[source, bash]
+------------------------------------------------------------
+cd /home/opensrf/Evergreen-ILS-2.2-beta2
+make STAFF_CLIENT_STAMP_ID=rel_2_2_beta2 install
+------------------------------------------------------------
++
+. As the root user, change all files to be owned by the opensrf user and group:
++
+[source, bash]
+------------------------------------------------------------
+chown -R opensrf:opensrf /openils
+------------------------------------------------------------
++
+. As the opensrf user, update the configuration files:
++
+[source, bash]
+-----------------------------------------------------------
+cd /home/opensrf/Evergreen-ILS-2.2-beta2
+
+perl Open-ILS/src/support-scripts/eg_db_config.pl \
+--create-offline --user evergreen --password evergreen \
+--hostname localhost --port 5432 --database evergreen
+----------------------------------------------------------
++
+. As the opensrf user, update the server symlink in /openils/var/web/xul/:
++
+[source, bash]
+-----------------------------------------------------------
+cd /openils/var/web/xul/
+rm server
+ln -s rel_2_2_beta2/server
+----------------------------------------------------------
++
+. As the opensrf user, update opensrf_core.xml and opensrf.xml by copying the
+ new example files (/openils/conf/opensrf_core.xml.example and
+ /openils/conf/opensrf.xml).
++
+[source, bash]
+----------------------------------------------------------
+cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
+cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+----------------------------------------------------------
++
+[CAUTION]
+Copying these configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
++
+. Update Apache files:
++
+[CAUTION]
+Copying these Apache configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
+For example, if you purchased an SSL certificate, you will need to edit eg.conf to point to the appropriate SSL certificate files.
++
+.. Update /etc/apache2/startup.pl by copying the example from Open-ILS/examples/apache/startup.pl.
+.. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf.
+.. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ examples/apache/eg.conf.
+. Update opensrf.xml with the database connection info:
++
+As the opensrf user, if you are happy with the default settings in
+opensrf.xml.example, then:
++
+[source, bash]
+-------------------------------------------------------------------------
+cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+cd /home/opensrf/Evergreen-ILS-2.2-beta2
+perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all \
+--database evergreen --host localhost --user evergreen --password evergreen
+-------------------------------------------------------------------------
++
+Otherwise, compare /openils/conf/opensrf.xml with /openils/conf/opensrf.xml.example and manually copy the new pieces into place in your existing opensrf.xml file
+
+Restart Evergreen and Test
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+. As the opensrf user, start all Evergreen and OpenSRF services:
++
+[source, bash]
+--------------------------------------------------------------
+osrf_ctl.sh -l -a start_all
+--------------------------------------------------------------
++
+. As the opensrf user, run autogen to refresh the static organizational data files:
++
+[source, bash]
+--------------------------------------------------------------
+cd /openils/bin
+../autogen.sh
+--------------------------------------------------------------
++
+. Start srfsh and try logging in using your Evergreen username and password:
++
+[source, bash]
+--------------------------------------------------------------
+/openils/bin/srfsh
+srfsh% login username password
+--------------------------------------------------------------
++
+You should see a result like:
++
+[source, bash]
+------------------------------------------------------
+Received Data: "250bf1518c7527a03249858687714376"
+ ------------------------------------
+ Request Completed Successfully
+ Request Time in seconds: 0.045286
+ ------------------------------------
+
+ Received Data: {
+ "ilsevent":0,
+ "textcode":"SUCCESS",
+ "desc":" ",
+ "pid":21616,
+ "stacktrace":"oils_auth.c:304",
+ "payload":{
+ "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
+ "authtime":420
+ }
+
+ }
+
+ ------------------------------------
+ Request Completed Successfully
+ Request Time in seconds: 1.336568
+ ------------------------------------
+----------------------------------------------------------
++
+If this does not work, it's time to do some troubleshooting.
++
+. As the root user, start the Apache web server.
++
+If you encounter errors, refer to the troubleshooting section of this documentation for tips on finding solutions and seeking further assistance
+from the Evergreen community.
--- /dev/null
+System Requirements
+-------------------
+
+Server Minimum Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following are the base requirements setting Evergreen up on a test server:
+
+ * An available desktop, server or virtual image
+ * 1GB RAM, or more if your server also runs a graphical desktop
+ * Linux Operating System
+ * Ports 80 and 443 should be opened in your firewall for TCP connections to allow OPAC and staff client connections to the Evergreen server.
+
+Staff Client Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Staff terminals connect to the central database using the Evergreen staff client, available for download from The Evergreen download page.
+The staff client must be installed on each staff workstation and requires at minimum:
+
+ * Windows (XP, Vista, or 7), Mac OS X, or Linux operating system
+ * a reliable high speed Internet connection
+ * 512Mb of RAM
+ * The staff client uses the TCP protocal on ports 80 and 443 to communicate with the Evergreen server.
+
+*Barcode Scanners*
+
+Evergreen will work with virtually any barcode scanner – if it worked with your legacy system it should work on Evergreen.
+
+*Printers*
+
+Evergreen can use any printer configured for your terminal to print receipts, check-out slips, holds lists, etc. The single exception is spine label printing,
+which is still under development. Evergreen currently formats spine labels for output to a label roll printer. If you do not have a roll printer manual formatting may be required.
--- /dev/null
+Licensing
+=========
+
+Creative Commons License
+------------------------
+
+image::media/ccbysa.png["CC-BY-SA",link="http://creativecommons.org/licenses/by-sa/3.0/"]
+
+This work is licensed under a
+link:http://creativecommons.org/licenses/by-sa/3.0/[Creative
+Commons Attribution-ShareAlike 3.0 Unported License].
+
+Additional Licensed Content
+---------------------------
+
+The
+
+image::media/application-pdf.png["PDF"]
+
+icon comes from the KDE project at: http://kde.org/ and is licensed under the GNU
+Lesser General Public License 3.0
+
+....
+GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+....
--- /dev/null
+My Lists 2.2\r
+------------\r
+\r
+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.\r
+\r
+\r
+*Create New Lists*\r
+\r
+1) Log in to your account in the OPAC.\r
+\r
+2) Search for titles.\r
+\r
+3) Choose a title to add to your list. Click *Add to My List*.\r
+\r
+image::media/My_Lists1.jpg[My_Lists1]\r
+\r
+4) Scroll up to the gray row on top of the *Search Results*. Click *View My List*\r
+\r
+5) Items are added to a temporary list. Your temporary list appears at the bottom of the screen.\r
+\r
+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. \r
+\r
+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.\r
+\r
+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.\r
+\r
+image::media/My_Lists3.jpg[My_Lists3]\r
+\r
+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.\r
+\r
+image::media/My_Lists4.jpg[My_Lists4]\r
+\r
+8) Click *Submit*.\r
+\r
+9) The new list appears beneath the temporary list.\r
+\r
+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.\r
+\r
+image::media/My_Lists5.jpg[My_Lists5]\r
+\r
+11) Click *Go*.\r
+\r
+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.\r
+\r
+13) Click *Edit* to add or edit a note.\r
+\r
+14). Enter desired notes, and click *Save Notes*.\r
+\r
+image::media/My_Lists6.jpg[My_Lists6]\r
+\r
+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. \r
+\r
+You can also download your list into a CSV file by clicking *Download CSV*.\r
+\r
+image::media/My_Lists7.jpg[My_Lists7]\r
+\r
+\r
+16) When you no longer need a list, click *Delete List*. \r
+\r
+\r
+\r
+\r
+\r
--- /dev/null
+Evergreen Documentation\r
+=======================\r
+Documentation Interest Group\r
+:doctype: book\r
+:toc:\r
+:numbered:\r
+\r
+Introduction\r
+============ \r
+\r
+About This Documentation\r
+------------------------\r
+\r
+This guide was produced by the Evergreen Documentation Interest Group (DIG),\r
+consisting of numerous volunteers from many different organizations. The DIG\r
+has drawn together, edited, and supplemented pre-existing documentation\r
+contributed by libraries and consortia running Evergreen that were kind enough\r
+to release their documentation into the creative commons. Please see the\r
+<<attributions,Attributions>> section for a full list of authors and\r
+contributing organizations. Just like the software it describes, this guide is\r
+a work in progress, continually revised to meet the needs of its users, so if\r
+you find errors or omissions, please let us know, by contacting the DIG\r
+facilitators at docs@evergreen-ils.org.\r
+\r
+This guide to Evergreen is intended to meet the needs of front-line library\r
+staff, catalogers, library administrators, system administrators, and software\r
+developers. It is organized into Parts, Chapters, and Sections addressing key\r
+aspects of the software, beginning with the topics of broadest interest to the\r
+largest groups of users and progressing to some of the more specialized and\r
+technical topics of interest to smaller numbers of users.\r
+\r
+Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
+\r
+About Evergreen\r
+---------------\r
+\r
+Evergreen is an open source library automation software designed to meet the\r
+needs of the very smallest to the very largest libraries and consortia. Through\r
+its staff interface, it facilitates the management, cataloging, and circulation\r
+of library materials, and through its online public access interface it helps\r
+patrons find those materials.\r
+\r
+The Evergreen software is freely licensed under the GNU General Public License,\r
+meaning that it is free to download, use, view, modify, and share. It has an\r
+active development and user community, as well as several companies offering\r
+migration, support, hosting, and development services.\r
+\r
+The community’s development requirements state that Evergreen must be:\r
+\r
+* Stable, even under extreme load.\r
+* Robust, and capable of handling a high volume of transactions and simultaneous users.\r
+* Flexible, to accommodate the varied needs of libraries.\r
+* Secure, to protect our patrons’ privacy and data.\r
+* User-friendly, to facilitate patron and staff use of the system.\r
+\r
+Evergreen, which first launched in 2006 now powers over 544 libraries of every\r
+type – public, academic, special, school, and even tribal and home libraries –\r
+in over a dozen countries worldwide.\r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::RELEASE_NOTES_2_2.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
+Software Installation\r
+=====================\r
+\r
+\r
+Introduction\r
+------------\r
+\r
+This part will guide you through the installation steps installation or\r
+upgrading your Evergreen system. It is intended for system administrators. \r
+\r
+\r
+include::installation/system_requirements.txt[]\r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::installation/server_installation.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
+include::installation/server_upgrade.txt[]\r
+\r
+include::installation/edi_setup.txt[]\r
+\r
+// include::staff_client_installation.txt[] \r
+// include::org_unit_structure_initialization.txt[]\r
+// include::loading_data.txt[]\r
+\r
+\r
+System Configuration and Customization\r
+======================================\r
+\r
+Introduction\r
+------------\r
+\r
+The Evergreen system allows a free range of customizations to every aspect of\r
+the system. Use this part of the documentation to become familiar with the tools\r
+for configuring the system as well as customizing the OPAC and staff client. \r
+\r
+// include::global_system_configuration.txt[]\r
+// include::opac_customization.txt[]\r
+\r
+include::admin/template_toolkit.txt[]\r
+\r
+include::admin/auto_suggest_search.txt[]\r
+\r
+include::admin/customize_staff_client.txt[]\r
+\r
+// include::backing_up.txt[]\r
+ \r
+\r
+\r
+Using the Staff Client\r
+======================\r
+\r
+\r
+Introduction\r
+------------\r
+\r
+This part of the documentation deals with general Staff Client usage including\r
+logging in, navigation and shortcuts.\r
+\r
+\r
+include::admin/staff_client-tab_buttons.txt[]\r
+\r
+include::admin/staff_client-double_clicking.txt[]\r
+\r
+include::admin/staff_client-sorting_columns.txt[]\r
+\r
+include::admin/staff_client-recent_searches.txt[]\r
+\r
+include::admin/staff_client-return_to_results_from_marc.txt[]\r
+\r
+System Administration From the Staff Client\r
+===========================================\r
+\r
+Introduction\r
+------------\r
+\r
+This part deals with the options in the Server Administration menu found in the\r
+staff client. \r
+\r
+// Follow structure from staff client system admin menu.\r
+\r
+include::admin/acquisitions_admin.txt[]\r
+\r
+include::admin/authorities.txt[]\r
+\r
+include::admin/cn_prefixes_and_suffixes.txt[]\r
+\r
+include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
+\r
+include::admin/booking-admin.txt[]\r
+\r
+include::admin/SMS_messaging.txt[]\r
+\r
+include::admin/user_activity_type.txt[]\r
+\r
+\r
+Local Administration\r
+====================\r
+\r
+Introduction\r
+------------\r
+\r
+This part covers the options in the Local Administration menu found in the staff\r
+client. \r
+\r
+// Follow structure from staff client local admin menu.\r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::admin/hold_driven_recalls.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
+include::admin/recent_staff_searches.txt[]\r
+\r
+include::admin/lsa-library_settings_editor.txt[]\r
+\r
+include::admin/lsa-statcat.txt[]\r
+\r
+\r
+Acquisitions\r
+===========\r
+\r
+include::acquisitions/introduction.txt[]\r
+\r
+include::acquisitions/selection_lists_po.txt[]\r
+\r
+include::acquisitions/receive_items_from_invoice.txt[]\r
+\r
+include::acquisitions/vandelay_acquisitions_integration.txt[]\r
+\r
+\r
+Cataloging\r
+==========\r
+\r
+Introduction\r
+------------\r
+\r
+Cataloguers should use this part for understanding the cataloguing procedures\r
+used in Evergreen.\r
+\r
+include::cataloging/batch_importing_MARC.txt[]\r
+\r
+include::cataloging/overlay_record_3950_import.txt[]\r
+\r
+include::cataloging/monograph_parts.txt[]\r
+\r
+include::cataloging/conjoined_items.txt[]\r
+\r
+\r
+Serials\r
+=======\r
+\r
+include::serials/A-intro.txt[]\r
+\r
+include::serials/B-copy_template.txt[]\r
+\r
+include::serials/C-subscription-SCV.txt[]\r
+\r
+include::serials/D-subscription-ASCV.txt[]\r
+\r
+include::serials/E-edit_subscriptions.txt[]\r
+\r
+include::serials/F-Receiving.txt[]\r
+\r
+include::serials/G-Special_issue.txt[]\r
+\r
+include::serials/H-holdings_statements.txt[]\r
+\r
+\r
+Circulation\r
+===========\r
+\r
+Introduction\r
+------------\r
+\r
+Use this section for understanding the circulation procedures in the Evergreen\r
+system. \r
+\r
+include::circulation/circulating_items.txt[]\r
+\r
+include::circulation/booking.txt[]\r
+\r
+Reports\r
+=======\r
+\r
+Introduction\r
+------------\r
+\r
+Learn how to create and use reports in Evergreen. \r
+\r
+Using the Public Access Catalog\r
+===============================\r
+\r
+Introduction\r
+------------\r
+\r
+Use this part for information about searching the Evergreen public access catalog.\r
+\r
+include::opac/my_lists.txt[]\r
+\r
+Developer Resources\r
+===================\r
+\r
+Introduction\r
+------------\r
+\r
+Developers can use this part to learn more about the programming languages,\r
+communication protocols and standards used in Evergreen. \r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::development/updating_translations_launchpad.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
+[appendix]\r
+\r
+include::attributions.txt[]\r
+\r
+include::licensing.txt[]\r
+\r
+Admonitions\r
+===========\r
+\r
+Images used for Admonitions\r
+---------------------------\r
+\r
+* Note \r
+\r
+image::media/note.png[]\r
+\r
+* warning\r
+\r
+image::media/warning.png[]\r
+\r
+* caution\r
+\r
+image::media/caution.png[]\r
+\r
+* tip\r
+\r
+image::media/tip.png[]\r
+\r
+\r
--- /dev/null
+Serials
+-------
+
+This documentation is intended for users who will be ordering subscriptions, distributing issues, and receiving issues in Evergreen.
+
+Serial Control View vs. Alternate Serial Control View
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Serial Control View and Alternate Serial Control View offer you two views of Serials. Both views enable you to create subscriptions, add distributions, define captions, predict future issues, and receive items. Serial Control View was designed for users who work with a smaller number of issues and was designed to accommodate workflows in academic and special libraries. Alternate Serial Control View was designed for users who receive a larger number of issues and was designed for use in public libraries.
+
+The views are interoperable, but because the views were designed for different purposes, some differences emerge. For example, Serial Control View enables you to create and edit serials in a single tabbed interface while Alternate Serial Control View leads you through a series of steps on multiple screens. In addition, receiving functions vary between views. Both receiving interfaces enable you to batch receive issues. However, the Serials Batch Receive interface, which is associated with Alternate Serial Control View, allows for more customization of each receiving unit while the Items tab in Serial Control View allows for greater flexibility in creating multi-issue units, such as in binding serials.
+
+.Serials Control View and Alternate Serials Control View Comparison
+[options="header"]
+|====================================================================================================
+|Function |Serials Control View |Alternate Serials Control View
+|Menu Style |Menu driven |Wizard oriented
+|Setting Up subscription |No calendar drop downs |Includes calendar drop down
+|Setting up distributions |No copy template selection |Requires the selection of a copy template
+|Creating streams |No setup required |Requires streams
+|Creating captions and patterns |Wizard available |Wizard available
+|Adding Starting Issue |No holdings code wizard |Includes holdings code wizard
+|Generate Predictions |Make predictions |Generate predictions
+|Add items for special issue |No functionality |New items on issuances tab
+|====================================================================================================
+
+MFHD Records
+~~~~~~~~~~~~
+
+MARC Format for Holdings Display (MFHD) display in the PAC in addition to holding statements generated by Evergreen from subscriptions created in the Serials Control View or the Alternate Serials Control View. The MFHDs are editable as MARC but the holdings statements generated from the control view are system generated. Multiple MFHDs can be created and are tied to Organizational Units.
--- /dev/null
+Copy Template for Serials
+-------------------------
+
+A copy template enables you to specify item attributes that should be applied by default to copies of serials. You can create one copy template and apply it to multiple serials. You can also create multiple copy templates. Templates will be used in the Alternate Serial Control View or the Serial Control View.
+
+Create a copy template
+~~~~~~~~~~~~~~~~~~~~~~
+
+To create a copy template, click Admin -> Local Administration -> Copy Template Editor.
+
+. Enter a Name for the template.
+. Select an owning library from the Owning lib drop down menu. This organization owns the copy template. A staff member with permissions at that organization can modify the copy template. The menu is populated from the organizations that you created in Admin . Server Administration . Organizational Units.
+. Click the box adjacent to Circulate. If you want the item to circulate.
+. Check the box adjacent to Holdable. if patrons can place holds on the item.
+. Check the box adjacent to OPAC Visible. if you want patrons to be able to see the item in the OPAC after you receive it.
+. Select a loan duration rule from the drop down menu.
+. Select a fine level for the item from the drop down menu.
+. Select a copy Location from the drop down menu. The menu is populated from the copy locations that you created in Admin . Local Administration . Copy Locations.
+. Select a circ modifier from the drop down box. The menu is populated from the modifiers that you created in Admin . Server Administration . Circulation Modifiers.
+. Check the box adjacent to Floating. if the item is part of a floating collection.
+. Check the box adjacent to Deposit. if patrons must place a deposit on the copy before they can use it.
+. Check the box adjacent to Reference. if the item is a reference item.
+. If the item is in mint condition, then check the box adjacent to Mint Condition.
+. Enter age protection rules in the Age Protect field. Age protection allows you to control the extent to which an item can circulate after it has been received. For example, you may want to protect new copies of a serial so that only patrons who check out the item at your branch can use it.
+. Enter a message in the Alert Message field. This message will appear every time the item is checked out to a patron.
+. Enter a code from the MARC fixed fields if you want to control the circulation based on the item type in the Circ as Type field.
+. Enter a deposit amount if patrons must place a deposit on the copy before they can use it.
+. Enter the price of the item.
+. Enter the ID of the copy status in the Status field. A list of copy statuses and their IDs can be found in Admin . Server Administration . Copy Status.
+. Click Save.
+. Fine level and loan duration are required fields in the Copy Template Editor.
+
+Edit a copy template
+~~~~~~~~~~~~~~~~~~~~
+
+You can make changes to an existing copy template. Changes that you make to a copy template will apply to any items that you receive after you edited the template.
+
+. To edit a copy template, click your cursor in the row that you want to edit. The row will turn blue.
+. Double-click. The copy template will appear, and you can edit the fields.
+. After making changes, click Save.
+
+[NOTE]
+From the copy template interface, you can delete copy templates that have never been used.
--- /dev/null
+
+Serials Control View
+--------------------
+
+Serial Control View is separate from the Alternate Serial Control interface. Serial Control View enables you to manage serials in a single tabbed interface. This view also enables you to bind units. Serial Control View consists of five tabs: Items, Units, Distributions, Subscriptions, and Claims. Units and Claims are not functional in 2.0.
+
+Create a subscription
+~~~~~~~~~~~~~~~~~~~~~
+A subscription is designed to hold all information related to a single serial title. Therefore, each library is likely to have only one subscription per serial title.
+
+image::media/scv-sub.jpg[Subscription]
+
+. Click the Subscriptions link.
+. Select the branch that will own the subscription.
+. Right-click or click Actions for Selected Row, and click Add Subscription.
+. Enter the date that the subscription begins in the start date, and click Apply. You must enter the date in YYYY-MM-DD format.
+. Enter the date that the subscription ends in the end date. This field is optional.
+. Enter the difference between the nominal publishing date of an issue and the date that you expect to receive your copy in the Expected Date Offset. For example, if an issue is published the first day of each month, but you receive the copy two days prior to the publication date, then enter -2 days into this field.
+. When finished, click Create Subscription(s) in the bottom right corner of the screen.
+. A confirmation message appears. Click OK.
+
+[NOTE]
+You can add notes to the subscription by clicking Subscription Notes. These notes are currently viewable only in the staff client by clicking on the Subscription Notes button.
+
+Create a distribution
+~~~~~~~~~~~~~~~~~~~~~
+
+Distributions indicate the branches that should receive copies of a serial. Distributions work together with streams to indicate the number of copies that should be sent to each branch.
+
+image::media/scv-distr.jpg[Distribution]
+
+. Click the distributions link beneath the subscription. Right click or click Actions for Selected Rows, and click Add distribution.
+. Apply a new label to the distribution. It may be useful to identify the branch to which you are distributing these issues in this field. This field is not publicly visible and only appears when an item is received. There are no limits on the number of characters that can be entered in this field.
+. Apply a prefix to the spine label if desired. This information will display in Serial Control View when the items are received, but it does not print on the spine label in . 0.
+. Apply a suffix to the spine label if desired. This information will display in Serial Control View when the items are received, but it does not print on the spine label in . 0.
+. The holding library is filled in by default and is the library to which you attached the subscription.
+. The Legacy Record Entry contains the MFHD records that are attached to the bib record if the owning library is identical to the distribution's holding library. A distribution can thus be an extension of an MFHD record. Select the MFHD record from the drop down menu.
+. The Receive Call Number field is empty until you receive the first item. When you receive the first item, you are prompted to enter a call number. That call number will populate this drop down menu.
+. The Bind Call Number field is empty until you bind the first item. When you receive the first item, you are prompted to enter a call number. That call number will populate this drop down menu.
+. Receive Unit Template - The template that should be applied to copies when they are received. Select a template from the drop down menu.
+. Bind Unit Template - The template that should be applied to copies when they are bound. Select a template from the drop down menu.
+. When finished, click Create Distribution(s) in the bottom right corner of the screen.
+. A confirmation message appears. Click OK.
+
+[NOTE]
+You can add notes to the distribution by clicking Distribution Notes. These notes are currently viewable only in the staff client by clicking on the Distribution Notes button.
+
+Create Captions and Patterns
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+. Click the captions and patterns link beneath the subscription. Right click or click Actions for Selected Rows, and click Add Caption/Pattern.
+. Apply the type which can be for basic subscription, supplements, or indices
+. Apply active. Only one active caption and pattern is allowed per type
+. In the Pattern Code dbox, you can enter a JSON representation of the 85X tag by hand, or you can click the Pattern CodeWizard to enter the information in a user-friendly format.
+
+Use the Pattern Code Wizard
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Pattern Code Wizard enables you to create the caption of the item and add its publication information. The Wizard is composed of five pages of questions. You can use the Next and Previous navigation buttons in the top corners to flip between pages.
+
+To add a pattern code, click Wizard.
+
+Page 1: Enumerations
+++++++++++++++++++++
+
+image::media/cap-wiz-num.jpg[Enuperation]
+
+. To add an enumeration, check the box adjacent to Use enumerations.. The enumerations conform to $a-$h of the 853,854, and 855 MARC tags.
+. A field for the First level will appear. Enter the enumeration for the first level. A common first level enumeration is volume, or "v."
+. Click Add Enumeration.
+. A field for the Second level will appear. Enter the enumeration for the second level. A common first level enumeration is number, or "no."
+. Enter the number of bibliographic units per next higher level. This conforms to $u in the 853, 854, and 855 MARC tags.
+. Choose the enumeration scheme from the drop down menu. This conforms to $v in the 853, 854, and 855 MARC tags.
++
+[NOTE]
+You can add up to six levels of enumeration.
++
+. Add Alternate Enumeration if desired.
+. When you have completed the enumerations, click Next.
+
+
+Page 2: Calendar
+++++++++++++++++
+
+image::media/cap-wiz-cal.jpg[Enumeration]
+
+. To use months, seasons, or dates in your caption, check the box adjacent to Use calendar changes.
+. Identify the point in the year at which the highest level enumeration caption changes.
+. In the Type drop down menu, select the points during the year at which you want the calendar to restart.
+. In the Point drop down menu, select the specific time at which you would like to change the calendar
+. To add another calendar change, click Add Calendar Change. There are no limits on the number of calendar changes that you can add.
+. When you have finished the calendar changes, click Next.
+
+Page 3: Chronology
+++++++++++++++++++
+
+image::media/cap-wiz-chron.jpg[Chronology]
+
+. To add chronological units to the captions, check the box adjacent to Use chronology captions.
+. Choose a chronology for the first level. If you want to display the terms such as "year" and "month" next to the chronology caption in the catlaog, then check the box beneath Display in holding field.
+. To include additional levels of chronology, click Add Chronology Caption. Each level that you add must be smaller than the previous level.
+. After you have completed the chronology caption, click Next.
+
+Page 4: Compress and Expand Captions
+++++++++++++++++++++++++++++++++++++
+
+image::media/cap-wiz-freq.jpg[Compress or Expand]
+
+. Select the appropriate option for compressing or expanding your captions in the catalog from the compressibility and expandability drop down menu. The entries in the drop down menu correspond to the indicator codes and the subfield $w in the 853 tag. Compressibility and expandability correspond to the first indicator in the 853 tag.
+. Choose the appropriate caption evaluation from the drop down menu.
+. Choose the frequency of your publication from the drop down menu. For irregular frequencies, you may wish to select use number of issues per year, and enter the total number of issues that you receive each year. However, in the . 0 release, recommended practice is that you use only regular frequencies. Planned development will create an additional step to aid in the creation of irregular frequencies.
+. Click Next.
+
+Page 5: Regularity Information
+++++++++++++++++++++++++++++++
+
+image::media/cap-wiz-chan.jpg[Changes]
+
+. If needed, check box for Use specific regularity information
+. Choose the appropriate information for combined, omitted or published issues
+. Choose the appropriate frequency and issue
+. Add additional rows as required
+
+Page 5: Finish Captions and Patterns
+++++++++++++++++++++++++++++++++++++
+
+. To complete the wizard, click Create Pattern Code.
+. Return to Subscription Details.
+. Confirm that the box adjacent to Active is checked. Click Save Changes. The row is now highlighted gray instead of orange.
+
+Creating an Issuance
+~~~~~~~~~~~~~~~~~~~~
+
+The Issuances function enables you to manually create an issue. Evergreen will use the initial issue that you manually create to predict future issues.
+
+image::media/scv-iss.jpg[Issue]
+
+. Click the Issuances link beneath the subscription. Right click or click Actions for Selected Rows, and click Issuance.
+. Click the holdings code and click apply. Currently there is no wizard to create this code. The wizard is only available in the Alternate Serials Control View.
+. Click the Caption/Pattern selecting the appropriate patternand click apply
+. Click the date published and enter date information (format YYYY-MM-DD) and click apply
+. Click label, enter label and click apply
+. When finished, click Create Issuance(s) in the bottom right corner of the screen.
+. A confirmation message appears. Click OK.
+
+Generate Prediction
+~~~~~~~~~~~~~~~~~~~
+
+. Open the Subscriptions tab.
+. Right-click or click Actions for Selected Row -> Make predictions.
+. A pop up box will aks you how many items you want to predict. Enter the number, and click OK.
+. A confirmation message will appear. Click OK.
+. Click the Issuances link to view the predicted issues.
--- /dev/null
+Alternate Serial Control View
+-----------------------------
+
+Using the Alternate Serial Control View, you can create a subscription, a distribution, a stream, and a caption and pattern, and you can generate predictions and receive issues. To access Alternate Serial Control View, open a serials record, and click Actions for this Record >> Alternate Serial Control. This opens the Subscriptions interface
+
+. Create a subscription
+. Create a distribution
+. Create a a stream (within the distribution)
+. Create a caption and pattern (or import from bibliographic or legacy serial records)
+. Create at least the first issuance and generate predictions
+
+Creating a Subscription
+~~~~~~~~~~~~~~~~~~~~~~~
+
+A subscription is designed to hold all information related to a single serial title. Therefore, each library is likely to have only one subscription per serial title.
+
+image::media/ascv-sub.jpg[Creating a Subscription]
+
+. Add new subscriptions to a serials record that exists in the catalog.
+. Create a subscription
+. Click New Subscription.
+. Select an owning library. The owning library indicates the organizational unit(s) whose staff can use this subscription. This menu is populated with the shortnames that you created for your libraries in the organizational units tree in Admin . Server Administration . Organizational Units. The rule of parental inheritance applies to this list. For example, if a system is made the owner of a subscription, then users, with appropriate permissions, at the branches within the system could also use this subscription.
+. Enter the date that the subscription begins in the start date. Recommended practice is that you select the date from the drop down calendar although you can manually enter a date. Owning library and start date are required fields in the new subscription pop up box.
+. Enter the date that the subscription ends in the end date. Recommended practice is to select a date from the drop down calendar, but you can manually enter a date, also.
+. Enter the difference between the nominal publishing date of an issue and the date that you expect to receive your copy in the Expected Date Offset. For example, if an issue is published the first day of each month, but you receive the copy two days prior to the publication date, then enter -2 days into this field.
+. Click Save.
+
+After you save the subscription, it will appear in a list with a hyperlinked ID number. Use the drop down menu at the top of the screen to view subscriptions at other organizations.
+
+Creating a Distribution
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Distributions indicate the branches that should receive copies of a serial. Distributions work together with streams to indicate the number of copies that should be sent to each branch.
+
+image::media/ascv-distr.jpg[Creating a Distribution]
+
+. Click the Distributions tab.
+. Click New Distribution.
+. Enter a name for the distribution in the Label field. It may be useful to identify the branch to which you are distributing these issues in this field. This field is not publicly visible and only appears when an item is received. There are no limits on the number of characters that can be entered in this field.
+. Select a holding library from the drop down menu. The holding library is the branch that will receive the copies.
+. Select a copy template from the Receive Unit Template drop down menu. This menu is populated with the copy templates that you created in Copy Template Editor.
++
+[NOTE]
+Label, Holding Library, and Receive Unit Template are required fields in the new distribution pop up box.
++
+. Ignore the fields, Unit Label Prefix and Unit Label Suffix. These fields are not functional in Alternate Serial Control View.
+. Click Save. The distribution will appear in a list in the Distributions tab in the Subscription Details.
+
+Creating a Stream
+~~~~~~~~~~~~~~~~~
+
+Distributions work together with streams to indicate the number of copies that should be sent to each branch. Distributions identify the branches that should receive copies of a serial. Streams identify how many copies should be sent to each branch. Streams are intended for copies that are received on a recurring, even if irregular, basis.
+
+. Click the hyperlinked title of the distribution. The number of streams that have already been created for this distribution displays adjacent to the title. You can choose one of two ways to create a stream: New Stream or Create Many Streams. The New Stream button allows you to create one new stream and assign it a routing label.
+. Click New Stream
+. Enter a routing label so that the copy could be read by specific users or departments before the copy is shelved. The routing label appears during receiving and could be added to routing lists; it is not viewable by the public. Routing lists do not print from in 2.0. This field is optional.
+. Click Save.
++
+[NOTE]
+The "Create Many Streams button" allows you to create multiple streams at once, but it does not allow you to add a routing label when you create the stream.
++
+. Click Create Many Streams.
+. Enter the number of streams that you want to create in the How many. Field.
+. Click Create.
+
+Creating a Caption and Pattern
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Captions and Patterns wizard allows you to enter caption and pattern data as it is described by the 853, 854, and 855 MARC tags. These tags allow you to define how issues will be captioned, and how often the library receives issues of the serial.
+
+. Open the Subscription Details.
+. Click the Captions and Patterns tab.
+. Click Add Caption and Pattern.
+. In the Type drop down box, select the MARC tag to which you would like to add data.
+. In the Pattern Code drop down box, you can enter a JSON representation of the 85X tag by hand, or you can click the Wizard to enter the information in a user-friendly format.
+. The Caption and Pattern that you create is Active by default, but you can deactivate a caption and pattern at a later time by unchecking the box.
+
+
+[NOTE]
+A subscription may have multiple captions and patterns listed in the subscripiton details, but only one Caption and Pattern can be active at any time. If you want to add multiple patterns, e.g. for Basic and Supplement, Click Add Caption and Pattern.
+
+
+Use the Pattern Code Wizard
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The Pattern Code Wizard enables you to create the caption of the item and add its publication information. The Wizard is composed of five pages of questions. You can use the Next and Previous navigation buttons in the top corners to flip between pages.
+
+To add a pattern code, click Wizard.
+
+Page 1: Enumerations
+++++++++++++++++++++
+
+image::media/cap-wiz-num.jpg[Enuperation]
+
+. To add an enumeration, check the box adjacent to Use enumerations.. The enumerations conform to $a-$h of the 853,854, and 855 MARC tags.
+. A field for the First level will appear. Enter the enumeration for the first level. A common first level enumeration is volume, or "v."
+. Click Add Enumeration.
+. A field for the Second level will appear. Enter the enumeration for the second level. A common first level enumeration is number, or "no."
+. Enter the number of bibliographic units per next higher level. This conforms to $u in the 853, 854, and 855 MARC tags.
+. Choose the enumeration scheme from the drop down menu. This conforms to $v in the 853, 854, and 855 MARC tags.
++
+[NOTE]
+You can add up to six levels of enumeration.
++
+. Add Alternate Enumeration if desired.
+. When you have completed the enumerations, click Next.
+
+Page 2: Calendar
+++++++++++++++++
+
+image::media/cap-wiz-cal.jpg[Enumeration]
+
+. To use months, seasons, or dates in your caption, check the box adjacent to Use calendar changes.
+. Identify the point in the year at which the highest level enumeration caption changes.
+. In the Type drop down menu, select the points during the year at which you want the calendar to restart.
+. In the Point drop down menu, select the specific time at which you would like to change the calendar
+. To add another calendar change, click Add Calendar Change. There are no limits on the number of calendar changes that you can add.
+. When you have finished the calendar changes, click Next.
+
+Page 3: Chronology
+++++++++++++++++++
+
+image::media/cap-wiz-chron.jpg[Chronology]
+
+. To add chronological units to the captions, check the box adjacent to Use chronology captions.
+. Choose a chronology for the first level. If you want to display the terms, "year" and "month" next to the chronology caption in the catlaog, then check the box beneath Display in holding field.
+. To include additional levels of chronology, click Add Chronology Caption. Each level that you add must be smaller than the previous level.
+. After you have completed the chronology caption, click Next.
+
+Page 4: Compress and Expand Captions
+++++++++++++++++++++++++++++++++++++
+
+image::media/cap-wiz-freq.jpg[Compress or Expand]
+
+. Select the appropriate option for compressing or expanding your captions in the catalog from the compressibility and expandability drop down menu. The entries in the drop down menu correspond to the indicator codes and the subfield $w in the 853 tag. Compressibility and expandability correspond to the first indicator in the 853 tag.
+. Choose the appropriate caption evaluation from the drop down menu.
+. Choose the frequency of your publication from the drop down menu. For irregular frequencies, you may wish to select use number of issues per year, and enter the total number of issues that you receive each year. However, in the . 0 release, recommended practice is that you use only regular frequencies. Planned development will create an additional step to aid in the creation of irregular frequencies.
+. Click Next.
+
+Page 5: Regularity Information
+++++++++++++++++++++++++++++++
+
+image::media/cap-wiz-chan.jpg[Changes]
+
+. If needed, check box for Use specific regularity information
+. Choose the appropriate information for combined, omitted or published issues
+. Choose the appropriate frequency and issue
+. Add additional rows as required
+
+Page 5: Finish Captions and Patterns
+++++++++++++++++++++++++++++++++++++
+
+. To complete the wizard, click Create Pattern Code.
+. Return to Subscription Details.
+. Confirm that the box adjacent to Active is checked. Click Save Changes. The row is now highlighted gray instead of orange.
+
+Creating an Issuance
+~~~~~~~~~~~~~~~~~~~~
+
+The Issuances tab enables you to manually create an issue. Evergreen will use the initial issue that you manually create to predict future issues.
+
+image::media/ascv-issues.jpg[Changes]
+
+. Click the Issuances tab in the Subscription Details.
+. Click New Issuance.
+. The Subscription, Creator, and Editor fields contain subscription and user IDs, respectively. These fields are disabled because Evergreen automatically fills in these fields.
+. Enter a name for this issuance in the Label field. There are no limits on the number of characters that can be entered in this field. You may want to enter the month and year of the publication in hand.
+. Enter the Date Published of the issuance that you are editing. Recommended practice is that you select the date from the drop down calendar although you can manually enter a date. If you are creating one manual issue before automatically predicting more issues, then this date should be the date of the most current issue before the prediction starts.
+. Select a Caption/Pattern from the drop down menu. The numbers in the drop down menu correspond to the IDs of the caption/patterns that you created.
+. The Holding Type appears by default and corresponds to the Type that you selected when you created the Caption/Pattern.
+. In the holding code area of the New Issuance dialog, click Wizard. The Wizard enables you to add holdings information.
+. Enter the volume of the item in hand in the v. field.
+. Enter the number of the item in hand in the no. field.
+. Enter the year of publication in the Year field.
+. Enter the month of publication in the Month field if applicable. You must enter the calendar number of the month rather than the name of the month. For example, enter 12 if the item in hand was published in December.
+. Enter the day of publication in the day field if applicable.
+. Click Compile to generate the holdings code.
+
+Generate Item Predictions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+After you manually create the first issue, Evergreen will predict future issuances. Use the Generate Predictions functionality to predict future issues.
+
+. Click Subscription Details -> Issuances -> Generate Predictions.
+. Choose the length of time for which you want to predict issues. If you select the radio button to predict until end of subscription, then Evergreen will predict issues until the end date that you created when you created the subscription. See simplesect . 1 for more information. If you do not have an end date, select the radio button to predict a certain number of issuances, and enter a number in the field.
+. Click Generate.
+. Evergreen will predict a run of issuances and copies. The prediction will appear in a list.
+. You can delete the first, manual issuance by clicking the check box adjacent to the issuance and clicking Delete Selected.
--- /dev/null
+Edit Subscriptions
+------------------
+Subscriptions can be edite to change the caption and pattern and other information.
+
+Serials Control View
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+. To access Serial Control View, open a serials record, and click Actions for this Record >> Serial Control. This opens the Subscriptions interface
+. Click the subscriptions tab
+. Click on the appropriate link to edit
+
+
+Alternate Serials Control View
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+. To access Alternate Serial Control View, open a serials record, and click Actions for this Record >> Alternate Serial Control. This opens the Subscriptions interface
+. Click the hyperlinked ID number to edit the subscription.
+. Click on the appropriate tab to edit the information
+
--- /dev/null
+Receiving
+---------
+You can receive either through the Serials Control View or in Batch Receive with the simple or advanced interface
+
+Serials Control View Receiving
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+image::media/scv-rec.jpg[Receiving]
+
+. To receive items, click the Receive radio button. In the top half of the screen, the items that have yet to be received are displayed. In the bottom half of the screen, recently received items are displayed.
+. Select the branch that will receive the items from the drop down box.
+. Select the issue that you want to receive.
+. Select the current working unit. Click Set Current Unit, located in the lower right corner of the screen. A drop down menu will appear.
+ * If you want to barcode each item individually, select Auto per item. This setting is recommended for most receiving processes.
+ * If you want each item within a unit to share the same barcode, then select New Unit. This setting is advised for most binding processes.
+ * If you want the item to be received or bound into an existing item, select Recent and select the desired issue. To making a change in bound items, receive or bind the items into an already existing unit.
+. Click Receive/Move Selected.
+. Enter a barcode and call number if prompted to do so.
+. A message confirming receipt of the item appears. Click OK.
+. The screen refreshes. In the top half of the screen, the item displays a received date. In the bottom half of the screen, the item that you have just received is now at the top of the list of the received items.
+
+After receiving items, you can view the updated holdings in the OPAC. In this example, the legacy MFHD record and the items recently received in the serial control view display together in the MFHD statement.
+
+Batch Receiving
+~~~~~~~~~~~~~~~
+
+You can batch receive items through a simple or an advanced interface. The simple interface does not allow you to add barcodes or use the copy template. These items are also not visible in the OPAC. The advanced interface enables you to use the copy templates that you created, add barcodes, and make items OPAC visible and holdable.
+
+You can access both Batch Receive interfaces from two locations in the ILS. From the Subscription Details screen, you can click Batch Item Receive. You can also access these interfaces by opening the catalog record for the serial, and clicking Actions for this Record . Serials Batch Receive.
+
+Simple Batch Receiving
+^^^^^^^^^^^^^^^^^^^^^^
+Follow these steps to receive items in batch in a simple interface.
+
+image::media/scv-srec.jpg[Receiving]
+
+. The Batch Receive interface displays issues that have not yet been received. The earliest expected issue appears at the top of the list.
+. In the right lower corner, you see a check box to Create Units for Received Items. If you do not check this box, then you will receive items in simple mode.
+. Click Next.
+. In simple mode, the distributions that you created are displayed. They are marked received by default. If you hover over the branch name, you can view the name of the distribution and its stream.
+. You can receive and add a note to each item individually, or you can perform these actions on all of the distributions and streams at once. To do so, look above the line, and enter the note that you want to apply to all copies and confirm that the box to Receive. is checked.
+. Click Apply. The note should appear in the note field in each distribution.
+. Then click Receive Selected Items.
+. The received items are cleared from the screen.
+
+Advanced Batch Receiving
+^^^^^^^^^^^^^^^^^^^^^^^^
+Follow these steps to receive items in batch in a simple interface.
+
+image::media/scv-srec.jpg[Receiving]
+
+. The Batch Receive interface displays issues that have not yet been received. The earliest expected issue appears at the top of the list.
+. If you want to barcode each copy, display it in the catalog, and make it holdable, then check the box adjacent to Create Units for Received Items in the lower right side of the screen.
+. This will allow you to utilize the copy templates and input additional information about the copy:
+. Barcode - You can scan printed barcodes into the barcode field for each copy, or you can allow the system to auto-generate barcodes. To auto-generate barcodes, check the box adjacent to Auto-generate., and enter the first barcode into the barcode field in the first row of the table. Then press the Tab key. The remaining barcode fields will automatically populate with the next barcodes in sequence, including check digits.
+ . Circ Modifiers - The circ modifiers drop down menu is populated with the circulation modifiers that you created in Admin . Server Administration . Circulation Modifiers. If you entered a circ modifier in the copy template that you created for this subscription, then it will appear by default in the distributions.
+ . Call Number - Enter a call number. Any item with a barcode must also have a call number.
+ . Note - Add a note. There are no limits on the number of characters that can be entered in this field. The note only displays in this screen.
+ . Copy Location - The copy location drop down menu is populated with the copy locations that you created in Admin . Local Administration . Copy Location Editor. If you entered a copy location in the copy template that you created for this subscription, then it will appear by default in the distributions.
+ . Price - If you entered a price in the copy template that you created for this subscription, then it will appear by default in the distributions. You can also manually enter a price if you did not include one in the copy template.
+ . Receive - The boxes in the Receive Column are checked by default. Uncheck the box if you do not want to receive the item. Evergreen will retain the unreceived copies and will allow you to receive them at a later time.
+. When you are ready to receive the items, click Receive Selected Items.
+. The items that have been received are cleared from the Batch Receive interface. The remaining disabled item is an unreceived item.
+. If the items that you received have a barcode, a copy template that was set to OPAC Visible, and are assigned a shelving location that is OPAC Visible, then you can view the received items in the catalog. Notice that the Holdings Summary has been updated to reflect the most recent addition to the holdings.
--- /dev/null
+Special Issues
+--------------
+Currently, Setting up the special issue can only be done through the Alternate Serials Control view.
+
+. Create an issuance in the Serials Control View or the Alternate Serials Control View
+. In the Alternate Serials Control View, click on the name of your special issue in the list of issuances.
+. Click the New Items button
+. Enter the appropriate information
+. The item is now ready to receive. If you complete the Date Received field and change the status to received then it will receive the issue but it won't create the associated copy record whereas if you leave it blank and receive the item through the Serials Control View or Batch Receive function you can create the Copy Record at that time.
--- /dev/null
+Holdings
+--------
+
+System Generated Holdings Statement
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+As issues are received, Evergreen creates a holding statement in the OPAC based on what is set up in the Caption and Patterns of the subscription. The systems generated holdings can only be edited by changing caption and pattern information and there is no abilitiy to edit the statement as free text.
+
+MARC Format for Holdings Display (MFHD)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Evergreen users can create, edit and delete their own MFHD.
+
+Create an MFHD record
+^^^^^^^^^^^^^^^^^^^^^
+
+. Open a serial record, and in the bottom right corner above the copy information, click Add MFHD Record. You can also add the MFHD statement by clicking Actions for this Record .MFHD Holdings .Add MFHD Record.
+. A message will confirm that you have created the MFHD Record. Click OK.
+. Click Reload in the top left corner of the record.
+. The Holdings Summary will appear. Click Edit Holdings in the right corner.
+. Click Edit Record.
+. The MFHD window will pop up. Enter holdings information. Click Save MFHD.
+. Close the MFHD window.
+. Click Reload in the top left corner of the record. The Holdings Summary will reflect the changes to the MFHD statement.
+
+Edit a MFHD record
+^^^^^^^^^^^^^^^^^^
+
+. Open a serial record, and in the Actions for this Record, click MFHD Record>>Edit MFHD Record and select the appropriate MFHD.
+. Edit the MFHD
+. Click Save MFHD
+
+Delete a MFHD Record
+^^^^^^^^^^^^^^^^^^^^
+
+. Open a serial record, and in the Actions for this Record, click MFHD Record>>Delete MFHD Record and select the appropriate MFHD.
+. Click to confirm the deletion of the MFHD
+++ /dev/null
-Setting Up EDI Acquisitions\r
----------------------------\r
-\r
-Introduction\r
-~~~~~~~~~~~~\r
-\r
-Electronic Data Interchange (EDI) is used to exchange information between \r
-participating vendors and Evergreen. This chapter contains technical \r
-information for installation and configuration of the components necessary \r
-to run EDI Acquisitions for Evergreen.\r
-\r
-Installation\r
-~~~~~~~~~~~~\r
-\r
-Install EDI Translator\r
-^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-The EDI Translator is used to convert data into EDI format. It runs\r
-on localhost and listens on port 9191 by default. This is controlled via \r
-the edi_webrick.cnf file located in the edi_translator directory. It should\r
-not be necessary to edit this configuration if you install EDI Translator \r
-on the same server used for running Action/Triggers events.\r
-\r
-[NOTE]\r
-If you are running Evergreen with a multi-server configuration, make sure\r
-to install EDI Translator on the same server used for Action/Trigger event\r
-generation.\r
-\r
-.Steps for Installing\r
-\r
-1. As the *opensrf* user, copy the EDI Translator code found in \r
- Open-ILS/src/edi_translator to somewhere accessible \r
- (for example, /openils/var/edi):\r
-+\r
-[source, bash]\r
---------------------------------------------------\r
-cp -r Open-ILS/src/edi_translator /openils/var/edi\r
---------------------------------------------------\r
-2. Navigate to where you have saved the code to begin next step:\r
-+\r
-[source, bash]\r
--------------------\r
-cd /openils/var/edi\r
--------------------\r
-3. Next, as the *root* user (or a user with sudo rights), install the \r
- dependencies, via "install.sh". This will perform some apt-get routines \r
- to install the code needed for the EDI translator to function. \r
- (Note: subversion must be installed first)\r
-+\r
-[source, bash]\r
------------\r
-./install.sh\r
------------\r
-4. Now, we're ready to start "edi_webrick.bash" which is the script that calls \r
- the "Ruby" code to translate EDI. This script needs to be started in \r
- order for EDI to function so please take appropriate measures to ensure this \r
- starts following reboots/upgrades/etc. As the *opensrf* user:\r
-+\r
-[source, bash]\r
------------------\r
-./edi_webrick.bash\r
------------------\r
-5. You can check to see if EDI translator is running.\r
- * Using the command "ps aux | grep edi" should show you something similar \r
- if the script is running properly:\r
-+\r
-[source, bash]\r
-------------------------------------------------------------------------------------------\r
-root 30349 0.8 0.1 52620 10824 pts/0 S 13:04 0:00 ruby ./edi_webrick.rb\r
-------------------------------------------------------------------------------------------\r
- * To shutdown EDI Translator you can use something like pkill (assuming \r
- no other ruby processes are running on that server):\r
-+\r
-[source, bash]\r
------------------------\r
-kill -INT $(pgrep ruby)\r
------------------------\r
-\r
-Install EDI Scripts\r
-^^^^^^^^^^^^^^^^^^^\r
-\r
-The EDI scripts are "edi_pusher.pl" and "edi_fetcher.pl" and are used to\r
-"push" and "fetch" EDI messages for configured EDI accounts.\r
-\r
-1. As the *opensrf* user, copy edi_pusher.pl and edi_fetcher.pl from\r
- Open-ILS/src/support-scripts into /openils/bin:\r
-+\r
-[source, bash]\r
---------------------------------------------------\r
-cp Open-ILS/src/support-scripts/edi_pusher.pl /openils/bin\r
-cp Open-ILS/src/support-scripts/edi_fetcher.pl /openils/bin\r
---------------------------------------------------\r
-2. Setup the edi_pusher.pl and edi_fetcher.pl scripts to run as cron jobs\r
- in order to regularly push and receive EDI messages.\r
- * Add to the opensrf user's crontab the following entries:\r
-+\r
-[source, bash]\r
------------------------------------------------------------------------\r
-10 * * * * cd /openils/bin && /usr/bin/perl ./edi_pusher.pl > /dev/null\r
-0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null\r
------------------------------------------------------------------------\r
- * The example for edi_pusher.pl sets the script to run at \r
- 10 minutes past the hour, every hour.\r
- * The example for edi_fetcher.pl sets the script to run at\r
- 1 AM every night.\r
-\r
-[NOTE]\r
-You may choose to run the EDI scripts more or less frequently based on the \r
-necessary response times from your vendors.\r
-\r
-Configuration\r
-~~~~~~~~~~~~~\r
-\r
-Configuring Providers\r
-^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Look in Admin > Server Administration > Acquisitions > Providers\r
-\r
-[options="header"]\r
-|======================================================================================\r
-|Column |Description/Notes\r
-|Provider Name |A unique name to identify the provider\r
-|Code |A unique code to identify the provider\r
-|Owner |The org unit who will "own" the provider.\r
-|Currency |The currency format the provider accepts\r
-|Active |Whether or not the Provider is "active" for use\r
-|Default Claim Policy|??\r
-|EDI Default |The default "EDI Account" to use (see EDI Accounts Configuration)\r
-|Email |The email address for the provider\r
-|Fax Phone |A fax number for the provider\r
-|Holdings Tag |The holdings tag to be utilized (usually 852, for Evergreen)\r
-|Phone |A phone number for the provider\r
-|Prepayment Required |Whether or not prepayment is required\r
-|SAN |The vendor provided, org unit specific SAN code\r
-|URL |The vendor website\r
-|======================================================================================\r
-\r
-Configuring EDI Accounts\r
-^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Look in Admin > Server Administration > Acquisitions > EDI Accounts\r
-\r
-[options="header"]\r
-|===============================================================================================================\r
-|Column |Description/Notes\r
-|Label |A unique name to identify the provider\r
-|Host |FTP/SFTP/SSH hostname - vendor assigned\r
-|Username |FTP/SFTP/SSH username - vendor assigned\r
-|Password |FTP/SFTP/SSH password - vendor assigned\r
-|Account |Vendor assigned account number associated with your organization\r
-|Owner |The organizational unit who owns the EDI account\r
-|Last Activity |The date of last activity for the account\r
-|Provider |This is a link to one of the "codes" in the "Providers" interface\r
-|Path |The path on the vendor's server where Evergreen will send it's outgoing .epo files\r
-|Incoming Directory |The path on the vendor's server where "incoming" .epo files are stored\r
-|Vendor Account Number|Vendor assigned account number.\r
-|Vendor Assigned Code |Usually a sub-account designation. Can be used with or without the Vendor Account Number.\r
-|===============================================================================================================\r
-\r
-Configuring Organizational Unit SAN code\r
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Look in Admin > Server Settings > Organizational Units\r
-\r
-This interface allows a library to configure their SAN, alongside \r
-their address, phone, etc.\r
-\r
-Troubleshooting\r
-~~~~~~~~~~~~~~~\r
-\r
-PO JEDI Template Issues\r
-^^^^^^^^^^^^^^^^^^^^^^^\r
-\r
-Some libraries may run into issues with the action/trigger (PO JEDI). \r
-The template has to be modified to handle different vendor codes that \r
-may be used. For instance, if you use "ingra" instead of INGRAM this \r
-may cause a problem because they are hardcoded in the template. The \r
-following is an example of one modification that seems to work.\r
-\r
-.Original template has:\r
-\r
-[source, bash]\r
-----------------------------------------------------------------------------------------------------------------------------------------------\r
-"buyer":[\r
- [% IF target.provider.edi_default.vendcode && (target.provider.code == 'BT' || target.provider.name.match('(?i)^BAKER & TAYLOR')) -%]\r
- {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
- [%- ELSIF target.provider.edi_default.vendcode && target.provider.code == 'INGRAM' -%]\r
- {"id":"[% target.ordering_agency.mailing_address.san %]"},\r
- {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"}\r
- [%- ELSE -%]\r
- {"id":"[% target.ordering_agency.mailing_address.san %]"}\r
- [%- END -%]\r
-],\r
-----------------------------------------------------------------------------------------------------------------------------------------------\r
-\r
-.Modified template has the following where it matches on provider SAN instead of code:\r
-\r
-[source, bash]\r
-------------------------------------------------------------------------------------------------------------------------------------------\r
-"buyer":[\r
- [% IF target.provider.edi_default.vendcode && (target.provider.san == '1556150') -%]\r
- {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
- {"id-qualifier": 91, "id":"[% target.ordering_agency.mailing_address.san _ ' ' _ target.provider.edi_default.vendcode %]"}\r
- [%- ELSIF target.provider.edi_default.vendcode && (target.provider.san == '1697978') -%]\r
- {"id":"[% target.ordering_agency.mailing_address.san %]"},\r
- {"id-qualifier": 91, "id":"[% target.provider.edi_default.vendcode %]"}\r
- [%- ELSE -%]\r
- {"id":"[% target.ordering_agency.mailing_address.san %]"}\r
- [%- END -%]\r
-],\r
-------------------------------------------------------------------------------------------------------------------------------------------\r
-\r
+++ /dev/null
-README for Evergreen 2.2
-========================
-:toc:
-:numbered:
-
-Preamble: referenced user accounts
-----------------------------------
-
-In subsequent sections, we will refer to a number of different accounts, as
-follows:
-
- * Linux user accounts:
- ** The *user* Linux account is the account that you use to log onto the
- Linux system as a regular user.
- ** The *root* Linux account is an account that has system administrator
- privileges. On Debian and Fedora you can switch to this account from
- your *user* account by issuing the `su -` command and entering the
- password for the *root* account when prompted. On Ubuntu you can switch
- to this account from your *user* account using the `sudo su -` command
- and entering the password for your *user* account when prompted.
- ** The *opensrf* Linux account is an account that you create when installing
- OpenSRF. You can switch to this account from the *root* account by
- issuing the `su - opensrf` command.
- ** The *postgres* Linux account is created automatically when you install
- the PostgreSQL database server. You can switch to this account from the
- *root* account by issuing the `su - postgres` command.
- * PostgreSQL user accounts:
- ** The *evergreen* PostgreSQL account is a superuser account that you will
- create to connect to the PostgreSQL database server.
- * Evergreen administrator account:
- ** The *egadmin* Evergreen account is an administrator account for
- Evergreen that you will use to test connectivity and configure your
- Evergreen instance.
-
-Preamble: Developer instructions
---------------------------------
-
-[NOTE]
-Skip this section if you are using an official release tarball downloaded
-from http://evergreen-ils.org/downloads
-
-Developers working directly with the source code from the Git repository,
-rather than an official release tarball, must install some extra packages
-and perform one step before they can proceed with the `./configure` step.
-
-As the *root* Linux account, install the following packages:
-
- * autoconf
- * automake
- * libtool
-
-As the *user* Linux account, issue the following command in the Evergreen
-source directory to generate the configure script and Makefiles:
-
-[source, bash]
-------------------------------------------------------------------------------
-autoreconf -i
-------------------------------------------------------------------------------
-
-After running `make install`, developers also need to install the Dojo Toolkit
-set of JavaScript libraries. The appropriate version of Dojo is included
-in Evergreen release tarballs. Developers should install the Dojo 1.3.3
-version of Dojo by issuing the following commands as the *opensrf* Linux
-account:
-
-[source, bash]
-------------------------------------------------------------------------------
-wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
-tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
-cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
-------------------------------------------------------------------------------
-
-Installing prerequisites
-------------------------
-
-Evergreen has a number of prerequisite packages that must be installed
-before you can successfully configure, compile, and install Evergreen.
-
-1. Begin by installing the most recent version of OpenSRF (2.1 or later).
- You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
-2. On many distributions, it is necessary to install PostgreSQL 9 from external
- repositories.
-+
- * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
- *root* Linux account and add the following line:
-+
-[source, bash]
-------------------------------------------------------------------------------
-deb http://backports.debian.org/debian-backports squeeze-backports main contrib
-------------------------------------------------------------------------------
-+
- * On Ubuntu Lucid, you can use a PPA (personal package archive), which are
- package sources hosted on Launchpad. The one most commonly used by Evergreen
- Community members is maintained by Martin Pitt, who also maintains the
- official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
- the following commands to add the PPA source:
-+
-[source, bash]
-------------------------------------------------------------------------------
-apt-get install python-software-properties
-add-apt-repository ppa:pitti/postgresql
-------------------------------------------------------------------------------
-+
- * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
-+
- * Fedora 16 comes with PostgreSQL 9, so no additional steps are required.
-+
-3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
- retrieve the new packages from the backports repository.
-4. Issue the following commands as the *root* Linux account to install
- prerequisites using the `Makefile.install` prerequisite installer,
- substituting `debian-squeeze`, `fedora16`, `ubuntu-lucid`, or
- `ubuntu-precise` for <osname> below:
-+
-[source, bash]
-------------------------------------------------------------------------------
-make -f Open-ILS/src/extras/Makefile.install <osname>
-------------------------------------------------------------------------------
-+
-5. Add the libdbi-libdbd libraries to the system dynamic library path by
- issuing the following commands as the *root* Linux account:
-+
-[NOTE]
-You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
-target uses libdbd-pgsql from packages.
-+
-.Debian / Ubuntu Lucid
-[source, bash]
-------------------------------------------------------------------------------
-echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
-ldconfig
-------------------------------------------------------------------------------
-+
-.Fedora
-[source, bash]
-------------------------------------------------------------------------------
-echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
-ldconfig
-------------------------------------------------------------------------------
-
-Configuration and compilation instructions
-------------------------------------------
-
-For the time being, we are still installing everything in the `/openils/`
-directory. From the Evergreen source directory, issue the following commands as
-the *user* Linux account to configure and build Evergreen:
-
-[source, bash]
-------------------------------------------------------------------------------
-./configure --prefix=/openils --sysconfdir=/openils/conf
-make
-------------------------------------------------------------------------------
-
-Installation instructions
--------------------------
-
-1. Once you have configured and compiled Evergreen, issue the following
- command as the *root* Linux account to install Evergreen, build the server
- portion of the staff client, and copy example configuration files to
- `/openils/conf`.
- Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
- of the staff client that you will use to connect to the Evergreen server.
-+
-[source, bash]
-------------------------------------------------------------------------------
-make STAFF_CLIENT_STAMP_ID=rel_2_2 install
-------------------------------------------------------------------------------
-+
-2. The server portion of the staff client expects `http://hostname/xul/server`
- to resolve. Issue the following commands as the *root* Linux account to
- create a symbolic link pointing to the `server` subdirectory of the server
- portion of the staff client that we just built using the staff client ID
- 'rel_name':
-+
-[source, bash]
-------------------------------------------------------------------------------
-cd /openils/var/web/xul
-ln -sf rel_name/server server
-------------------------------------------------------------------------------
-
-Change ownership of the Evergreen files
----------------------------------------
-
-All files in the `/openils/` directory and subdirectories must be owned by the
-`opensrf` user. Issue the following command as the *root* Linux account to
-change the ownership on the files:
-
-[source, bash]
-------------------------------------------------------------------------------
-chown -R opensrf:opensrf /openils
-------------------------------------------------------------------------------
-
-Configure the Apache Web server
--------------------------------
-
-1. Use the example configuration files in `Open-ILS/examples/apache/` to
-configure your Web server for the Evergreen catalog, staff client, Web
-services, and administration interfaces. Issue the following commands as the
-*root* Linux account:
-+
-.Debian and Ubuntu
-[source,bash]
-------------------------------------------------------------------------------
-cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
-cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
-cp Open-ILS/examples/apache/startup.pl /etc/apache2/
-# Now set up SSL
-mkdir /etc/apache2/ssl
-cd /etc/apache2/ssl
-------------------------------------------------------------------------------
-+
-.Fedora
-[source,bash]
-------------------------------------------------------------------------------
-cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/
-cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
-cp Open-ILS/examples/apache/startup.pl /etc/httpd/
-# Now set up SSL
-mkdir /etc/httpd/ssl
-cd /etc/httpd/ssl
-------------------------------------------------------------------------------
-+
-2. The `openssl` command cuts a new SSL key for your Apache server. For a
-production server, you should purchase a signed SSL certificate, but you can
-just use a self-signed certificate and accept the warnings in the staff client
-and browser during testing and development. Create an SSL key for the Apache
-server by issuing the following command as the *root* Linux account:
-+
-[source,bash]
-------------------------------------------------------------------------------
-openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
-------------------------------------------------------------------------------
-+
-3. As the *root* Linux account, edit the `eg.conf` file that you copied into
-place.
- a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
- access to the offline upload / execute interface from any workstation on
- any network - note that you must secure this for a production instance)
- b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
- to `/etc/httpd/`.
-4. Change the user for the Apache server.
- * (Debian and Ubuntu): As the *root* Linux account, edit
- `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
- `export APACHE_RUN_USER=opensrf`.
- * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
- Change `User apache` to `User opensrf`.
-5. Configure Apache with performance settings appropriate for Evergreen:
- * (Debian and Ubuntu): As the *root* Linux account, edit
- `/etc/apache2/apache2.conf`:
- * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
- a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
- a request timing out unexpectedly, but increase the risk of using up
- all available Apache child processes.
- b. 'Optional': Change `MaxKeepAliveRequests` to `100`
- c. Update the prefork configuration section to suit your environment. The
- following settings apply to a busy system:
-+
-[source,bash]
-------------------------------------------------------------------------------
-<IfModule mpm_prefork_module>
- StartServers 20
- MinSpareServers 5
- MaxSpareServers 15
- MaxClients 150
- MaxRequestsPerChild 10000
-</IfModule>
-------------------------------------------------------------------------------
-+
-6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
- file to change references from the non-existent `/etc/apache2/` directory
- to `/etc/httpd/`.
-7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
-+
-[source,bash]
-------------------------------------------------------------------------------
-a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
-a2ensite eg.conf
-------------------------------------------------------------------------------
-
-Configure OpenSRF for the Evergreen application
------------------------------------------------
-There are a number of example OpenSRF configuration files in `/openils/conf/`
-that you can use as a template for your Evergreen installation. Issue the
-following commands as the *opensrf* Linux account:
-
-[source, bash]
-------------------------------------------------------------------------------
-cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
-cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
-------------------------------------------------------------------------------
-
-When you installed OpenSRF, you created four Jabber users on two
-separate domains and edited the `opensrf_core.xml` file accordingly. Please
-refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
-Evergreen version of the `opensrf_core.xml` file using the same Jabber users
-and domains as you used while installing and testing OpenSRF.
-
-[NOTE]
-The `-b` flag tells the `cp` command to create a backup version of the
-destination file. The backup version of the destination file has a tilde (`~`)
-appended to the file name, so if you have forgotten the Jabber users and
-domains, you can retrieve the settings from the backup version of the files.
-
-`eg_db_config.pl`, described in the following section, sets the database
-connection information in `opensrf.xml` for you.
-
-Creating the Evergreen database
--------------------------------
-
-By default, the `Makefile.install` prerequisite installer does not install
-the PostgreSQL 9 database server required by every Evergreen system;
-for production use, most libraries install the PostgreSQL database server on a
-dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
-on the machine of your choice using the following commands as the *root*
-Linux account:
-
-.(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
-[source, bash]
-------------------------------------------------------------------------------
-make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
-------------------------------------------------------------------------------
-
-.(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
-[source, bash]
-------------------------------------------------------------------------------
-make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
-------------------------------------------------------------------------------
-
-You can install the packages required by Fedora on the machine of your choice
-using the following commands as the *root* Linux account:
-
-.(Fedora 16) Installing PostgreSQL server packages
-[source, bash]
-------------------------------------------------------------------------------
-make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
-postgresql-setup initdb
-------------------------------------------------------------------------------
-
-For a standalone PostgreSQL server, install the following Perl modules as the
-*root* Linux account:
-
-.(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
-[source, bash]
-------------------------------------------------------------------------------
-aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
-cpan Business::ISBN
-cpan JSON::XS
-cpan Library::CallNumber::LC
-cpan MARC::Record
-cpan MARC::File::XML
-cpan UUID::Tiny
-------------------------------------------------------------------------------
-
-.(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
-[source, bash]
-------------------------------------------------------------------------------
-yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
-cpan Library::CallNumber::LC
-cpan MARC::Record
-cpan MARC::File::XML
-cpan UUID::Tiny
-------------------------------------------------------------------------------
-
-You need to create a PostgreSQL superuser to create and access the database.
-Issue the following command as the *postgres* Linux account to create a new
-PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
-password:
-
-[source, bash]
-------------------------------------------------------------------------------
-createuser -s -P evergreen
-------------------------------------------------------------------------------
-
-Once you have created the *evergreen* PostgreSQL account, you also need to
-create the database and schema, and configure your configuration files to point
-at the database server. Issue the following command as the *root* Linux account
-from inside the Evergreen source directory, replacing <user>, <password>,
-<hostname>, <port>, and <dbname> with the appropriate values for your
-PostgreSQL database (where <user> and <password> are for the *evergreen*
-PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
-with the values you want for the *egadmin* Evergreen administrator account:
-
-[source, bash]
-------------------------------------------------------------------------------
-perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
- --service all --create-database --create-schema --create-offline \
- --user <user> --password <password> --hostname <hostname> --port <port> \
- --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
-------------------------------------------------------------------------------
-
-This creates the database and schema and configures all of the services in
-your `/openils/conf/opensrf.xml` configuration file to point to that database.
-It also creates the configuration files required by the Evergreen `cgi-bin`
-administration scripts, and sets the user name and password for the *egadmin*
-Evergreen administrator account to your requested values.
-
-Creating the database on a remote server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-In a production instance of Evergreen, your PostgreSQL server should be
-installed on a dedicated server.
-
-PostgreSQL 9.1 and later
-^^^^^^^^^^^^^^^^^^^^^^^^
-To create the database instance on a remote database server running PostgreSQL
-9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`.
-
-For PostgreSQL 9.0
-^^^^^^^^^^^^^^^^^^
-To create the database instance on a remote database server running PostgreSQL
-9.0, you can either:
-
- * Install the PostgreSQL contrib modules on the machine on which you
- are installing the Evergreen code, and use the `--create-database`
- option from that machine, or
- * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
- PostgreSQL server and invoke it as the *postgres* Linux account:
-+
-[source, bash]
-------------------------------------------------------------------------------
-psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
-------------------------------------------------------------------------------
-
-Then you can issue the `eg_db_config.pl` command as above _without_ the
-`--create-database` argument to create your schema and configure your
-configuration files.
-
-Starting Evergreen
-------------------
-1. As the *root* Linux account, start the `memcached` and `ejabberd` services
-(if they aren't already running):
-+
-[source, bash]
-------------------------------------------------------------------------------
-/etc/init.d/ejabberd start
-/etc/init.d/memcached start
-------------------------------------------------------------------------------
-+
-2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
-following command is only necessary if you want to force Evergreen to treat the
-hostname as `localhost`; if you configured `opensrf.xml` using the real
-hostname of your machine as returned by `perl -ENet::Domain 'print
-Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
-+
-[source, bash]
-------------------------------------------------------------------------------
-osrf_ctl.sh -l -a start_all
-------------------------------------------------------------------------------
-+
- ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
- then your environment variable `PATH` does not include the `/openils/bin`
- directory; this should have been set in the *opensrf* Linux account's
- `.bashrc` configuration file. To manually set the `PATH` variable, edit the
- configuration file `~/.bashrc` as the *opensrf* Linux account and add the
- following line:
-+
-[source, bash]
-------------------------------------------------------------------------------
-export PATH=$PATH:/openils/bin
-------------------------------------------------------------------------------
-+
-3. As the *opensrf* Linux account, generate the Web files needed by the staff
- client and catalogue and update the organization unit proximity (you need to do
- this the first time you start Evergreen, and after that each time you change
- the library hierarchy in `config.cgi`):
-+
-[source, bash]
-------------------------------------------------------------------------------
-autogen.sh -u
-------------------------------------------------------------------------------
-+
-4. As the *root* Linux account, restart the Apache Web server:
-+
-[source, bash]
-------------------------------------------------------------------------------
-/etc/init.d/apache2 restart
-------------------------------------------------------------------------------
-+
-If the Apache Web server was running when you started the OpenSRF services, you
-might not be able to successfully log in to the OPAC or staff client until the
-Apache Web server is restarted.
-
-Testing connections to Evergreen
---------------------------------
-
-Once you have installed and started Evergreen, test your connection to
-Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
-commands to start `srfsh` and try to log onto the Evergreen server using the
-*egadmin* Evergreen administrator user name and password that you set using the
-`eg_db_config.pl` command:
-
-[source, bash]
-------------------------------------------------------------------------------
-/openils/bin/srfsh
-srfsh% login <admin-user> <admin-pass>
-------------------------------------------------------------------------------
-
-You should see a result like:
-
- Received Data: "250bf1518c7527a03249858687714376"
- ------------------------------------
- Request Completed Successfully
- Request Time in seconds: 0.045286
- ------------------------------------
-
- Received Data: {
- "ilsevent":0,
- "textcode":"SUCCESS",
- "desc":" ",
- "pid":21616,
- "stacktrace":"oils_auth.c:304",
- "payload":{
- "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
- "authtime":420
- }
-
- }
-
- ------------------------------------
- Request Completed Successfully
- Request Time in seconds: 1.336568
- ------------------------------------
-
-If this does not work, it's time to do some troubleshooting.
-
- * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
- if it finds any system configuration problems. The script is found at
- `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
- tree.
- * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
- * If you have faithfully followed the entire set of installation steps
- listed here, you are probably extremely close to a working system.
- Gather your configuration files and log files and contact the
- http://open-ils.org/listserv.php[Evergreen development mailing list]
- for assistance before making any drastic changes to your system
- configuration.
-
-Getting help
-------------
-
-Need help installing or using Evergreen? Join the mailing lists at
-http://evergreen-ils.org/listserv.php or contact us on the Freenode
-IRC network on the #evergreen channel.
-
-License
--------
-This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
-Unported License. To view a copy of this license, visit
-http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
-Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
+++ /dev/null
-Upgrading the Evergreen Server
-------------------------------
-Before upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and service interruptions.
-All of the steps in this chapter are to be completed from the command line.
-
-Software Prerequisites:
-~~~~~~~~~~~~~~~~~~~~~~~
-
- * **PostgreSQL**: Version 9.1 is recommended. The minimum supported version
- is 9.0.
- * **Linux**: Evergreen 2.0 has been tested on Debian Squeeze (6.0),
- Ubuntu Lucid Lynx (10.04) and Ubuntu Precise Pangolin (12.04). If you are
- running an older version of these distributions, you may want to upgrade
- before upgrading Evergreen. For instructions on upgrading these
- distributions, visit the Debian or Ubuntu websites.
- * **OpenSRF**: The minimum supported version of OpenSRF is 2.1.0.
-
-In the following instructions, you are asked to perform certain steps as either the root or opensrf user.
-
- * **Debian**: To become the root user, issue the `su` command and enter the password of the root user.
- * **Ubuntu**: To become the root user, issue the `sudo su` command and enter the password of your current user.
-
-To switch from the root user to a different user, issue the `su - [user]`
-command; for example, `su - opensrf`. Once you have become a non-root user, to
-become the root user again simply issue the `exit` command.
-
-[CAUTION]
-Pay attention to error output as you run these scripts. If you encounter errors
-that you cannot resolve yourself through additional troubleshooting, please
-report the errors to the http://evergreen-ils.org/listserv.php[Evergreen
-Technical Discussion List].
-
-Upgrade the Evergreen database schema
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The upgrade of the Evergreen database schema is the lengthiest part of the
-upgrade process for sites with a significant amount of production data.
-
-Before running the upgrade script against your production Evergreen database,
-back up your database, restore it to a test server, and run the upgrade script
-against the test server. This enables you to determine how long the upgrade
-will take and whether any local customizations present problems for the
-stock upgrade script that require further tailoring of the upgrade script.
-The backup also enables you to cleanly restore your production data if
-anything goes wrong during the upgrade.
-
-Run the following script as a user with the ability to connect to the
-database server. Adjust the arguments to the `psql` command to reflect your
-database server connection information:
-
-[source, bash]
-----------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.1-beta2/Open-ILS/src/sql/Pg
-psql -U evergreen -h localhost -f version_upgrade/2.1-2.2-upgrade-db.sql evergreen
-----------------------------------------------------------
-
-Upgrade the Evergreen code
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-The following steps guide you through a simplistic upgrade of a production
-server. You must adjust these steps to accommodate your customizations such
-as catalogue skins.
-
-. Stop Evergreen and back up your data:
- .. As root, stop the Apache web server.
- .. As the opensrf user, stop all Evergreen and OpenSRF services:
-+
-[source, bash]
------------------------------
-osrf_ctl.sh -l -a stop_all
------------------------------
-+
- .. Back up the /openils directory.
-. Upgrade OpenSRF. Download and install the latest version of OpenSRF from
-the http://evergreen-ils.org/opensrf.php[OpenSRF download page].
-. As the opensrf user, download and extract Evergreen 2.2:
-+
-[source, bash]
------------------------------------------------
-wget http://evergreen-ils.org/downloads/previews/Evergreen-ILS-2.2-beta2.tar.gz
-tar xzf Evergreen-ILS-2.2-beta2.tar.gz
------------------------------------------------
-+
-[NOTE]
-For the latest edition of Evergreen, check the http://evergreen-ils.org/downloads.php[Evergreen download page] and adjust upgrading instructions accordingly.
-+
-. As the root user, install the prerequisites:
-+
-[source, bash]
-----------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.2-beta2
----------------------------------------------
-+
-On the next command, replace `[distribution]` with one of these values for your
-distribution of Debian or Ubuntu:
-
- * `debian-squeeze` for Debian Squeeze (6.0)
- * `ubuntu-lucid` for Ubuntu Lucid Lynx (10.04)
- * `ubuntu-precise` for Ubuntu Precise Pangolin (12.04)
-+
-[source, bash]
-------------------------------------------------------------
-make -f Open-ILS/src/extras/Makefile.install [distribution]
-------------------------------------------------------------
-+
-. As the opensrf user, configure and compile Evergreen:
-+
-[source, bash]
-------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.2-beta2
-./configure --prefix=/openils --sysconfdir=/openils/conf
-make
-------------------------------------------------------------
-+
-. As the root user, install Evergreen:
-+
-[source, bash]
-------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.2-beta2
-make STAFF_CLIENT_STAMP_ID=rel_2_2_beta2 install
-------------------------------------------------------------
-+
-. As the root user, change all files to be owned by the opensrf user and group:
-+
-[source, bash]
-------------------------------------------------------------
-chown -R opensrf:opensrf /openils
-------------------------------------------------------------
-+
-. As the opensrf user, update the configuration files:
-+
-[source, bash]
------------------------------------------------------------
-cd /home/opensrf/Evergreen-ILS-2.2-beta2
-
-perl Open-ILS/src/support-scripts/eg_db_config.pl \
---create-offline --user evergreen --password evergreen \
---hostname localhost --port 5432 --database evergreen
-----------------------------------------------------------
-+
-. As the opensrf user, update the server symlink in /openils/var/web/xul/:
-+
-[source, bash]
------------------------------------------------------------
-cd /openils/var/web/xul/
-rm server
-ln -s rel_2_2_beta2/server
-----------------------------------------------------------
-+
-. As the opensrf user, update opensrf_core.xml and opensrf.xml by copying the
- new example files (/openils/conf/opensrf_core.xml.example and
- /openils/conf/opensrf.xml).
-+
-[source, bash]
-----------------------------------------------------------
-cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
-cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
-----------------------------------------------------------
-+
-[CAUTION]
-Copying these configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
-+
-. Update Apache files:
-+
-[CAUTION]
-Copying these Apache configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
-For example, if you purchased an SSL certificate, you will need to edit eg.conf to point to the appropriate SSL certificate files.
-+
-.. Update /etc/apache2/startup.pl by copying the example from Open-ILS/examples/apache/startup.pl.
-.. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf.
-.. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ examples/apache/eg.conf.
-. Update opensrf.xml with the database connection info:
-+
-As the opensrf user, if you are happy with the default settings in
-opensrf.xml.example, then:
-+
-[source, bash]
--------------------------------------------------------------------------
-cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
-cd /home/opensrf/Evergreen-ILS-2.2-beta2
-perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all \
---database evergreen --host localhost --user evergreen --password evergreen
--------------------------------------------------------------------------
-+
-Otherwise, compare /openils/conf/opensrf.xml with /openils/conf/opensrf.xml.example and manually copy the new pieces into place in your existing opensrf.xml file
-
-Restart Evergreen and Test
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-. As the opensrf user, start all Evergreen and OpenSRF services:
-+
-[source, bash]
---------------------------------------------------------------
-osrf_ctl.sh -l -a start_all
---------------------------------------------------------------
-+
-. As the opensrf user, run autogen to refresh the static organizational data files:
-+
-[source, bash]
---------------------------------------------------------------
-cd /openils/bin
-../autogen.sh
---------------------------------------------------------------
-+
-. Start srfsh and try logging in using your Evergreen username and password:
-+
-[source, bash]
---------------------------------------------------------------
-/openils/bin/srfsh
-srfsh% login username password
---------------------------------------------------------------
-+
-You should see a result like:
-+
-[source, bash]
-------------------------------------------------------
-Received Data: "250bf1518c7527a03249858687714376"
- ------------------------------------
- Request Completed Successfully
- Request Time in seconds: 0.045286
- ------------------------------------
-
- Received Data: {
- "ilsevent":0,
- "textcode":"SUCCESS",
- "desc":" ",
- "pid":21616,
- "stacktrace":"oils_auth.c:304",
- "payload":{
- "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
- "authtime":420
- }
-
- }
-
- ------------------------------------
- Request Completed Successfully
- Request Time in seconds: 1.336568
- ------------------------------------
-----------------------------------------------------------
-+
-If this does not work, it's time to do some troubleshooting.
-+
-. As the root user, start the Apache web server.
-+
-If you encounter errors, refer to the troubleshooting section of this documentation for tips on finding solutions and seeking further assistance
-from the Evergreen community.
+++ /dev/null
-System Requirements
--------------------
-
-Server Minimum Requirements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following are the base requirements setting Evergreen up on a test server:
-
- * An available desktop, server or virtual image
- * 1GB RAM, or more if your server also runs a graphical desktop
- * Linux Operating System
- * Ports 80 and 443 should be opened in your firewall for TCP connections to allow OPAC and staff client connections to the Evergreen server.
-
-Staff Client Requirements
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Staff terminals connect to the central database using the Evergreen staff client, available for download from The Evergreen download page.
-The staff client must be installed on each staff workstation and requires at minimum:
-
- * Windows (XP, Vista, or 7), Mac OS X, or Linux operating system
- * a reliable high speed Internet connection
- * 512Mb of RAM
- * The staff client uses the TCP protocal on ports 80 and 443 to communicate with the Evergreen server.
-
-*Barcode Scanners*
-
-Evergreen will work with virtually any barcode scanner – if it worked with your legacy system it should work on Evergreen.
-
-*Printers*
-
-Evergreen can use any printer configured for your terminal to print receipts, check-out slips, holds lists, etc. The single exception is spine label printing,
-which is still under development. Evergreen currently formats spine labels for output to a label roll printer. If you do not have a roll printer manual formatting may be required.
+++ /dev/null
-Licensing
-=========
-
-Creative Commons License
-------------------------
-
-image::media/ccbysa.png["CC-BY-SA",link="http://creativecommons.org/licenses/by-sa/3.0/"]
-
-This work is licensed under a
-link:http://creativecommons.org/licenses/by-sa/3.0/[Creative
-Commons Attribution-ShareAlike 3.0 Unported License].
-
-Additional Licensed Content
----------------------------
-
-The
-
-image::media/application-pdf.png["PDF"]
-
-icon comes from the KDE project at: http://kde.org/ and is licensed under the GNU
-Lesser General Public License 3.0
-
-....
-GNU LESSER GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
- This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
- 0. Additional Definitions.
-
- As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
- "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
- An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
- A "Combined Work" is a work produced by combining or linking an
-Application with the Library. The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
- The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
- The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
- 1. Exception to Section 3 of the GNU GPL.
-
- You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
- 2. Conveying Modified Versions.
-
- If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
- a) under this License, provided that you make a good faith effort to
- ensure that, in the event an Application does not supply the
- function or data, the facility still operates, and performs
- whatever part of its purpose remains meaningful, or
-
- b) under the GNU GPL, with none of the additional permissions of
- this License applicable to that copy.
-
- 3. Object Code Incorporating Material from Library Header Files.
-
- The object code form of an Application may incorporate material from
-a header file that is part of the Library. You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
- a) Give prominent notice with each copy of the object code that the
- Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the object code with a copy of the GNU GPL and this license
- document.
-
- 4. Combined Works.
-
- You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
- a) Give prominent notice with each copy of the Combined Work that
- the Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the Combined Work with a copy of the GNU GPL and this license
- document.
-
- c) For a Combined Work that displays copyright notices during
- execution, include the copyright notice for the Library among
- these notices, as well as a reference directing the user to the
- copies of the GNU GPL and this license document.
-
- d) Do one of the following:
-
- 0) Convey the Minimal Corresponding Source under the terms of this
- License, and the Corresponding Application Code in a form
- suitable for, and under terms that permit, the user to
- recombine or relink the Application with a modified version of
- the Linked Version to produce a modified Combined Work, in the
- manner specified by section 6 of the GNU GPL for conveying
- Corresponding Source.
-
- 1) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (a) uses at run time
- a copy of the Library already present on the user's computer
- system, and (b) will operate properly with a modified version
- of the Library that is interface-compatible with the Linked
- Version.
-
- e) Provide Installation Information, but only if you would otherwise
- be required to provide such information under section 6 of the
- GNU GPL, and only to the extent that such information is
- necessary to install and execute a modified version of the
- Combined Work produced by recombining or relinking the
- Application with a modified version of the Linked Version. (If
- you use option 4d0, the Installation Information must accompany
- the Minimal Corresponding Source and Corresponding Application
- Code. If you use option 4d1, you must provide the Installation
- Information in the manner specified by section 6 of the GNU GPL
- for conveying Corresponding Source.)
-
- 5. Combined Libraries.
-
- You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
- a) Accompany the combined library with a copy of the same work based
- on the Library, uncombined with any other library facilities,
- conveyed under the terms of this License.
-
- b) Give prominent notice with the combined library that part of it
- is a work based on the Library, and explaining where to find the
- accompanying uncombined form of the same work.
-
- 6. Revised Versions of the GNU Lesser General Public License.
-
- The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
- If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
-....
+++ /dev/null
-My Lists 2.2\r
-------------\r
-\r
-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.\r
-\r
-\r
-*Create New Lists*\r
-\r
-1) Log in to your account in the OPAC.\r
-\r
-2) Search for titles.\r
-\r
-3) Choose a title to add to your list. Click *Add to My List*.\r
-\r
-image::media/My_Lists1.jpg[My_Lists1]\r
-\r
-4) Scroll up to the gray row on top of the *Search Results*. Click *View My List*\r
-\r
-5) Items are added to a temporary list. Your temporary list appears at the bottom of the screen.\r
-\r
-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. \r
-\r
-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.\r
-\r
-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.\r
-\r
-image::media/My_Lists3.jpg[My_Lists3]\r
-\r
-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.\r
-\r
-image::media/My_Lists4.jpg[My_Lists4]\r
-\r
-8) Click *Submit*.\r
-\r
-9) The new list appears beneath the temporary list.\r
-\r
-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.\r
-\r
-image::media/My_Lists5.jpg[My_Lists5]\r
-\r
-11) Click *Go*.\r
-\r
-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.\r
-\r
-13) Click *Edit* to add or edit a note.\r
-\r
-14). Enter desired notes, and click *Save Notes*.\r
-\r
-image::media/My_Lists6.jpg[My_Lists6]\r
-\r
-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. \r
-\r
-You can also download your list into a CSV file by clicking *Download CSV*.\r
-\r
-image::media/My_Lists7.jpg[My_Lists7]\r
-\r
-\r
-16) When you no longer need a list, click *Delete List*. \r
-\r
-\r
-\r
-\r
-\r
+++ /dev/null
-Release notes
-=============
-:toc:
-:numbered:
-
-Upgrade notes
--------------
-
-Z39.50 Server Definitions
-~~~~~~~~~~~~~~~~~~~~~~~
-Z39.50 server target definitions have been removed from the sample
-`opensrf.xml.example` file. To migrate existing settings from your
-`opensrf.xml` configuration file to the database, peform the
-following steps:
-
- 1. First, set up your custom Z39.50 sources in the database. For
- each entry in `z3950/services`, map the following XML paths to the
- corresponding `config.z3950_source` table column as follows:
-+
- ** `z3950/services/<entry>` = name
- ** `//<entry>/name` = label
- ** `//<entry>/host` = host
- ** `//<entry>/port` = port
- ** `//<entry>/db` = db
- ** `//<entry>/record_format` = record_format
- ** `//<entry>/transmission_format` = transmission_format
-+
- 2. Then, for each attribute defined in the `<attrs>` element for
- a given service, map the following XML paths to the corresponding
- `config.z3950_attr` table column as follows:
-+
- ** `z3950/services/<entry>` = source
- ** `//<entry>/attrs/<attr>` = name
- ** `//<entry>/attrs/<attr>/code` = code
- ** `//<entry>/attrs/<attr>/format` = format
-+
- 3. After adding the new Z39.50 sources and corresponding attributes,
- you will need to log out of the staff client and log back into the
- staff client to retrieve the new entry values. If a given Z39.50
- server does not work for a given attribute, pay attention to the
- `truncation` column for the attribute.
-
-
-New features
-------------
-
-Administration
-~~~~~~~~~~~~
-
-Custom Org Unit Trees
-^^^^^^^^^^^^^^^^^^^^^
-Evergreen enables you to create an organizational tree that describes the
-systems, branches, or other units that comprise your organization. By default,
-the org unit tree that appears to patrons in the OPAC is identical to the one
-that appears to users of the staff client. Using this feature, you can condense
-or re-order the organizational tree into a simpler structure for patrons using
-the OPAC while maintaining the complex organizational tree that is available to
-users of the staff client.
-
-As a further enhancement, you can hide a parental org unit yet still make its
-child org units visible in the OPAC. In previous versions of Evergreen, child
-org units inherited the visibility setting of their parents.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Fine Accrual on Closed Dates
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-By default, fines accrue only on dates that the library is open. This feature
-enables you to charge patrons fines on dates the library is closed. Fines
-accrue during scheduled closings as well as during normal weekly closed dates.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Target Copies for Holds at Closed Libraries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-By default, when a patron places a hold on a title, the hold targeter will
-search for copies to fill the hold only at circulating libraries that are open.
-Copies at closed libraries are not targeted to fill holds. When turned on, this
-feature enables Evergreen to target copies that have closed circulating
-libraries to fill holds. Two new org unit settings control this feature.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-OPAC
-~~~~
-
-Template Toolkit OPAC (_TPAC_)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The basic catalog has been replaced by the Template Toolkit OPAC (_TPAC_).
-Compared to the traditional catalog (_JSPAC_), TPAC uses far fewer network
-calls for each page, resulting in faster loading pages. TPAC is built on the
-http://template-toolkit.org[Template Toolkit] language to enable simple but
-powerful customization, and supports integrated `gettext`-based translation
-for strings--including placeholders and quantities--for better
-internationalization support.
-
-The next feature release of Evergreen will make TPAC the primary catalog
-and deprecate the use of the JSPAC.
-
-Auto Suggest in Catalog Search
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The
-http://docs.evergreen-ils.org/2.2/_auto_suggest_in_catalog_search_2.html[auto
-suggest feature] suggests the completion of search terms as the user enters his
-query. By default, the user will see ten suggestions although this
-number 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.
-
-Copy Location Groups
-^^^^^^^^^^^^^^^^^^^^
-This feature allows staff to create and name sets of copy locations to use as
-a search filter in the catalog. OPAC-visible groups will display within the
-library selector in the template toolkit OPAC. When a user selects a group
-and performs a search, the set of results will be limited to records that have
-copies in one of the copy locations within the group. Groups can live at any
-level of the library hierarchy and may include copy locations from any parent
-org unit or child org unit.
-
-For advanced users, this change includes a new Query Parser filter called
-location_groups().
-
-My Lists
-^^^^^^^^
-The My Lists feature replaces the bookbag feature that was available in
-versions proior to 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.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-SMS Text Messaging
-^^^^^^^^^^^^^^^^^^
-The SMS Text Messaging feature enables users to receive hold notices via text
-message. Users can opt-in to this hold notification as their default setting
-for all holds, or they can receive specific hold notifications via text
-message. Users can also send call numbers and copy locations via text message.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-New Patron Preferences
-^^^^^^^^^^^^^^^^^^^^^^^
-Users will now have the ability to designate the following preferences in the
-Template Toolkit catalog (_TPAC_):
-
-* A preferred search location. Unlike the default search library in JSPAC, this
- setting will also control which copies display first in search results and
- record detail screens.
-* A preferred pickup location.
-* The ability to keep a history of checked out items.
-* The ability to keep a history of holds.
-
-Credit Card Payment via Public Catalog
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Patrons can now use credit cards to pay fines and bills in *My Account* of the
-TPAC.
-
-Record Detail Print and E-mail Actions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Implements Print and Email actions as links below the *Add to List* link
-in the TPAC record detail page.
-
-Identify Previously-Checked-Out Items in Search Results
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When a user is logged into the TPAC and performs a search, this feature
-indicates in the results set when any of the result items were ever checked
-out by the logged-in user. Items will only be tagged when the related org
-setting is enabled and the user has opted in to circ history tracking.
-
-Patron Management
-~~~~~~~~~~~~~~~~~
-
-Patron Statistical Category Enhancements
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The following enhancements have been added to patron statistical categories:
-
- * categories can be marked as 'required' (must be filled out when a patron is
- registered)
- * categories can be marked to allow or disallow user-created entries
- * an entry for a given category and org unit can be marked as the default
- entry. It will be automatically selected in the new patron registration
- screen.
-
-User Settings Available from Patron Editor
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Staff can now access and update user settings, like notification prefererences
-and default pickup library, in the patron editor.
-
-Mark Patron E-mail or Phone as Invalid
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Staff can mark a patron's email address or phone number as invalid in the
-patron editor. The system will clear the email (or phone) field from
-`actor.usr`, and [both optionally, per OU setting]:
-
- . create a corresponding standing penalty against the user, for staff to
- notice next time they bring up said patron in the staff client;
- . create a patron note. Related penalties (but not notes) will be cleared
- whenever that patron's email address or phone number is updated again.
-
-Address Alert in Patron Registration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Support for comparing user addresses to alert addresses. When an address is
-found, the address in question is styled (the header row turns red) and the
-configured alert message is shown along the top-right, where other warnings
-appear.
-
-Circulation
-~~~~~~~~~~~
-
-Telephony Improvements
-^^^^^^^^^^^^^^^^^^^^^^
-Enhancements to notifications by telephony, including:
-
-* A feature that allows an Evergreen system to roll over failed notifcations
- into new ones with a different notification method.
-* Holiday awareness. System administrators can, via `cron`, schedule the
- `set_pbx_holidays` script on an Evergreen system to periodically update
- the PBX's table of holidays, based on a given org unit's closed date ranges.
-* Smart retry. In certain situations, if you put too many callfiles into
- Asterisk's spool at once, Asterisk will try to make too many calls at
- once, and all such calls just fail. That is what the allocator is meant to
- prevent. Smart retry is about moving calls that have been tried once, and will
- be retried again later due to resulting in a busy signal or other problem, out
- of the spool to make room for other calls that could be made in the meantime.
-
-Circulation Limit Groups & Limit Sets
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The new *Circulation Limit Groups* interface found in the *Server
-administration* menu can be thought of as _tags_ the system places on
-circulations so that it can find them later. The *Limit Sets* interface found
-in the *Local administration* menu defines rules for limiting the number of
-active circulations a patron may have based on Circulation Modifiers and Limit
-Groups. These new features support the following options:
-
-* Setting circ limits for circulations that have no circ modifiers. This is
- useful for systems with circulation rules based on something other than
- circulation modifiers (for example, *MARC type*) or for grouping items
- that may have different circulation modifiers so that, for example, you
- can count every video, regardless of circulation modifiers.
-* The ability to set limits for a single library's items, regardless of
- the checkout library.
-
-New Checkin Modifiers
-^^^^^^^^^^^^^^^^^^^^^
-The following modifiers have been added to the check-in interface:
-
-* *Clear Shelf-Expired Holds*. When checking in something on the hold shelf,
- run a 'Clear Shelf Process' for the specific copy ID at that library to
- auto-clear any Shelf-Expired holds.
-* *Retarget Local Holds*. When checking in 'in process' items that are owned by
- the library, attempt to find a local hold to retarget. This is intended to
- help with proper targeting of newly-cataloged items.
-* *Retarget All Statuses*. Similar to 'Retarget Local Holds', this modifier will
- attempt to find a local hold to retarget, regardless of the status of the
- item being checked in. This modifier must be used in conjunction with the
- 'Retarget Local Holds' modifier.
-* *Capture Local Holds as Transits*. With this checkin modifier, any local holds
- will be given an 'in transit' status instead of 'holds shelf'. The intent is
- to stop the system from sending holds notifications before the item is ready
- to be placed on the holds shelf. Possible use cases include Automated
- Materials Handling(AMH) checkins, in which items may be sitting in a bin for a
- while before landing on the holds shelf, and checkins done on closed days.
-
-Copy Location Alerts
-^^^^^^^^^^^^^^^^^^^^
-This enhancement adds a new 'checkin_alert' column to copy locations. If true
-(defaults to false), then a routing alert is generated at reshelving time for
-the location. This is intended for special locations, such as 'Display', that
-may require special handling, or that temporarily contain items that are not
-normally in that location.
-
-Age Hold Protection Based on a Copy's Active Date
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* Adds a 'Sets copy active' column to the 'Copy Statuses' interface to identify
- statuses that indicate a copy is active and ready for checkout. The first
- time a copy is set to one of these statuses, the system adds an 'active date'
- for the copy, which can be used for reporting.
-* Provides a new library setting for age hold protection to be based on the
- copy's active date instead of its create date.
-
-Option to Place Holds on Age Protected Items
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Allow choice of placing hold despite age protection. This alters the backend to
-watch when so much as one copy failed only due to age protection. In JSPAC, an
-alternate confirm message is shown. In TPAC, the failure message is changed
-and override is always allowed for the hold in question.
-
-Force and Cataloging Recall Holds
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Creates two new types of copy-level holds, *Force* and *Cataloging Recall*,
-that cut in front of all other holds and ignore hold rules. For cataloging
-recall holds, the copy's status changes to 'cataloging' when it reaches its
-destination.
-
-Archiving Statistical Categories and Circulation-Time Copy Locations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Circulation-time copy locations are now archived with circulations (aged or active).
-
-Using the *Statistical Categories Editor*, staff can also designate statistical
-categories (patron and copy) to archive with circulations.
-
-Browse Holds Shelf Interface Displays Canceled Holds
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Holds that are canceled after they are placed on the holds shelf will continue
-to display in this interface and will also display in the 'shelf-expired holds'
-view.
-
-Acquisitions
-~~~~~~~~~~~~
-
-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 when importing acquisitions records.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-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.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Lineitem and Copy Actions Accessible from More Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Users can now access lineitem actions (for example, receive, unreceive, update
-barcodes, new invoice) from the acquisitions lineitem search results and
-selection list interfaces. Also available on these interfaces is a link to copy
-details where users can take receive actions (receive, unreceive, cancel) on
-individual copies.
-
-Improved Displays for Provider and Fund Administration Pages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-This enhancement provides improved support for viewing the provider and fund
-administation pages. It also allows staff to use filters to find providers and
-funds.
-
-Cataloging
-~~~~~~~~~~
-
-Authority Control Sets
-^^^^^^^^^^^^^^^^^^^^^^
-The tags and subfields that display in authority records in Evergreen are
-proscribed by control sets. The Library of Congress control set is the default
-control set in all versions of Evergreen. However, in Evergreen release 2.2,
-you can create customized control sets for authority records, and you can
-define thesauri and authority fields for these control sets.
-
-Patrons and staff can browse authorities in the JSPAC. The following fields are
-browsable by default: author, series, subject, title, and topic. You can add
-custom browse axes in addition to these default fields.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Batch Importing MARC Records
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The MARC Batch Import interface features improved matching of records and
-managing of your import queue. In version 2.2, you can specify match points
-between incoming and existing records to better detect matching records and
-prevent record duplication. You can also create quality controls to ensure that
-incoming matching records are superior in quality to existing catalog records.
-
-You also have new options for managing your queue. You can apply filters to
-your queue, and you can generate a list of import errors. You can also print
-your queue, email your queue, or export your queue as a CSV file.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Hide Fields in Copy Editor
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-You can customize the *Copy Editor* for staff by hiding fields in the *Copy
-Editor* that are not relevant for workflows at particular org units. Descendant
-org units inherit the settings of their parents.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Prevent Bibliographic Records from Having Attached Copies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To enable libraries to designate specific sets of records as only for use as
-electronic resources, it is possible to configure a bibliographic source such
-that physical copies or MFHD records may not be attached to records from that
-source. The `config.bib_source` table now includes a new Boolean column,
-`can_have_copies`, that controls this behavior. If `can_have_copies` for a
-given bibliographic source is `TRUE`, then the staff client will prevent a
-cataloger from adding volumes or MFHD records to records belonging to that
-source.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Overlay Existing Catalog Record via Z39.50 Import
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-You can replace an existing catalog record with a record obtained through a
-Z39.50 search. No new permissions or administrative settings are needed to use
-this feature.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Restrict Z39.50 Sources by Permission Group
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Switch Copy Location Name and Library Short Name in Copy Editor
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-By default, the copy editor shows the library shortname ('BR1' or 'CONS')
-followed by the copy location name ('Stacks', 'Reference'). A new workstation
-setting, under *Admin -> Workstation Administration -> Copy Editor: Copy
-Location Name First*, enables staff to change the display so that the copy
-location name is displayed first, followed by the library shortname. This may
-be particularly useful for libraries that have defined one set of copy
-locations at the consortial level and want to enable quick keyboard navigation
-to copy locations by typing just the first letters of the copy location.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-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. Currently, this feature only tracks user authentication.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Authentication Proxy
-~~~~~~~~~~~~~~~~~~
-To support integration of Evergreen with organizational authentication systems,
-and to reduce the proliferation of user names and passwords, Evergreen offers
-a new service called `open-ils.auth_proxy`. If you enable the service,
-`open-ils.auth_proxy` supports different authentication mechanisms
-that implement the `authenticate` method. You can define a chain of these
-authentication mechanisms to be tried in order within the `<authenticators>`
-element of the `opensrf.xml` configuration file, with the option of falling
-back to the `native` mode that uses Evergreen's internal method of password
-authentication.
-
-This service only provides authentication; there is no support for automatic
-provisioning of accounts. To authenticate against any authentication system,
-the user account must first be defined within the Evergreen system, and
-authentication will be based on the user name as it exists in Evergreen.
-
-A sample authentication mechanism for LDAP is provided in
-`Open-ILS::Application::AuthProxy::LDAP_AUTH`, and corresponding sample
-attributes can be found in `opensrf.xml.example`.
-
-Auditor Tables
-~~~~~~~~~~~~~~
-This enhancement adds user and workstation IDs to the auditor tables. It also
-adds/changes auditor functions to allow for setting, getting, and clearing
-auditor information, as well as adding a couple of utility functions for
-updating auditors after changes to their origin columns.
-
-Reports
-~~~~~~~
-
-New Views for Reporting Sources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To support the creation of collection development reports, the following
-reporting sources have been added:
-
- * 'Last Circulation or Creation Date' is a source that offers the copy ID,
- the last circulation date or creation date, and the last circulation date
- * 'Hold/Copy Ratio per Bib and Pickup Library' is a source that calculates
- the number of holds per copy per bibliographic record, with granularity
- by pickup library.
-
-
-Staff Client Navigation
-~~~~~~~~~~~~~~~~~~~~~~~
-
-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 add buttons that will enable quick access to a variety of features.
-You can create toolbars for specific org unit(s), workstation(s), or login(s).
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Double Clicking in the Staff Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-You can search for a patron's record, and double click on a result to access
-that record. You can double click on an item in the *Holdings Maintenance*
-screen to access copy information. The item is linked to the *Volume/Copy
-Creator*, if you turned it on in the staff client's org unit settings. If you
-did not turn on the *Volume/Copy Creator*, then the item links to the *Item
-Attributes*.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Recent Staff Searches
-^^^^^^^^^^^^^^^^^^^^^
-You can view your recent searches as you perform them in the staff client. By
-default, staff can view their recent searches, although the number is
-configurable. This feature is only available through the staff client; it is
-not available to patrons in the OPAC.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-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* views. 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.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Sorting Columns
-^^^^^^^^^^^^^^^
-This feature enables you to sort by multiple display columns so that you can
-find easily the information that you need on a screen. 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
- * Vandelay Import Errors
-
-You can sort items in an ascending or descending order, and you can prioritize
-the order in which columns will sort.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Tab Button
-^^^^^^^^^^
-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*.
-
-Documentation for this feature is available in the Book of Evergreen at
-http://docs.evergreen-ils.org/2.2/
-
-Close All Tabs Shortcut
-^^^^^^^^^^^^^^^^^^^^^^^
-You can use *CTRL+Click* on the close tab (*X*) button to close all tabs.
-
-Independent Column Configurations and Receipt Templates for Different Hold List Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Previously, all hold list interfaces shared the same column picker settings and
-receipt templates. This enhancement creates independent settings for the
-following interfaces:
-
-* Actions for this Record -> View Holds
-* Patron Display -> Holds
-* Circulation -> Browse Hold Shelf
-* Circulation -> Pull List for Hold Requests
-
-Line Number Columns
-^^^^^^^^^^^^^^^^^^^
-List displays in the staff client now have a non-sortable line number column
-which displays the ordinal position of each row in the list. The first row in
-such a list will always have a value of 1 in the ordinal column, no matter how
-the list is sorted. There is no special handling for paged interfaces; the
-first row on any given page still gets an ordinal value of 1.
-
-Auto-Login
-^^^^^^^^^^
-Supports auto-login in the staff client by adding three new command line
-parameters:
-
-* `-ILSuser`: user name to log in with
-* `-ILSpassword`: password to use
-* `-ILShost`: hostname to use
-
-License
--------
-This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
-Unported License. To view a copy of this license, visit
-http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
-Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
+++ /dev/null
-Evergreen Documentation\r
-=======================\r
-Documentation Interest Group\r
-:doctype: book\r
-:toc:\r
-:numbered:\r
-\r
-Introduction\r
-============ \r
-\r
-About This Documentation\r
-------------------------\r
-\r
-This guide was produced by the Evergreen Documentation Interest Group (DIG),\r
-consisting of numerous volunteers from many different organizations. The DIG\r
-has drawn together, edited, and supplemented pre-existing documentation\r
-contributed by libraries and consortia running Evergreen that were kind enough\r
-to release their documentation into the creative commons. Please see the\r
-<<attributions,Attributions>> section for a full list of authors and\r
-contributing organizations. Just like the software it describes, this guide is\r
-a work in progress, continually revised to meet the needs of its users, so if\r
-you find errors or omissions, please let us know, by contacting the DIG\r
-facilitators at docs@evergreen-ils.org.\r
-\r
-This guide to Evergreen is intended to meet the needs of front-line library\r
-staff, catalogers, library administrators, system administrators, and software\r
-developers. It is organized into Parts, Chapters, and Sections addressing key\r
-aspects of the software, beginning with the topics of broadest interest to the\r
-largest groups of users and progressing to some of the more specialized and\r
-technical topics of interest to smaller numbers of users.\r
-\r
-Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
-\r
-About Evergreen\r
----------------\r
-\r
-Evergreen is an open source library automation software designed to meet the\r
-needs of the very smallest to the very largest libraries and consortia. Through\r
-its staff interface, it facilitates the management, cataloging, and circulation\r
-of library materials, and through its online public access interface it helps\r
-patrons find those materials.\r
-\r
-The Evergreen software is freely licensed under the GNU General Public License,\r
-meaning that it is free to download, use, view, modify, and share. It has an\r
-active development and user community, as well as several companies offering\r
-migration, support, hosting, and development services.\r
-\r
-The community’s development requirements state that Evergreen must be:\r
-\r
-* Stable, even under extreme load.\r
-* Robust, and capable of handling a high volume of transactions and simultaneous users.\r
-* Flexible, to accommodate the varied needs of libraries.\r
-* Secure, to protect our patrons’ privacy and data.\r
-* User-friendly, to facilitate patron and staff use of the system.\r
-\r
-Evergreen, which first launched in 2006 now powers over 544 libraries of every\r
-type – public, academic, special, school, and even tribal and home libraries –\r
-in over a dozen countries worldwide.\r
-\r
-// Push titles down one level.\r
-:leveloffset: 1\r
-\r
-include::release_notes.txt[]\r
-\r
-// Return to normal title levels.\r
-:leveloffset: 0\r
-\r
-Software Installation\r
-=====================\r
-\r
-\r
-Introduction\r
-------------\r
-\r
-This part will guide you through the installation steps installation or\r
-upgrading your Evergreen system. It is intended for system administrators. \r
-\r
-\r
-include::installation/system_requirements.txt[]\r
-\r
-// Push titles down one level.\r
-:leveloffset: 1\r
-\r
-include::installation/server_installation.txt[]\r
-\r
-// Return to normal title levels.\r
-:leveloffset: 0\r
-\r
-include::installation/server_upgrade.txt[]\r
-\r
-include::installation/edi_setup.txt[]\r
-\r
-// include::staff_client_installation.txt[] \r
-// include::org_unit_structure_initialization.txt[]\r
-// include::loading_data.txt[]\r
-\r
-\r
-System Configuration and Customization\r
-======================================\r
-\r
-Introduction\r
-------------\r
-\r
-The Evergreen system allows a free range of customizations to every aspect of\r
-the system. Use this part of the documentation to become familiar with the tools\r
-for configuring the system as well as customizing the OPAC and staff client. \r
-\r
-// include::global_system_configuration.txt[]\r
-// include::opac_customization.txt[]\r
-\r
-include::admin/template_toolkit.txt[]\r
-\r
-include::admin/auto_suggest_search.txt[]\r
-\r
-include::admin/customize_staff_client.txt[]\r
-\r
-// include::backing_up.txt[]\r
- \r
-\r
-\r
-Using the Staff Client\r
-======================\r
-\r
-\r
-Introduction\r
-------------\r
-\r
-This part of the documentation deals with general Staff Client usage including\r
-logging in, navigation and shortcuts.\r
-\r
-\r
-include::admin/staff_client-tab_buttons.txt[]\r
-\r
-include::admin/staff_client-double_clicking.txt[]\r
-\r
-include::admin/staff_client-sorting_columns.txt[]\r
-\r
-include::admin/staff_client-recent_searches.txt[]\r
-\r
-include::admin/staff_client-return_to_results_from_marc.txt[]\r
-\r
-System Administration From the Staff Client\r
-===========================================\r
-\r
-Introduction\r
-------------\r
-\r
-This part deals with the options in the Server Administration menu found in the\r
-staff client. \r
-\r
-// Follow structure from staff client system admin menu.\r
-\r
-include::admin/acquisitions_admin.txt[]\r
-\r
-include::admin/authorities.txt[]\r
-\r
-include::admin/cn_prefixes_and_suffixes.txt[]\r
-\r
-include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
-\r
-include::admin/booking-admin.txt[]\r
-\r
-include::admin/SMS_messaging.txt[]\r
-\r
-include::admin/user_activity_type.txt[]\r
-\r
-\r
-Local Administration\r
-====================\r
-\r
-Introduction\r
-------------\r
-\r
-This part covers the options in the Local Administration menu found in the staff\r
-client. \r
-\r
-// Follow structure from staff client local admin menu.\r
-\r
-// Push titles down one level.\r
-:leveloffset: 1\r
-\r
-include::admin/hold_driven_recalls.txt[]\r
-\r
-// Return to normal title levels.\r
-:leveloffset: 0\r
-\r
-include::admin/recent_staff_searches.txt[]\r
-\r
-include::admin/lsa-library_settings_editor.txt[]\r
-\r
-include::admin/lsa-statcat.txt[]\r
-\r
-\r
-Acquisitions\r
-===========\r
-\r
-include::acquisitions/introduction.txt[]\r
-\r
-include::acquisitions/selection_lists_po.txt[]\r
-\r
-include::acquisitions/receive_items_from_invoice.txt[]\r
-\r
-include::acquisitions/vandelay_acquisitions_integration.txt[]\r
-\r
-\r
-Cataloging\r
-==========\r
-\r
-Introduction\r
-------------\r
-\r
-Cataloguers should use this part for understanding the cataloguing procedures\r
-used in Evergreen.\r
-\r
-include::cataloging/batch_importing_MARC.txt[]\r
-\r
-include::cataloging/overlay_record_3950_import.txt[]\r
-\r
-include::cataloging/monograph_parts.txt[]\r
-\r
-include::cataloging/conjoined_items.txt[]\r
-\r
-\r
-Serials\r
-=======\r
-\r
-include::serials/A-intro.txt[]\r
-\r
-include::serials/B-copy_template.txt[]\r
-\r
-include::serials/C-subscription-SCV.txt[]\r
-\r
-include::serials/D-subscription-ASCV.txt[]\r
-\r
-include::serials/E-edit_subscriptions.txt[]\r
-\r
-include::serials/F-Receiving.txt[]\r
-\r
-include::serials/G-Special_issue.txt[]\r
-\r
-include::serials/H-holdings_statements.txt[]\r
-\r
-\r
-Circulation\r
-===========\r
-\r
-Introduction\r
-------------\r
-\r
-Use this section for understanding the circulation procedures in the Evergreen\r
-system. \r
-\r
-include::circulation/circulating_items.txt[]\r
-\r
-include::circulation/booking.txt[]\r
-\r
-Reports\r
-=======\r
-\r
-Introduction\r
-------------\r
-\r
-Learn how to create and use reports in Evergreen. \r
-\r
-Using the Public Access Catalog\r
-===============================\r
-\r
-Introduction\r
-------------\r
-\r
-Use this part for information about searching the Evergreen public access catalog.\r
-\r
-include::opac/my_lists.txt[]\r
-\r
-Developer Resources\r
-===================\r
-\r
-Introduction\r
-------------\r
-\r
-Developers can use this part to learn more about the programming languages,\r
-communication protocols and standards used in Evergreen. \r
-\r
-// Push titles down one level.\r
-:leveloffset: 1\r
-\r
-include::development/updating_translations_launchpad.txt[]\r
-\r
-// Return to normal title levels.\r
-:leveloffset: 0\r
-\r
-[appendix]\r
-\r
-include::attributions.txt[]\r
-\r
-include::licensing.txt[]\r
-\r
-Admonitions\r
-===========\r
-\r
-Images used for Admonitions\r
----------------------------\r
-\r
-* Note \r
-\r
-image::media/note.png[]\r
-\r
-* warning\r
-\r
-image::media/warning.png[]\r
-\r
-* caution\r
-\r
-image::media/caution.png[]\r
-\r
-* tip\r
-\r
-image::media/tip.png[]\r
-\r
-\r
+++ /dev/null
-Serials
--------
-
-This documentation is intended for users who will be ordering subscriptions, distributing issues, and receiving issues in Evergreen.
-
-Serial Control View vs. Alternate Serial Control View
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Serial Control View and Alternate Serial Control View offer you two views of Serials. Both views enable you to create subscriptions, add distributions, define captions, predict future issues, and receive items. Serial Control View was designed for users who work with a smaller number of issues and was designed to accommodate workflows in academic and special libraries. Alternate Serial Control View was designed for users who receive a larger number of issues and was designed for use in public libraries.
-
-The views are interoperable, but because the views were designed for different purposes, some differences emerge. For example, Serial Control View enables you to create and edit serials in a single tabbed interface while Alternate Serial Control View leads you through a series of steps on multiple screens. In addition, receiving functions vary between views. Both receiving interfaces enable you to batch receive issues. However, the Serials Batch Receive interface, which is associated with Alternate Serial Control View, allows for more customization of each receiving unit while the Items tab in Serial Control View allows for greater flexibility in creating multi-issue units, such as in binding serials.
-
-.Serials Control View and Alternate Serials Control View Comparison
-[options="header"]
-|====================================================================================================
-|Function |Serials Control View |Alternate Serials Control View
-|Menu Style |Menu driven |Wizard oriented
-|Setting Up subscription |No calendar drop downs |Includes calendar drop down
-|Setting up distributions |No copy template selection |Requires the selection of a copy template
-|Creating streams |No setup required |Requires streams
-|Creating captions and patterns |Wizard available |Wizard available
-|Adding Starting Issue |No holdings code wizard |Includes holdings code wizard
-|Generate Predictions |Make predictions |Generate predictions
-|Add items for special issue |No functionality |New items on issuances tab
-|====================================================================================================
-
-MFHD Records
-~~~~~~~~~~~~
-
-MARC Format for Holdings Display (MFHD) display in the PAC in addition to holding statements generated by Evergreen from subscriptions created in the Serials Control View or the Alternate Serials Control View. The MFHDs are editable as MARC but the holdings statements generated from the control view are system generated. Multiple MFHDs can be created and are tied to Organizational Units.
+++ /dev/null
-Copy Template for Serials
--------------------------
-
-A copy template enables you to specify item attributes that should be applied by default to copies of serials. You can create one copy template and apply it to multiple serials. You can also create multiple copy templates. Templates will be used in the Alternate Serial Control View or the Serial Control View.
-
-Create a copy template
-~~~~~~~~~~~~~~~~~~~~~~
-
-To create a copy template, click Admin -> Local Administration -> Copy Template Editor.
-
-. Enter a Name for the template.
-. Select an owning library from the Owning lib drop down menu. This organization owns the copy template. A staff member with permissions at that organization can modify the copy template. The menu is populated from the organizations that you created in Admin . Server Administration . Organizational Units.
-. Click the box adjacent to Circulate. If you want the item to circulate.
-. Check the box adjacent to Holdable. if patrons can place holds on the item.
-. Check the box adjacent to OPAC Visible. if you want patrons to be able to see the item in the OPAC after you receive it.
-. Select a loan duration rule from the drop down menu.
-. Select a fine level for the item from the drop down menu.
-. Select a copy Location from the drop down menu. The menu is populated from the copy locations that you created in Admin . Local Administration . Copy Locations.
-. Select a circ modifier from the drop down box. The menu is populated from the modifiers that you created in Admin . Server Administration . Circulation Modifiers.
-. Check the box adjacent to Floating. if the item is part of a floating collection.
-. Check the box adjacent to Deposit. if patrons must place a deposit on the copy before they can use it.
-. Check the box adjacent to Reference. if the item is a reference item.
-. If the item is in mint condition, then check the box adjacent to Mint Condition.
-. Enter age protection rules in the Age Protect field. Age protection allows you to control the extent to which an item can circulate after it has been received. For example, you may want to protect new copies of a serial so that only patrons who check out the item at your branch can use it.
-. Enter a message in the Alert Message field. This message will appear every time the item is checked out to a patron.
-. Enter a code from the MARC fixed fields if you want to control the circulation based on the item type in the Circ as Type field.
-. Enter a deposit amount if patrons must place a deposit on the copy before they can use it.
-. Enter the price of the item.
-. Enter the ID of the copy status in the Status field. A list of copy statuses and their IDs can be found in Admin . Server Administration . Copy Status.
-. Click Save.
-. Fine level and loan duration are required fields in the Copy Template Editor.
-
-Edit a copy template
-~~~~~~~~~~~~~~~~~~~~
-
-You can make changes to an existing copy template. Changes that you make to a copy template will apply to any items that you receive after you edited the template.
-
-. To edit a copy template, click your cursor in the row that you want to edit. The row will turn blue.
-. Double-click. The copy template will appear, and you can edit the fields.
-. After making changes, click Save.
-
-[NOTE]
-From the copy template interface, you can delete copy templates that have never been used.
+++ /dev/null
-
-Serials Control View
---------------------
-
-Serial Control View is separate from the Alternate Serial Control interface. Serial Control View enables you to manage serials in a single tabbed interface. This view also enables you to bind units. Serial Control View consists of five tabs: Items, Units, Distributions, Subscriptions, and Claims. Units and Claims are not functional in 2.0.
-
-Create a subscription
-~~~~~~~~~~~~~~~~~~~~~
-A subscription is designed to hold all information related to a single serial title. Therefore, each library is likely to have only one subscription per serial title.
-
-image::media/scv-sub.jpg[Subscription]
-
-. Click the Subscriptions link.
-. Select the branch that will own the subscription.
-. Right-click or click Actions for Selected Row, and click Add Subscription.
-. Enter the date that the subscription begins in the start date, and click Apply. You must enter the date in YYYY-MM-DD format.
-. Enter the date that the subscription ends in the end date. This field is optional.
-. Enter the difference between the nominal publishing date of an issue and the date that you expect to receive your copy in the Expected Date Offset. For example, if an issue is published the first day of each month, but you receive the copy two days prior to the publication date, then enter -2 days into this field.
-. When finished, click Create Subscription(s) in the bottom right corner of the screen.
-. A confirmation message appears. Click OK.
-
-[NOTE]
-You can add notes to the subscription by clicking Subscription Notes. These notes are currently viewable only in the staff client by clicking on the Subscription Notes button.
-
-Create a distribution
-~~~~~~~~~~~~~~~~~~~~~
-
-Distributions indicate the branches that should receive copies of a serial. Distributions work together with streams to indicate the number of copies that should be sent to each branch.
-
-image::media/scv-distr.jpg[Distribution]
-
-. Click the distributions link beneath the subscription. Right click or click Actions for Selected Rows, and click Add distribution.
-. Apply a new label to the distribution. It may be useful to identify the branch to which you are distributing these issues in this field. This field is not publicly visible and only appears when an item is received. There are no limits on the number of characters that can be entered in this field.
-. Apply a prefix to the spine label if desired. This information will display in Serial Control View when the items are received, but it does not print on the spine label in . 0.
-. Apply a suffix to the spine label if desired. This information will display in Serial Control View when the items are received, but it does not print on the spine label in . 0.
-. The holding library is filled in by default and is the library to which you attached the subscription.
-. The Legacy Record Entry contains the MFHD records that are attached to the bib record if the owning library is identical to the distribution's holding library. A distribution can thus be an extension of an MFHD record. Select the MFHD record from the drop down menu.
-. The Receive Call Number field is empty until you receive the first item. When you receive the first item, you are prompted to enter a call number. That call number will populate this drop down menu.
-. The Bind Call Number field is empty until you bind the first item. When you receive the first item, you are prompted to enter a call number. That call number will populate this drop down menu.
-. Receive Unit Template - The template that should be applied to copies when they are received. Select a template from the drop down menu.
-. Bind Unit Template - The template that should be applied to copies when they are bound. Select a template from the drop down menu.
-. When finished, click Create Distribution(s) in the bottom right corner of the screen.
-. A confirmation message appears. Click OK.
-
-[NOTE]
-You can add notes to the distribution by clicking Distribution Notes. These notes are currently viewable only in the staff client by clicking on the Distribution Notes button.
-
-Create Captions and Patterns
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-. Click the captions and patterns link beneath the subscription. Right click or click Actions for Selected Rows, and click Add Caption/Pattern.
-. Apply the type which can be for basic subscription, supplements, or indices
-. Apply active. Only one active caption and pattern is allowed per type
-. In the Pattern Code dbox, you can enter a JSON representation of the 85X tag by hand, or you can click the Pattern CodeWizard to enter the information in a user-friendly format.
-
-Use the Pattern Code Wizard
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The Pattern Code Wizard enables you to create the caption of the item and add its publication information. The Wizard is composed of five pages of questions. You can use the Next and Previous navigation buttons in the top corners to flip between pages.
-
-To add a pattern code, click Wizard.
-
-Page 1: Enumerations
-++++++++++++++++++++
-
-image::media/cap-wiz-num.jpg[Enuperation]
-
-. To add an enumeration, check the box adjacent to Use enumerations.. The enumerations conform to $a-$h of the 853,854, and 855 MARC tags.
-. A field for the First level will appear. Enter the enumeration for the first level. A common first level enumeration is volume, or "v."
-. Click Add Enumeration.
-. A field for the Second level will appear. Enter the enumeration for the second level. A common first level enumeration is number, or "no."
-. Enter the number of bibliographic units per next higher level. This conforms to $u in the 853, 854, and 855 MARC tags.
-. Choose the enumeration scheme from the drop down menu. This conforms to $v in the 853, 854, and 855 MARC tags.
-+
-[NOTE]
-You can add up to six levels of enumeration.
-+
-. Add Alternate Enumeration if desired.
-. When you have completed the enumerations, click Next.
-
-
-Page 2: Calendar
-++++++++++++++++
-
-image::media/cap-wiz-cal.jpg[Enumeration]
-
-. To use months, seasons, or dates in your caption, check the box adjacent to Use calendar changes.
-. Identify the point in the year at which the highest level enumeration caption changes.
-. In the Type drop down menu, select the points during the year at which you want the calendar to restart.
-. In the Point drop down menu, select the specific time at which you would like to change the calendar
-. To add another calendar change, click Add Calendar Change. There are no limits on the number of calendar changes that you can add.
-. When you have finished the calendar changes, click Next.
-
-Page 3: Chronology
-++++++++++++++++++
-
-image::media/cap-wiz-chron.jpg[Chronology]
-
-. To add chronological units to the captions, check the box adjacent to Use chronology captions.
-. Choose a chronology for the first level. If you want to display the terms such as "year" and "month" next to the chronology caption in the catlaog, then check the box beneath Display in holding field.
-. To include additional levels of chronology, click Add Chronology Caption. Each level that you add must be smaller than the previous level.
-. After you have completed the chronology caption, click Next.
-
-Page 4: Compress and Expand Captions
-++++++++++++++++++++++++++++++++++++
-
-image::media/cap-wiz-freq.jpg[Compress or Expand]
-
-. Select the appropriate option for compressing or expanding your captions in the catalog from the compressibility and expandability drop down menu. The entries in the drop down menu correspond to the indicator codes and the subfield $w in the 853 tag. Compressibility and expandability correspond to the first indicator in the 853 tag.
-. Choose the appropriate caption evaluation from the drop down menu.
-. Choose the frequency of your publication from the drop down menu. For irregular frequencies, you may wish to select use number of issues per year, and enter the total number of issues that you receive each year. However, in the . 0 release, recommended practice is that you use only regular frequencies. Planned development will create an additional step to aid in the creation of irregular frequencies.
-. Click Next.
-
-Page 5: Regularity Information
-++++++++++++++++++++++++++++++
-
-image::media/cap-wiz-chan.jpg[Changes]
-
-. If needed, check box for Use specific regularity information
-. Choose the appropriate information for combined, omitted or published issues
-. Choose the appropriate frequency and issue
-. Add additional rows as required
-
-Page 5: Finish Captions and Patterns
-++++++++++++++++++++++++++++++++++++
-
-. To complete the wizard, click Create Pattern Code.
-. Return to Subscription Details.
-. Confirm that the box adjacent to Active is checked. Click Save Changes. The row is now highlighted gray instead of orange.
-
-Creating an Issuance
-~~~~~~~~~~~~~~~~~~~~
-
-The Issuances function enables you to manually create an issue. Evergreen will use the initial issue that you manually create to predict future issues.
-
-image::media/scv-iss.jpg[Issue]
-
-. Click the Issuances link beneath the subscription. Right click or click Actions for Selected Rows, and click Issuance.
-. Click the holdings code and click apply. Currently there is no wizard to create this code. The wizard is only available in the Alternate Serials Control View.
-. Click the Caption/Pattern selecting the appropriate patternand click apply
-. Click the date published and enter date information (format YYYY-MM-DD) and click apply
-. Click label, enter label and click apply
-. When finished, click Create Issuance(s) in the bottom right corner of the screen.
-. A confirmation message appears. Click OK.
-
-Generate Prediction
-~~~~~~~~~~~~~~~~~~~
-
-. Open the Subscriptions tab.
-. Right-click or click Actions for Selected Row -> Make predictions.
-. A pop up box will aks you how many items you want to predict. Enter the number, and click OK.
-. A confirmation message will appear. Click OK.
-. Click the Issuances link to view the predicted issues.
+++ /dev/null
-Alternate Serial Control View
------------------------------
-
-Using the Alternate Serial Control View, you can create a subscription, a distribution, a stream, and a caption and pattern, and you can generate predictions and receive issues. To access Alternate Serial Control View, open a serials record, and click Actions for this Record >> Alternate Serial Control. This opens the Subscriptions interface
-
-. Create a subscription
-. Create a distribution
-. Create a a stream (within the distribution)
-. Create a caption and pattern (or import from bibliographic or legacy serial records)
-. Create at least the first issuance and generate predictions
-
-Creating a Subscription
-~~~~~~~~~~~~~~~~~~~~~~~
-
-A subscription is designed to hold all information related to a single serial title. Therefore, each library is likely to have only one subscription per serial title.
-
-image::media/ascv-sub.jpg[Creating a Subscription]
-
-. Add new subscriptions to a serials record that exists in the catalog.
-. Create a subscription
-. Click New Subscription.
-. Select an owning library. The owning library indicates the organizational unit(s) whose staff can use this subscription. This menu is populated with the shortnames that you created for your libraries in the organizational units tree in Admin . Server Administration . Organizational Units. The rule of parental inheritance applies to this list. For example, if a system is made the owner of a subscription, then users, with appropriate permissions, at the branches within the system could also use this subscription.
-. Enter the date that the subscription begins in the start date. Recommended practice is that you select the date from the drop down calendar although you can manually enter a date. Owning library and start date are required fields in the new subscription pop up box.
-. Enter the date that the subscription ends in the end date. Recommended practice is to select a date from the drop down calendar, but you can manually enter a date, also.
-. Enter the difference between the nominal publishing date of an issue and the date that you expect to receive your copy in the Expected Date Offset. For example, if an issue is published the first day of each month, but you receive the copy two days prior to the publication date, then enter -2 days into this field.
-. Click Save.
-
-After you save the subscription, it will appear in a list with a hyperlinked ID number. Use the drop down menu at the top of the screen to view subscriptions at other organizations.
-
-Creating a Distribution
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Distributions indicate the branches that should receive copies of a serial. Distributions work together with streams to indicate the number of copies that should be sent to each branch.
-
-image::media/ascv-distr.jpg[Creating a Distribution]
-
-. Click the Distributions tab.
-. Click New Distribution.
-. Enter a name for the distribution in the Label field. It may be useful to identify the branch to which you are distributing these issues in this field. This field is not publicly visible and only appears when an item is received. There are no limits on the number of characters that can be entered in this field.
-. Select a holding library from the drop down menu. The holding library is the branch that will receive the copies.
-. Select a copy template from the Receive Unit Template drop down menu. This menu is populated with the copy templates that you created in Copy Template Editor.
-+
-[NOTE]
-Label, Holding Library, and Receive Unit Template are required fields in the new distribution pop up box.
-+
-. Ignore the fields, Unit Label Prefix and Unit Label Suffix. These fields are not functional in Alternate Serial Control View.
-. Click Save. The distribution will appear in a list in the Distributions tab in the Subscription Details.
-
-Creating a Stream
-~~~~~~~~~~~~~~~~~
-
-Distributions work together with streams to indicate the number of copies that should be sent to each branch. Distributions identify the branches that should receive copies of a serial. Streams identify how many copies should be sent to each branch. Streams are intended for copies that are received on a recurring, even if irregular, basis.
-
-. Click the hyperlinked title of the distribution. The number of streams that have already been created for this distribution displays adjacent to the title. You can choose one of two ways to create a stream: New Stream or Create Many Streams. The New Stream button allows you to create one new stream and assign it a routing label.
-. Click New Stream
-. Enter a routing label so that the copy could be read by specific users or departments before the copy is shelved. The routing label appears during receiving and could be added to routing lists; it is not viewable by the public. Routing lists do not print from in 2.0. This field is optional.
-. Click Save.
-+
-[NOTE]
-The "Create Many Streams button" allows you to create multiple streams at once, but it does not allow you to add a routing label when you create the stream.
-+
-. Click Create Many Streams.
-. Enter the number of streams that you want to create in the How many. Field.
-. Click Create.
-
-Creating a Caption and Pattern
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The Captions and Patterns wizard allows you to enter caption and pattern data as it is described by the 853, 854, and 855 MARC tags. These tags allow you to define how issues will be captioned, and how often the library receives issues of the serial.
-
-. Open the Subscription Details.
-. Click the Captions and Patterns tab.
-. Click Add Caption and Pattern.
-. In the Type drop down box, select the MARC tag to which you would like to add data.
-. In the Pattern Code drop down box, you can enter a JSON representation of the 85X tag by hand, or you can click the Wizard to enter the information in a user-friendly format.
-. The Caption and Pattern that you create is Active by default, but you can deactivate a caption and pattern at a later time by unchecking the box.
-
-
-[NOTE]
-A subscription may have multiple captions and patterns listed in the subscripiton details, but only one Caption and Pattern can be active at any time. If you want to add multiple patterns, e.g. for Basic and Supplement, Click Add Caption and Pattern.
-
-
-Use the Pattern Code Wizard
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The Pattern Code Wizard enables you to create the caption of the item and add its publication information. The Wizard is composed of five pages of questions. You can use the Next and Previous navigation buttons in the top corners to flip between pages.
-
-To add a pattern code, click Wizard.
-
-Page 1: Enumerations
-++++++++++++++++++++
-
-image::media/cap-wiz-num.jpg[Enuperation]
-
-. To add an enumeration, check the box adjacent to Use enumerations.. The enumerations conform to $a-$h of the 853,854, and 855 MARC tags.
-. A field for the First level will appear. Enter the enumeration for the first level. A common first level enumeration is volume, or "v."
-. Click Add Enumeration.
-. A field for the Second level will appear. Enter the enumeration for the second level. A common first level enumeration is number, or "no."
-. Enter the number of bibliographic units per next higher level. This conforms to $u in the 853, 854, and 855 MARC tags.
-. Choose the enumeration scheme from the drop down menu. This conforms to $v in the 853, 854, and 855 MARC tags.
-+
-[NOTE]
-You can add up to six levels of enumeration.
-+
-. Add Alternate Enumeration if desired.
-. When you have completed the enumerations, click Next.
-
-Page 2: Calendar
-++++++++++++++++
-
-image::media/cap-wiz-cal.jpg[Enumeration]
-
-. To use months, seasons, or dates in your caption, check the box adjacent to Use calendar changes.
-. Identify the point in the year at which the highest level enumeration caption changes.
-. In the Type drop down menu, select the points during the year at which you want the calendar to restart.
-. In the Point drop down menu, select the specific time at which you would like to change the calendar
-. To add another calendar change, click Add Calendar Change. There are no limits on the number of calendar changes that you can add.
-. When you have finished the calendar changes, click Next.
-
-Page 3: Chronology
-++++++++++++++++++
-
-image::media/cap-wiz-chron.jpg[Chronology]
-
-. To add chronological units to the captions, check the box adjacent to Use chronology captions.
-. Choose a chronology for the first level. If you want to display the terms, "year" and "month" next to the chronology caption in the catlaog, then check the box beneath Display in holding field.
-. To include additional levels of chronology, click Add Chronology Caption. Each level that you add must be smaller than the previous level.
-. After you have completed the chronology caption, click Next.
-
-Page 4: Compress and Expand Captions
-++++++++++++++++++++++++++++++++++++
-
-image::media/cap-wiz-freq.jpg[Compress or Expand]
-
-. Select the appropriate option for compressing or expanding your captions in the catalog from the compressibility and expandability drop down menu. The entries in the drop down menu correspond to the indicator codes and the subfield $w in the 853 tag. Compressibility and expandability correspond to the first indicator in the 853 tag.
-. Choose the appropriate caption evaluation from the drop down menu.
-. Choose the frequency of your publication from the drop down menu. For irregular frequencies, you may wish to select use number of issues per year, and enter the total number of issues that you receive each year. However, in the . 0 release, recommended practice is that you use only regular frequencies. Planned development will create an additional step to aid in the creation of irregular frequencies.
-. Click Next.
-
-Page 5: Regularity Information
-++++++++++++++++++++++++++++++
-
-image::media/cap-wiz-chan.jpg[Changes]
-
-. If needed, check box for Use specific regularity information
-. Choose the appropriate information for combined, omitted or published issues
-. Choose the appropriate frequency and issue
-. Add additional rows as required
-
-Page 5: Finish Captions and Patterns
-++++++++++++++++++++++++++++++++++++
-
-. To complete the wizard, click Create Pattern Code.
-. Return to Subscription Details.
-. Confirm that the box adjacent to Active is checked. Click Save Changes. The row is now highlighted gray instead of orange.
-
-Creating an Issuance
-~~~~~~~~~~~~~~~~~~~~
-
-The Issuances tab enables you to manually create an issue. Evergreen will use the initial issue that you manually create to predict future issues.
-
-image::media/ascv-issues.jpg[Changes]
-
-. Click the Issuances tab in the Subscription Details.
-. Click New Issuance.
-. The Subscription, Creator, and Editor fields contain subscription and user IDs, respectively. These fields are disabled because Evergreen automatically fills in these fields.
-. Enter a name for this issuance in the Label field. There are no limits on the number of characters that can be entered in this field. You may want to enter the month and year of the publication in hand.
-. Enter the Date Published of the issuance that you are editing. Recommended practice is that you select the date from the drop down calendar although you can manually enter a date. If you are creating one manual issue before automatically predicting more issues, then this date should be the date of the most current issue before the prediction starts.
-. Select a Caption/Pattern from the drop down menu. The numbers in the drop down menu correspond to the IDs of the caption/patterns that you created.
-. The Holding Type appears by default and corresponds to the Type that you selected when you created the Caption/Pattern.
-. In the holding code area of the New Issuance dialog, click Wizard. The Wizard enables you to add holdings information.
-. Enter the volume of the item in hand in the v. field.
-. Enter the number of the item in hand in the no. field.
-. Enter the year of publication in the Year field.
-. Enter the month of publication in the Month field if applicable. You must enter the calendar number of the month rather than the name of the month. For example, enter 12 if the item in hand was published in December.
-. Enter the day of publication in the day field if applicable.
-. Click Compile to generate the holdings code.
-
-Generate Item Predictions
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-After you manually create the first issue, Evergreen will predict future issuances. Use the Generate Predictions functionality to predict future issues.
-
-. Click Subscription Details -> Issuances -> Generate Predictions.
-. Choose the length of time for which you want to predict issues. If you select the radio button to predict until end of subscription, then Evergreen will predict issues until the end date that you created when you created the subscription. See simplesect . 1 for more information. If you do not have an end date, select the radio button to predict a certain number of issuances, and enter a number in the field.
-. Click Generate.
-. Evergreen will predict a run of issuances and copies. The prediction will appear in a list.
-. You can delete the first, manual issuance by clicking the check box adjacent to the issuance and clicking Delete Selected.
+++ /dev/null
-Edit Subscriptions
-------------------
-Subscriptions can be edite to change the caption and pattern and other information.
-
-Serials Control View
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-. To access Serial Control View, open a serials record, and click Actions for this Record >> Serial Control. This opens the Subscriptions interface
-. Click the subscriptions tab
-. Click on the appropriate link to edit
-
-
-Alternate Serials Control View
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-. To access Alternate Serial Control View, open a serials record, and click Actions for this Record >> Alternate Serial Control. This opens the Subscriptions interface
-. Click the hyperlinked ID number to edit the subscription.
-. Click on the appropriate tab to edit the information
-
+++ /dev/null
-Receiving
----------
-You can receive either through the Serials Control View or in Batch Receive with the simple or advanced interface
-
-Serials Control View Receiving
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-image::media/scv-rec.jpg[Receiving]
-
-. To receive items, click the Receive radio button. In the top half of the screen, the items that have yet to be received are displayed. In the bottom half of the screen, recently received items are displayed.
-. Select the branch that will receive the items from the drop down box.
-. Select the issue that you want to receive.
-. Select the current working unit. Click Set Current Unit, located in the lower right corner of the screen. A drop down menu will appear.
- * If you want to barcode each item individually, select Auto per item. This setting is recommended for most receiving processes.
- * If you want each item within a unit to share the same barcode, then select New Unit. This setting is advised for most binding processes.
- * If you want the item to be received or bound into an existing item, select Recent and select the desired issue. To making a change in bound items, receive or bind the items into an already existing unit.
-. Click Receive/Move Selected.
-. Enter a barcode and call number if prompted to do so.
-. A message confirming receipt of the item appears. Click OK.
-. The screen refreshes. In the top half of the screen, the item displays a received date. In the bottom half of the screen, the item that you have just received is now at the top of the list of the received items.
-
-After receiving items, you can view the updated holdings in the OPAC. In this example, the legacy MFHD record and the items recently received in the serial control view display together in the MFHD statement.
-
-Batch Receiving
-~~~~~~~~~~~~~~~
-
-You can batch receive items through a simple or an advanced interface. The simple interface does not allow you to add barcodes or use the copy template. These items are also not visible in the OPAC. The advanced interface enables you to use the copy templates that you created, add barcodes, and make items OPAC visible and holdable.
-
-You can access both Batch Receive interfaces from two locations in the ILS. From the Subscription Details screen, you can click Batch Item Receive. You can also access these interfaces by opening the catalog record for the serial, and clicking Actions for this Record . Serials Batch Receive.
-
-Simple Batch Receiving
-^^^^^^^^^^^^^^^^^^^^^^
-Follow these steps to receive items in batch in a simple interface.
-
-image::media/scv-srec.jpg[Receiving]
-
-. The Batch Receive interface displays issues that have not yet been received. The earliest expected issue appears at the top of the list.
-. In the right lower corner, you see a check box to Create Units for Received Items. If you do not check this box, then you will receive items in simple mode.
-. Click Next.
-. In simple mode, the distributions that you created are displayed. They are marked received by default. If you hover over the branch name, you can view the name of the distribution and its stream.
-. You can receive and add a note to each item individually, or you can perform these actions on all of the distributions and streams at once. To do so, look above the line, and enter the note that you want to apply to all copies and confirm that the box to Receive. is checked.
-. Click Apply. The note should appear in the note field in each distribution.
-. Then click Receive Selected Items.
-. The received items are cleared from the screen.
-
-Advanced Batch Receiving
-^^^^^^^^^^^^^^^^^^^^^^^^
-Follow these steps to receive items in batch in a simple interface.
-
-image::media/scv-srec.jpg[Receiving]
-
-. The Batch Receive interface displays issues that have not yet been received. The earliest expected issue appears at the top of the list.
-. If you want to barcode each copy, display it in the catalog, and make it holdable, then check the box adjacent to Create Units for Received Items in the lower right side of the screen.
-. This will allow you to utilize the copy templates and input additional information about the copy:
-. Barcode - You can scan printed barcodes into the barcode field for each copy, or you can allow the system to auto-generate barcodes. To auto-generate barcodes, check the box adjacent to Auto-generate., and enter the first barcode into the barcode field in the first row of the table. Then press the Tab key. The remaining barcode fields will automatically populate with the next barcodes in sequence, including check digits.
- . Circ Modifiers - The circ modifiers drop down menu is populated with the circulation modifiers that you created in Admin . Server Administration . Circulation Modifiers. If you entered a circ modifier in the copy template that you created for this subscription, then it will appear by default in the distributions.
- . Call Number - Enter a call number. Any item with a barcode must also have a call number.
- . Note - Add a note. There are no limits on the number of characters that can be entered in this field. The note only displays in this screen.
- . Copy Location - The copy location drop down menu is populated with the copy locations that you created in Admin . Local Administration . Copy Location Editor. If you entered a copy location in the copy template that you created for this subscription, then it will appear by default in the distributions.
- . Price - If you entered a price in the copy template that you created for this subscription, then it will appear by default in the distributions. You can also manually enter a price if you did not include one in the copy template.
- . Receive - The boxes in the Receive Column are checked by default. Uncheck the box if you do not want to receive the item. Evergreen will retain the unreceived copies and will allow you to receive them at a later time.
-. When you are ready to receive the items, click Receive Selected Items.
-. The items that have been received are cleared from the Batch Receive interface. The remaining disabled item is an unreceived item.
-. If the items that you received have a barcode, a copy template that was set to OPAC Visible, and are assigned a shelving location that is OPAC Visible, then you can view the received items in the catalog. Notice that the Holdings Summary has been updated to reflect the most recent addition to the holdings.
+++ /dev/null
-Special Issues
---------------
-Currently, Setting up the special issue can only be done through the Alternate Serials Control view.
-
-. Create an issuance in the Serials Control View or the Alternate Serials Control View
-. In the Alternate Serials Control View, click on the name of your special issue in the list of issuances.
-. Click the New Items button
-. Enter the appropriate information
-. The item is now ready to receive. If you complete the Date Received field and change the status to received then it will receive the issue but it won't create the associated copy record whereas if you leave it blank and receive the item through the Serials Control View or Batch Receive function you can create the Copy Record at that time.
+++ /dev/null
-Holdings
---------
-
-System Generated Holdings Statement
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-As issues are received, Evergreen creates a holding statement in the OPAC based on what is set up in the Caption and Patterns of the subscription. The systems generated holdings can only be edited by changing caption and pattern information and there is no abilitiy to edit the statement as free text.
-
-MARC Format for Holdings Display (MFHD)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Evergreen users can create, edit and delete their own MFHD.
-
-Create an MFHD record
-^^^^^^^^^^^^^^^^^^^^^
-
-. Open a serial record, and in the bottom right corner above the copy information, click Add MFHD Record. You can also add the MFHD statement by clicking Actions for this Record .MFHD Holdings .Add MFHD Record.
-. A message will confirm that you have created the MFHD Record. Click OK.
-. Click Reload in the top left corner of the record.
-. The Holdings Summary will appear. Click Edit Holdings in the right corner.
-. Click Edit Record.
-. The MFHD window will pop up. Enter holdings information. Click Save MFHD.
-. Close the MFHD window.
-. Click Reload in the top left corner of the record. The Holdings Summary will reflect the changes to the MFHD statement.
-
-Edit a MFHD record
-^^^^^^^^^^^^^^^^^^
-
-. Open a serial record, and in the Actions for this Record, click MFHD Record>>Edit MFHD Record and select the appropriate MFHD.
-. Edit the MFHD
-. Click Save MFHD
-
-Delete a MFHD Record
-^^^^^^^^^^^^^^^^^^^^
-
-. Open a serial record, and in the Actions for this Record, click MFHD Record>>Delete MFHD Record and select the appropriate MFHD.
-. Click to confirm the deletion of the MFHD
projects / evergreen / masslnc.git / commitdiff
