From: Angela Kilsdonk Date: Tue, 29 Sep 2020 20:57:23 +0000 (-0400) Subject: docs: OPAC Email Print documentation X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=a5ceafc96fb4eba51600a819dae5090ec49b41d3;p=evergreen%2Fpines.git docs: OPAC Email Print documentation Signed-off-by: Angela Kilsdonk Signed-off-by: Andrea Buntz Neiman Signed-off-by: Galen Charlton --- diff --git a/docs/modules/admin/assets/images/media/ope_event_defs.png b/docs/modules/admin/assets/images/media/ope_event_defs.png new file mode 100644 index 0000000000..a06c3c38d9 Binary files /dev/null and b/docs/modules/admin/assets/images/media/ope_event_defs.png differ diff --git a/docs/modules/admin/assets/images/media/ope_event_params.png b/docs/modules/admin/assets/images/media/ope_event_params.png new file mode 100644 index 0000000000..0be8d03e69 Binary files /dev/null and b/docs/modules/admin/assets/images/media/ope_event_params.png differ diff --git a/docs/modules/admin/pages/actiontriggers.adoc b/docs/modules/admin/pages/actiontriggers.adoc index 8d43a1c49a..27b8ebaf19 100644 --- a/docs/modules/admin/pages/actiontriggers.adoc +++ b/docs/modules/admin/pages/actiontriggers.adoc @@ -276,3 +276,44 @@ pending events with that same granularity. perl action_trigger_runner.pl --run-pending --granularity=Hourly --process-hooks ---- +[[configure_opac_email_print]] +== Configure OPAC Record Email and Print == + +The information displayed in the printout and email is defined and generated by two new Notification/Action Triggers named “biblio.record_entry.print” and biblio.record_entry.email”. Notification/Action Triggers are found under *Admin -> Local Administration.* + +The printout and email will include the following bibliographic information by default: + +* Bibliographic Record ID +* Title statement +* Author +* Item Type +* Publisher +* Publication date +* ISBN +* ISSN +* UPC + +If *Full display* is selected by the OPAC user, the following holdings information is included in the printout or email, if relevant: + +* Circulating Library +* Item Location +* Call Number (including prefix and suffix) +* Monograph Parts +* Item Status +* Item Barcode + +The bibliographic and item information included in the printout or email can be configured by modifying the respective Action Trigger templates. + +For the Full display, the maximum number of copies to be displayed per record can also be configured in the Action Trigger Event Parameter field. To set the maximum number of copies for display, go to *Admin -> Local Administration -> Notifications / Action Triggers* and find the print or email notification/action trigger to modify. + +. Select the hyperlinked name of the Notification/Action Trigger to view the Trigger Event Environment. ++ +image::media/ope_event_defs.png[Email and Print Event Definitions] ++ +. Select the *Event Parameters* tab and in the upper right-hand corner, select *New* to create a new Trigger Event Parameter. +. In the _Parameter Name_ field enter holdings_limit. +. In the _Parameter Value_ field enter the maximum number of copies to be displayed per record. +. Select *Save* to save your changes. ++ +image::media/ope_event_params.png[Email and Print Event Parameters] ++ \ No newline at end of file diff --git a/docs/modules/admin/pages/event_definition_groups.adoc b/docs/modules/admin/pages/event_definition_groups.adoc new file mode 100644 index 0000000000..7d4566ce57 --- /dev/null +++ b/docs/modules/admin/pages/event_definition_groups.adoc @@ -0,0 +1,9 @@ +[[event_definition_groups]] += Event Definition Groups = +:toc: + +Two new interfaces have been added to Server Administration: *Event Definition Groups* and *Event Definition Group Members*. The Event Definition Groups defines the various groups for Action Trigger Event Definitions -- currently Print Record(s) or Email Record(s). The Event Definition Group Members defines the options within each group -- currently Brief or Full record information. + +These two interfaces expose the infrastructure behind the OPAC print and email functionality and library staff will not need to make any changes to these interfaces to use the existing print and email options. + +The stock print and email Action Trigger Event Definitions can be cloned and modified to provide additional bibliographic format options. After creating the custom Event Definition, add it to the appropriate Event Definition Group (Print Record or Email Record) and the new format will be available in the catalog. \ No newline at end of file diff --git a/docs/modules/opac/assets/images/media/ope_email_captcha.png b/docs/modules/opac/assets/images/media/ope_email_captcha.png new file mode 100644 index 0000000000..0757f2b2c6 Binary files /dev/null and b/docs/modules/opac/assets/images/media/ope_email_captcha.png differ diff --git a/docs/modules/opac/assets/images/media/ope_email_logged_in.png b/docs/modules/opac/assets/images/media/ope_email_logged_in.png new file mode 100644 index 0000000000..e4410d3492 Binary files /dev/null and b/docs/modules/opac/assets/images/media/ope_email_logged_in.png differ diff --git a/docs/modules/opac/assets/images/media/ope_print.png b/docs/modules/opac/assets/images/media/ope_print.png new file mode 100644 index 0000000000..2a8e17bc74 Binary files /dev/null and b/docs/modules/opac/assets/images/media/ope_print.png differ diff --git a/docs/modules/opac/assets/images/media/ope_record_view.png b/docs/modules/opac/assets/images/media/ope_record_view.png new file mode 100644 index 0000000000..08725705ee Binary files /dev/null and b/docs/modules/opac/assets/images/media/ope_record_view.png differ diff --git a/docs/modules/opac/pages/using_the_public_access_catalog.adoc b/docs/modules/opac/pages/using_the_public_access_catalog.adoc index 800a8d3ef0..892ff4d87b 100644 --- a/docs/modules/opac/pages/using_the_public_access_catalog.adoc +++ b/docs/modules/opac/pages/using_the_public_access_catalog.adoc @@ -524,6 +524,31 @@ hold has not been fulfilled you do not need the item anymore. image::media/catalogue-9.png[catalogue-9] +=== Printing and Emailing Records === + +indexterm:[opac printing, opac emailing] + +Evergreen now provides additional functionality for printing and emailing bibliographic record and holdings information from the catalog. Users can print or email bibliographic information from an individual bibliographic record or from a basket. + +image::media/ope_record_view.png[Location of Print and Email function] + +After selecting Print or Email, the user will be presented with a preview of the printout or email, respectively. From the preview users can choose to view Brief or Full record information (Full includes holdings information) and how records should be sorted (Author, Title, Publication Date). Holdings information can also be limited to a certain library. Users can be required to log in to their OPAC account to send an email or this feature can be configured to allow sending an email without signing in to the OPAC. + +*Print Preview* + +image::media/ope_print.png[Record Print Preview] + +*Email Preview (logged in to OPAC account)* + +image::media/ope_email_logged_in.png[Email Preview, logged in to OPAC] + +*Email Preview (not logged in to OPAC account)* + +image::media/ope_email_captcha.png[Email Preview, not logged in to OPAC] + +Printing from the OPAC while not logged in is controlled by a Library Setting called “Allow record emailing without login”. If set to True, users are not required to log in to an OPAC account to use this feature. Instead they can provide their email address and answer a CAPTCHA test. If set to False, users will be required to log in to their OPAC account and Evergreen will email the records to the address set in their account or they may provide a different email address. + + === Permalink === The record summary page offers a link to a shorter permalink that diff --git a/docs/modules/sys_admin/nav.adoc b/docs/modules/sys_admin/nav.adoc index cae85f1951..64da5034ab 100644 --- a/docs/modules/sys_admin/nav.adoc +++ b/docs/modules/sys_admin/nav.adoc @@ -23,3 +23,4 @@ ** xref:admin:SMS_messaging.adoc[SMS Text Messaging] ** xref:admin:user_activity_type.adoc[User Activity Types] ** xref:admin:restrict_Z39.50_sources_by_perm_group.adoc[Z39.50 Servers] +** xref:admin:event_definition_groups.adoc[Event Definition Groups] \ No newline at end of file