+++ /dev/null
-<?xml version="1.0" encoding="utf-8"?>\r
-<chapter xml:id="actiontriggers" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
- <info>\r
- <title>Action Triggers</title>\r
- <indexterm><primary>action triggers</primary></indexterm> \r
- </info>\r
- <para>Action Triggers were introduced to Evergreen in 1.6. They allow administrators the ability to set up actions for specific events. They are useful for notification events such as \r
- hold notifications.</para>\r
- \r
- \r
- <para>To access the Action Triggers module, select\r
- <menuchoice>\r
- <guimenu>Admin</guimenu> \r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guisubmenu>Notifications / Action triggers</guisubmenu>\r
- </menuchoice>\r
- </para>\r
- <note><para>You must have Local Administrator permissions to access the Action Triggers module.</para></note>\r
- <para>You will notice four tabs on this page: <guilabel><link linkend="eventdefinitions">Event Definitions</link></guilabel>, <guilabel><link linkend="Hooks">Hooks</link></guilabel>, \r
- <guilabel><link linkend="Reactors">Reactors</link></guilabel> and <guilabel><link linkend="Validators">Validators</link></guilabel>.</para>\r
- \r
- <section xml:id="eventdefinitions">\r
- <title>Event Definitions</title>\r
- <indexterm><primary>action triggers</primary><secondary>event definitions</secondary></indexterm> \r
- <para><guilabel>Event Definitions</guilabel> is the main tab and contains the key fields when working with action triggers. These fields include:</para>\r
- <table xml:id="eventdefinitionstable">\r
- <title>Action Trigger Event Definitions</title>\r
- <tgroup cols="2">\r
- <colspec colnum="1" colname="col1" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="col2" colwidth="3.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Field</entry>\r
- <entry>Description</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry><guilabel>Owning library</guilabel></entry>\r
- <entry>The shortname of the library for which the action / trigger / hook is defined.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Name</guilabel></entry>\r
- <entry>The name of the trigger event, that links to a trigger event environment containing a set of fields \r
- that will be returned to the <link linkend="Validators">Validators</link> / <link linkend="Reactors">Reactors</link> for processing.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel><link linkend="Hooks">Hooks</link></guilabel></entry>\r
- <entry>The name of the trigger for the trigger event. The underlying action_trigger.hook table defines the Fieldmapper \r
- class in the core_type column off of which the rest of the field definitions <quote>hang</quote>. </entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Enabled</guilabel></entry>\r
- <entry>Sets the given trigger as enabled or disabled. This must be set to enabled for the Action trigger to run.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Processing Delay</guilabel></entry>\r
- <entry>Defines how long after a given trigger / hook event has occurred before the associated action (<quote>Reactor</quote>) \r
- will be taken.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Processing Delay Field</guilabel></entry>\r
- <entry>Defines the field associated with the event on which the processing delay is calculated. For example, the processing delay \r
- context field on the hold.capture hook (which has a core_type of ahr) is <emphasis>capture_time</emphasis>.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Processing Group Context Field</guilabel></entry>\r
- <entry>Used to batch actions based on its associated group.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel><link linkend="Validators">Validators</link></guilabel></entry>\r
- <entry>The subroutines receive the trigger environment as an argument (see the linked <emphasis>Name</emphasis> for \r
- the environment definition) and returns either <emphasis>1</emphasis> if the validator is <emphasis>true</emphasis> or <emphasis>0</emphasis> \r
- if the validator returns <emphasis>false</emphasis>.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel><link linkend="Reactors">Reactors</link></guilabel></entry>\r
- <entry>Links the action trigger to the Reactor.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Max Event Validity Delay</guilabel></entry>\r
- <entry>Define the threshold for how far back the action_trigger_runner.pl script should reach to generate \r
- a batch of events.</entry>\r
- </row>\r
- </tbody> \r
- </tgroup>\r
- </table>\r
- \r
- <procedure>\r
- <title>Creating Action Triggers</title>\r
- <indexterm><primary>action triggers</primary><secondary>creating</secondary></indexterm> \r
- <step>\r
- <para>From the top menu, select\r
- <menuchoice>\r
- <guimenu>Admin</guimenu> \r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guisubmenu>Notifications / Action triggers</guisubmenu>\r
- </menuchoice>\r
- </para>\r
- </step>\r
- <step><para>Click on the <guibutton>New</guibutton> button.</para></step>\r
- <step><para>Select an <guilabel>Owning Library</guilabel>.</para></step>\r
- <step><para>Create a unique <guilabel>Name</guilabel> for your new action trigger.</para></step> \r
- <step><para>Select the <guilabel>Hook</guilabel>.</para></step>\r
- <step><para>Check the <guilabel>Enabled</guilabel> check box.</para></step>\r
- \r
- <step><para>Create a unique <guilabel>Name</guilabel> for your new action trigger.</para></step>\r
- <step><para>Set the <guilabel>Processing Delay</guilabel> in the appropriate format. Eg. <emphasis class="bold">7 days</emphasis> to run 7 days from the trigger event \r
- or <emphasis class="bold">00:01:00</emphasis> to run 1 hour after the <guilabel>Processing Delay Context Field</guilabel>.</para></step>\r
- <step><para>Set the <guilabel>Processing Delay Context Field</guilabel> and <guilabel>Processing Group Context Field</guilabel>.</para></step> \r
- <step><para>Select the <guilabel>Validator</guilabel>, <guilabel>Reactor</guilabel>, <guilabel>Failure Cleanup</guilabel> and <guilabel>Success Cleanup</guilabel>.\r
- </para></step> \r
- <step><para>Set the <guilabel>Processing Delay Context Field</guilabel> and <guilabel>Processing Group Context Field</guilabel>.</para></step> \r
- <step preformance="optional"><para>Enter text in the <guilabel>Template</guilabel> text box if required. These are for email messages. Here is an sample \r
- template for sending 90 day overdue notices:</para>\r
-<programlisting><![CDATA[\r
-\r
-[%- USE date -%]\r
-[%- user = target.0.usr -%]\r
-To: [%- params.recipient_email || user.email %]\r
-From: [%- params.sender_email || default_sender %]\r
-Subject: Overdue Items Marked Lost\r
-\r
-Dear [% user.family_name %], [% user.first_given_name %]\r
-The following items are 90 days overdue and have been marked LOST.\r
-[%- params.recipient_email || user.email %][%- params.sender_email || default_sender %]\r
-[% FOR circ IN target %]\r
- Title: [% circ.target_copy.call_number.record.simple_record.title %] \r
- Barcode: [% circ.target_copy.barcode %] \r
- Due: [% date.format(helpers.format_date(circ.due_date), '%Y-%m-%d') %]\r
- Item Cost: [% helpers.get_copy_price(circ.target_copy) %]\r
- Total Owed For Transaction: [% circ.billable_transaction.summary.total_owed %]\r
- Library: [% circ.circ_lib.name %]\r
-[% END %]\r
-\r
-\r
-[% FOR circ IN target %]\r
- Title: [% circ.target_copy.call_number.record.simple_record.title %] \r
- Barcode: [% circ.target_copy.barcode %] \r
- Due: [% date.format(helpers.format_date(circ.due_date), '%Y-%m-%d') %]\r
- Item Cost: [% helpers.get_copy_price(circ.target_copy) %]\r
- Total Owed For Transaction: [% circ.billable_transaction.summary.total_owed %]\r
- Library: [% circ.circ_lib.name %]\r
-[% END %]\r
-]]>\r
-</programlisting> \r
- </step> \r
- <step><para>Once you are satisfied with your new event trigger , click the <guibutton>Save</guibutton> button located at the bottom of the \r
- form</para></step>\r
- </procedure>\r
- <tip><para>A quick and easy way to create new action triggers is to clone an existing action trigger.</para></tip>\r
- <procedure>\r
- <title>Cloning Existing Action Triggers</title>\r
- <step>\r
- <para>Check the check box next to the action trigger you wish to clone</para>\r
- </step>\r
- <step>\r
- <para>Click the <guibutton>Clone Selected</guibutton> on the top left of the page.</para>\r
- </step>\r
- <step>\r
- <para>An editing window with open. Notice that the fields will be populated with content from the cloned action trigger. Edit as necessary and \r
- give the new action trigger a unique <guilabel>Name</guilabel>.</para>\r
- </step>\r
- <step>\r
- <para>Click <guilabel>Save</guilabel>.</para>\r
- </step>\r
- </procedure>\r
- <procedure>\r
- <title>Editing Action Triggers</title>\r
- <step>\r
- <para>Check the check box next to the action trigger you wish to delete</para>\r
- </step>\r
- <step>\r
- <para>Click the <guibutton>Delete Selected</guibutton> on the top left of the page.</para>\r
- </step>\r
- </procedure>\r
- \r
- <note><para>Before deleting an action trigger, you should consider disabling it through the editing form. This way you can simply enable it if you decide that you would like to use \r
- the action trigger in the future.</para></note>\r
- <procedure>\r
- <title>Deleting Action Triggers</title>\r
- <step>\r
- <para>Check the check box next to the action trigger you wish to delete</para>\r
- </step>\r
- <step>\r
- <para>Click the <guibutton>Delete Selected</guibutton> on the top left of the page.</para>\r
- </step>\r
- </procedure>\r
- </section>\r
- <section xml:id="Hooks">\r
- <title>Hooks</title>\r
- <indexterm><primary>action triggers</primary><secondary>hooks</secondary></indexterm>\r
- <para><guilabel>Hooks</guilabel> define the Fieldmapper class in the core_type column off of which the rest of the field definitions <quote>hang</quote>.</para>\r
- <table xml:id="Hookstable">\r
- <title>Hooks</title>\r
- <tgroup cols="2">\r
- <colspec colnum="1" colname="col1" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="col2" colwidth="3.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Field</entry>\r
- <entry>Description</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry><guilabel>Hook Key</guilabel></entry>\r
- <entry>A unique name given to the hook.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Core Type</guilabel></entry>\r
- <entry>Used to link the action trigger to the IDL class in fm_IDL.xml</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Description</guilabel></entry>\r
- <entry>Text to describe the purpose of the hook. </entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Passive</guilabel></entry>\r
- <entry>Indicates whether or not an event is created by direct user action or is circumstantial.</entry>\r
- </row>\r
- </tbody> \r
- </tgroup>\r
- </table>\r
- <para>You may also create, edit and delete Hooks but the <guilabel>Core Type</guilabel> must refer to an IDL class in the fm_IDL.xml file.</para>\r
- </section> \r
- <section xml:id="Reactors">\r
- <title>Reactors</title>\r
- <indexterm><primary>action triggers</primary><secondary>reactors</secondary></indexterm>\r
- <para><guilabel>Reactors</guilabel> link the trigger definition to the action to be carried out.</para>\r
- <table xml:id="Reactorstable">\r
- <title>Action Trigger Reactors</title>\r
- <tgroup cols="2">\r
- <colspec colnum="1" colname="col1" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="col2" colwidth="3.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Field</entry>\r
- <entry>Description</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry><guilabel>Module Name</guilabel></entry>\r
- <entry>The name of the Module to run if the action trigger is validated. It must be defined as a subroutine in \r
- <filename>/openils/lib/perl5/OpenILS/Application/Trigger/Reactor.pm</filename> or as a module\r
- in <filename>/openils/lib/perl5/OpenILS/Application/Trigger/Reactor/*.pm</filename>.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Description</guilabel></entry>\r
- <entry>Description of the Action to be carried out.</entry>\r
- </row>\r
- </tbody> \r
- </tgroup>\r
- </table>\r
- <para>You may also create, edit and delete Reactors. Just remember that their must be an associated subroutine or module in the Reactor Perl module.</para>\r
- </section> \r
- <section xml:id="Validators">\r
- <title>Validators</title>\r
- <indexterm><primary>action triggers</primary><secondary>validators</secondary></indexterm>\r
- <para><guilabel>Validators</guilabel> set the validation test to be preformed to determine whether the action trigger is executed.</para>\r
- <table xml:id="Validatorstable">\r
- <title>Action Trigger Validators</title>\r
- \r
- <tgroup cols="2">\r
- <colspec colnum="1" colname="col1" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="col2" colwidth="3.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Field</entry>\r
- <entry>Description</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry><guilabel>Module Name</guilabel></entry>\r
- <entry>The name of the subroutine in \r
- <filename>/openils/lib/perl5/OpenILS/Application/Trigger/Reactor.pm</filename> to validate the action trigger.</entry>\r
- </row>\r
- <row>\r
- <entry><guilabel>Description</guilabel></entry>\r
- <entry>Description of validation test to run.</entry>\r
- </row>\r
- </tbody> \r
- </tgroup>\r
- </table>\r
- <para>You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the <filename>Reactor.pm</filename> Perl module.</para>\r
- </section> \r
- <section xml:id="ProcessingActionTriggers"> \r
- <title>Processing Action Triggers</title>\r
- <indexterm><primary>action triggers</primary><secondary>processing</secondary></indexterm>\r
- <para>To run the action triggers, an Evergreen administrator will need to run the trigger processing script <command>/openils/bin/action_trigger_runner.pl \r
- <option>--process-hooks</option> <option>--run-pending</option></command>. This should be set up as a cron job to run \r
- periodically.</para> \r
- <para>You have several options when running the script:</para>\r
- <itemizedlist>\r
- <listitem><option>--run-pending</option>: Run the pending events.</listitem>\r
- <listitem><option>--process-hooks</option>: Create hook events</listitem>\r
- <listitem><option>--osrf-config=[<varname>config_file</varname>]</option>: OpenSRF core config file. Defaults to: \r
- <filename>/openils/conf/opensrf_core.xml</filename>.</listitem>\r
- <listitem><option>--custom-filters=[<varname>filter_file</varname>]</option>: File containing a JSON Object which describes any hooks that should\r
- use a user-defined filter to find their target objects. Defaults to: <filename>/openils/conf/action_trigger_filters.json</filename></listitem>\r
- <listitem><option>--max-sleep=[<varname>seconds</varname>]</option>: When in process-hooks mode, wait up to [<varname>seconds</varname>] for the lock file to go away. \r
- Defaults to 3600 (1 hour).</listitem>\r
- <listitem><option>--hooks=hook1[,hook2,hook3,...]</option>: Define which hooks to create events for. If none are defined, it defaults to the list of hooks defined \r
- in the <option>--custom-filters</option> option.</listitem>\r
- <listitem><option>--debug-stdout</option>: Print server responses to stdout (as JSON) for debugging.</listitem>\r
- <listitem><option>--lock-file=[<varname>file_name</varname>]</option>: Sets the lock file for the process.</listitem>\r
- <listitem><option>--help</option>: Show help information.</listitem>\r
- </itemizedlist>\r
- </section> \r
-</chapter>\r
-\r
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8'?>\r
-<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xml:lang="EN" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="admin-booking">\r
- <info>\r
- <title>Booking Module Administration</title>\r
- <legalnotice>\r
- <para><emphasis role="bold">Adapted with permission from original material by the <link\r
- xlink:title="http://docs.evergreen-ils.org/1.6/draft/html/"\r
- xlink:href="http://docs.evergreen-ils.org/1.6/draft/html/">Evergreen\r
- Community</link></emphasis></para>\r
- </legalnotice>\r
-\r
- <abstract>\r
- <para>The Evergreen booking module is included in Evergreen 1.6.1.x and above.The following\r
- documentation will include information about making cataloged items bookable; making\r
- non-bibliographic items bookable; and setting permissions in the booking module for\r
- staff.</para>\r
- </abstract>\r
- </info>\r
- <section xml:id="MakeCataloguedItemBookable">\r
- <title>Make a Cataloged Item Bookable in Advance</title>\r
- <indexterm><primary>booking reservation</primary><secondary>making a cataloged item bookable</secondary></indexterm>\r
- <para>If their permission settings allow, staff members can make items bookable. Staff members\r
- can do this in advance of a booking request, or they can do it on the fly.</para>\r
- <para>If you know in advance of the request that an item will need to be booked, you can make\r
- the item bookable.</para>\r
-\r
-\r
- <procedure>\r
- <step>\r
- <para>In the staff client, select <menuchoice>\r
- <guimenu>Search</guimenu>\r
- <guimenuitem>Search the Catalog</guimenuitem>\r
- </menuchoice></para>\r
- </step>\r
- <step>\r
- <para>Begin a title search to find an item.</para>\r
- </step>\r
- <step>\r
- <para>Click the title of the item that you want to book.</para>\r
- </step>\r
-\r
- <step>\r
- <para>The <guilabel>Record Summary</guilabel> will appear. In this view you can see\r
- information about the item and its locations. Click <menuchoice>\r
- <guimenu>Actions for this Record</guimenu>\r
- <guimenuitem>Holdings Maintenance</guimenuitem>\r
- </menuchoice> in the top right corner of the screen.</para>\r
- </step>\r
-\r
- <step>\r
- <para>The <guilabel>Holdings Maintenance</guilabel> screen will appear. In this screen,\r
- you can view the volumes and copies of an item avaialable at each branch. To view the\r
- barcodes and other information for each copy, click the arrow adjacent to the branch\r
- with the copy that you need to view. Click on successive arrows until you find the\r
- copy that you need to view.</para>\r
- </step>\r
- <step>\r
- <para>Select the item that you want to make bookable. Right click to open the menu, and\r
- click <guimenuitem>Make Item Bookable</guimenuitem>.</para>\r
- </step>\r
- <step>\r
- <para>The item has now been added to the list of resources that are bookable. To book\r
- the item, return to the <guilabel>Record Summary</guilabel>, and proceed with\r
- booking..</para>\r
- </step>\r
-\r
- </procedure>\r
- <note>\r
- <para>In Evergreen 1.6.1, there is no way to make an item “unbookable” after it has been\r
- made bookable and has been reserved. The <guibutton>Delete Selected</guibutton> button\r
- on this screen deletes the resource from the screen, but the item will be able to be\r
- booked after it has been returned.</para>\r
- </note>\r
-\r
- </section>\r
- <section xml:id="MakeItemBookableOnTheFly">\r
- <title>Make a Cataloged Item Bookable On the Fly</title>\r
- <para>If a patron wants to book an item immediately that does not have bookable status, you\r
- can book the item on the fly if you have the appropriate permissions.</para>\r
-\r
- <procedure>\r
- <step>\r
- <para>Follow steps one through five in <xref linkend="MakeCataloguedItemBookable"\r
- />.</para>\r
- </step>\r
- <step>\r
- <para>Select the item that you want to make bookable. Right click to open the menu, and\r
- click <guimenuitem>Book Item Now</guimenuitem>.</para>\r
- </step>\r
- <step>\r
- <para>A <guilabel>Reservations</guilabel> screen will appear in a new tab, and you can\r
- make the reservation.</para>\r
- </step>\r
-\r
- </procedure>\r
-\r
- </section>\r
- <section xml:id="MakeNon-CataloguedItemBookable">\r
- <title>Create a Bookable Status for Non-Bibliographic Items</title>\r
- <indexterm><primary>booking reservation</primary><secondary>non-bibliographic items</secondary></indexterm>\r
- <para>Staff with the required permissions can create a bookable status for non-bibliographic\r
- items. For example, staff can book conference rooms or laptops. You will be able to create\r
- types of resources, specify the names of individual resources within each type, and set\r
- attributes to describe those resources. You can then bring the values together through the\r
- <guilabel>Resource Attribute Map</guilabel>.</para>\r
- <procedure>\r
- <step>\r
- <para>First, create the type of resource that you want to make bookable. Select <menuchoice>\r
- <guimenu>Admin</guimenu>\r
- <guisubmenu>Server Administration</guisubmenu>\r
- <guisubmenu>Booking</guisubmenu>\r
- <guimenuitem>Resource Types</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <para>A list of resource types will appear. You may also see titles of cataloged items\r
- on this screen if they were added using the <guilabel>Make Item Bookable</guilabel>\r
- or <guilabel>Book Now</guilabel> links. You should not attempt to add cataloged items\r
- on this screen; it is best to use the aforementioned links to make those items\r
- bookable. In this screen, you will create a type of resource.</para>\r
- </step>\r
- <step>\r
- <para>In the right corner, click <guibutton>New Resource Type</guibutton>.</para>\r
- </step>\r
- <step>\r
- <para>A box will appear in which you will create a type of resource. In this box, you\r
- can set fines, determine “elbow room” periods between reservations on this type of\r
- resource, and indicate if this type of resource can be transferred to another\r
- library. Click <guibutton>Save</guibutton> when you have entered the needed\r
- information.</para>\r
- </step>\r
- <step>\r
- <para>After you click <guibutton>Save</guibutton>, the box will disappear. Refresh the\r
- screen to see the item that you have added.</para>\r
- </step>\r
- <step>\r
- <para>Next, set the attributes for the type of resource that you have created. Select <menuchoice>\r
- <guimenu>Server Administration</guimenu>\r
- <guisubmenu>Booking</guisubmenu>\r
- <guimenuitem>Resource Attributes</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Click <guibutton>New Resource Attribute</guibutton>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>A box will appear in which you can add the attributes of the resource. Attributes\r
- are descriptive information that is provided to the staff member when the booking\r
- request is made. For example, an attribute of the projector may be a cart that allows\r
- for its transportation. Other attributes might be number of seats available in a\r
- room, or MAC or PC attributes for a laptop. Click <guibutton>Save</guibutton> when\r
- the necessary information has been entered.</para>\r
- </step>\r
-\r
- <step>\r
- <para>The box will disappear. Refresh the screen to see the added attribute.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Next, add the values for the resource attributes. A value can be a number, yes/no,\r
- or any other meaningful information. Select <menuchoice>\r
- <guimenu>Server Administration</guimenu>\r
- <guisubmenu>Booking</guisubmenu>\r
- <guimenuitem>Resource Attribute Values</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Select <guibutton>New Resource Attribute Value</guibutton>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>A pop up box will appear. Select the <guilabel>Resource Attribute</guilabel> from\r
- the drop down box. Add the value. You can add multiple values for this field. Click\r
- <guibutton>Save</guibutton> when the required information has been added.</para>\r
- </step>\r
-\r
- <step>\r
- <para>If you refresh the screen, the attribute value may not appear, but it has been\r
- saved.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Next, identify the specific objects that are associated with this resource type.\r
- Click <menuchoice>\r
- <guimenu>Admin</guimenu>\r
- <guisubmenu>Server Administration</guisubmenu>\r
- <guisubmenu>Booking</guisubmenu>\r
- <guimenuitem>Resources</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Click <guibutton>New Resource</guibutton>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>A pop-up box will appear. Add information for the resource and click\r
- <guibutton>Save</guibutton>. Repeat this process for each resource.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Refresh the screen, and the resource(s) that you added will appear.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Finally, use <guilabel>Resource Attribute Maps</guilabel> to bring together the\r
- resource and its attributes. Select <menuchoice>\r
- <guimenu>Admin</guimenu>\r
- <guisubmenu>Server Administration</guisubmenu>\r
- <guisubmenu>Booking</guisubmenu>\r
- <guimenuitem>Resource Attribute Maps</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
-\r
- <step>\r
- <para>Select <guibutton>New Resource Attribute Map</guibutton></para>\r
- </step>\r
-\r
- <step>\r
- <para>Select the resource that you want to match with its attributes, then click\r
- <guibutton>Save</guibutton>. Repeat for all applicable resources.</para>\r
- </step>\r
-\r
- <step>\r
- <para>You have now created bookable, non-bibliographic resource(s) with\r
- attributes.</para>\r
- </step>\r
-\r
- </procedure>\r
- </section>\r
- <section xml:id="SettingBookingPermissions">\r
- <title>Setting Booking Permissions</title>\r
- <indexterm><primary>booking reservation</primary><secondary>setting booking permissions</secondary></indexterm>\r
- <para>Administrators can set permissions so that staff members can view reservations, make\r
- reservations, and make bibliographic or non-bibliographic items bookable.</para>\r
-\r
- <para>If a staff member attempts to book an item for which they do not have the appropriate\r
- permissions, they will receive an error message.</para>\r
-\r
- <para>To set permissions, select <menuchoice>\r
- <guimenu>Admin</guimenu>\r
- <guisubmenu>Server Administration</guisubmenu>\r
- <guimenuitem>Permissions</guimenuitem>\r
- </menuchoice>.</para>\r
-\r
- <para>Staff members should be assigned the following permissions to do common tasks in the\r
- booking module. These permissions could be assigned to front line staff members, such as\r
- circulation staff. Permissions with an asterisk (<emphasis role="bold">*</emphasis>) are\r
- already included in the <emphasis role="bold">Staff</emphasis> permission group. All other\r
- booking permissions must be applied individually.</para>\r
-\r
- <itemizedlist>\r
- <listitem>\r
- <para><emphasis role="bold">View Reservations:</emphasis> VIEW_TRANSACTION*</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Use the pull list:</emphasis>\r
- RETRIEVE_RESERVATION_PULL_LIST</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Capture reservations:</emphasis> CAPTURE_RESERVATION</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Assist patrons with pickup and return:</emphasis>\r
- VIEW_USER*</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete reservations:</emphasis>\r
- ADMIN_BOOKING_RESERVATION</para>\r
- </listitem>\r
- </itemizedlist>\r
-\r
- <para>The following permissions allow users to do more advanced tasks, such as making items\r
- bookable, booking items on the fly, and creating non-bibliographic resources for\r
- booking.</para>\r
-\r
- <itemizedlist>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete booking resource type:</emphasis>\r
- ADMIN_BOOKING_RESOURCE_TYPE</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete booking resource attributes:</emphasis>\r
- ADMIN_BOOKING_RESOURCE_ATTR</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete booking resource attribute\r
- values:</emphasis> ADMIN_BOOKING_RESOURCE_ATTR_VALUE</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete booking resource:</emphasis>\r
- ADMIN_BOOKING_RESOURCE</para>\r
- </listitem>\r
- <listitem>\r
- <para><emphasis role="bold">Create/update/delete booking resource attribute\r
- maps:</emphasis> ADMIN_BOOKING_RESOURCE_ATTR_MAP</para>\r
- </listitem>\r
- </itemizedlist>\r
-\r
- <para>In addition to having the permissions listed above, staff members will need a valid\r
- working location in their profiles. This should be done when registering new staff members.</para>\r
-\r
- <!-- Pages 14-16 of source document from http://evergreen-ils.org/dokuwiki/doku.php?id=booking ommitted at conversion (Jeremy Buhler, Oct 6 2010). Rationale: subject is covered elsewhere in the Book of Evergreen and it confuses 'working location' with 'home library', both of which should already be set for all staff accounts. -->\r
-\r
- </section>\r
-</chapter>\r
+++ /dev/null
-<?xml version="1.0" encoding="utf-8"?>\r
-<chapter xml:id="lsa" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
- <info>\r
- <title>Local Administration Menu</title>\r
- </info>\r
- <section>\r
- <info>\r
- <title>Overview</title>\r
- </info>\r
- <informalfigure>\r
- <para>Many Evergreen configuration options are available under the <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guimenuitem>Local Administration</guimenuitem>\r
- </menuchoice> rollover menu.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-1.png"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <para>This menu is new in Evergreen 1.6 and provides shortcuts to settings also available\r
- from the <guilabel>Local Administration</guilabel> page.</para>\r
- <para>Either access point can be used, but examples in this manual use the more comprehensive\r
- <guilabel>Local Administration</guilabel> rollover menu.</para>\r
- <para>Items on this menu are visible to anyone logged into the staff client but usually\r
- require special permissions to edit. The following table describes each of the menu options. </para>\r
- <informaltable>\r
- <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
- <colspec colnum="1" colname="menu" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="description" colwidth="3.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Menu option</entry>\r
- <entry>Description</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-receipt">Receipt Template Editor</link>\r
- </entry>\r
- <entry>Customize printed receipts (checkout receipts, hold slips, etc) for a\r
- single workstation</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-font">Global Font and Sound Settings</link>\r
- </entry>\r
- <entry>Change font size and sound settings for a single workstation</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-printer">Printer Settings Editor</link>\r
- </entry>\r
- <entry>Configure printer settings for a single workstation</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-closed">Closed Dates Editor</link>\r
- </entry>\r
- <entry>Set library closure dates (affects due dates and fines)</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-copy-locations">Copy Locations Editor</link>\r
- </entry>\r
- <entry>Create and edit copy locations, also known as shelving locations</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-library-settings">Library Settings Editor</link>\r
- </entry>\r
- <entry>Detailed library configuration settings</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-noncat">Non-Catalogued Type Editor</link>\r
- </entry>\r
- <entry>Create and edit optional <guilabel>non-catalogued</guilabel> item\r
- types</entry> \r
- </row>\r
-\r
- <row>\r
- <entry>\r
- <link linkend="lsa-statcat">Statistical Categories Editor</link>\r
- </entry>\r
- <entry>Create and manage optional categories for detailed patron/item\r
- information</entry> \r
- </row>\r
- <row>\r
- <entry>Standing Penalties</entry>\r
- <entry>\r
- <emphasis>admin settings</emphasis>\r
- </entry> \r
- </row>\r
- <row xml:id="lsa-group-penalty-table-entry">\r
- <entry>\r
- <link linkend="lsa-group-penalty">Group Penalty Thresholds</link>\r
- </entry>\r
- <entry> Set library-specific thresholds for maximum items out, maximum overdues,\r
- and maximum fines </entry> \r
- </row>\r
- <row>\r
- <entry>Field Documentation</entry>\r
- <entry>\r
- <emphasis>admin settings</emphasis>\r
- </entry> \r
- </row>\r
- <row>\r
- <entry>Notifications / Action Triggers</entry>\r
- <entry>\r
- <emphasis>admin settings</emphasis>\r
- </entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-survey">Surveys</link>\r
- </entry>\r
- <entry>Create patron surveys to be completed at patron registration</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- Reports\r
- </entry>\r
- <entry>Generate reports on any field in the Evergreen database</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- <link linkend="lsa-cash-reports">Cash Reports</link>\r
- </entry>\r
- <entry>View summary report of cash transactions for selected date range</entry> \r
- </row>\r
- <row>\r
- <entry>\r
- Transit List\r
- </entry>\r
- <entry>View items in transit to or from your library during selected date\r
- range</entry> \r
- </row>\r
- <row>\r
- <entry>Circulation Policies</entry>\r
- <entry>\r
- <emphasis>admin settings</emphasis>\r
- </entry> \r
- </row>\r
- <row>\r
- <entry>Hold Policies</entry>\r
- <entry>\r
- <emphasis>admin settings</emphasis>\r
- </entry>\r
- </row>\r
- </tbody>\r
- </tgroup>\r
- </informaltable>\r
- </section>\r
- <xi:include href="admin-receipt.xml"/>\r
- <section xml:id="lsa-font">\r
- <info>\r
- <title>Global Font and Sound Settings</title>\r
- <indexterm><primary>staff client</primary><secondary>fonts</secondary></indexterm>\r
- \r
- </info>\r
- <para><guilabel>Global Font and Sound Settings</guilabel> apply to the current workstation\r
- only. Use to turn staff client sounds on/off or to adjust the font size in the staff client\r
- interface. These settings do not affect OPAC font sizes.</para>\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Global Font and Sound Settings</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <indexterm><primary>staff client</primary><secondary>sounds</secondary></indexterm>\r
- <para>To turn off the system sounds, like the noise that happens when a patron with a\r
- block is retrieved check the <guilabel>disable sound</guilabel> box and click\r
- <guibutton>Save to Disk</guibutton>. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-4.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>To change the size of the font, pick the desired option and click\r
- <guibutton>Save to Disk</guibutton>. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-5.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- </section>\r
- <section xml:id="lsa-printer">\r
- <info>\r
- <title>Printer Settings Editor</title>\r
- <indexterm><primary>staff client</primary><secondary>printer settings</secondary></indexterm>\r
- </info>\r
- <para>Use the <guilabel>Printer Settings Editor</guilabel> to configure printer output for\r
- each workstation.</para>\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Printer Settings Editor</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>From this screen you can print a test page, or alter the page settings for your\r
- receipt printer. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-7.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>Click on <guibutton>Page Settings</guibutton> to change printing format and\r
- option settings. Click on the <guilabel>Margins &\r
- Header/Footer</guilabel> tab to adjust </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-8.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- </section>\r
- <section xml:id="lsa-closed">\r
- <info>\r
- <title>Closed Dates Editor</title>\r
- <indexterm><primary>closed dates editor</primary></indexterm>\r
- </info>\r
- <para>These dates are in addition to your regular weekly closed days (see <xref\r
- linkend="server-hours"/>). Both regular closed days and those entered in the\r
- <guilabel>Closed Dates Editor</guilabel> affect due dates and fines:</para>\r
- <itemizedlist>\r
- <listitem>\r
- <formalpara>\r
- <title>Due dates</title>\r
- <indexterm><primary>closed dates editor</primary><secondary>due dates</secondary></indexterm>\r
- <para>Due dates that would fall on closed days are automatically pushed forward to\r
- the next open day. Likewise, if an item is checked out at 8pm, for example, and\r
- would normally be due on a day when the library closes before 8pm, Evergreen\r
- pushes the due date forward to the next open day.</para>\r
- </formalpara>\r
- </listitem>\r
- <listitem>\r
- <formalpara>\r
- <title>Overdue fines</title>\r
- <indexterm><primary>closed dates editor</primary><secondary>fines</secondary></indexterm>\r
- <para>Overdue fines are not charged on days when the library is closed.</para>\r
- </formalpara>\r
- </listitem>\r
- </itemizedlist> \r
- <simplesect>\r
- <title>Multi-Day Closing</title>\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Closed Dates Editor</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step xml:id="lsa-multi-day-select">\r
- <informalfigure>\r
- <para>Select <guibutton>Add Multi-Date Closing</guibutton> if your closed dates\r
- are entire business days.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-10.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>Enter applicable dates and a descriptive reason for the closing and click\r
- <guibutton>Save</guibutton>. Check the <guilabel>Apply to all of my\r
- libraries</guilabel> box if your library is a multi-branch system and the\r
- closing applies to all of your branches. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-11.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- <tip>\r
- <para>You can type dates into fields using YYYY-MM-DD format or use calendar widgets to\r
- choose dates.</para>\r
- </tip>\r
- </simplesect>\r
- <simplesect>\r
- <title>Detailed Closing</title>\r
- <informalfigure>\r
- <para>If your closed dates include a portion of a business day, select Add Detailed\r
- Closing at <xref linkend="lsa-multi-day-select"/>, then enter detailed hours and\r
- dates and click <guibutton>Save</guibutton>. Time format must be HH:MM.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-12.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </simplesect> \r
- </section>\r
- <section xml:id="lsa-copy-locations">\r
- <info>\r
- <title>Copy Locations Editor</title>\r
- <indexterm><primary>copy locations editor</primary></indexterm>\r
- </info>\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Copy Locations Editor</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>You can create new copy locations, or edit existing copy locations. To create a\r
- new shelving location type in the name, and select <guilabel>Yes</guilabel> or\r
- <guilabel>No</guilabel> for the various attributes: <guilabel>OPAC Visible,\r
- Holdable, Circulate,</guilabel> and <guilabel>Hold Verify</guilabel>.\r
- <guilabel>Holdable</guilabel> means a patron is able to place a hold on an item\r
- in this location; <guilabel>Hold Verify</guilabel> means staff will be prompted\r
- before an item is captured for a hold. Finally click\r
- <guibutton>Create</guibutton>.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-14.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>In the bottom part of the <guilabel>Copy Locations Editor</guilabel> you can\r
- edit or delete existing copy locations. You cannot delete a location that contains\r
- items. In this example the copy location <guilabel>Adult Videos</guilabel> is\r
- being edited.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-16.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- <tip>\r
- <para>There are also options in the <guilabel>Copy Editor</guilabel> for a copy to be\r
- <guilabel>OPAC Visible</guilabel>-yes or no, <guilabel>Holdable</guilabel>-yes or no,\r
- or <guilabel>Circulate</guilabel>-yes or no. If either the copy record or the shelving\r
- location is set to Circulate-no, then the item will not be able to circulate.</para>\r
- </tip>\r
- <informalfigure>\r
- <para>This is where you see the shelving locations in the <guilabel>Copy\r
- Editor</guilabel>:</para>\r
-\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-17.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <para>This is where the shelving location appears in the OPAC.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-18.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </section>\r
- <section xml:id="lsa-library-settings">\r
- <info>\r
- <title>Library Settings Editor</title>\r
- <indexterm><primary>library settings editor</primary></indexterm>\r
- </info>\r
- <para>With the <guilabel>Library Settings Editor</guilabel> Local System Admnistrators (LSAs)\r
- can optionally customize Evergreen's behaviour for a particular library or library system.\r
- For descriptions of available settings see the <link\r
- linkend="lsa-library-settings-overview">Settings Overview</link> table below. \r
- </para>\r
- <para>To open the <guilabel>Library Settings Editor</guilabel> select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Adminstration</guisubmenu>\r
- <guimenuitem>Library Settings Editor</guimenuitem>\r
- </menuchoice>. </para>\r
- <simplesect>\r
- <title>Settings Overview</title>\r
- <para>This table describes available settings and shows which LSAs can change on a\r
- per-library basis. Below the table is a list of <link\r
- linkend="lsa-library-settings-data">data types</link> with details about acceptable\r
- settings values.</para>\r
- <informaltable xml:id="lsa-library-settings-overview">\r
- <tgroup cols="4" align="left" colsep="1" rowsep="1">\r
- <colspec colnum="1" colname="setting" colwidth="2.0*"/>\r
- <colspec colnum="2" colname="description" colwidth="3.0*"/>\r
- <colspec colnum="3" colname="type" colwidth="1.0*"/>\r
- <colspec colnum="4" colname="notes" colwidth="2.0*"/>\r
- <thead>\r
- <row>\r
- <entry>Setting</entry>\r
- <entry>Description</entry>\r
- <entry>Data type</entry>\r
- <entry>Notes</entry>\r
- </row>\r
- </thead>\r
- <tbody>\r
- <row>\r
- <entry>Alert on empty bib records</entry>\r
- <entry>Alert staff before the last copy for a record is deleted</entry>\r
- <entry><link linkend="lsa-data-types">True/false</link></entry>\r
- <entry></entry>\r
- </row>\r
- <row>\r
- <entry>Allow Credit Card Payments</entry>\r
- <entry>Not available</entry>\r
- <entry><link linkend="lsa-data-types">True/false</link></entry> \r
- <entry></entry>\r
- </row>\r
- <row>\r
- <entry>Change reshelving status interval</entry>\r
- <entry>Amount of time to wait before changing an item from “reshelving” status\r
- to “available”</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- <entry></entry>\r
- </row>\r
- <row>\r
- <entry>Charge item price when marked damaged </entry>\r
- <entry>If true Evergreen bills item price to the last patron who checked out\r
- the damaged item. Staff receive an alert with patron information and must\r
- confirm the billing.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- <entry>\r
- </entry>\r
- </row>\r
- <row>\r
- <entry>Charge processing fee for damaged items</entry>\r
- <entry>Optional processing fee billed to last patron who checked out the\r
- damaged item. Staff receive an alert with patron information and must\r
- confirm the billing.</entry>\r
- <entry><link linkend="lsa-data-types">Number</link> (dollars)</entry>\r
- <entry>Disabled when set to 0</entry>\r
- </row>\r
- <row>\r
- <entry>Circ: Lost items usable on checkin</entry>\r
- <entry>Lost items are usable on checkin instead of going 'home' first</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>Circ: Restore overdues on lost item return</entry>\r
- <entry>If true when a lost item is checked in overdue fines are charged (up to\r
- the maximum fines amount)</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Circ: Void lost item billing when returned</entry>\r
- <entry>If true,when a lost item is checked in the item replacement bill (item\r
- price) is voided. If the patron has already paid the bill a credit is\r
- applied.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Circ: Void lost max interval</entry>\r
- <entry>Items that have been lost this long will not result in voided billings\r
- when returned. Only applies if <guilabel>Circ: Void lost item\r
- billing</guilabel> or <guilabel>Circ: Void processing fee on lost\r
- item</guilabel> are true.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Circ: Void processing fee on lost item return</entry>\r
- <entry>If true the processing fee is voided when a lost item is\r
- returned</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Default Item Price</entry>\r
- <entry>Replacement charge for lost items if price is unset in the <guilabel>\r
- <link linkend="add-editor">Copy Editor</link>\r
- </guilabel>. Does not apply if item price is set to $0</entry>\r
- <entry><link linkend="lsa-data-types">Number</link> (dollars)</entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Default locale</entry>\r
- <entry>Sets language used in staff client</entry>\r
- <entry><link linkend="lsa-data-types">Text</link> (dollars)</entry>\r
- \r
- <entry>Can be set for each workstation at login</entry>\r
- </row>\r
-\r
- <row xml:id="lsa-do-not-automatically-delete">\r
- <entry>Do not automatically delete empty bib records</entry>\r
- <entry>If false bib records (aka MARC records) will automatically be deleted\r
- when the last attached volume is deleted </entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry>Set to <emphasis>false</emphasis> to avoid orphaned bib records</entry>\r
- </row>\r
-\r
- <row xml:id="lsa-library-settings-button">\r
- <entry>GUI: Above-Tab Button Bar </entry>\r
- <entry>If true the staff client <link linkend="button-bar">button bar</link>\r
- appears by default on all workstations registered to your library; staff can\r
- override this setting at each login.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row xml:id="lsa-library-settings-horizontal">\r
- <entry>GUI: Alternative Horizontal Patron Summary Panel</entry>\r
- <entry>If true replaces the vertical patron summary panel with a horizontal one\r
- on all workstations registered to your library</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>GUI: Network Activity Meter</entry>\r
- <entry>If true displays a progress bar when the staff client is sending or\r
- receiving information from the Evergreen server</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>GUI: Patron display timeout interval</entry>\r
- <entry>Patron accounts opened in the staff client will close if inactive for\r
- this period of time</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- \r
- <entry>Not functional in this version of Evergreen</entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Holds: Estimated Wait (Days) </entry>\r
- <entry>Average number of days between check out and check in, multiplied by a\r
- patron's position in the hold queue to estimate wait for holds</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry>Not yet implemented</entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Holds: Expire Alert Interval</entry>\r
- <entry>Time before a hold expires at which to send an email notifying the\r
- patron</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- \r
- <entry>Only applies if your library notifies patrons of expired holds. </entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Holds: Expire Interval</entry>\r
- <entry>Amount of time until an unfulfilled hold expires</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Holds: Hard boundary</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>Holds: Soft boundary</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Holds: Soft stalling interval</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Duration</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>Juvenile Age Threshold</entry>\r
- <entry>Upper cut-off age for patrons to be considered juvenile, calculated from\r
- date of birth in patron accounts</entry>\r
- <entry><link linkend="lsa-data-types">Duration</link> (years)</entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Lost Materials Processing Fee</entry>\r
- <entry>The amount charged in addition to item price when an item is marked los.\r
- </entry>\r
- <entry><link linkend="lsa-data-types">Number</link> (dollars)</entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>Maximum previous checkouts displayed</entry>\r
- <entry>Number of previous circulations displayed in staff client</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>OPAC Inactivity Timeout (in seconds)</entry>\r
- <entry>Number of seconds of inactivity before OPAC accounts are automatically\r
- logged out.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row>\r
- <entry>OPAC: Allow pending addresses</entry>\r
- <entry>If true patrons can edit their addresses in the OPAC. Changes must be\r
- approved by staff</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>Password format</entry>\r
- <entry>Defines acceptable format for OPAC account passwords</entry>\r
- <entry> Regular expression </entry>\r
- \r
- <entry>Default requires that passwords "be at least 7 characters in length,\r
- contain at least one letter (a-z/A-Z), and contain at least one number.\r
- </entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Patron barcode format </entry>\r
- <entry>Defines acceptable format for patron barcodes</entry>\r
- <entry> Regular expression </entry>\r
- \r
- <entry></entry>\r
- </row>\r
-\r
- <row xml:id="library-settings-phone-password">\r
- <entry>Patron: password from phone #</entry>\r
- <entry>If true the last 4 digits of the patron's phone number is the password\r
- for new accounts (password must still be changed at first OPAC\r
- login)</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
- <row>\r
- <entry>Selfcheck: Patron Login Timeout (in seconds)</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- \r
- <entry>Not for SIP connections</entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Selfcheck: Pop-up alert for errors</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry>Not for SIP connections</entry>\r
- </row>\r
- <row>\r
- <entry>Selfcheck: Require patron password</entry>\r
- <entry>Administrative setting</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- \r
- <entry>Not for SIP connections</entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Sending email address for patron notices</entry>\r
- <entry>This email address is for automatically generated patron notices (e.g.\r
- email overdues, email holds notification). It is good practice to set up a\r
- generic account, like info@nameofyourlibrary.ca, so that one person’s\r
- individual email inbox doesn’t get cluttered with emails that were not\r
- delivered.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Text</link>\r
- </entry>\r
- \r
- <entry/>\r
- </row>\r
-\r
- <row xml:id="lsa-show-billing-tab-first">\r
- <entry>Show billing tab first when bills are present</entry>\r
- <entry>If true, accounts for patrons with bills will open to the billing tab\r
- instead of check out</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- <entry></entry>\r
- </row>\r
- <row>\r
- <entry>Staff Login Inactivity Timeout (in seconds)</entry>\r
- <entry>Number of seconds of inactivity before staff client prompts for login\r
- and password.</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">Number</link>\r
- </entry>\r
- <entry>\r
- </entry>\r
- </row>\r
-\r
- <row>\r
- <entry>Void overdue fines when items are marked lost</entry>\r
- <entry>If true overdue fines are voided when an item is marked lost</entry>\r
- <entry>\r
- <link linkend="lsa-data-types">True/false</link>\r
- </entry>\r
- <entry>\r
- </entry>\r
- </row>\r
-\r
- </tbody>\r
- </tgroup>\r
- </informaltable>\r
-\r
-\r
- <para xml:id="lsa-library-settings-data">Acceptable formats for each setting type are\r
- listed below. Quotation marks are never required when updating settings in the staff\r
- client.</para>\r
-\r
-\r
- <informaltable xml:id="lsa-data-types">\r
-\r
- <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
- <colspec colnum="1" colname="type" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="formatting" colwidth="5.0*"/>\r
- \r
-\r
- <thead>\r
- <row>\r
- <entry>Data type</entry>\r
- <entry>Formatting</entry>\r
- </row>\r
- </thead>\r
-\r
-\r
-\r
- <tbody>\r
- <row>\r
- <entry>True/false</entry>\r
- <entry>Select value from drop-down menu</entry>\r
- </row>\r
- <row>\r
- <entry>Number</entry>\r
- <entry>Enter a numerical value (decimals allowed in price settings)</entry>\r
- </row>\r
- <row>\r
- <entry>Duration</entry>\r
- <entry>Enter a number followed by a space and any of the following units:\r
- minutes, hours, days, months (30 minutes, 2 days, etc)</entry>\r
- </row>\r
- <row>\r
- <entry>Text</entry>\r
- <entry>Free text</entry>\r
- </row>\r
-\r
-\r
- </tbody>\r
- </tgroup>\r
- </informaltable>\r
-\r
-\r
- </simplesect>\r
-\r
-\r
-\r
- </section>\r
- <section xml:id="lsa-noncat">\r
- <info>\r
- <title>Non-Catalogued Type Editor </title>\r
- <indexterm><primary>non-catalogued type editor</primary></indexterm>\r
- </info>\r
-\r
- <para>This is where you configure your non-catalogued types that appear in the dropdown menu\r
- for non-catalogued circulations. </para>\r
-\r
- <procedure>\r
- <step>\r
-\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Non Catalogued Type Editor</guimenuitem>\r
- </menuchoice>.</para>\r
-\r
-\r
- </step>\r
-\r
- <step>\r
- <informalfigure>\r
- <para>To set up a new non-catalogued type, type the name in the left hand box, and\r
- choose how many days the item will circulate for. Click\r
- <guibutton>Create</guibutton>.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-22.png"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <para>Select the <guilabel>Circulate In-House</guilabel> box for non-catalogued items\r
- that will circulate in house. This can be used to manually track computer use, or\r
- meeting room rentals. </para>\r
- </step>\r
- </procedure>\r
-\r
-\r
-\r
-\r
- <informalfigure>\r
- <para>This is what the dropdown menu for non-catalogued circulations in the patron checkout\r
- screen looks like:</para>\r
-\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-23.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </section>\r
- <section xml:id="lsa-group-penalty">\r
- <info>\r
- <title>Group Penalty Thresholds</title>\r
- <indexterm><primary>group penalty thresholds</primary></indexterm>\r
- </info>\r
- <para>Group Penalty Thresholds block circulation transactions for users who exceed maximum\r
- check out limits, number of overdue items, or fines. Settings for your library are\r
- visible under <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Group Penalty Thresholds</guimenuitem>\r
- </menuchoice>. </para>\r
-\r
-\r
- <informaltable>\r
-\r
- <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
- <colspec colnum="1" colname="penalty" colwidth="1.0*"/>\r
- <colspec colnum="2" colname="effect" colwidth="1.0*"/>\r
-\r
- <thead>\r
- <row>\r
- <entry>Penalty</entry>\r
- <entry>Effect</entry>\r
-\r
- </row>\r
- </thead>\r
-\r
- <tbody>\r
-\r
- <row>\r
- <entry>PATRON_EXCEEDS_FINES</entry>\r
-\r
- <entry>Blocks new circulations and renewals if patron exceeds X in fines </entry>\r
-\r
- </row>\r
- <row>\r
- <entry>PATRON_EXCEEDS_OVERDUE_COUNT</entry>\r
-\r
- <entry>Blocks new circulations and renewals if patron exceeds X overdue items </entry>\r
-\r
- </row>\r
-\r
- <row>\r
- <entry>PATRON_EXCEEDS_CHECKOUT_COUNT</entry>\r
-\r
- <entry>Blocks new circulations if patron exceeds X items out </entry>\r
-\r
- </row>\r
- </tbody>\r
- </tgroup>\r
-\r
- </informaltable>\r
-\r
-\r
-\r
-\r
- <informalfigure>\r
- <para>Accounts that exceed penalty thresholds display an alert message when opened and\r
- require staff overrides for blocked transactions.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>patron account with circulation blocks</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-1.png"/>\r
- </imageobject>\r
-\r
-\r
- </mediaobject>\r
- </para>\r
-\r
- </informalfigure>\r
-\r
-\r
- <simplesect xml:id="lsa-group-inheritance">\r
- <title>Penalty threshold inheritance rules</title>\r
-\r
- <informalfigure>\r
- <para>Local penalty thresholds are identified by <guilabel>Org Unit</guilabel> and\r
- appear in the same table as the system wide defaults.</para>\r
-\r
- <para>\r
- <mediaobject>\r
- <alt>group penalty threshold table</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-1a.png"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
-\r
- <para>Where there is more than one threshold for the same penalty Evergreen gives\r
- precedence to local settings. In this example Salt Spring Island Public Library (BGSI)\r
- patrons are blocked when owing $5.00 in fines (<inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/2.png"/>\r
- </imageobject>\r
- </inlinemediaobject>) instead of the system default(<inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/1.png"/>\r
- </imageobject>\r
- </inlinemediaobject>). </para>\r
-\r
- <para>Thresholds <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/3.png"/>\r
- </imageobject>\r
- </inlinemediaobject> and <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/4.png"/>\r
- </imageobject>\r
- </inlinemediaobject> are both for BGSI but apply to different user profile groups.\r
- Threshold <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/3.png"/>\r
- </imageobject>\r
- </inlinemediaobject> limits all patrons to a maximum of 12 items out, but <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/4.png"/>\r
- </imageobject>\r
- </inlinemediaobject> provides an exception for the <guilabel>Board</guilabel>\r
- profile.</para>\r
-\r
-\r
- <tip>\r
- <para>Multi-branch libraries may create rules for the entire library system or for\r
- individual branches. Evergreen will use the most specific applicable rule.</para>\r
- </tip>\r
-\r
-\r
-\r
- </simplesect>\r
-\r
- <simplesect xml:id="lsa-group-create">\r
- <title>Creating local penalty thresholds</title>\r
- <indexterm><primary>group penalty thresholds</primary><secondary>creating local penalty thresholds</secondary></indexterm>\r
- <para>Local System Administrators can override the system defaults by creating local penalty\r
- thresholds for selected patron groups.</para>\r
-\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Group Penalty Thresholds</guimenuitem>\r
- </menuchoice>.</para>\r
-\r
-\r
- </step>\r
-\r
- <step>\r
- <informalfigure>\r
- <para>Click <guibutton>New Penalty Threshold</guibutton>. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>group penalty threshold interface</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-2.png"/>\r
- </imageobject>\r
-\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
-\r
- <step>\r
- <informalfigure>\r
- <para>The new penalty pop-up appears. Complete all fields and click\r
- <guibutton>Save</guibutton>. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>new penalty threshold form</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-3.png"/>\r
- </imageobject>\r
-\r
-\r
- </mediaobject>\r
- </para>\r
- <para>\r
- <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/1.png"/>\r
- </imageobject>\r
- </inlinemediaobject>\r
- <guilabel> Group</guilabel> - the profile group to which the rule applies.\r
- Selecting <guilabel>Patrons</guilabel> includes all profiles below it in the\r
- user hierarchy.</para>\r
-\r
-\r
- <para>\r
- <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/2.png"/>\r
- </imageobject>\r
- </inlinemediaobject>\r
- <guilabel> Org Unit</guilabel> - multi-branch libraries may create rules for\r
- individual branches or the entire library system.</para>\r
-\r
-\r
- <para>\r
- <inlinemediaobject>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/3.png"/>\r
- </imageobject>\r
- </inlinemediaobject>\r
- <guilabel> Penalty</guilabel> - select\r
- <guilabel>PATRON_EXCEEDS_CHECKOUT_COUNT</guilabel>,\r
- <guilabel>PATRON_EXCEEDS_OVERDUE_COUNT</guilabel>, or\r
- <guilabel>PATRON_EXCEEDS_FINES</guilabel></para>\r
- </informalfigure>\r
- </step>\r
-\r
- <step>\r
- <informalfigure>\r
- <para>After clicking <guibutton>Save</guibutton> the new threshold appears with\r
- the defaults. Evergreen always gives precedence to local settings (in\r
- this example, BSP). </para>\r
- <para>\r
- <mediaobject>\r
- <alt>group penalty threshold interface</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-4.png"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- </simplesect>\r
- <simplesect>\r
- <title>Deleting or editing local penalty thresholds</title>\r
- <informalfigure>\r
- <para>To delete a local threshold select the row to remove and click <guibutton>Delete\r
- Selected</guibutton>. The threshold is removed immediately without further\r
- confirmation.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-5.png"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <informalfigure>\r
- <para>To edit a local threshold, double-click the desired row to open the pop-up form.\r
- Edit the form and click <guibutton>Save</guibutton>. New settings take effect\r
- immediately.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-group-6.png"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </simplesect>\r
- </section>\r
- <section xml:id="lsa-statcat">\r
- <info>\r
- <title>Statistical Categories Editor</title>\r
- <indexterm><primary>statistical categories editor</primary></indexterm>\r
- </info>\r
- <para>This is where you configure your statistical categories (stat cats). Stat cats are a\r
- way to save and report on additional information that doesn’t fit elsewhere in Evergreen's\r
- default records. It is possible to have stat cats for copies or patrons. </para>\r
-\r
- <procedure>\r
- <step>\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Statistical Categories Editor</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>To create a new stat cat, enter the name of the stat cat, select if you want\r
- <guilabel>OPAC Visiblity</guilabel>, and select either\r
- <guimenuitem>patron</guimenuitem> or <guimenuitem>copy</guimenuitem> from the\r
- <guimenu>Type</guimenu> dropdown menu. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-25.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- <formalpara>\r
- <title>Copy Stat Cats</title>\r
- <indexterm><primary>copy stat cats</primary></indexterm>\r
- <para>The image above shows some examples of copy stat cats. You would see these when\r
- editing items in the <guilabel>Copy Editor</guilabel>, also known as the <guilabel>Edit\r
- Item Attributes</guilabel> screen. You might use copy stat cats to track books you\r
- have bought from a specific vendor, or donations. </para>\r
- </formalpara>\r
-\r
- <informalfigure>\r
- <para>This is what the copy stat cat looks like in the <guilabel>Copy\r
- Editor</guilabel>.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-26.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <informalfigure>\r
- <formalpara>\r
- <title>Patron stat cats</title>\r
- <indexterm><primary>patron stat cats</primary></indexterm>\r
- <para>Below are some examples of patron stat cats. Patron stat cats can be used to keep\r
- track of information like the high school a patron attends, or the home library for a\r
- consortium patron, e.g. Interlink. You would see these in the fifth screen of patron\r
- registration/edit patron. </para>\r
- </formalpara>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-27.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- <informalfigure>\r
- <para>This is what the patron stat cat looks like in the patron registration screen. It\r
- looks very similar in the patron edit screen.</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-28.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </section>\r
- <section xml:id="fielddocumentation">\r
- <title>Field Documentation</title>\r
- <para>Field Documentation is custom field-level documentation that explains individual fields for\r
- library staff. As of 2.0, the field documentation only is used in the Patron Registration screen.</para>\r
- <simplesect>\r
- <title>Administering Field Documentation</title>\r
- <indexterm><primary>field documentation</primary><secondary>administering field documentation</secondary></indexterm>\r
- <para>If their permission settings allow, staff members can create local field documentation. This\r
- requires the ADMIN_FIELD_DOC permission. The 'depth' at which that permission is applied, is the maximum\r
- level of the org tree at which the staff member will be able to create field documentation.</para>\r
- <procedure>\r
- <step>\r
- <para>In the staff client, select <menuchoice>\r
- <guimenu>Admin</guimenu>\r
- <guimenuitem>Local Administration</guimenuitem>\r
- <guimenuitem>Field Documentation</guimenuitem>\r
- </menuchoice></para>\r
- </step>\r
- <step>\r
- <para>Click the <guibutton>New</guibutton> button.</para>\r
- </step>\r
- <step>\r
- <para>Using the <guilabel>fm_class</guilabel> selector, select the database table for which you wish to create Field Documentation. This will show all of the \r
- existing Field Documentation for that table.</para>\r
- <note><para>As of Evergreen 2.0, only the ILS User table is used anywhere in the Evergreen UI</para></note>\r
- </step>\r
- <step>\r
- <para>Using the <guilabel>owner</guilabel> selector, select the topmost org unit at which you would like the field documentation to be available.</para>\r
- </step>\r
- <step>\r
- <para>Using the <guilabel>field</guilabel> selector, select the field you wish to document.</para>\r
- </step> \r
- <step>\r
- <para>Enter your actual documentation in the <guilabel>string</guilabel> text box.</para>\r
- </step> \r
- <step>\r
- <para>Click <guibutton>Save</guibutton> to save your Field Documentation entry</para>\r
- </step>\r
- </procedure>\r
- <note>\r
- <para>To view field documentation for different tables, use the <guilabel>Class</guilabel> selector to filter the Field Documentation list</para>\r
- </note>\r
- </simplesect>\r
- <simplesect>\r
- <title>Patron Field Documentation</title>\r
- <indexterm><primary>field documentation</primary><secondary>patron field documentation</secondary></indexterm>\r
- <para>On the patron registration screen there are small boxes along the left hand side. If a magnifying glass appears, you may click that magnifying \r
- glass to retrieve the Field Documentation for that patron field.</para>\r
- </simplesect>\r
-</section>\r
-<xi:include href="admin-survey.xml"/>\r
- <section xml:id="lsa-cash-reports">\r
- <info>\r
- <title>Cash Reports</title>\r
- <indexterm><primary>cash reports</primary></indexterm>\r
- </info>\r
- <procedure>\r
- <step>\r
-\r
- <para>Select <menuchoice>\r
- <guimenu>Admin (-)</guimenu>\r
- <guisubmenu>Local Administration</guisubmenu>\r
- <guimenuitem>Cash Reports</guimenuitem>\r
- </menuchoice>.</para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>Select the start date and the end date that you wish to run a cash report for.\r
- You can either enter the date in the YYYY-MM-DD format, or click on the calendar\r
- icon to use the calendar widget. </para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata scalefit="0" fileref="../media/lsa-32.jpg"/>\r
- </imageobject>\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- <step>\r
- <para>Select your library from the drop down menu. Click <guibutton>Go</guibutton>.\r
- </para>\r
- </step>\r
- <step>\r
- <informalfigure>\r
- <para>The output will show cash, check, and credit card payments. It will also show\r
- amounts for credits, forgiven payments, work payments and goods payments (i.e.\r
- food for fines initiatives). The output will look something like this:</para>\r
- <para>\r
- <mediaobject>\r
- <alt>screenshot of staff client</alt>\r
- <imageobject>\r
- <imagedata width="100%" scalefit="1" fileref="../media/lsa-33.jpg"/>\r
- </imageobject>\r
-\r
- </mediaobject>\r
- </para>\r
- </informalfigure>\r
- </step>\r
- </procedure>\r
- <tip>\r
- <para>By clicking on the hyperlinked column headers (i.e. <guilabel>workstation</guilabel>,\r
- <guilabel>cash_payment</guilabel>, <guilabel>check_payment</guilabel>, etc.) it is\r
- possible to sort the columns to order the payments from smallest to largest, or largest\r
- to smallest, or to group the workstation names. </para>\r
- </tip>\r
- </section>\r
-</chapter>\r
projects / Evergreen-DocBook.git / commitdiff