From: Robert Soulliere Date: Wed, 2 Jun 2010 13:59:06 +0000 (-0400) Subject: add root.xml and admin directory X-Git-Tag: sprint4-merge-nov22~4203^2~470^2~11 X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=e3e1bf80e144c4b82a54b35de55bfb26fef756cb;p=working%2FEvergreen.git add root.xml and admin directory --- diff --git a/1.6/admin/AdminMisc.pdf b/1.6/admin/AdminMisc.pdf new file mode 100644 index 0000000000..4b0bc90b11 Binary files /dev/null and b/1.6/admin/AdminMisc.pdf differ diff --git a/1.6/admin/AdminMisc.xml b/1.6/admin/AdminMisc.xml new file mode 100644 index 0000000000..ce2b571727 --- /dev/null +++ b/1.6/admin/AdminMisc.xml @@ -0,0 +1,193 @@ + + + + + Server Operations and Maintenance + + This chapter deals with basic server operations such as starting and stopping Evergreen as well wall security, backing up and troubleshooting Evergreen. + + +
+ Starting, Stopping and Restarting + Occasionally, you may need to restart Evergreen. It is imperative that you understand the basic + commands to stop and start the Evergreen server. You can start and stop Evergreen from the command line of + the server using the osrf_ctl.sh script located in the + openils/bin directory. + The osrf_ctl.sh script must be run as the opensrf user. + To view help on osrf_ctl.sh and get all of its options, + run: + osrf_ctl.sh -h + To start Evergreen, run: + osrf_ctl.sh -l -a start_all + The -l flag is used to indicate that Evergreen is configured to use localhost as + the host. If you have configured opensrf.xml to use your real hostname, do not use the -l flag. The -a + option is required and indicates the action of the command. In this case + start_all. + + + If you receive the error message bash: osrf_ctl.sh: + command not found, then your environment variable PATH does not include the + /openils/bin directory. + You can set it using the following command: + export PATH=$PATH:/openils/bin + If you receive the error message Can't locate OpenSRF/System.pm in @INC … BEGIN + failed–compilation aborted, then your environment variable PERL5LIB does not + include the /openils/lib/perl5 directory. You can set it + using the following command: + export PERL5LIB=$PERL5LIB:/openils/lib/perl5 + + It is also possible to start a specific service. For example: + osrf_ctl.sh -l -a start_router + will only start the router service. + + If you decide to start each service individually, you need to start them in a specific order + for Evergreen to start correctly. Run the commands in this exact order: + osrf_ctl.sh -l -a start_router + osrf_ctl.sh -l -a start_perl + osrf_ctl.sh -l -a start_c + + After starting or restarting Evergreen, it is also necessary to restart the Apache web server for the + OPAC to work correctly. + To stop Evergreen, run: + osrf_ctl.sh -l -a stop_all + As with starting, you can choose to stop one service + To restart Evergreen, run: + osrf_ctl.sh -l -a restart_all +
+
+ Backing Up + Backing up your system files and data is a critical task for server and database adminstrators. + Having a strategy for backing up and recovery could be the difference between a minor annoyance for users and + a a complete catastrophy. + + Backing up the Evergreen Database + Most of the critical data for an Evergreen system – patrons, bibliographic records, holdings, + transactions, bills – is stored in the PostgreSQL database. You can therefore use normal PostgreSQL + backup procedures to backup this data. For example, the simplest method of backing up the Evergreen + database is to use the pg_dump command to create a live backup of the database without having to + interrupt any Evergreen services as follows: + # pg_dump -U [username] -h [hostname] -f [output-file] [database-name] + pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen + To restore the backed up database into a new database, create a new database using the + template0 database template and the UTF8 encoding, and run the psql command, specifying the new + database as your target: + createdb -T template0 -E UTF8 -U evergreen -h localhost new_evergreen + psql -U evergreen -h localhost -f evergreen_db.backup new_evergreen + + This method of backup is only suitable for small Evergreen instances. Larger sites + should consider implementing continuous archiving (also known as “log shipping”) to provide + more granular backups with lower system overhead. More information on backing up PostgreSQL + databases can be found in the official PostgreSQL documentation. + + + + Backing up Evergreen Files + When you deploy Evergreen, you will probably customize many aspects of your system includung + the system configuration files, Apache configuration files, OPAC and Staff Client. In order to + protect your investment of time, you should carefully consider the best approach to backing up + files. + There are a number of ways of tackling this problem. You could create a script that regularly + creates a time-stamped tarball of all of these files and copies it to a remote server - but that + would build up over time to hundreds of files. You could use rsync to ensure that the files of + interest are regularly updated on a remote server - but then you would lose track of the changes to + the files, should you make a change that introduces a problem down the road. + Perhaps one of the best options is to use a version control system like Bazaar, git, + Subversion, or CVS to regularly push updates of the files you care about to a repository on a + remote server. This gives you the advantage of quickly being able to run through the history of the + changes you made, with a commenting system that reminds you why each change was made, combined with + remote storage of the pertinent files in case of disaster on site. In addition, your team can create + local copies of the repository and test their own changes in isolation from the production + system. Using a version control system also helps to recover system customizations after an + upgrade. + + + Full System Backup + A full system backup archives every file on the file system. Some basic methods require you + to shut down most system processes; other methods can use mirrored RAID setups or SAN storage to + take “snapshot” backups of your full system while the system continues to run. The subject of how + to implement full system backups is beyond the scope of this documentation. + +
+
+ Security + As with an ILS and resource accessible from the world wilde web careful consideration needs to be + given to the security of your Evergreen servers and database. While it is impossible to cover all aspects + of security, it is important to take several percautions when setting up production Evergreen site. + + + Change the Evergreen Admin password and keep it secure. The + default Admin password is known by anyone who has installed Evergreen. It is not a secret + and needs to be changed by the Administrator. It should also only be shared by those who + need the highest level access to Evergreen. + + + Create strong passwords using a combination of numerican and alphatbetical characters + for all of the Administrative passwords used by Evergreen including the Evergreen + postgresql user, opensrf linux account, and Admin evergreen users, and of course, any + superusers on your server. + + + Open ports in the firewall with Caution - It is necessary to open some ports to the + server such as port 80 for http and 443 for ssl, and it can be helpful to open ports for + remote access to the database or staff client. It is also critical for an administrator to + understand the concepts of network security and take precautions to not allow the server to + be vulnerable to the outside world. + + + + Use permissions and permission groups wisely - it is important to understand the + purpose of the permissions and to only give users the level of access that they require. + + + +
+
+ Managing Log Files + Evergreen comes with a sophisticated logging system, but it is important to manage the OpenSRF and Evergreen logs. This section will provide a couple of log management techniques + and tools. + + Using the Log Rotate Utility to Manage Log Size + Fortunately, this is not a new problem for Unix administrators, and there are a number of ways of keeping your logs under control. On Debian and Ubuntu, for example, + the logrotate utility controls when old log files are compressed and a new log file is started. logrotate runs once a day and checks all log files that it knows about to see if a + threshold of time or size has been reached and rotates the log files if a threshold condition has been met. + To teach logrotate to rotate Evergreen logs on a weekly basis, or if they are > 50MB in size, create a new file /etc/logrotate.d/evergreen with the + following contents: + compress + /openils/var/log/*.log { + # keep the last 4 archived log files along with the current log file + # log log.1.gz log.2.gz log.3.gz log.4.gz + # and delete the oldest log file (what would have been log.5.gz) + rotate 5 + # if the log file is > 50MB in size, rotate it immediately + size 50M + # for those logs that don't grow fast, rotate them weekly anyway + weekly + } + + + Chaning Logging Level for Evergreen + Change the Log Levels in your config files. Changing the level of logging will help + narrow down errors. + + A high logging level is not wise to do in a production environment since it + will produce vastly larger log files and thus reduce server performance. + + Change logging levels by editing the configuration file + /openils/conf/opensrf_core.xml + you will want to search for lines containing <loglevel>. + the default setting for loglevel is 3 which will log errors, + warnings and information. + The next level is 4 which is for debugging and provides additional information + helpful for the debugging process. + Thus, lines with: + <loglevel>3</loglevel> + Should be changed to: + <loglevel>4</loglevel> + to allow debugging level logging + Other logging levels inclide 0 for no logging, + 1 for logging errors and 2 for logging warnings + and errors. + +
+ diff --git a/1.6/admin/Upgrading-Evergreen_1.6.pdf b/1.6/admin/Upgrading-Evergreen_1.6.pdf new file mode 100644 index 0000000000..baf36ab9b0 Binary files /dev/null and b/1.6/admin/Upgrading-Evergreen_1.6.pdf differ diff --git a/1.6/admin/Upgrading-Evergreen_1.6.xml b/1.6/admin/Upgrading-Evergreen_1.6.xml new file mode 100644 index 0000000000..334889ead5 --- /dev/null +++ b/1.6/admin/Upgrading-Evergreen_1.6.xml @@ -0,0 +1,289 @@ + + + + Upgrading Evergreen from 1.4 to 1.6 + + This Chapter will explain the step-by-step process of upgrading Evergreen + from version 1.4 to 1.6, including steps to upgrade OpenSRF. Before + upgrading, it is important to carefully plan an upgrade strategy to minimise system downtime and + service interruptions. All of the steps in this chapter are to be completed from the command line. + + + + + Stop Evergreen and back up data. + + + As root, stop the Apache + web server. + + + As the opensrf user, stop all + Evergreen + and OpenSRF services: + osrf_ctl.sh -l -a stop_all + + + Back up of the /openils + directory. + + + Back up the evergreen + database. + + + + + Upgrade OpenSRF to 1.2 + + + As the opensrf user, download and extract the source files for OpenSRF + 1.2: + wget \ + http://open-ils.org/downloads/OpenSRF-1.2.2.tar.gz + tar xzf OpenSRF-1.2.2.tar.gz + A new directory OpenSRF-1.2.2 will be created + For the latest edition of OpenSRF, check the Evergreen download page at + . + + + + As the root user, install the software prerequisites using the automatic + prerequisite installer. + aptitude install make + cd /home/opensrf/OpenSRF-1.2.2 + Replace [distribution] below with the following value + for your distribution: + + + debian-etch for Debian Etch (4.0) + + + debian-lenny for Debian Lenny (5.0) + + + ubuntu-hardy for Ubuntu Hardy Heron (8.04) + + + ubuntu-intrepid for Ubuntu Intrepid Ibex + (8.10) + + + ubuntu-jaunty for Ubuntu Jaunty Jackalope + (9.04) + + + ubuntu-karmic for Ubuntu Karmic Koala + (9.10) + + + make -f src/extras/Makefile.install [distribution] + + This will install a number of packages required by OpenSRF on your system, + including some Perl modules from CPAN. You can say “no” to the initial CPAN + configuration prompt to allow it to automatically configure itself to download + and install Perl modules from CPAN. The CPAN installer will ask you a number of + times whether it should install prerequisite modules - say “yes”. + + + As the opensrf user, configure and compile OpenSRF: + You can include the –enable-python and –enable-java configure options if + you want to include support for Python and Java, respectively. + cd /home/opensrf/OpenSRF-1.2.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + + + As the root user, return to your OpenSRF build directory and install + OpenSRF: + cd /home/opensrf/OpenSRF-1.2.2 + make install + + + As the root user, change the ownership of the installed files to the opensrf + user: + chown -R opensrf:opensrf /openils + + + Restart and Test OpenSRF + osrf_ctl.sh -l -a start_all + /openils/bin/srfsh + srfsh# request opensrf.math add 2 2 + You should see output like: + Received Data: 4 + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.007519 + ------------------------------------ + + srfsh# + If test Completed Successfully move onto next section. + If not, refer to troubleshooting section + of this documentation. + + + + + Upgrade Evergreen to 1.6 + + + As the opensrf user, download and extract Evergreen 1.6 + + wget \ + http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.3.tar.gz + tar xzf Evergreen-ILS-1.6.0.3.tar.gz + For the latest edition of Evergreen check the Evergreen download page at + + + + As the root user, install the prerequisites: + cd /home/opensrf/Evergreen-ILS-1.6.0.3 + On the next command, replace [distribution] with one of + these values for your distribution of Debian or Ubuntu: + + + debian-etch for Debian Etch (4.0) + + + debian-lenny for Debian Lenny (5.0) + + + ubuntu-hardy for Ubuntu Hardy Heron + (8.04) + + + ubuntu-intrepid for Ubuntu Intrepid Ibex + (8.10) + + + ubuntu-jaunty for Ubuntu Jaunty Jackalope + (9.04) + + + ubuntu-karmic for Ubuntu Karmic Koala + (9.10) + + + make -f Open-ILS/src/extras/Makefile.install [distribution] + + + As the opensrf user, configure and compile + Evergreen: + cd /home/opensrf/Evergreen-ILS-1.6.0.3 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + + + As the root user, install + Evergreen: + make STAFF_CLIENT_BUILD_ID=rel_1_6_0_3 install + + + Change to the Evergreen installation + directory: + cd /home/opensrf/Evergreen-ILS-1.6.0.3 + + + As the root user, build live-db-setup.pl for the cgi-bin + bootstrapping scripts and offline-config.pl for the offline staff client data + uploader: + perl Open-ILS/src/support-scripts/eg_db_config.pl \ + --create-bootstrap --create-offline --user evergreen \ + --password evergreen --hostname localhost --port 5432 \ + --database evergreen + + + As the root user, change all files to be owned by the + opensrf user and group: + chown -R opensrf:opensrf /openils + + + Update the Evergreen database + psql -U evergreen -h localhost \ + -f Open-ILS/src/sql/Pg/1.4.0.5-1.6.0.0-upgrade-db.sql evergreen + psql -U evergreen -h localhost \ + -f Open-ILS/src/sql/Pg/1.6.0.0-1.6.0.1-upgrade-db.sql evergreen + psql -U evergreen -h localhost \ + -f Open-ILS/src/sql/Pg/1.6.0.1-1.6.0.2-upgrade-db.sql evergreen + psql -U evergreen -h localhost \ + -f Open-ILS/src/sql/Pg/1.6.0.2-1.6.0.3-upgrade-db.sql evergreen + psql -U evergreen -h localhost \ + psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql \ + evergreen + + + As the opensrf user, + copy /openils/conf/oils_web.xml.example to /openils/conf/oils_web.xml + (needed for acquisitions templates). + cp /openils/conf/oils_web.xml.example \ + /openils/conf/oils_web.xml + + + Update opensrf_core.xml and opensrf.xml by copying the new example files (/ + openils/conf/opensrf_core.xml.example and /openils/conf/opensrf.xml). + cp /openils/conf/opensrf_core.xml.example \ + /openils/conf/opensrf_core.xml + cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml + + + Update opensrf.xml with the database connection info: + perl Open-ILS/src/support-scripts/eg_db_config.pl \ + --update-config --service all --user evergreen \ + --password evergreen --hostname localhost --port 5432 \ + --database evergreen + + + Update /etc/apache2/startup.pl by copying the example from + Open-ILS/examples/apache/startup.pl. + + + Update /etc/apache2/eg_vhost.conf by copying the example from + Open-ILS/examples/apache/eg_vhost.conf. + + + Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ + examples/apache/eg.conf. + + + Recover customizations you have made to the Apache + configuration files. For example, if you purchased an SSL certificate, you + will need to edit eg.conf to point to the appropriate SSL certificate files. + + + + + Restart Evergreen and Test + + + As the opensrf user, start all + Evergreen and OpenSRF + services: + osrf_ctl.sh -l -a start_all + + + As the opensrf user, run autogen to refresh the static + organizational data files: + cd /openils/bin + ./autogen.sh -c /openils/conf/opensrf_core.xml -u + + + Start srfsh and try logging in using your Evergreen + username and password: + /openils/bin/srfsh + srfsh% login username password + + + Start the Apache web server. + + + + + + Troubleshooting: + If you encounter errors, refer to the troubleshooting + section of this documentation for tips + on finding solutions and seeking further assistance from the Evergreen community. + + diff --git a/1.6/admin/indexedfieldweighting.xml b/1.6/admin/indexedfieldweighting.xml new file mode 100644 index 0000000000..565a5021c9 --- /dev/null +++ b/1.6/admin/indexedfieldweighting.xml @@ -0,0 +1,233 @@ + +
+ Indexed-Field and Matchpoint Weighting + + + This chapter describes indexed field weighting and matchpoint weighting, which + control relevance ranking in Evergreen catalog search results. + + + In tuning search relevance, it is good practice to make incremental + adjustments, capture search logs, and assess results before making further + adjustments. + + + + +
+ Indexed-field Weighting + Indexed-field weighting is configured in the Evergreen database in the weight column + of the config.metabib_field table, which follows the other four columns in this table: + field_class, name, xpath, and format. + The following is one representative line from the config.metabib_field table: + author | conference | + //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] + | mods32 | 1 ) + The default value for index-field weights in config.metabib_field is 1. Adjust the + weighting of indexed fields to boost or lower the relevance score for matches on that + indexed field. The weight value may be increased or decreased by whole integers. + For example, by increasing the weight of the title-proper field from 1 to 2, a search + for jaguar would double the relevance for the book + titled Aimee and Jaguar than for a record with the + term jaguar in another indexed field. +
+
+ Matchpoint Weighting + Matchpoint weighting provides another way to fine-tune Evergreen relevance ranking, + and is configured through floating-point multipliers in the multiplier column of the + search.relevance_adjustment table. + Weighting can be adjusted for one, more, or all multiplier fields in + search.relevance_adjustment. + You can adjust the following three matchpoints: + + + + first_word + boosts relevance if the query is one term long and matches the + first term in the indexed field (search for twain, get a bonus for twain, + mark but not mark twain) + + + + word_order + increases relevance for words matching the order of search terms, + so that the results for the search legend + suicide would match higher for the book Legend of a Suicide than for the book, Suicide Legend + + + + full_match + boosts relevance when the full query exactly matches the entire + indexed field (after space, case, and diacritics are normalized). So a title + search for The Future of Ice would get a + relevance boost above Ice Ages of the + Future. + + + Here are the default settings of the search.relevance_adjustment table: + + search.relevance_adjustment table + + + + field_class + name + bump_type + multiplier + + + + + author + conference + first_word + 1.5 + + + author + corporate + first_word + 1.5 + + + author + other + first_word + 1.5 + + + author + personal + first_word + 1.5 + + + keyword + keyword + word_order + 10 + + + series + seriestitle + first_word + 1.5 + + + series + seriestitle + full_match + 20 + + + title + abbreviated + first_word + 1.5 + + + title + abbreviated + full_match + 20 + + + title + abbreviated + word_order + 10 + + + title + alternative + first_word + 1.5 + + + title + alternative + full_match + 20 + + + title + alternative + word_order + 10 + + + title + proper + first_word + 1.5 + + + title + proper + full_match + 20 + + + title + proper + word_order + 10 + + + title + translated + first_word + 1.5 + + + title + translated + full_match + 20 + + + title + translated + word_order + 10 + + + title + uniform + first_word + 1.5 + + + title + uniform + full_match + 20 + + + title + uniform + word_order + 10 + + + +
+
+
+ Combining Index Weighting and Matchpoint Weighting + Index weighting and matchpoint weighting may be combined. The relevance boost of the + combined weighting is equal to the product of the two multiplied values. + If the relevance setting in the config.metabib_field were increased to 2, and the + multiplier set to 1.2 in the search.relevance_adjustment table, the resulting matchpoint + increase would be 240%. + + In practice, these weights are applied serially -- first the index weight, then + all the matchpoint weights that apply -- because they are evaluated at different + stages of the search process. + +
+
diff --git a/1.6/admin/migratingdata.xml b/1.6/admin/migratingdata.xml new file mode 100644 index 0000000000..ebc5be0e20 --- /dev/null +++ b/1.6/admin/migratingdata.xml @@ -0,0 +1,12 @@ + + + + + + Migrating Data + + Robert edited this at 3:06 (Eastern time) Repke changed back, Friday at 19.21 (GMT +1) This is a test 2 by rob + + + diff --git a/1.6/admin/serveradministration.pdf b/1.6/admin/serveradministration.pdf new file mode 100644 index 0000000000..f72af00b71 Binary files /dev/null and b/1.6/admin/serveradministration.pdf differ diff --git a/1.6/admin/serveradministration.xml b/1.6/admin/serveradministration.xml new file mode 100644 index 0000000000..d04cb64d21 --- /dev/null +++ b/1.6/admin/serveradministration.xml @@ -0,0 +1,1440 @@ + + + + Server Administration + + Administration of Evergreen involves configuration done from both the Staff Client as well a + the command line. The goal of this chapter is to provide you with the procedures to help + you optimize your Evergreen system. + + +
+ Organizational Unit Types and Organizational Units +
+ Organizational Unit Types + Organizational Unit Types are the terms used to refer to levels in the hierarchy of your + library system(s). Examples could include>All-Encompassing Consortium, Consortium Within a + Consortium, Library System, Branch, Bookmobile, Sub-Branch, Twig, etc. + You can add or remove organizational unit types, and rename them as needed to match the + organizational hierarchy that exists in reality for the libraries using your installation of + Evergreen. Evergreen can support organizations as simple as a single library with one or more + branches or as complex as a consortium composed of many independently governed library + systems. Organizational unit types should never have proper names since they are only generic types . + The fields in the organizational unit type record include: + + Type Name - The name of the organization unit type. + Opac Label - This is the label displayed in the OPAC to describe the search + range and the copy count columns for results. They are range + relative labels. + + Parent Type - The parent organizational unit type of this type. + Can Have Volumes - Flag that allows an organizational unit of this type to contain + Volumes/Call Numbers and thus Copies. + Can Have Users - Flag that allows an Organizational unit of this type to be home to + Users. + + An organizational unit type can be added, edited, or removed using the staff client. + To navigate to the Organization Unit Types from the staff client select + + Admin + Server Administration + Organization Types + + + + Adding Organization Types + Select an organization type from the organization type tree on the left and + click New Child. + Make sure your new type is selected and edit the Type Name, + OPAC Label and Parent Type. + Change the Parent Type if necessary. + Check the Can Have Volumes and Copies checkbox if the + organization units of this type will have volumes and copies assigned to it. + Check the Can Have Users checkbox if you will allow users + to be have the organization units of this type as their home unit. + Click Save to save your new organization type. + + + + Deleting Organization Types + Select the organization type from the Organization Type + tree. + Click Delete. + Click OK on the warning alert box. + + You will not be able to delete organization types if organization units are + assigned to that type. Before you can delete the organization + Type, you must change the organization type of the units associated with the type + or delete the units. + + + + Editing Organization Types + Select the organization type you wish to edit from the + organization type tree. + Make the changes in the right pane. + Click Save to save your changes. + +
+
+
+ Organizational Units + + Organizational Units are the specific instances of the organization unit types that + make up your library's hierarchy. These can include consortia, systems, branches, + etc. The organizational units should have distictive proper names such as + Main Street Branch or Townsville Campus. + + To navigate to the organizational units adminstration page in the staff client select + + Admin + Server Administration + Organizational Units + + + + Adding Organizational Units + Select an Organizational Unit from the organizational unit tree on the left and click + New Child. + Make sure your new unit is selected and edit the Organizational Unit + Name, Organizational Unit Policy Code, + Main Email Address and Main Phone Number. + + The Organizational Unit Name is the name that will appear in the + OPAC. The Policy Code is used by the system to associate policies and + copies with the unit. + + + Select the Organization Unit Type and + Parent Organization Unit. + Check the Can Have Volumes and Copies checkbox if the + organization units of this type will have volumes and copies assigned to it. + Check the OPAC Visible checkbox if you want this location to be + visible in the OPAC for searching. + Click Save to save your new organizational unit. + + + Deleting Organizational Units + Select the organizational unit you wish to delete from the organzational unit tree in the left pane. + ClickDelete. + Click OK on the warning alert box. + + You will not be able to delete organizational units if you have + users, workstations or copies assigned to the unit. Before you can delete the + organizational unit, you must move its users, workstations, copies and other associated resources to other + organizational units units. + + + + Editing Organizational Units + Select the organizational unit you wish to edit from the + organizational unit tree in the left pane. + Edit the fields in the right pane. + Click Save to save your changes. + +
+
+ Adjusting Search Relevancy Rankings + + + This section describes indexed field weighting and matchpoint weighting, which + control relevance ranking in Evergreen catalog search results. Adjusting relavancy can only be completed through access to the Evergreen database as of version 1.6. + + In tuning search relevance, it is good practice to make incremental + adjustments, capture search logs, and assess results before making further + adjustments. + + + +
+ Indexed-field Weighting + Indexed-field weighting is configured in the Evergreen database in the weight column + of the config.metabib_field table, which follows the other four columns in this table: + field_class, name, xpath, and format. + The following is one representative line from the config.metabib_field table: + author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) + The default value for index-field weights in config.metabib_field is 1. Adjust the + weighting of indexed fields to boost or lower the relevance score for matches on that + indexed field. The weight value may be increased or decreased by whole integers. + For example, by increasing the weight of the title-proper field from 1 to 2, a search + for jaguar would double the relevance for the book titled + Aimee and Jaguar than for a record with the term + jaguar in another indexed field. +
+
+ Matchpoint Weighting + Matchpoint weighting provides another way to fine-tune Evergreen relevance ranking, + and is configured through floating-point multipliers in the multiplier column of the + search.relevance_adjustment table. + Weighting can be adjusted for one, more, or all multiplier fields in + search.relevance_adjustment. + You can adjust the following three matchpoints: + + + first_word boosts relevance if the query is + one term long and matches the first term in the indexed field (search for twain, get a bonus for twain, mark + but not mark twain) + + + word_order increases relevance for words + matching the order of search terms, so that the results for the search legend suicide would match higher for the book Legend of a Suicide than for the book, + Suicide Legend + + + full_match boosts relevance when the full + query exactly matches the entire indexed field (after space, case, and diacritics are + normalized). So a title search for The Future of Ice + would get a relevance boost above Ice>Ages of the + Future. + + + Here are the default settings of the search.relevance_adjustment table: + + search.relevance_adjustment table + + + + field_class + name + bump_type + multiplier + + + + + author + conference + first_word + 1.5 + + + author + corporate + first_word + 1.5 + + + author + other + first_word + 1.5 + + + author + personal + first_word + 1.5 + + + keyword + keyword + word_order + 10 + + + series + seriestitle + first_word + 1.5 + + + series + seriestitle + full_match + 20 + + + title + abbreviated + first_word + 1.5 + + + title + abbreviated + full_match + 20 + + + title + abbreviated + word_order + 10 + + + title + alternative + first_word + 1.5 + + + title + alternative + full_match + 20 + + + title + alternative + word_order + 10 + + + title + proper + first_word + 1.5 + + + title + proper + full_match + 20 + + + title + proper + word_order + 10 + + + title + translated + first_word + 1.5 + + + title + translated + full_match + 20 + + + title + translated + word_order + 10 + + + title + uniform + first_word + 1.5 + + + title + uniform + full_match + 20 + + + title + uniform + word_order + 10 + + + +
+
+
+ Combining Index Weighting and Matchpoint Weighting + Index weighting and matchpoint weighting may be combined. The relevance boost of the combined + weighting is equal to the product of the two multiplied values. + If the relevance setting in the config.metabib_field were increased to 2, and the multiplier + set to 1.2 in the search.relevance_adjustment table, the resulting matchpoint increase would be + 240%. + + In practice, these weights are applied serially -- first the index weight, then all + the matchpoint weights that apply -- because they are evaluated at different stages of the + search process. + +
+
+ Adjusting Relevancy for Keyword Searches + Searching the out of the box keyword does not boost the ranking for terms appearing in, the title or subject fields since there is just one + keyword index which does not distinguish terms that appear in the title field from those in the notes field for example. In comparison, the title index is actually composed of + a number of separate indexes: title|proper, title|uniform, title|alternative, title|translated, etc, that collectively form the title index. You can see this in the + config.metabib_field table. The following procedure will add a keyword|title index so that terms found in the title field of an item are given more weight than terms in + other fields. + + + From the command line, access the PorstgreSQL command line interface + psql -U evergreen + + + Clone the title|proper index to create a keyword|title index + 6 = the title|proper index + INSERT INTO config.metabib_field + (field_class, name, xpath, weight, + format, search_field, facet_field) + SELECT 'keyword', 'title', xpath, weight, format, + search_field, facet_field + FROM config.metabib_field + WHERE id = 6; + + + Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table; + 6 = the title|proper index + INSERT INTO metabib.keyword_field_entry (source, field, value) + SELECT source, 17, value (the field value, 17, field be different + in your database so you may need to check the + config.metabib_field for the id of your new index). + FROM metabib.title_field_entry + WHERE field = 6; + + + Bump the relevance when the first search term appears first in the title in a keyword search. + 17 = our new keyword|title index (This may be different in your database so you may need to check the config.metabib_field for the id + of your new index). + INSERT INTO search.relevance_adjustment + (active, field, bump_type, multiplier) + VALUES (true, 17, 'first_word', 5); + + + Boost the relevance for search terms appearing in the title in general + 17 = our new keyword|title index (This may be different in your database so you may need to check the config.metabib_field for the id + of your new index). + UPDATE config.metabib_field + SET weight = 10 + WHERE id = 17; + + +
+
+
+ User and Group Permissions + + It is essential to understand how user and group permissions can be used to allow staff + to fulfil their roles while ensuring that they only have access to the appropriate level. + Permissions in Evergreen are applied to a specific location and system depth based on the home + library of the user. The user will only have that permission within the scope provided by the + Depth field in relation to his/her working locations. + Evergreen provides group application permissions in order to restrict which staff members + have the ability to assign elevated permissions to a user, and which staff members have the ability + to edit users in particular groups. + +
+ User Permissions + Ihe User permissions editor allows an administrator to set up permission fopr an individual user. However, In most cases, permissions can be controlled more + efficiently at the group level with individuals being assigned to specific groups based on their roles in the library. + To open the user permission editor, select Admin + User Permission Editor. Type the user's barcode when prompted. +
+ Working Locations + The first section of the User Permission Editor is the the Working Locations + section. You may select more than one working location for a user. This will effect + the availability of certain permissions which are dependent on the user having the working location. +
+
+ User Permission Settings + Below the working locations is the long list of all the permissions available on your + system. For each permission you can apply it by checking the + Applied check box. You can also select a depth to which the + permission is applied and also make the permission grantable, allowing + the user the ability to grant the permission to others. +
+
+
+ Group Permissions + Most permissions should be assigned at the group level. Here you can create new + groups based on the roles and responsibilities of the users in your system. Staff will be able to + assign users to these groups when they register patrons. + It is a good idea to create your groups soon after creating your organizational units. + It is also imprtaant to give careful consideration to the hierarchy of your groups to make + permission assignment as efficient as possible. + To enter the Group Permission module from the staff client menu, select + Admin Server Administration + Permission Groups + + Adding Groups + Select the Group Configuration tab if not + already selected in the right pane + Click New Child + Enter a unique Group Name + Enter a Description + Select a Permission Interval. This will determine the + default expiry date of user account when you register patrons and select + their groups + Selecting an Editing Permission will determine the group level the user will have for editing other users. + Select the Parent Group for the group. + The group will inherit its parent group's permissions so it is unecessary to assign permissions already inherited from its parent. + Click the Save button. + + + Deleting Groups + Select the group you wish to delete from the group tree on + left pane. + Click the Delete button. + Click on OKto verify. + + + Editing Groups + Select the group you wish to edit from the group tree on left pane. + Edit the fields you wish to change in the right pane. + Click on Save to save changes. + + + Adding Group Permissions + Select the Group Permissions tab on the right + pane + Click on New Mapping. + Select the permission you would like to add from the + Permission Select box. + Select the Depth you wish to set the + permission. This will determine if the group has the permission at a local level or across a + system, or consortium, or other organizational unit type. + check the Grantable check box to allow the user to + grant the permission to others. + Click Add Mapping to add the permission to the + group + + + Deleting Group Permissions + Select the group permission you wish to delete. + Click the Delete Selected button. + Click on OK to verify + + + Editing Group Permissions + Click on the Depth or Grantable + field for the permission setting you wish to change. + Make changes to other permissions in the same way. + Click Save Changes when you are finished all + the changes. + +
+
+ Permissions + + Permissions Table + + + + Permission Name + Permission Description + + + + + ABORT_REMOTE_TRANIST + Allows user to abort a copy transit if the user is not at + the transit source or destination + + + ABORT_TRANSIT + Allows user to abort a copy transit if the user is at the + transit destination or source + + + ASSIGN_WORK_ORG_UNIT + Allows user to define where another staff member's + permissions apply via the Permissions Editor interface. + + + BAR_PATRON + Allows user to bar a patron + + + CANCEL_HOLDS + Allows user to cancel holds + + + CIRC_CLAIMS_RETURNED.override + Allows user to check in/out an item that is claims + returned + + + CIRC_EXCEEDS_COPY_RANGE.override + Allows user to override the copy exceeds range event + + + CIRC_OVERRIDE_DUE_DATE + Allows user to change due date + + + CIRC_PERMIT_OVERRIDE + Allows user to bypass the circ permit call for i + checkout + + + COPY_ALERT_MESSAGE.override + Allows user to check in/out an item that has an alert + message + + + COPY_BAD_STATUS.override + Allows user to check out an item in a non-circulatable + status + + + COPY_CHECKIN + Allows user to check in a copy + + + COPY_CHECKOUT + Allows user to check out a copy + + + COPY_CIRC_NOT_ALLOWED.override + Allows user to checkout an item that is marked as + non-circ + + + COPY_HOLDS + Allows user to place a hold on a specific copy + + + COPY_IS_REFERENCE.override + Allows user to override the copy_is_reference event + + + + COPY_NOT_AVAILABLE.override + Allows user to force checkout of Missing/Lost type + items + + + COPY_STATUS_LOST.override + Allows user to remove the lost status from a copy + + + COPY_STATUS_MISSING.override + Allows user to change the missing status on a copy + + + COPY_TRANSIT_RECEIVE + Allows user to close out a transit on a copy + + + CREATE_BILL + Allows user to create a new bill on a transaction + + + CREATE_CONTAINER + Allows user to create containers owned by other users + (containers are Item Buckets, Volume Buckets, and Book Bags) + + + CREATE_CONTAINER_ITEM + Allows user to place an item in a container (even if the + container is owned by other users). + + + CREATE_COPY + Allows user to create a new copy object + + + CREATE_COPY_LOCATION + Allows user to create a new copy location + + + CREATE_COPY_NOTE + Allows user to create a new copy note + + + CREATE_COPY_STAT_CAT + Allows user to create a statisitcal category for + copies + + + CREATE_COPY_STAT_CAT_ENTRY + Allows user to create a new entry for a copy statistical + category + + + CREATE_COPY_STAT_CAT_ENTRY_MAP + Allows user to link a copy to a statistical category + (i.e., allows user to specify the appropriate entry for a copy and + given statistical category) + + + CREATE_COPY_TRANSIT + Allows user to create a transit + + + CREATE_DUPLICATE_HOLDS + Allows user to create duplicate holds (e.g. two holds on the + same title) + + + CREATE_HOLD_NOTIFICATION + Allows user to create new hold notifications + + + CREATE_IN_HOUSE_USE + Allows user to create a new in-house-use + + + CREATE_MARC + Allows user to create new MARC records + + + CREATE_MY_CONTAINER + Allows user to create containers for self (containers are + Item Buckets, Volume Buckets, and Book Bags). + + + CREATE_NON_CAT_TYPE + Allows user to create a new non-cataloged item type + + + CREATE_PATRON_STAT_CAT + Allows user to create a new patron statistical + category + + + CREATE_PATRON_STAT_CAT_ENTRY + Allows user to create a new possible entry for patron + statistical categories + + + CREATE_PATRON_STAT_CAT_ENTRY_MAP + Allows user to link another user to a stat cat entry (i.e., + specify the patron's entry for a given statistical category) + + + CREATE_PAYMENT + Allows user to record payments in the Billing + Interface + + + CREATE_TITLE_NOTE + Allows user to create a new title note + + + CREATE_TRANSACTION + Allows user to create new billable transactions (these + include checkouts and transactions created via the Bill Patron + operation) + + + CREATE_TRANSIT + Allows user to place item in transit + + + CREATE_USER + Allows user to create another user + + + CREATE_USER_GROUP_LINK + Allows user to add other users to permission groups + + + CREATE_VOLUME + Allows user to create a volume + + + CREATE_VOLUME_NOTE + Allows user to create a new volume note + + + DELETE_CONTAINER + Allows user to delete containers (containers are Item Buckets, + Volume Buckets, and Book Bags). + + + DELETE_CONTAINER_ITEM + Allows user to remove items from buckets and bookbags + + + DELETE_COPY + Allows user to delete a copy + + + DELETE_COPY_LOCATION + Allows user to delete a copy location + + + DELETE_COPY_NOTE + Allows user to delete copy notes + + + DELETE_COPY_STAT_CAT + Allows user to delete a copy statistical category + + + DELETE_COPY_STAT_CAT_ENTRY + Allows user to delete an entry for a copy statistical + category + + + DELETE_COPY_STAT_CAT_ENTRY_MAP + Allows user to delete a copy stat cat entry map + + + DELETE_NON_CAT_TYPE + Allows user to delete a non cataloged type (the user still + cannot deleted a non-cat type if any items of that type have + circulated). + + + DELETE_PATRON_STAT_CAT + Allows user to delete a patron statistical category + + + DELETE_PATRON_STAT_CAT_ENTRY + Allows user to delete an entry for patron statistical + categories + + + DELETE_PATRON_STAT_CAT_ENTRY_MAP + Allows user to remove a patron's entry for a given + statistical category + + + DELETE_RECORD + Allows user to delete a bib record + + + DELETE_TITLE_NOTE + Allows user to delete title notes + + + DELETE_USER + Allows user to mark a user as deleted + + + DELETE_VOLUME + Allows user to delete a volume + + + DELETE_VOLUME_NOTE + Allows user to delete volume notes + + + DELETE_WORKSTATION + Allows user to remove an existing workstation so a new one + can replace it + + + EVERYTHING + Every permssion is granted (for sysadmins and developers + only!) + + + HOLD_EXISTS.override + Allows users to place multiple holds on a single + copy/volume/title/metarecord (depending on hold type) + + + IMPORT_MARC + Allows user to import a MARC record via the z39.50 + interface + + + ITEM_AGE_PROTECTED.override + Allows user to place a hold on an age-protected item + + ITEM_ON_HOLDS_SHELF.override + Allows user to check out an item that is on holds shelf for a + different patron + + + MAX_RENEWALS_REACHED.override + Allows user to renew an item past the maximun renewal + count + + + MERGE_BIB_RECORDS + Allows user to merge bib records and their associated data + regardless of their bib/volume/copy level perms (in theory - as of + 1.2.2, users still must have VOLUME_UPDATE and UPDATE_VOLUME in + order to merge records. + + + MR_HOLDS + Allows user to create a metarecord holds + + + OFFLINE_EXECUTE + Allows user to process an offline/standalone script + batch + + + OFFLINE_UPLOAD + Allows user to upload an offline/standalone script + + + OFFLINE_VIEW + Allows user to view uploaded offline script information + + + OPAC_LOGIN + Allows user to login to the OPAC + + + patron_exceeds_checkout_count.override + Allow user to override checkout count failure + + + patron_exceeds_fines .override + Allow user to override fine amount checkout failure + + + patron_exceeds_overdue_count .override + Allow user to override overdue count failure + + + REGISTER_WORKSTATION + Allows user to register a new workstation + + + REMOTE_Z3950_QUERY + Allows user to perform z3950 queries against remote + servers + + + REMOVE_USER_GROUP_LINK + Allows user to remove other users from permission + groups + + + RENEW_CIRC + Allows user to renew items + + + RENEW_HOLD_OVERRIDE + Allows user to continue to renew an item even if it is + required for a hold. + + + REQUEST_HOLDS + Allows user to create holds for another user (if true, we + still check to make sure they have permission to make the type of + hold they are requesting, e.g. COPY_HOLDS) + + + RUN_REPORTS + Allows user to view the Reports Interface, create templates, + and run reports + + + SET_CIRC_CLAIMS_RETURNED + Allows user to mark an item as claimed returned + + + SET_CIRC_LOST + Allows user to mark an item as lost + + + SET_CIRC_MISSING + Allows user to mark an item as missing + + + SHARE_REPORT_FOLDER + Allows user to share Template/Report/Output folders via the + Reporting Interface + + + STAFF_LOGIN + Allows user to login to the staff client + + + TITLE_HOLDS + Allows user to place a hold at the title level + + + UNBAR_PATRON + Allows user to un-bar a patron + + + UPDATE_BATCH_COPY + Allows user to edit copies in batch + + + UPDATE_CONTAINER + Allows user to update another users Buckets or Book + Bags + + + UPDATE_COPY + Allows user to edit a copy + + + UPDATE_COPY_LOCATION + Allows user to edit a copy location + + + UPDATE_COPY_STAT_CAT + Allows user to change a copy statistical category + + + UPDATE_COPY_STAT_CAT_ENTRY + Allows user to change a copy statistical category entry + + + UPDATE_HOLD + Allows user to edit holds (such as change notification phone + number or pickup library, as well as retarget the hold and capture + an item for hold or pickup) + + + UPDATE_MARC + Allows user to edit a marc record + + + UPDATE_NON_CAT_TYPE + Allows user to update a non cataloged type + + + UPDATE_ORG_SETTING + Allows user to update an org unit setting + + + UPDATE_ORG_UNIT + Allows user to change org unit settings + + + UPDATE_PATRON_STAT_CAT + Allows user to change a patron statistical category (such as + renaming the category) + + + UPDATE_PATRON_STAT_CAT_ENTRY + Allows user to change a patron stat cat entry(such as + renaming the entry) + + + UPDATE_RECORD + Allows user to undelete a MARC record + + + UPDATE_USER + Allows user to edit a user's record + + + UPDATE_VOLUME + Allows user to edit volumes - needed for merging records. + This is a duplicate of VOLUME_UPDATE; user must have both + permissions at appropriate level to merge records. + + + VIEW_CIRCULATIONS + Allows user to see what another user has checked out + + + VIEW_CONTAINER + Allows user to view buckets and bookbags + + + VIEW_COPY_CHECKOUT_HISTORY + Allows user to view which users have checked out a given + copy + + + VIEW_COPY_NOTES + Allows user to view notes attached to a copy + + + VIEW_HOLD + Allows user to view another user's holds + + + VIEW_HOLD_NOTIFICATION + Allows user to view notifications attached to a hold + + + VIEW_HOLD_PERMIT + Allows user to see if another user has permission to place a + hold on a given copy + + + VIEW_PERM_GROUPS + Allows user to view permission groups. + + + VIEW_PERMISSION + Allows user to view user permissions within the user + permissions editor + + + VIEW_PERMIT_CHECKOUT + Allows user to see if another user can check out an item + (should be true for all staff) + + + VIEW_REPORT_OUTPUT + Allows user to view report output + + + VIEW_TITLE_NOTES + Allows user to view all notes attached to a title + + + VIEW_TRANSACTION + Allows user to see another users grocery/circ transactions + in the Bills Interface + + + VIEW_USER + Allows user to view another user's Patron Record + + + VIEW_USER_FINES_SUMMARY + Allows user to view bill details + + + VIEW_USER_TRANSACTIONS + *same as VIEW_TRANSACTION (duplicate perm) + + + VIEW_VOLUME_NOTES + Allows user to view all notes attached to a volume + + + VIEW_ZIP_DATA + Allows user to query the zip code data method + + + VOID_BILLING + Allows user to void a bill + + + VOLUME_HOLDS + Allows user to place a volume level hold + + + + actor.org_unit.closed_date.create + Allows user to create a new closed date for a location + + + actor.org_unit.closed_date.delete + Allows user to remove a closed date interval for a given + location + + + actor.org_unit.closed_date.update + Allows user to update a closed date interval for a given + location + + + group_application.user + Allows user to add/remove users to/from the User group + + + group_application.user.patron + Allows user to add/remove users to/from the Patron + group + + + group_application.user.sip_client + Allows user to add/remove users to/from the SIP-Client + group + + + group_application.user.staff + Allows user to add/remove users to/from the Staff + group + + + group_application.user.staff.admin.global_admin + Allows user to add/remove users to/from the GlobalAdmin + group + + + group_application.user.staff.admin.lib_manager + Allows user to add/remove users to/from the LibraryManager + group + + + group_application.user.staff.admin.local_admin + Allows user to add/remove users to/from the LocalAdmin + group + + + group_application.user.staff.cat + Allows user to add/remove users to/from the Cataloger group + + + group_application.user.staff.cat.cat1 + Allows user to add/remove users to/from the Cat1 group + + + group_application.user.staff.circ + Allows user to add/remove users to/from the Circulator + group + + + group_application.user.staff.supercat + Allows user to add/remove users to/from the Supercat + group + + + group_application.user.vendor + Allows user to add/remove users to/from the Vendor + group + + + money.collections_tracker.create + Allows user to put someone into collections + + + money.collections_tracker.delete + Allows user to take someone out of collections + + + +
+
+
+
+ Copy Status + To navigate to the copy status editor from the staff client menu, select + Admin Server Administration + Copy Statuses + The Copy Status Editor is used to Add, edit and delete statuses of copies in your system. + Evergreen comes pre-loaded with a number of copy statuses. + + Copy Status Table + + + + ID + Name + Holdable - default setting + OPAC Visible - default setting + + + + + 0 + Available + true + true + + + 1 + Checked out + true + true + + + 2 + Bindery + false + false + + + 3 + Lost + false + false + + + 4 + Missing + false + false + + + 5 + In process + false + true + + + 6 + In transit + true + true + + + 7 + Reshelving + true + true + + + 8 + On holds shelf + true + true + + + 9 + On order + true + true + + + 10 + ILL + true + false + + + 11 + Cataloging + true + false + + + 12 + Reserves + false + true + + + 13 + Discard/Weed + false + false + + + 14 + Damaged + false + false + + + 15 + On reservation shelf + true + false + + + +
+ It is possible to add, delete and edit copy statuses. + + Adding Copy Statuses + In the New Status field, enter the name of the + new status you wish to add. + Click Add. + Locate you new status and check the Holdable check box + if you wish to all users to place holds on items in this status. Check + OPAC Visble if you wish for this status to appear in the public + OPAC. + Click Save Changes at the bottum of the screen to + save changes to the new status. + + + Deleting Copy Statuses + Highlight the statuses you wish to delete. Hold the + Shift to select more than one status. + Click Delete Selected. + Click OK to verify. + You will not be able to delete statuses if copies currently + exist with that status. + + + + Editing Copy Statuses + Double click on a status name to change its name and enter the new + name. To change whether a status is visible in the OPAC, check or uncheck + the OPAC Visible check box.To allow patrons the ability to + hold items in that status, check the Holdable check box. To prevent + users from holding items in that status, uncheck the Holdable + check box. + Once you have finished editing the statuses, remember to click + Save Changes. + +
+
+ Billing Types + The billing types editor is used for creating, editing and deleting billing types. + To navigate to the billing types editor from the staff client menu, select + Admin Server Administration + Billing Types + + Adding Billing Types + Click New Billing Type. + Enter the name of the billing type. + Select the Org Unit to use this billing type. + Enter the Default Price. This is only the default since + the actual price of a specific billing can be adjusted when staff create + a billing + Click Save to save the new billing type. + + + Deleting Billing Types + Check the checkbox of the billing type(s) you wish to delete. + Click Delete Selected. + The selected billing types will be deleted without a + verification alert. + + + + Editing Billing Types + Double click on a billing types to open the editing window. + Make desired changes to the name, + Org Unit and Default Price. + Once you have finished editing, click + Save. + + +
+
+ Circulation Modifiers + The circulation modifier editor is used to create, edit and delete modifier categories to control + circulation policies on specific groups of items. + To navigate to the circulation modifiers editor from the staff client menu, select + + Admin Server Administration + Circulation Modifiers. + + + Adding Circulation Modifiers + Click New Circ Modifier. + Enter a Code, Name and + Description. + Select the SIP 2 Media Type. + Check the Magnetic Media check box if the item is magnetic media such as a casette + tape. + Click Save to save the new circulation + modifier. + + + Deleting Circulation Modifiers + Check the check box(es) next to the circulation modifiers(s) you wish to + delete. + Click Delete Selected near the top of the page. + The selected circulation modifiers will be deleted without a + verification alert. + + + + Editing Circulation Modifiers + Double click on the row of the cirlation modifier you wish to + edit. + Make desired changes. + Once you have finished editing, click + Save. + +
+
+ Cataloging Templates + Cataloging templates are essential for making the cataloguing process more efficient. Templates are used that that the basic structure of specific types of cataloguing records can loaded when the cataloguer adds a new record + + Adding Cataloging Templates + + + Create a marc template in the directory /openils/var/templates/marc/. It should be in xml format. + Here is an example file k_video.xml: + + + + Catalog Template Example + + + + + + + + + Add the template to the to the marctemplates list in the open-ils.cat section of the evergreen configuration file opensrf.xml + + + Restart perl services for changes to take effect. + /openils/bin/osrf_ctl.sh -l -a restart_perl + + +
+ diff --git a/1.6/admin/troubleshooting.pdf b/1.6/admin/troubleshooting.pdf new file mode 100644 index 0000000000..4ec3bf4542 Binary files /dev/null and b/1.6/admin/troubleshooting.pdf differ diff --git a/1.6/admin/troubleshooting.xml b/1.6/admin/troubleshooting.xml new file mode 100644 index 0000000000..f0536ddd15 --- /dev/null +++ b/1.6/admin/troubleshooting.xml @@ -0,0 +1,199 @@ + + + Troubleshooting System Errors + If you have Evergreen installed and are encountering systematic errors, here is the steps to find the + cause and solution to most problems. These instructions assume standard locations and file names for Evergreen + installations, and may also include commands for specific Linux distributions. + + Systematic Evergreen Restart to isolate Errors + + Stop Apache: + /etc/init.d/apache2 stop + or + apache2ctl stop + + + Stop OpenSRF: + osrf_ctl.sh -l -a stop_all + You should get either output resembling this: + Stopping OpenSRF C process 12515... + Stopping OpenSRF C process 12520... + Stopping OpenSRF C process 12526... + Stopping OpenSRF Perl process 12471... + Stopping OpenSRF Router process 12466... + Or, if services have already been stopped, output maay look like this: + OpenSRF C not running + OpenSRF Perl not running + OpenSRF Router not running + Occasionally osrf_ctl.sh fails to kill OpenSRF processes, so we should check to make + sure that none are still running with the command: + ps -aef | grep OpenSRF + You should manually kill any OpenSRF processes. + If you were unable to stop OpenSRF with the above methods, you could also try this + command: + rm –R /openils/var/run/*.pid + This will remove the temporary OpenSRF process files from the run directory which may + have been left over from a previous system boot cycle. + + + Restart Ejabberd and Memcached with the following commands: + sudo /etc/init.d/ejabberd restart + sudo /etc/init.d/memcached restart + + + Start the OpenSRF router and check for errors + /openils/bin/osrf_ctl.sh -l -a start_router + If the router started correctly, output will be: + Starting OpenSRF Router + If router does not start correcltly, you should check the router error log files + for error information. + Evergreen 1.6 uses two routers, a public one and a private one, with two different + logfiles: + /openils/var/log/private.router.log + /openils/var/log/public.router.log + A quick way to find error information in the logs is with the grep command. + grep ERR /openils/var/log/*router.log + As a final sanity check, look for router processes using the process status + command: + ps -aef | grep Router + + + Start the OpenSRF perl services and check for errors + /openils/bin/osrf_ctl.sh -l -a start_perl + You should see the following output: + Starting OpenSRF Perl + * starting all services for norcrossfx.norcross.esi + * starting servivce pid=7484 opensrf.settings + * starting servivce pid=7493 open-ils.cat + * starting servivce pid=7495 open-ils.supercat + * starting servivce pid=7497 open-ils.search + * starting servivce pid=7499 open-ils.circ + * starting servivce pid=7501 open-ils.actor + * starting servivce pid=7502 open-ils.storage + * starting servivce pid=7509 open-ils.penalty + * starting servivce pid=7512 open-ils.collections + * starting servivce pid=7514 open-ils.ingest + * starting servivce pid=7517 open-ils.permacrud + * starting servivce pid=7522 open-ils.fielder + * starting servivce pid=7527 open-ils.vandelay + * starting servivce pid=7516 open-ils.reporter + If the perl services do not start correclty or you receive errors, search for errors + in the following log files: + /openils/var/log/router.log + /openils/var/log/osrfsys.log + At this point you can use the grep command to find errors in + any of the Evrgreen log files: + grep ERR /openils/var/log/*.log + As a final sanity check, look for OpenSRF processes: + ps -aef | grep -i opensrf + + + Start the OpenSRF C services and check for errors: + /openils/bin/osrf_ctl.sh -l -a start_c + And output should be: + Starting OpenSRF C (host=localhost) + If the c service does not start, check for errors by grepping + the log files for errors: + grep ERR /openils/var/log/*.log + Check for OpenSRF processes: + ps -aef | grep -i opensrf + + + Smoke test with autogen.sh + The Autogen tool will take some dynamic information from the database and generate + static Javascript files for use by the OPAC and staff client. It is also able to refresh + the proximity map between libraries for the purpose of efficiently routing hold + requests. + As user opensrf, you invoke Autogen with the command: + /openils/bin/autogen.sh -c /openils/conf/opensrf_core.xml -u + If Autogen completes successfully, the output will be: + Updating fieldmapper + Updating web_fieldmapper + Updating OrgTree + removing OrgTree from the cache... + Updating OrgTree HTML + Updating locales selection HTML + Updating Search Groups + Refreshing proximity of org units + Successfully updated the organization proximity + Done + If Autogen does not complete its task and you recieve errors, use + grep to find errors in the log files: + grep ERR /openils/var/log/*.log + + + Connect to Evergreen using the srfsh command-line OpenSRF client + /openils/bin/srfsh + + In order for you to connect using srfsh, you will need to + have set up the .srfsh.xml configuration file in your home directory as as + described in the installation chapter. + + You will then see the srfsh prompt: + srfsh# + At the srfsh prompt, enter this command: + login admin open-ils + You should the request verification: + Received Data: "6f63ff5542da1fead4431c6c280efc75" + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.018414 + ------------------------------------ + + Received Data: { + "ilsevent":0, + "textcode":"SUCCESS", + "desc":" ", + "pid":7793, + "stacktrace":"oils_auth.c:312", + "payload":{ + "authtoken":"28804ebf99508496e2a4d2593aaa930e", + "authtime":420.000000 + } + } + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.552430 + ------------------------------------ + Login Session: 28804. Session timeout: 420.000 + srfsh# + If you encounter errors or if you are unable to connect, you should consult the + srfsh.log file. The location of this file is configured in your + .srfsh.xml configuration file and is + /openils/var/log/srfsh.log by default. + Pressing + + Ctrl + D + + or entering exit will terminate srfsh. + + + Start Apache and check for errors: + /etc/init.d/apache2 start + or + apache2ctl start + You should see output: + * Starting web server apache2 + ...done. + the Apache OpenSRF modules write to the + /openils/var/log/gateway.log + However, you should check all of the log files for errors: + grep ERR /openils/var/log/*.log + Another place to check for erros is the Apache error logs + generally located in in the /var/log/Apapche2 + directory + If you encounter errors with Apache, a common source of potential problems are the + Evergreen site configuration files /etc/apache2/eg_vhost.conf and + /etc/apache2/sites-available/eg.conf + + + Try to authenticate with the staff client + + + Try to authenticate with the OPAC + + + diff --git a/1.6/root.xml b/1.6/root.xml new file mode 100755 index 0000000000..37ef683978 --- /dev/null +++ b/1.6/root.xml @@ -0,0 +1,80 @@ + + + + Evergreen 1.6 Documentation + Draft Version + + + + + + 2010 + Evergreen Community + + + + + + + + + + + This document was updated . + + + + + + Introduction + + + + + + Public Access Catalog + + + + + + Core Staff Tasks + + + + + + + + + + Administration + + + + + + + + + + Third Party System Integration + + + + + Development + + + + + Appendices + + + +