Update serials docs for 2.4
authorRemington Steed <rjs7@calvin.edu>
Fri, 10 May 2013 13:57:31 +0000 (09:57 -0400)
committerKathy Lussier <klussier@masslnc.org>
Fri, 20 Sep 2013 20:32:36 +0000 (16:32 -0400)
In version 2.4, the serials modules underwent significant changes that
require significant updates to the documentation. This commit provides
the necessary updates, including some new screenshots. And in a few
cases, existing documentation was corrected or improved in ways
unrelated to the 2.4 update.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
Signed-off-by: Kathy Lussier <klussier@masslnc.org>
docs/media/scv-combined-dist.png [new file with mode: 0644]
docs/media/scv-combined-iss.png [new file with mode: 0644]
docs/media/scv-combined-sub.png [new file with mode: 0644]
docs/media/scv-distr.png [new file with mode: 0644]
docs/media/scv-iss.png [new file with mode: 0644]
docs/media/scv-rec.png [new file with mode: 0644]
docs/media/scv-status.png [new file with mode: 0644]

diff --git a/docs/media/scv-combined-dist.png b/docs/media/scv-combined-dist.png
new file mode 100644 (file)
index 0000000..d84ee4f
Binary files /dev/null and b/docs/media/scv-combined-dist.png differ
diff --git a/docs/media/scv-combined-iss.png b/docs/media/scv-combined-iss.png
new file mode 100644 (file)
index 0000000..248e328
Binary files /dev/null and b/docs/media/scv-combined-iss.png differ
diff --git a/docs/media/scv-combined-sub.png b/docs/media/scv-combined-sub.png
new file mode 100644 (file)
index 0000000..c3e171c
Binary files /dev/null and b/docs/media/scv-combined-sub.png differ
diff --git a/docs/media/scv-distr.png b/docs/media/scv-distr.png
new file mode 100644 (file)
index 0000000..db21628
Binary files /dev/null and b/docs/media/scv-distr.png differ
diff --git a/docs/media/scv-iss.png b/docs/media/scv-iss.png
new file mode 100644 (file)
index 0000000..bf9ddc0
Binary files /dev/null and b/docs/media/scv-iss.png differ
diff --git a/docs/media/scv-rec.png b/docs/media/scv-rec.png
new file mode 100644 (file)
index 0000000..a88e5c1
Binary files /dev/null and b/docs/media/scv-rec.png differ
diff --git a/docs/media/scv-status.png b/docs/media/scv-status.png
new file mode 100644 (file)
index 0000000..467d50b
Binary files /dev/null and b/docs/media/scv-status.png differ
index b366ac9..a9411d7 100644 (file)
@@ -8,20 +8,26 @@ 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.
+In version 2.4, the two interfaces have taken a big step toward unification.  Now in the Serial Control View, within the Subscription editor, you will find an embedded version of the Alternate Serial Control View.  This new unified interface tries to provide the best features of both views, giving full access to the Alternate view functions from within the tabbed Serial Control View.  One exception is that you cannot predict new issues from within the embedded Alternate view; instead you should use the standard Serial Control View method of predicting issues, link:_generate_prediction.html[explained here].  Also, some improvements were made to the embedded Alternate view to prevent losing features that were available in the old Serial Control View editors.  These changes include: new "Edit Notes" buttons on the subscriptions and distributions editors; labeled dropdown for distribution summary options ("Add to record entry", "Use record entry only", etc.); new legacy record entry linkage (allows one to tie a distribution's information to a particular serial record entry (i.e. a MFHD record)).
+Outside of the Subscription Editor, the two views maintain their previous looks and usage.  You are encouraged to use the new combination view and provide feedback to the link:http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[Evergreen general discussion list].
+The views are interoperable, but because they 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.
+The new combination view tries to provide the best of both views in one place. Try it out and send your feedback to the link:http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[Evergreen general discussion list].
 .Serials Control View and Alternate Serials Control View Comparison
-|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
+|Function      |Serials Control View   |Alternate Serials Control View |Combination View
+|Menu Style    |Menu driven    |Wizard oriented        |Both
+|Setting Up subscription       |No calendar drop downs |Includes calendar drop down |Includes calendar drop down
+|Creating streams      |No setup required      |Requires streams       |No setup required
+|Creating captions and patterns        |Wizard available       |Wizard available       |Wizard available
+|Adding Starting Issue |Includes holdings code wizard  |Includes holdings code wizard  |Includes holdings code wizard
+|Generate Predictions  |Make predictions       |Generate predictions   |Make predictions
+|Add items for special issue   |No functionality       |New items on issuances tab     |New items on issuances tab
 MFHD Records
index 4cef1f0..2091402 100644 (file)
@@ -2,37 +2,72 @@
 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.
+As of Evergreen 2.4, the Serial Control View incorporates the Alternate Serial Control interface in the Subscription editor. 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.4.
 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.
-. Click the Subscriptions link.
-. Select the branch that will own the subscription.
+. Click the Subscriptions tab.
+. In the tree on the left, 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.
+. Enter the date that the subscription begins in the Start Date field.
+. Enter the date that the subscription ends in the End Date field. 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 field. 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 Save. Or to exit the editor without saving, click Cancel.
-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.
+You can add notes to the subscription by clicking View/Edit Notes. These notes can also be accessed from the Items tab by right-clicking on an item and choosing View Sub. Notes. Also, the Notes column in the Items tab displays the total notes of each kind (Item notes, then Distribution notes, then Subscription notes).
 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.
+From the new combination Serial Control View
+. Click the subscription from the list on the left
+. In the panel on the right, click the Distributions tab
+. Click the New Distribution button
+. Enter your desired label 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 Display Grouping
+. Choose a Legacy Record Entry to attach to this serial record. 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 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.
+. Select a Summary method. This determines how the Holdings Summary will treat the Legacy Record Entry (i.e. MFHD record) in relation to the Serial Control holdings data.
+  * Add to record entry - Displays the MFHD holdings summary first, followed by the summary generated from the Serial Control received issues
+  * Use record entry only - Displays only the MFHD holdings summary
+  * Do not use record entry - Displays only the holdings summary generated from Serial Control received issues
+  * Merge with record entry - Merges the two holdings summaries into a single statement
+. Enter a Unit label prefix. This information will display in Serial Control View when the items are received, but it does not print in the Spine Label printing interface.
+. Enter a Unit label suffix. This information will display in Serial Control View when the items are received, but it does not print in the Spine Label printing interface.
+. Click the Save button to finish.
+Label, Holding Library, and Receive Unit Template are required fields when creating a distribution.
+Streams are created automatically in the Serial Control View. For information on using Streams in the combination Serial Control View, see link:_creating_a_stream.html[Creating a Stream].
-. Click the distributions link beneath the subscription. Right click or click Actions for Selected Rows, and click Add distribution.
+From the original Serial Control View
+. Click the distributions link beneath the subscription from the tree on the left. 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.
+. Select a Summary method. This determines how the Holdings Summary will treat the Legacy Record Entry (i.e. MFHD record) in relation to the Serial Control holdings data.
+  * Add to record entry - Displays the MFHD holdings summary first, followed by the summary generated from the Serial Control received issues
+  * Use record entry only - Displays only the MFHD holdings summary
+  * Do not use record entry - Displays only the holdings summary generated from Serial Control received issues
+  * Merge with record entry - Merges the two holdings summaries into a single statement
+. 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 in the Spine Label printing interface.
+. 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 in the Spine Label printing interface.
 . 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.
@@ -43,15 +78,29 @@ image::media/scv-distr.jpg[Distribution]
 . A confirmation message appears. Click OK.
-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.
+You can add notes to the distribution by clicking Distribution Notes. These notes can also be accessed from the Items tab by right-clicking on an item and choosing View Dist. Notes. Also, the Notes column in the Items tab displays the total notes of each kind (Item notes, then Distribution notes, then Subscription notes).
 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.
+From the new combination Serial Control View
+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.
+. In the panel on the right, click the Captions and Patterns tab.
+. Click Add New.
+. In the Type drop down menu, select the MARC tag to which you would like to add data.
+. In the Pattern Code text 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 is Active by default. You can deactivate it at any time by unchecking the box and clicking Save Changes. Only one active caption and pattern is allowed per type.
+. Click Save Changes to finish.
+. To delete a pattern, simply click the red X button.
+From the original Serial Control View
+. Click the captions and patterns link beneath the subscription from the tree on the left. 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.
+. In the Pattern Code box, you can enter a JSON representation of the 85X tag by hand, or you can click the Pattern Code Wizard to enter the information in a user-friendly format.
 Use the Pattern Code Wizard
@@ -62,7 +111,7 @@ To add a pattern code, click Wizard.
 Page 1: Enumerations
 . 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."
@@ -132,21 +181,38 @@ 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.
-. 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.
+From the new combination Serial Control View
+. In the panel on the right, click the Issuances tab.
+. 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. 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.
+. Click Save to finish.
+From the original Serial Control View
+. Click the Issuances link beneath the subscription from the tree on the left. Right click or click Actions for Selected Rows, and click Add Issuance.
+. As of Evergreen 2.2, the Issuance editor is the same as mentioned above in the new combination view.
 Generate Prediction
-. Open the Subscriptions tab.
+. Select the Subscription in the tree on the left.
 . 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.
+. To view the predicted issues, click the Subscription link from the tree on the left, then click the Issuances tab in the panel on the right.
index 0f0efa8..160bbec 100644 (file)
@@ -90,7 +90,7 @@ To add a pattern code, click Wizard.
 Page 1: Enumerations
 . 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."
index 656f202..620af2f 100644 (file)
@@ -5,21 +5,35 @@ You can receive either through the Serials Control View or in Batch Receive with
 Serials Control View 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.
+. To receive items, click the Receive radio button. In the top pane, the items that have yet to be received are displayed. In the bottom pane, recently received items are displayed with the most recent at the top.
 . Select the branch that will receive the items from the drop down box.
-. Select the issue that you want to receive.
+. Select the item 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.
+       * If you want the item to be received or bound into an existing item, select Recent and select the desired item from the menu. To make 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.
+. The screen refreshes. Now the item has moved from the top pane to the bottom pane. (If you have checked "Show all", the item also remains in the top pane, with a received date added to it.) In the bottom pane, 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.
+After receiving items, you can view the updated holdings in the OPAC.
+Set Special Statuses
+image::media/scv-status.png[Set Item Status]
+The Serial Control interface prevents direct editing of serial item statuses
+for data integrity reasons. As an alternative to direct control, the interface
+now offers new menu options for setting items to 'claimed', 'not held', and
+'not published'. Note that these statuses are still currently useful for
+reporting and display purposes only. The 'claimed' status changes the display 
+but does not yet connect with the Acquisitions module in any way. Also note 
+that, once you set an item to 'not held' or 'not published', that item will 
+be hidden from the list unless you check the "Show All" checkbox.
 Batch Receiving