Remington Steed [Mon, 12 Mar 2018 14:26:05 +0000 (10:26 -0400)]
Docs: Fix broken include in root.adoc
A recent commit added a section to root.adoc and root_cataloging.adoc.
The reference was correct in the second file, but in the first file was
missing the subdirectory. This commit adds it.
Remington Steed [Mon, 12 Mar 2018 14:02:54 +0000 (10:02 -0400)]
Docs: Remove docs not applicable in web client
A few docs chapters relate to features that don't exist (yet) in the web
client, so this commit removes those from the table of contents
(root*.adoc).
Also, duplicate content was found during the web client docs review, so
this commit removes the nearly identical docs file and replaces its
references with references to the slightly better version of the file.
Mike Rylander [Sat, 3 Mar 2018 18:29:17 +0000 (13:29 -0500)]
LP#1717593: Missing strings cause serial item delete (and status change) failures
There are two places in the code that expect a serial-related string to exist,
but neither do. So, let's correct that.
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: John Amundson <jamundson@cwmars.org> Signed-off-by: Jason Stephenson <jason@sigio.com>
Remington Steed [Thu, 8 Mar 2018 16:21:10 +0000 (11:21 -0500)]
Docs: Update "Alternate Hold Pick up Location" for web client
- New screenshot
- Remove instructions for changing location label (e.g. "Drive-thru")
- Wrap long lines to 72 characters (if those lines were changed)
Remington Steed [Wed, 7 Mar 2018 20:03:12 +0000 (15:03 -0500)]
Docs: Use raw ampersand '&' to fix conversion error
The AsciiDoc to DocBook conversion process seems handle raw ampersands
just fine, but sometimes chokes on the special entity forms like {amp}
or & . No more fancy talk. Just simple '&'.
Remington Steed [Wed, 7 Mar 2018 19:21:51 +0000 (14:21 -0500)]
Docs: Fix '&' DocBook conversion error
Using the AsciiDoc named character reference {amp} seems to have
converted to a plain '&' too early, causing the DocBook XML validation
to fail. Let's try a numerical reference: &
- Replace screenshots
- Reformat long lines to around 72 characters
- Convert numbered list to automatic numbering
- Update instructions to match web client
Kevin Tran [Thu, 15 Feb 2018 16:18:21 +0000 (11:18 -0500)]
Docs: Update "Managing Holds" for web client
- changed "Actions for Selected Holds" to "Actions"
- several new screenshots
- some instructions updated
- merged and updated steps 3.E - 3.F, and created a new screenshot "holds-managing-5 and 6.JPG" (that will take place of the two current screenshots)
Kevin Tran [Thu, 8 Feb 2018 16:02:02 +0000 (11:02 -0500)]
Docs: Update "Resetting Patron's Password" for web client
A new screenshot has been created. The description in the instructions
have been changed. Some button names have been updated and verify
password has been removed.
Dan Scott [Thu, 22 Feb 2018 15:40:00 +0000 (10:40 -0500)]
Link to the Optional: Developer Additions step
We were referring people to a previous section by text, but we
have the power of linking in HTML, PDF, and ePub, so let's do
that and ease the navigation.
As discussed at Hack-a-way 2016, rather than continue to try to cram
multiple meanings into one timestamp, let's create a complete set of
all the useful timestamps for a typical billing.
In this new config, every billing will have a 'create_date', then most
(overdues) will also describe when they start and end.
billing_ts is now deprecated, but will continue to exist for backwards
compatibility. It will be managed by trigger to approximate its
current definition; equal to 'period_end' for overdues, equal to
'create_date' for other billings.
Signed-off-by: Dan Wells <dbw2@calvin.edu> Signed-off-by: Jeff Godin <jgodin@tadl.org>
LP#1748466: Fix http -> https /eg/staff rewrite on Apache 2.4.
Remove the SSLRequireSSL directive from the Location /eg/staff stanza
in Open-ILS/examples/apache_24/eg_vhost.conf.in so that the rewrite
from http to https works for the web staff client without the user
getting a 403.
Signed-off-by: Jason Stephenson <jason@sigio.com> Signed-off-by: Ben Shum <ben@evergreener.net>
[1] Create a patron that has at least two loans, one that is
overdue by 7 days and one that will be due in 3 days.
[2] Activate the '3 Day Courtesy Notice' and '7 Day Overdue Email Notification'
action trigger events, then generate events for those two loans
by running something like this:
Note that --run-pending is needed to ensure that the events are
complete, as the new columns include only checkout.due events
that are complete. (Pending ones don't count because no notification
would have yet made its way to the patron.)
[3] Apply the patch.
[4] Verify that the patron Items Out grid in the web staff client
now has Total Notices and Last Notice columns respectively
including the count of notices and the date of the last one.
[5] Turn on the webstaff.circ.itemsout_notice_count_excludes_courtesies
library setting and refresh the grid. This time, the courtesy notice
event should not be reflected by those two columns.
Cesar Velez [Fri, 8 Dec 2017 18:50:38 +0000 (13:50 -0500)]
LP#1732275: Patron Itemsout Notices - Add YAOUS for pre-due notices
Adding library permission 'webstaff.circ.itemsout_notice_count_excludes_courtesies'
so that pre-due/courtesy events aren't included in the notices count.
Cesar Velez [Mon, 13 Nov 2017 23:25:05 +0000 (18:25 -0500)]
LP#1732275: add open-ils.actor.user.itemsout.notices api
Add a method to Actor.pm to count completed action
trigger events for a given circ and return the latest
notice date. Uses the json_query for performance.
Add release notes for the new --uris option on marc_export.
To test the new option, run marc_export to export records with
holdings for a given library using the --library and --items options.
If that library also has electronic resources, do another export with
the same options but add the --uris option and direct this output to a
different file. Compare the file sizes. The second file should be
larger than the first.
Signed-off-by: Jason Stephenson <jason@sigio.com> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Kathy Lussier [Wed, 21 Feb 2018 20:19:34 +0000 (15:19 -0500)]
LP#1661688: Add a link and other tweaks to alternate hold pickup feature
Adding a couple of tweaks to the alternate hold pickup feature:
* Created a link for the hold patron so that staff can easily retrieve the record and potentially verify that the user allows the alternate patron to pick
up their holds.
* Tweaked the language in the event dialog.
* Removed the new OU setting from actor.org_unit_setting so that a default value is not set.
Dan Pearl [Tue, 24 Jan 2017 18:59:01 +0000 (13:59 -0500)]
LP##1661688 - Want easy way to clear a hold when picked up by other patron.
This common action was handled previously as
1) item is scanned - The system detects that this items is for a different
patron, and an error message is displayed.
2) Force Override was selected - If the librarian had the appropriate
privileges, the Force Override could allow the checkout to occur.
3) librarian cancels original hold - This independent operation would
be needed to cancel the original hold, otherwise the hold would be
targeted again.
This feature provides the option to cancel the hold in step #2. An error
message will be displayed as before, but within that message will be a checkbox to allow cancelling of the original hold which, if checked, will mean that step #3 will be automatically done.
The checked/non-checked state of the checkbox is initialized with an
organizational unit setting. The default is false (to preserve default
prior behavior).
Note: This change only affects the "web client".
TO TEST THIS
A. Before the Patch
Hold an item for patron "A". Attempt to check it out for patron "B".
Observe the choices to Force Override (to allow the checkout) or to cancel.
Do a Force Override and observe that the original hold is still active.
B. After the Patch
Repeat the above scenario, and observe the (blank) checkbox. Perform the
Force Override and observe that the original hold is still active.
Repeat the scenario, except this time check the checkbox. Observe after the checheckout is done that original hold is gone.
Adjust the organizational setting (see the Release Notes) to change the default
appearance of the checkbox.
For completeness, you can verify that if you cancel out the message pop-up that the checkout is cancelled and and that the hold status is unchanged, regardless of the state of the checkbox.
Signed-off-by: Dan Pearl <dpearl@cwmars.org> Signed-off-by: Jason Stephenson <jason@sigio.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Kathy Lussier [Mon, 26 Feb 2018 20:04:30 +0000 (15:04 -0500)]
LP#1744385: Additions and edits to release note entry
Minor edits to the release notes entry. Also, I highlighted the increased
use of Display Fields in the client since I thought it would be of
interest to some users. I also incorporated information regarding
default weights, which were added after Mike wrote up his release
note for this feature.
Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
This commit removes a layer of opensrf-perl indirection and uses cstore
instead of storage for retrieval. This trims seconds off the render time
of results and a bit off record detail.
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Here we replace the series title link generation based directly on the MARCXML
with the Display Field equivalent. Note, the previous method created broken
links in many cases, because it included more in the search terms than were
being indexed by the stock series title definition.
Signed-off-by: Mike Rylander <mrylander@gmail.com>
Starting # ../../../../multi-source-attrs.sql
Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Mike Rylander [Wed, 14 Feb 2018 17:52:21 +0000 (12:52 -0500)]
LP#1744385: Optimize real-field additions to virtual field searches
Now we only add on UNION query for each class providing real fields to a
virtual field, rather than a UNION per real field. This should reduce
core-query run time.
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Instead of searching by combined field within the rank-addition real fields,
we'll just search on the fields itself. This preserves the ranking additions
provided by the real-virtual mapping.
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
* Improve author and publisher display fields
* Reimplement Simple Record Extracts using Display Fields
* Address potential failure in combined search collection
* Provide useful helper function for inspecting transformed records
* Implement MODS transforms specified by LoC documentation but not
actually included in the stylesheet
* Expand highlighting use to publisher, edition, and physical description
* Reifying schema from updates
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Mike Rylander [Mon, 11 Sep 2017 19:24:55 +0000 (15:24 -0400)]
LP#1744385: Search and Result Display improvements
== Virtual Index Definitions
The practical purpose of Virtual Index Definitions is to supply an Evergreen administrator with
the ability to control the weighting and field inclusion of values in the general keyword index,
commonly referred to as "the blob," without requiring tricky configuration that has subtle semantics, an
over-abundance of index definitions which can slow search generally, or the need to reingest all
records on a regular basis as experiments are performed and the configuration refined. Significant
results of recasting keyword indexes as a set of one or more Virtual Index Definitions will be simpler
search configuration management, faster search speed overall, and more practical reconfiguration and
adjustment as needed.
Previous to this commit, in order to provide field-specific weighting to keyword matches against titles or authors, an
administrator must duplicate many other index definitions and supply overriding weights to those
duplicates. This not only complicates configuration, but slows down record ingest as well as search. It
is also fairly ineffective at achieving the goal of weighted keyword fields. Virtual Index Definitions will
substantially alleviate the need for these workarounds and their consequences.
* A Virtual Index Definition is not required supply any configuration for extracting bibliographic
data from records, but instead can become a sink for data collected by other index definitions
which is then colocated together to supply a search target made up of the separately extracted
data. Virtual Index Definitions are effectively treated as aggregate definitions, matching across
all values extracted from constituent non-virtual index definitions. They can further make use
of the Combined class functionality to colocate all values in a class together for matching even
across virtual fields.
* Configuration allows for weighting of constituent index definitions that participate in a
Virtual Index Definition. This weighting is separate from the weighting supplied when the index
definition itself is a search target.
* The Evergreen QueryParser driver returns the list of fields actually searched using every
user-supplied term set, including constituent expansion when a Virtual Index Definition is
searched. In particular, this will facilitate Search Term Highlighting described below.
* Stock configuration changes make use of pre-existing, non-virtual index definitions mapped
to new a Virtual Index Definition that implements the functionality provided by the
keyword|keyword index definition. The keyword|keyword definition is left in place for the time
being, until more data can be gathered about the real-world effect of removing it entirely and
replacing it with Virtual Index Definition mappings.
* New system administration functions will be created to facilitate modification of Virtual Index
Definition mapping, avoiding the need for a full reingest when existing index definitions are
added or removed from a virtual field.
== Increased use of Metabib Display Fields
In extention of changes proposed in other available branches, we here use Metabib Display Fields
to render catalog search results, intermediate metarecord results, and record detail pages.
This will requires the addition of several new Metabib Display Field definitions, as well as Perl
services to gather and render the data.
== Search Term Highlighting
This commit enables Search Term Highlighting in the OPAC on the main search results page, the record
detail page, and intermediate pages such as metarecord grouped results page. Highlighting
search terms will help the user determine why a particular record (or set of records) was retrieved.
Highlighting of matched terms uses the same stemming used to accomplish the search, as configured
per field and class.
This feature will help the user more quickly determine the relevance of a particular record by calling their
attention to search terms in context. Lastly, it will help familiarize the user with how records are
searched, including which fields are searched as well as exposing concepts like stemming.
== Interfaces
A new AngularJS "MARC Search/Facet Fields" interface has been created to replace the Dojo version, and
both have been extended to support Virtual Index Definition data supplier mapping and weighting.
== Settings & Permissions
The new Virtual Index Definition data supplier mapping table, config.metabib_field_virtual_map, requires
the same permissions as the MARC Search/Facet Fields interface: CREATE_METABIB_FIELD, UPDATE_METABIB_FIELD,
DELETE_METABIB_FIELD, or ADMIN_METABIB_FIELD for all actions
There is a new template-level global configuration variable in config.tt2 called search.no_highlight
which disables highlighting for users of that config.tt2 instance.
== Public Catalog
The public and staff catalog will make use of new APIs to identify and display highlight-augmented
values for those Display Fields used to render the search result pages, intermediate metarecord
constituent pages, and record detail pages. Highlighting of terms will be performed using the
application of Template::Toolkit-driven CSS. A generic CSS class identifying a highlighted term,
along with CSS classes identifying the search class and each search field will be available for
use for customization of the highlighting. A stock CSS
template is provided as a baseline upon which sites may expand.
When highlighting is generally enabled, it may be turned on or off on a per-page basis through the use of
a UI component which will request the page again without highlighting.
== Backend
There now exist several new database tables and functions primarily in support of search highlighting.
Additionally, the QueryParser driver for Evergreen has been augmented to be able to return a data structure
describing how the search was performed, in a way that allows a separate support API to gather a highlighted
version of the Display Field data for a given record.
== Re-ingest or Indexing Dependencies
With the addition and modification of many Index Definitions, a full reingest is recommended. However, search
will continue to work as it did before the changes in this commit for those records that have not yet been
reingested during that process. Therefore a slow, rolling reingest is recommended.
== Performance Implications or Concerns
Because the Metabib Display Fields infrastructure will eventually replace functionality that is significantly more
CPU-intensive in the various forms of XML parsing, XSLT transformation, XPath calculation, and
Metabib Virtual Record construction, it is expected that the overall CPU load will be reduced by this
development, and ideally the overall time required to perform and render a search will likewise drop. It
is unlikely that the speed increase will be visible to users on a per-search basis, but that search in
aggregate will become a smaller consumer of resources.
Signed-off-by: Mike Rylander <mrylander@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Replace reporter.simple_record data with metabib display fields.
Use flat_display_entries instead of wide_display_entry partially as an
example, but also because it requires slightly less data munging on the
DB side.
Signed-off-by: Bill Erickson <berickxx@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Conflicts:
Open-ILS/web/js/ui/default/staff/circ/in_house_use/app.js
Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Support an option in the webstaff-side display field munging code to
collapse array/multi values down to a single comma-separated string.
This is useful for buidling displays (grids especially) where you have a
single spot to put a field's value (e.g. a list of ISBN's) and don't want
to munge the data by hand in each UI.
Signed-off-by: Bill Erickson <berickxx@gmail.com> Signed-off-by: Kathy Lussier <klussier@masslnc.org> Signed-off-by: Dan Wells <dbw2@calvin.edu>
Galen Charlton [Wed, 28 Feb 2018 16:27:52 +0000 (11:27 -0500)]
LP#1676608: activate more copy alert types by default
Since users of 3.1 should be using the web staff client unless
they absolutely cannot switch from the XUL client yet, the copy
alert types for exceptional checkin and checkout statuses are now
active by default.
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org> Signed-off-by: Mike Rylander <mrylander@gmail.com>
In a few places we use the word "Paid", but there are quite a few
things in that bucket (forgiveness, adjustments, etc.) which don't fit
well under the term "Paid".
Though we have some deep structural causes for this, we can take a baby
step in the right direction by sprinkling the term "Credited" in a few
key places.
Also, correct an mislabeled "Balance" field.
Signed-off-by: Dan Wells <dbw2@calvin.edu> Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Over time, Evergreen has developed a rich set of features to support
various billing scenarios. Unfortunately, our interface has not kept up
in some ways, and this leads to some confusion at times, particularly
for front line staff.
One way to bring clarity is to apply better grouping, labeling, and
ordering of the various transactional events. By doing so, we can
generate a billing "statement" with similarities to the statements we
regularly encounter when dealing with other financial institutions.
This branch does so for the staff client view, but it also seems viable
to carry over the same idea to an eventual patron (or print) view as
well.
Signed-off-by: Dan Wells <dbw2@calvin.edu> Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Galen Charlton [Tue, 27 Feb 2018 22:23:22 +0000 (17:23 -0500)]
LP#1676608: don't sound the klaxon for unusual copy statuses during checkin
During a successful checkin, play the success sound if an
unexpected copy status is noted in the success message -- it
may have been set via a copy alert.
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org> Signed-off-by: Mike Rylander <mrylander@gmail.com>
Galen Charlton [Fri, 23 Feb 2018 21:54:51 +0000 (16:54 -0500)]
LP#1676608: inject copy alert dialog in two more places
The copy alert dialog (if an item has relevant copy alerts)
is now injected into the dialog box series when handling
checkouts of items that are in transit or where the patron
record has overridable conditions that would block the checkout.
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org> Signed-off-by: Mike Rylander <mrylander@gmail.com>
Galen Charlton [Thu, 22 Feb 2018 22:02:11 +0000 (17:02 -0500)]
LP#1676608: provide DB update script to convert legacy copy alert messages
Legacy copy alert messages are moved to new normal checkout and
normal checkin copy alerts. This patch also converts the foreign
key relationship from asset.copy_alert to asset.copy to a "fake"
one using a constraint trigger.
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org> Signed-off-by: Mike Rylander <mrylander@gmail.com>
projects / working / Evergreen.git / log