Revisions to Search the Acquisitions Module.
authorJennifer Pringle <jpringle@sitka.bclibraries.ca>
Thu, 26 Apr 2012 23:18:57 +0000 (16:18 -0700)
committerJennifer Pringle <jpringle@sitka.bclibraries.ca>
Thu, 26 Apr 2012 23:18:57 +0000 (16:18 -0700)
Signed-off-by: Jennifer Pringle <jpringle@sitka.bclibraries.ca>
acq/acq-search-module.xml
acq/media/general-search-0.png [new file with mode: 0644]

index 8671c71..6188902 100644 (file)
@@ -15,7 +15,7 @@
       <abstract>\r
          <para>The acquisitions module has a powerful searching interface that enables you to search for line items, catalogue records, selection lists, purchase \r
 orders, and invoices.  Searching for line items and catalogue records can help ensure that duplicate orders are not placed.</para></abstract>\r
-      \r
+  \r
 \r
    </info>\r
 \r
@@ -23,6 +23,22 @@ orders, and invoices.  Searching for line items and catalogue records can help e
       <title>Using the General Search</title>\r
 <para><link linkend="general-search-tips">Search Tips</link></para>      \r
 <para>In the acquisitions module you can search for line items, line items and catalog records, selection lists, purchase orders, and invoices.</para>\r
+<para>The option chosen in the <guilabel>Search for</guilabel> box determines what form your search results will return in.  The possible options are: line items, line items and catalogue\r
+records, selection lists, purchase orders, and invoices.</para>\r
+\r
+<para>Search fields are divided into a number of categories.  These categories are: Line Item, Selection List, Purchase Order, Invoice, and Line Item Attribute.  \r
+Unless greyed out these fields can be used with any of the Search for options.</para>\r
+\r
+<informalfigure>\r
+<para>The example below illustrates searching for invoices using the ID of a purchase order.</para>\r
+<para><mediaobject>\r
+<alt>screenshot of the General Search</alt>\r
+\r
+<imageobject>\r
+<imagedata fileref="media/general-search-0.png" scalefit="0"></imagedata>\r
+</imageobject>\r
+</mediaobject></para>\r
+</informalfigure>\r
 \r
 <note><para>You may wish to begin your acquisitions process by searching for line items and catalogue records. This ensures that you do not purchase an item that the \r
 library already owns or is on another selection list or purchase order. \r
@@ -44,8 +60,7 @@ See <link linkend="lineitem-catalogue-search">Searching for Line Items and Catal
 \r
 <step>\r
 <informalfigure>\r
-<para>Select the option best suited to your search from the <guilabel>Search for</guilabel> drop down menu.  Some search terms may be \r
-disabled depending on the option you chose.</para>\r
+<para>Select the option best suited to your search from the <guilabel>Search for</guilabel> drop down menu.</para>\r
 <para><mediaobject>\r
 <alt>screenshot of the General Search</alt>\r
 \r
@@ -58,7 +73,8 @@ disabled depending on the option you chose.</para>
 \r
 <step>\r
 <informalfigure>\r
-<para>Refine your search by selecting the specific fields you would like to search.</para>\r
+<para>Refine your search by selecting the specific fields you would like to search.  Some search terms may be disabled depending on the <guilabel>Search for</guilabel>\r
+option you chose. </para>\r
 <para><mediaobject>\r
 <alt>screenshot of the General Search</alt>\r
 \r
@@ -84,7 +100,7 @@ disabled depending on the option you chose.</para>
 \r
 <step>\r
 <informalfigure>\r
-<para>If you wish to edit your search, click <guibutton>Reveal Search</guibutton> in the top right hand corner of the results screen to display your search.</para>\r
+<para>If you wish to edit your search, click <guibutton>Reveal Search Form</guibutton> in the top right hand corner of the results screen to display your search.</para>\r
 <para><mediaobject>\r
 <alt>screenshot of the General Search</alt>\r
 \r
@@ -102,6 +118,9 @@ disabled depending on the option you chose.</para>
 <title>Search Tips:</title>\r
 <itemizedlist>\r
 <listitem>\r
