-* Introduction
-** xref:shared:about_evergreen.adoc[]
-** xref:shared:about_this_documentation.adoc[]
+* xref:shared:about_this_documentation.adoc[Introduction]
+** xref:shared:about_evergreen.adoc[About Evergreen]
-* Acquisitions
-** xref:acquisitions:introduction.adoc[Introduction]
+* xref:acquisitions:introduction.adoc[Acquisitions]
** xref:acquisitions:selection_lists_po.adoc[]
** xref:acquisitions:invoices.adoc[]
** xref:acquisitions:receive_items_from_invoice.adoc[]
==== Create a selection list ====
-Selection lists can be created in four areas within the module. Selection lists can be created when you <<_brief_records,Add Brief Records>>, Upload MARC Order Records, or find records through the <<_marc_federated_search,MARC Federated Search>>. In each of these interfaces, you will find the Add to Selection List field. Enter the name of the selection list that you want to create in that field.
+Selection lists can be created in four areas within the module. Selection lists can be created when you xref:#brief_records[Add Brief Records], Upload MARC Order Records, or find records through the xref:#marc_federated_search[MARC Federated Search]. In each of these interfaces, you will find the Add to Selection List field. Enter the name of the selection list that you want to create in that field.
Selection lists can also be created through the My Selection Lists interface:
==== Add items to a selection list ====
-You can add items to a selection list in one of three ways: <<_brief_records,add a brief record>>; upload MARC order records; add records through a <<_marc_federated_search,federated search>>; or use the View/Place Orders menu item in the catalog.
+You can add items to a selection list in one of three ways: xref:#brief_records[add a brief record]; upload MARC order records; add records through a xref:#marc_federated_search[federated search]; or use the View/Place Orders menu item in the catalog.
==== Clone selection lists ====
. Click Submit.
+[#purchase_orders]
=== Purchase Orders ===
Purchase Orders allow you to keep track of orders and, if EDI is enabled, communicate with your provider.
image::media/2_10_Lineitem_Paid.png[Paid Lineitem]
+[#brief_records]
=== Brief Records ===
Brief records are short bibliographic records with minimal information that are often used as placeholder records until items are received. Brief records can be added to selection lists or purchase orders and can be imported into the catalog. You can add brief records to new or existing selection lists. You can add brief records to new, pending or on-order purchase orders.
You can add brief records to new or existing purchase orders.
-. Open or create a purchase order. See the section on <<_purchase_orders,purchase orders>> for more information.
+. Open or create a purchase order. See the section on xref:#purchase_orders[purchase orders] for more information.
. Click Add Brief Record.
. Enter bibliographic information in the desired fields. Notice that the record is added to the purchase order that you just created.
. Click Save Record.
image::media/acq_brief_record-2.png[]
+[#marc_federated_search]
=== MARC Federated Search ===
The MARC Federated Search enables you to import bibliographic records into a selection list or purchase order from a Z39.50 source.
+
image::media/acq_marc_search.png[search form]
+
-. A list of results will appear. Click the "Copies" link to add copy information to the line item. See the <<_line_items,section on Line Items>> for more information.
-. Click the Notes link to add notes or line item alerts to the line item. See the <<_line_items,section on Line Items>> for more information.
+. A list of results will appear. Click the "Copies" link to add copy information to the line item. See the xref:#line_items[section on Line Items] for more information.
+. Click the Notes link to add notes or line item alerts to the line item. See the xref:#line_items[section on Line Items] for more information.
. Enter a price in the "Estimated Price" field.
. You can save the line item(s) to a selection list by checking the box
on the line item and clicking *Actions* -> *Save Items to Selection
image::media/acq_marc_search-2.png[line item]
+[#line_items]
=== Line Items ===
==== Return to Line Item ====
+[#best_hold_selection_sort_order]
== Best-Hold Selection Sort Order ==
Best-Hold Selection Sort Order allows libraries to configure customized rules for Evergreen to use to select the best hold to fill at opportunistic capture. When an item is captured for a hold upon check-in, Evergreen evaluates the holds in the system that the item could fill. Evergreen uses a set of rules, or a Best-Hold Selection Sort Order, to determine the best hold to fill with the item. In previous version of Evergreen, there were two sets of rules for Evergreen to use to determine the best hold to fulfill: Traditional and FIFO (First In, First Out). Traditional uses Org Unit Proximity to identify the nearest hold to fill. FIFO follows a strict order of first-in, first-out rules. This feature allows new, custom Best-Hold Selection Sort Orders to be created. Existing Best-Hold Selection Sort Orders can also be modified.
Org Unit Proximity Adjustments allow libraries to customize the distances between org units, which provides
more control over which libraries are looked at when targeting copies to fill a hold. Evergreen can also be
configured to take Org Unit Proximity Adjustments into account during opportunistic capture through the
-creation of a custom Best-Hold Selection Sort Order. See documentation <<_best_hold_selection_sort_order,here>>
+creation of a custom Best-Hold Selection Sort Order. See documentation xref:#best_hold_selection_sort_order[here]
for more information on Best-Hold Selection Sort Order.
An Org Unit Proximity Adjustment can be created to tell Evergreen which libraries to look at first for items to fill a hold or which library to look at last. This may be useful for accounting for true transit costs or physical distances between libraries. It can also be used to identify libraries that have special lending agreements or preferences. Org Unit Proximity Adjustments can be created for all holds between two org units, or they can be created for holds on specific Shelving Locations and Circulation Modifiers.
The SMS Text Messaging feature enables users to receive hold notices via text message. Users can opt-in to this hold notification as their default setting for all holds, or they
can receive specific hold notifications via text message. Users can also send call numbers and item locations via text message.
+[#administrative_setup]
=== Administrative Setup ===
You cannot receive text messages from Evergreen by default. You must enable this feature to receive hold notices and item information from Evergreen via text message.
. Login to your account in the OPAC. NOTE: If you have disabled the
setting that requires patron login, then you do not have to login to
their accounts to send text messages. See
-<<_administrative_setup,Administrative Setup>> for more information.
+xref:#administrative_setup[Administrative Setup] for more information.
+
image::media/SMS_Text_Messaging7.jpg[SMS_Text_Messaging7]
+
You will notice four tabs on this page: <<event_definitions, Event Definitions>>, <<hooks, Hooks>>, <<reactors, Reactors>> and <<validators, Validators>>.
-anchor:event_definitions[]
+[#event_definitions]
=== Event Definitions ===
WARNING: If you are testing an email or SMS notification, use a test account and email as an example. Using the Test feature will actually result in the notification being sent if configured correctly. Similarly, use a test item or barcode when testing a circulation-based event like Mark Lost since the test will mark the item as lost.
-anchor:hooks[]
+[#hooks]
==== Hooks ====
Hooks define the Fieldmapper class in the core_type column off of which the rest of the field definitions ``hang''.
You may also create, edit and delete Hooks but the Core Type must refer to an IDL class in the fm_IDL.xml file.
-anchor:reactors[]
+[#reactors]
==== Reactors ====
You may also create, edit and delete Reactors. Just remember that there must be an associated subroutine or module in the Reactor Perl module.
-anchor:validators[]
+[#validators]
==== Validators ====
+[#processing_action_triggers]
=== Processing Action Triggers ===
To run action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
+[#apache_access_handler_perl_module]
== Apache Access Handler Perl Module ==
The OpenILS::WWW::AccessHandler Perl module is intended for limiting patron
access to configured locations in Apache. These locations could be folder
+[#apache_rewrite_tricks]
== Apache Rewrite Tricks ==
It is possible to use Apache's Rewrite Module features to perform a number of
useful tricks that can make people's lives much easier.
With the *Library Settings Editor* one can optionally customize
Evergreen's behavior for a particular library or library system. For
-descriptions of available settings see the <<_settings_overview,Settings
-Overview>> table below.
+descriptions of available settings see the xref:#settings_overview[Settings Overview] table below.
=== Editing Library Settings ===
image::media/lse-3.png[Library Setting History]
NOTE: Please note that different settings may require different data
-formats, which are listed in the <<_settings_overview,Settings
-Overview>> table. Refer to the <<_data_types,Data Types>> table at the
+formats, which are listed in the xref:#settings_overview[Settings Overview] table. Refer to the xref:#data_types[Data Types] table at the
bottom of this page for more information.
=== Exporting/Importing Library Settings ===
+
image::media/lse-5.png[Importing Library Settings]
+[#settings_overview]
=== Settings Overview ===
The settings are grouped together in separate tables based on functions
sequence as you see in the staff client. Each table describes the
available settings in the group and shows which can be changed on a
per-library basis. At the bottom is the table with a list of
-<<_data_types, data types>> with details about acceptable settings
+ xref:#data_types[data types] with details about acceptable settings
values.
((("Acquisitions", "Library Settings Editor")))
|Vandelay Generate Default Call Numbers|Auto-generate default item call numbers when no item call number is present|True/False|These are pulled from the MARC Record.
|========
+[#data_types]
==== Data Types ====
((("Data Types", "Library Settings Editor")))
currently has on hold by adding the `addcount` parameter.
As always, you can add the skipemail parameter to skip patrons with
-email notifications of their overdues, see <<_skipping_patrons_with_email_notification_of_holds, Skipping
-patrons with email notification of holds>> as described below.
+email notifications of their overdues, see xref:#skipping_patrons_with_email_notification_of_holds[Skipping patrons with email notification of holds] as described below.
.Columns in the holds CSV file:
less than or greater than the number of days specified.
As always, you can add the skipemail parameter to skip patrons with
-email notifications of their overdues, see <<_skipping_patrons_with_email_notification_of_holds, Skipping patrons with
-email notification of holds>> as described below.
+email notifications of their overdues, see xref:#skipping_patrons_with_email_notification_of_holds[Skipping patrons with email notification of holds] as described below.
.Columns in the overdues CSV file:
|=================================
| Titles | A colon-separated list of titles that the patron has overdue.
|=================================
+[#skipping_patrons_with_email_notification_of_holds]
=== Skipping patrons with email notification of holds ===
Skipping patrons who have email notification for their holds or
| 99-98 | SC-ACS Status | Yes |<<sip_99-98_sc_and_acs_status, 99/98_SC_and_ACS_Status>>
|===========================================================================
-anchor:sip_01_block_patron[]
+[#sip_01_block_patron]
==== 01 Block Patron ====
* Screen Message 1 (AF): _blocked_
* Patron
-anchor:sip_09-10_checkin[]
+[#sip_09-10_checkin]
==== 09/10 Checkin ====
* CT is the _destination location_ (i.e., pickup lib for a hold or target lib for a transfer).
===============
-anchor:sip_11-12_checkout[]
+[#sip_11-12_checkout]
==== 11/12 Checkout ====
-anchor:sip_15-16_hold[]
+[#sip_15-16_hold]
==== 15/16 Hold ====
holds. It does not currently support creating hold requests via SIP2.
-anchor:sip_17-18_item_information[]
+[#sip_17-18_item_information]
17/18 Item Information
^^^^^^^^^^^^^^^^^^^^^^
systems.
-anchor:sip_19-20_item_status_update[]
+[#sip_19-20_item_status_update]
==== 19/20 Item Status Update ====
-anchor:sip_23-24_patron_status[]
+[#sip_23-24_patron_status]
23/24 Patron Status
^^^^^^^^^^^^^^^^^^^
field definitions in your copy of the spec.
-anchor:sip_25-26_patron_enable[]
+[#sip_25-26_patron_enable]
25/26 Patron Enable
^^^^^^^^^^^^^^^^^^^
Not yet supported.
-anchor:sip_29-30_renew[]
+[#sip_29-30_renew]
==== 29/30 Renew ====
renewals before blocking any SIP renewal.
-anchor:sip_35-36_end_session[]
+[#sip_35-36_end_session]
==== 35/36 End Session ====
-anchor:sip_37-38_fee_paid[]
+[#sip_37-38_fee_paid]
37/38 Fee Paid
^^^^^^^^^^^^^^
Evergreen supports the Fee Paid message.
-anchor:sip_63-64_patron_information[]
+[#sip_63-64_patron_information]
63/64 Patron Information
^^^^^^^^^^^^^^^^^^^^^^^^
-anchor:sip_65-66_renew_all[]
+[#sip_65-66_renew_all]
==== 65/66 Renew All ====
Evergreen supports the Renew All message.
-anchor:sip_93-94_login[]
+[#sip_93-94_login]
93/94 Login
^^^^^^^^^^^
When using a version of SIPServer that supports the feature, the Location (CP) field of the Login (93) message will be used as the workstation name if supplied. Blank or missing location fields will be ignored. This allows users or reports to determine which selfcheck performed a circulation.
-anchor:sip_97-96_resend[]
+[#sip_97-96_resend]
==== 97/96 Resend ====
-anchor:sip_99-98_sc_and_acs_status[]
+[#sip_99-98_sc_and_acs_status]
==== 99/98 SC and ACS Status ====
supported by the +ACS+ or not.
-anchor:fields[]
+[#fields]
==== Fields ====
thing to note is that the file references are relative to the top of the
template directory.
+[#how_to_override_templates]
=== How to override templates ===
Overrides for templates go in a directory that parallels the structure of the
-----------------------
=== Registering a Workstation ===
-anchor:register_workstation[]
+[#register_workstation]
indexterm:[staff client, registering a workstation]
Before logging into Evergreen, you must first register a workstation from your
-* System Configuration and Customization
-** xref:admin_initial_setup:introduction.adoc[Introduction]
+* xref:admin_initial_setup:introduction.adoc[System Configuration and
+* Customization]
** xref:admin_initial_setup:describing_your_organization.adoc[]
** xref:admin_initial_setup:describing_your_people.adoc[]
** xref:admin_initial_setup:migrating_patron_data.adoc[]
The following example enables you to configure the alternate skin (Monster Skin, kpac2) for the Kids
Catalog.
-You should be familiar with how the <<_how_to_override_templates,Evergreen TPAC handles template folders>>
+You should be familiar with how the xref:admin:template_toolkit.adoc#how_to_override_templates[Evergreen TPAC handles template folders]
before you make these changes.
If you already have a custom template directory setup you can copy the *Open-ILS/examples/web/templates/kpac*
SetEnv physical_loc 104
----
+[#setting_a_default_language_and_adding_optional_languages]
=== Setting a default language and adding optional languages ===
_OILSWebLocale_ adds support for a specific language. Add this variable to the
. Select _PO format_ and submit the _request for download_ button. You can also request for download of all existing templates and languages at once, see https://translations.launchpad.net/evergreen/master/+export. The download link will be sent You to email address provided.
. Download the file and name it according to the language used (e.g., _cs-CZ.po_ for Czech or _es-ES.po_ for Spanish)
. Copy the downloaded file to _/openils/var/template/data/locale_. It is a good practice to backup the original PO file before.
-. Be sure that the desired language is set as default, using the <<_setting_a_default_language_and_adding_optional_languages,Default language>> procedures.
+. Be sure that the desired language is set as default, using the xref:#setting_a_default_language_and_adding_optional_languages[Default language] procedures.
Analogously, to update the web staff client translations, download the translation template _webstaff_ and copy it to _openils/var/template/data/locale/staff_.
NOTE: All fields (except for Name and Tag) can contain a MARC subfield code
(such as "a") or an XPATH query. You can also use the
-<<lse-vandelay,related library settings>> to set defaults for some of these fields.
+xref:admin:librarysettings.adoc#lse-vandelay[related library settings] to set defaults for some of these fields.
image::media/batch_import_profile.png[Partial Screenshot of a Holdings Import Profile]
-* Getting Data from Evergreen
-** xref:development:introduction.adoc[Introduction]
+* xref:development:introduction.adoc[Getting Data from Evergreen]
** xref:development:data_supercat.adoc[]
** xref:development:data_unapi.adoc[]
** xref:development:data_opensearch.adoc[]
--- /dev/null
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
-* Appendix
-** xref:shared:attributions.adoc[Attributions]
-** xref:shared:licensing.adoc[Licensing]
-** xref:shared:index.adoc[Index]
+* xref:shared:attributions.adoc[Appendix A. Attributions]
+* xref:shared:licensing.adoc[Appendix B. Licensing]
+* xref:shared:index.adoc[Index]
--- /dev/null
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
-* Cataloging
-** xref:cataloging:introduction.adoc[Introduction]
+* xref:cataloging:introduction.adoc[Cataloging]
** xref:cataloging:marc_tag_table.adoc[]
** xref:cataloging:copy-buckets_web_client.adoc[]
** xref:cataloging:item_tags_cataloging.adoc[]
to finally add the new authority record to your system.
-[[_importing_authority_records_from_the_staff_client]]
+[[importing_authority_records_from_the_staff_client]]
=== Importing Authorities ===
. Click *Cataloging -> MARC Batch Import/Export.*
. You may create a queue to better track this import project. If you do not create a new queue, it will automatically put your records into a default queue named *-*.
-* Circulation
-** xref:circulation:introduction.adoc[Introduction]
+* xref:circulation:introduction.adoc[Circulation]
** xref:circulation:circulating_items_web_client.adoc[]
** xref:circulation:basic_holds.adoc[]
** xref:circulation:advanced_holds.adoc[]
==============
+[#actions_for_selected_holds]
==== Actions for Selected Holds ====
. Retrieve the patron record and go to the _Holds_ screen.
+
. Highlight the hold you want to edit. Choose an action from the
_Actions_ menu. For more information see the
-<<_actions_for_selected_holds,Actions for Selected Holds>> section. For
+xref:#actions_for_selected_holds[Actions for Selected Holds] section. For
example, you can retrieve the hold requestor’s account by selecting
_Retrieve Patron_ from this menu.
+
=== Managing Offline Transactions ===
+[#offline_block_list]
==== Offline Block List ====
While logged in and still online, you may download an *Offline Block List*. This will locally store a list of all patrons with blocks at the time of the download. If this list is present, the Offline Circulation interface will check transactions against this list.
To export transactions while you are logged in, navigate to *Circulation -> Offline Circulation* and click on the *Session Management* tab. Click on the *Export Transactions* button to generate the pending.xacts file as above. If you wish, you can at this point click *Clear Transactions* to clear the list of pending transactions.
+[#processing_offline_transactions]
==== Processing Offline Transactions ====
Once connectivity is restored, navigate back to your *Evergreen Login Page*. You will see a message telling you that there are unprocessed Offline Transactions waiting for upload.
+
image::media/offline_processing_complete.png[Offline processing complete]
+
-. Scroll to the bottom of the screen to see if there are any entries in the <<_exceptions,*Exception List*>>. Some of these may require staff follow up.
+. Scroll to the bottom of the screen to see if there are any entries in the xref:#exceptions[*Exception List*]. Some of these may require staff follow up.
==== Uploading Previously Exported Transactions ====
. Navigate to the location on your computer where the pending.xacts file is saved.
. Select the file for importing.
. The *Pending Transactions* list will populate with your imported transactions.
-. You may now proceed according to the instructions under <<_processing_offline_transactions,Processing Offline Transactions>>.
+. You may now proceed according to the instructions under xref:#processing_offline_transactions[Processing Offline Transactions].
+[#exceptions]
===== Exceptions =====
Exceptions are problems that were encountered during processing. For example, a mis-scanned patron barcode, an open circulation, or an item that was not checked in before it was checked out to another patron would all be listed as exceptions. Those transactions causing exceptions might not be loaded into Evergreen database. Staff should examine the exceptions and take necessary action.
* An item that is targeted for a patron hold and captured via offline checkin will not cause an exception unless that item also goes to an In Transit status.
* An item that is on hold for Patron A but checked out to Patron B will not cause an exception. Patron A's hold will be reset and will retarget the next time the hold targeter is run. In order to avoid this it is recommended to not check out holds to other patrons.
* If you check out a book to a patron using a previous barcode for that patron, it will cause an exception and you will have to retrieve that patron while online and re-enter the item barcode in order to checkout the item.
-* The Offline Interface can recognize blocked, barred, and expired patrons if you have downloaded the Offline Block List in the browser you are using. You will get an error message indicating the patron status from within the Standalone Interface at check-out time. See the section on the <<_offline_block_list,Offline Block List>> for more information.
+* The Offline Interface can recognize blocked, barred, and expired patrons if you have downloaded the Offline Block List in the browser you are using. You will get an error message indicating the patron status from within the Standalone Interface at check-out time. See the section on the xref:#offline_block_list[Offline Block List] for more information.
image::media/offline_exceptions.png[Offline exception list]
-* Developer Resources
-** xref:development:introduction.adoc[Introduction]
+* xref:development:introduction.adoc[Developer Resources]
** xref:development:support_scripts.adoc[]
** xref:development:pgtap.adoc[]
** xref:development:intro_opensrf.adoc[]
`opensrf` XMPP client credentials could be
`opensrf@private.localhost/opensrf.simple-text_drone_at_localhost_6285`.
-[id="OpenSRFOverHTTP"]
+[#OpenSRFOverHTTP]
==== OpenSRF communication flows over HTTP ====
Any OpenSRF service registered with the public router is accessible via the
OpenSRF HTTP Translator. The OpenSRF HTTP Translator implements the
`/osrf-http-translator` is the default location in the Apache example
configuration files shipped with the OpenSRF source, but this is configurable.
-[id="httpResults"]
+[#httpResults]
.Results from an HTTP POST request to an OpenSRF method via the OpenSRF HTTP Translator
[source,bash]
--------------------------------------------------------------------------------
`__PACKAGE__` that contains the current package name). The `register_method()`
procedure is how we introduce a method to the rest of the OpenSRF world.
-[id="serviceRegistration"]
+[#serviceRegistration]
==== Registering a service with the OpenSRF configuration files ====
Two files control most of the configuration for OpenSRF:
=------------------------------------
--------------------------------------------------------------------------------
-[id="opensrfIntrospection"]
+[#opensrfIntrospection]
===== Getting documentation for OpenSRF methods from the srfsh client =====
The `srfsh` client also gives you command-line access to retrieving metadata
-- Groups together event output for already processed events. Useful for
creating files that contain data from a group of events. Such as a CSV
file with all the overdue data for one day.
- * <<_processing_action_triggers,action_trigger_runner.pl>>
+ * xref:admin:actiontriggers_process.adoc#processing_action_triggers[action_trigger_runner.pl]
-- Useful for creating events for specified hooks and running pending events
* authority_authority_linker.pl
-- Links reference headings in authority records to main entry headings
in other authority records. Should be run at least once a day (only for
changed records).
- * <<_authority_control_fields,authority_control_fields.pl>>
+ * xref:#authority_control_fields[authority_control_fields.pl]
-- Links bibliographic records to the best matching authority record.
Should be run at least once a day (only for changed records).
You can accomplish this by running _authority_control_fields.pl --days-back=1_
facet definitions, compressed JS files and related cache key
* clark-kent.pl
-- Used to start and stop the reporter (which runs scheduled reports)
- * <<_creating_the_evergreen_database,eg_db_config>>
+ * xref:installation:server_installation.adoc#creating_the_evergreen_database[eg_db_config]
-- Creates database and schema, updates config files, sets Evergreen
administrator username and password
* fine_generator.pl
* hold_targeter.pl
- * <<_importing_authority_records_from_command_line,marc2are.pl>>
+ * xref:#importing_authority_records_from_command_line[marc2are.pl]
-- Converts authority records from MARC format to Evergreen objects
suitable for importing via pg_loader.pl (or parallel_pg_loader.pl)
* marc2bre.pl
* marc2sre.pl
-- Converts serial records from MARC format to Evergreen objects
suitable for importing via pg_loader.pl (or parallel_pg_loader.pl)
- * <<_marc_export,marc_export>>
+ * xref:#marc_export[marc_export]
-- Exports authority, bibliographic, and serial holdings records into
any of these formats: USMARC, UNIMARC, XML, BRE, ARE
* osrf_control
-- Uses the output of marc2bre.pl (or similar tools) to generate the SQL
for importing records into Evergreen in a parallel fashion
-anchor:_authority_control_fields[]
+[#authority_control_fields]
=== authority_control_fields: Connecting Bibliographic and Authority records ===
|=========================================================
-anchor:_marc_export[]
+[#marc_export]
=== marc_export: Exporting Bibliographic Records into MARC files ===
`--library` or `--descendants` options to export *all* of a library's
holdings both physical and electronic.
-anchor:_pingest_pl[]
+[#pingest_pl]
=== Parallel Ingest with pingest.pl ===
+[#importing_authority_records_from_command_line]
=== Importing Authority Records from Command Line ===
indexterm:[marc2are.pl]
-* Software Installation
-** xref:installation:introduction.adoc[Introduction]
+* xref:installation:introduction.adoc[Software Installation]
** xref:installation:system_requirements.adoc[System Requirements]
** xref:installation:server_installation.adoc[Installing the Evergreen server]
** xref:installation:server_upgrade.adoc[Upgrading the Evergreen Server]
+
[source, bash]
--------------------------------------------------
-== cp -r Open-ILS/src/edi_translator /openils/var/edi ==
+cp -r Open-ILS/src/edi_translator /openils/var/edi
+--------------------------------------------------
2. Navigate to where you have saved the code to begin next step:
+
[source, bash]
-------------------
-== cd /openils/var/edi ==
+cd /openils/var/edi
+-------------------
3. Next, as the *root* user (or a user with sudo rights), install the
dependencies, via "install.sh". This will perform some apt-get routines
to install the code needed for the EDI translator to function.
+
[source, bash]
-----------------------
-== kill -INT $(pgrep ruby) ==
+kill -INT $(pgrep ruby)
+-----------------------
==== Install EDI Scripts ====
[source, bash]
-----------------------------------------------------------------------
10 * * * * cd /openils/bin && /usr/bin/perl ./edi_pusher.pl > /dev/null
-== 0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null ==
+0 1 * * * cd /openils/bin && /usr/bin/perl ./edi_fetcher.pl > /dev/null
+-----------------------------------------------------------------------
* The example for edi_pusher.pl sets the script to run at
10 minutes past the hour, every hour.
* The example for edi_fetcher.pl sets the script to run at
== Installing the Evergreen server ==
:toc:
-:numbered:
=== Preamble: referenced user accounts ===
Learn more about additional Apache options in the following sections:
- * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
- * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
+ * xref:admin:apache_rewrite_tricks.adoc#apache_rewrite_tricks[Apache Rewrite Tricks]
+ * xref:admin:apache_access_handler.adoc#apache_access_handler_perl_module[Apache Access Handler Perl Module]
=== Configure OpenSRF for the Evergreen application ===
There are a number of example OpenSRF configuration files in `/openils/conf/`
appended to the file name, so if you have forgotten the Jabber users and
domains, you can retrieve the settings from the backup version of the files.
-`eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
-database>>, sets the database connection information in `opensrf.xml` for you.
+`eg_db_config`, described in xref:#creating_the_evergreen_database[Creating the Evergreen database], sets the database connection information in `opensrf.xml` for you.
=== Configure action triggers for the Evergreen application ===
_Action Triggers_ provide hooks for the system to perform actions when a given
------------------------------------------------------------------------------
For more information about configuring and running action triggers, see
-<<_processing_action_triggers,Notifications / Action Triggers>>.
+xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers].
+[#creating_the_evergreen_database]
=== Creating the Evergreen database ===
==== Setting up the PostgreSQL server ====
------------------------------------
--------------------------------------------------------------
+
-If this does not work, it's time to do some <<install-troubleshooting-1,troubleshooting>>.
+If this does not work, it's time to do some
+xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting].
+
. As the *root* user, start the Apache web server.
+
-If you encounter errors, refer to the <<install-troubleshooting-1,troubleshooting>> section
+If you encounter errors, refer to the
+xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting] section
of this documentation for tips on finding solutions and seeking further assistance
from the Evergreen community.
-* Local Administration
-** xref:local_admin:introduction.adoc[Introduction]
+* xref:local_admin:introduction.adoc[Local Administration]
** xref:admin:librarysettings.adoc[Library Settings Editor]
** xref:admin:lsa-address_alert.adoc[Address Alert]
** xref:admin:lsa-barcode_completion.adoc[Barcode Completion]
--- /dev/null
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
-* Using the Public Access Catalog
-** xref:opac:introduction.adoc[Introduction]
+* xref:opac:introduction.adoc[Using the Public Access Catalog]
** xref:opac:using_the_public_access_catalog.adoc[]
** xref:opac:my_lists.adoc[]
** xref:opac:batch_actions_from_search.adoc[]
+[#batch_actions_from_search]
== Batch Actions from Search ==
=== Introduction ===
-anchor:my_account[]
+[#my_account]
=== My Account ===
If using a public computer be sure to log out!
=================
-anchor:password_reset[]
+[#password_reset]
==== Password Reset ====
There is now a direct link to *My Lists* from the *My Account* area in the top right part of the screen. This gives users the ability to quickly access their lists while logged into the catalog.
-As of version 3.2, <<_batch_actions_from_search,Batch Actions from Search Results>> has replaced the old Temporary Lists feature, as well as enabled multiple selections from a search results list.
+As of version 3.2, xref:opac:batch_actions_from_search.adoc#batch_actions_from_search[Batch Actions from Search Results] has replaced the old Temporary Lists feature, as well as enabled multiple selections from a search results list.
image::media/My_Lists.png[My Lists]
Each filter can be removed by clicking the X next to the filter name to modify the search within the search results screen. Below the search box on the search results screen, there is also a link to _Refine My Original Search_, which will bring the user back to the advanced search screen where the original search parameters selected can be viewed and modified.
-anchor:numeric_search[]
+[#numeric_search]
indexterm:[advanced search, numeric search]
==== Numeric Search ====
=== Search Methodology ===
-anchor:stemming[]
+[#stemming]
Stemming
^^^^^^^^
_golden_.
-anchor:order_of_results[]
+[#order_of_results]
==== Order of Results ====
-* Reports
-** xref:reports:introduction.adoc[Introduction]
+* xref:reports:introduction.adoc[Reports]
** xref:reports:reporter_daemon.adoc[]
** xref:reports:reporter_folder.adoc[]
** xref:reports:reporter_create_templates.adoc[]
Folders_.
The steps below assume you have already created at least one _Templates_ folder.
-If you haven’t done this, please see <<reporter_creating_folders,Creating Folders>>.
+If you haven’t done this, please see
+xref:reports:reporter_folder.adoc#reporter_creating_folders[Creating Folders].
. Access the reports interface from _Administration_ -> _Reports_
. Under _Shared Folders_ expand the _Templates_ folder and the subfolder of the
. Choose the folder where you want to save the cloned template, then click
_Select Folder_. Only template folders created with your account will be visible.
If there are no folders to choose from please see
-<<reporter_creating_folders,Creating Folders>>.
+xref:reports:reporter_folder.adoc#reporter_creating_folders[Creating Folders].
. The cloned template opens in the template editor. From here you may modify
the template by adding, removing, or editing fields and filters as described in
-<<reporter_creating_templates,Creating Templates>>. _Template Name_ and
+xref:reports:reporter_create_templates.adoc#reporter_creating_templates[Creating Templates]. _Template Name_ and
_Description_ can also be edited. When satisfied with your changes click _Save_.
. Click _OK_ in the resulting confirmation windows.
image::media/create-template-6.png[create-template-6]
+
_Field Transforms_ have either an _Aggregate_ or _Non-Aggregate_ output type.
-See the section called <<field_transforms,Field Transforms>> for more about
+See the section called
+xref:reports:reporter_template_terminology.adoc#field_transforms[Field Transforms] for more about
_Count, _Count Distinct_, and other transform options.
+
. Click _Add Selected Fields_ underneath the _Field Transform_ pane to add this
client or browser), and as a bar chart.
+
2) If you want the report to be recurring, check the box and select the
-_Recurrence Interval_ as described in <<recurring_reports,Recurring Reports>>.
+_Recurrence Interval_ as described in
+xref:reports:reporter_running_recurring_reports.adoc#recurring_reports[Recurring Reports].
In this example, as this is a report that will only be run once, the _Recurring
Report_ box is not checked.
+
you’ll get an email informing you that the report has successfully run. You can
click on a link in the email that will take you directly to the report output.
You can also access the output through the reporter interface as described in
-<<viewing_report_output,Viewing Report Output>>.
+xref:reports:reporter_view_output.adoc#viewing_report_output[Viewing Report Output].
-To set up a monthly recurring report follow the procedure in <<generating_reports,
-Generating Reports from Templates>> but make the changes described below.
+To set up a monthly recurring report follow the procedure in
+xref:reports:reporter_generating_reports.adoc#generating_reports[Generating Reports from Templates] but make the changes described below.
. Select the Recurring Report check-box and set the recurrence interval to 1 month.
. Do not select Run ASAP. Instead schedule the report to run early on the first
-* Serials
-** xref:serials:A-intro.adoc[]
+* xref:serials:A-intro.adoc[Serials]
** xref:serials:B-serials_admin.adoc[]
** xref:serials:C-serials_workflow.adoc[]
** xref:serials:D-Receiving.adoc[]
has drawn together, edited, and supplemented pre-existing documentation
contributed by libraries and consortia running Evergreen that were kind enough
to release their documentation into the creative commons. Please see the
-<<attributions,Attributions>> section for a full list of authors and
+xref:shared:attributions.adoc#attributions[Attributions] section for a full list of authors and
contributing organizations. Just like the software it describes, this guide is
a work in progress, continually revised to meet the needs of its users, so if
you find errors or omissions, please let us know, by contacting the DIG
-* System Administration From the Staff Client
-** xref:sys_admin:introduction.adoc[Introduction]
+* xref:sys_admin:introduction.adoc[System Administration From the Staff Client]
** xref:admin:acquisitions_admin.adoc[Acquisitions Administration]
** xref:admin:age_hold_protection.adoc[Age hold protection]
** xref:admin:authorities.adoc[Authorities]
--- /dev/null
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
-* Using the Browser Staff Client
-** xref:using_staff_client:introduction.adoc[Introduction]
+* xref:using_staff_client:introduction.adoc[Using the Browser Staff Client]
** xref:admin:web_client-login.adoc[Logging into Evergreen]
** xref:admin:web-client-browser-best-practices.adoc[Best Practices for Using the Browser]
** xref:admin:staff_client-column_picker.adoc[Column Picker]
--- /dev/null
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
projects / evergreen-equinox.git / commitdiff