+<para>The <guilabel>Search for</guilabel> option you choose will be the form in which your results are returned in.</para>\r
+</listitem>\r
+<listitem>\r
 <para>Search terms are ANDed together when <guilabel>all</guilabel> is selected.</para>\r
 </listitem>\r
 <listitem>\r
@@ -111,6 +130,9 @@ disabled depending on the option you chose.</para>
 <para>Click <guibutton>Add Search Term</guibutton> to add more fields.</para>\r
 </listitem>\r
 <listitem>\r
+<para>Search fields from any category can be used in a search unless the search fields are grayed out in the list.</para>\r
+</listitem>\r
+<listitem>\r
 <para>Click the red <guibutton>X</guibutton> at the end of each row to delete search terms.</para>\r
 </listitem>\r
 <listitem>\r
@@ -126,8 +148,10 @@ disabled depending on the option you chose.</para>
 \r
 <section xml:id="lineitem-catalogue-search">\r
 <title>Searching for Line Items and Catalogue Records</title>\r
-<para>To prevent duplication, best practice is to search for an item before adding it to a selection list or purchase order.  This helps to ensure that duplicate orders \r
-are not placed for items that your library already owns or is currently ordering.</para>\r
+<para><link linkend="line-cat-search-tips">Search Tips</link></para> \r
+<para>To prevent duplication, best practice is to search for an item before adding it to a selection list or purchase order.  A search for Line Items and Catalogue\r
+records searches all records in the catalogue as well as all line items.  This helps to ensure that duplicate orders \r
+are not placed for items that your library already owns or is in the process of ordering.</para>\r
 \r
 <note><para>There are five <guilabel>Line Item Attribute</guilabel> search fields you can use when searching for line items and catalogue records.</para>\r
 <para>They are:</para>\r
@@ -181,22 +205,6 @@ are not placed for items that your library already owns or is currently ordering
 \r
 <step>\r
 <para>Select your search field(s) and enter your search term(s).</para>\r
-<tip>\r
-<informalfigure>\r
-<para>When searching for line items and catalogue records the best search fields to use are Title of work and the number field associated with \r
-the item (ISBN, ISSN, UPC).</para>\r
-<para>If you ask the system to match <guilabel>any</guilabel> of the following terms your results will include items that match either the title or number \r
-or both.</para>\r
-<para><mediaobject>\r
-<alt>screenshot of the General Search</alt>\r
-\r
-<imageobject>\r
-<imagedata fileref="media/lineitem-catalogue-search-1.png" scalefit="0"></imagedata>\r
-</imageobject>\r
-</mediaobject></para>\r
-</informalfigure>\r
-<para>See <link linkend="general-search-tips">Using the General Search</link> for more general search tips.</para>\r
-</tip>\r
 </step>\r
 \r
 <step>\r
@@ -218,12 +226,38 @@ or both.</para>
 \r
 </procedure>\r
 \r
+<simplesect xml:id="line-cat-search-tips">\r
+<title>Search Tips</title>\r
+\r
+<itemizedlist>\r
+<listitem>\r
+<informalfigure>\r
+<para>When searching for line items and catalogue records the best search fields to use are Title of work and the number field associated with \r
+the item (ISBN, ISSN, UPC).</para>\r
+<para>If the system is set to match <guilabel>any</guilabel> of the following terms the results will include items that match either the title or number \r
+or both.</para>\r
+<para><mediaobject>\r
+<alt>screenshot of the General Search</alt>\r
+\r
+<imageobject>\r
+<imagedata fileref="media/lineitem-catalogue-search-1.png" scalefit="0"></imagedata>\r
+</imageobject>\r
+</mediaobject></para>\r
+</informalfigure>\r
+</listitem>\r
+<listitem>\r
+<para>See <link linkend="general-search-tips">Using the General Search</link> for more general search tips.</para>\r
+</listitem>\r
+</itemizedlist>\r
+</simplesect>\r
+\r
 </section>\r
 \r
 <section xml:id="selection-search">\r
 <title>Searching for Selection Lists</title>\r
-<para><guilabel>My Selection List</guilabel> only displays the selection lists created by the user currently logged onto the workstation.  You can view other users' selection \r
-lists using the <guilabel>General Search</guilabel>.</para> \r
+<para><link linkend="selection-search-tips">Search Tips</link></para>\r
+<para><link linkend="selection-lists">My Selection List</link> only displays the selection lists created by the user currently logged onto the workstation.  You can view selection \r
+lists created by other users using the <guilabel>General Search</guilabel>.</para> \r
 \r
 <procedure>\r
 <step>\r
@@ -255,23 +289,6 @@ lists using the <guilabel>General Search</guilabel>.</para>
 \r
 <step>\r
 <para>Select your search field(s) and enter your search term(s).</para>\r
-<tip><para>When searching for lists created by a particular user the best search fields are:</para>\r
-<itemizedlist>\r
-<listitem>\r
-<para>SL-Owner: Searches the selection lists based on the owning user.</para>\r
-</listitem>\r
-<listitem>\r
-<para>SL-Creator: Searches the selection lists based on the creating user.</para>\r
-</listitem>\r
-</itemizedlist>\r
-<para>When searching for a particular selection list, the best search field is:</para>\r
-<itemizedlist>\r
-<listitem>\r
-<para>SL-Name: Searches for the name of a particular selection list.</para>\r
-</listitem>\r
-</itemizedlist>\r
-<para>See <link linkend="general-search-tips">Using the General Search</link> for more general search tips.</para>\r
-</tip>\r
 </step>\r
 \r
 <step>\r
@@ -302,6 +319,31 @@ lists using the <guilabel>General Search</guilabel>.</para>
 \r
 </procedure>\r
 \r
+<simplesect xml:id="selection-search-tips">\r
+<title>Search Tips</title>\r
+<para>When searching for lists created by a particular user the best search fields are:</para>\r
+<itemizedlist>\r
+<listitem>\r
+<para>SL-Owner: Searches the selection lists based on the owning user.</para>\r
+</listitem>\r
+<listitem>\r
+<para>SL-Creator: Searches the selection lists based on the creating user.</para>\r
+</listitem>\r
+</itemizedlist>\r
+<para>When searching for a particular selection list, the best search field is:</para>\r
+<itemizedlist>\r
+<listitem>\r
+<para>SL-Name: Searches for the name of a particular selection list.</para>\r
+</listitem>\r
+<listitem>\r
+<para>Search fields in the catagories of Line Item, Purchase Order, Invoice, and Line Item Attribute may also be used to build a search.</para>\r
+</listitem>\r
+</itemizedlist>\r
+<para>See <link linkend="general-search-tips">Using the General Search</link> for more general search tips.</para>\r
+\r
+\r
+</simplesect>\r
+\r
 </section>\r
 \r
 <section xml:id="purchase-order-search">\r
@@ -348,6 +390,10 @@ lists using the <guilabel>General Search</guilabel>.</para>
 <para>To search for purchase orders with a status other than on-order, simply replace <guilabel>on-order</guilabel> with the status you wish to search.</para>\r
 </listitem>\r
 <listitem>\r
+<para>By default the <guilabel>PO-Ordering Agency</guilabel> is the workstation the user is logged in at.  Multi-branch systems with centralized ordering will need \r
+to update this to the location that is their actual ordering agency.</para>\r
+</listitem>\r
+<listitem>\r
 <informalfigure>\r
 <para>Use the <guilabel>Purchase Order</guilabel> search fields to modify your search as needed.</para>\r
 <para><mediaobject>\r
@@ -411,6 +457,10 @@ lists using the <guilabel>General Search</guilabel>.</para>
 <para>To search for closed invoices simply check the box adjacent to the <guilabel>I-Complete</guilabel> search field.</para>\r
 </listitem>\r
 <listitem>\r
+<para>By default the I-Receiver is the workstation the user is logged in at.  Multi-branch systems with centralized ordering will need to update this to \r
+the location that is their actual receiver.</para>\r
+</listitem>\r
+<listitem>\r
 <informalfigure>\r
 <para>Use the <guilabel>Invoice</guilabel> search fields to modify your search as needed.</para>\r
 <para><mediaobject>\r
diff --git a/acq/media/general-search-0.png b/acq/media/general-search-0.png
new file mode 100644 (file)
index 0000000..9f83fa6
Binary files /dev/null and b/acq/media/general-search-0.png differ