From 4e78e9ee6d3fc30ae0cdaca6ddeae9b4fcc1ca73 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Tue, 14 Sep 2010 16:36:07 -0400 Subject: [PATCH 1/1] more clean up of some admin files.. --- 1.6/admin/Upgrading-Evergreen_1.6.xml | 297 ++++++++++--------- 1.6/admin/sip.xml | 71 +++-- 1.6/admin/troubleshooting.xml | 396 ++++++++++++++------------ 3 files changed, 402 insertions(+), 362 deletions(-) diff --git a/1.6/admin/Upgrading-Evergreen_1.6.xml b/1.6/admin/Upgrading-Evergreen_1.6.xml index f24bfcb661..5b856c259b 100644 --- a/1.6/admin/Upgrading-Evergreen_1.6.xml +++ b/1.6/admin/Upgrading-Evergreen_1.6.xml @@ -14,21 +14,21 @@ Stop Evergreen and back up data. - As root, stop the Apache + As root, stop the Apache web serverweb serverApache. - As the opensrf user, stop all + As the opensrf user, stop all Evergreen and OpenSRF services: - osrf_ctl.sh -l -a stop_all + osrf_ctl.sh -l -a stop_all Back up of the /openils directory. - Back up the evergreen + Back up the evergreen database. @@ -37,93 +37,93 @@ Upgrade OpenSRF<indexterm><primary>OpenSRF</primary><secondary>1.2</secondary></indexterm> to 1.2 - As the opensrf user, download and extract the source files for OpenSRF + 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 + 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 + As the root user, install the software prerequisites using the automatic prerequisite installer. - aptitude install make - cd /home/opensrf/OpenSRF-1.2.2 + aptitude install make + cd /home/opensrf/OpenSRF-1.2.2 - Replace [distribution] below with the following value + Replace below with the following value for your distribution: - debian-etch for Debian Etch (4.0)LinuxDebian + for Debian Etch (4.0)LinuxDebian - debian-lenny for Debian Lenny (5.0) + for Debian Lenny (5.0) - ubuntu-hardy for Ubuntu Hardy Heron (8.04)LinuxUbuntu + for Ubuntu Hardy Heron (8.04)LinuxUbuntu - ubuntu-intrepid for Ubuntu Intrepid Ibex - (8.10) + for Ubuntu Intrepid Ibex + (8.10) - ubuntu-jaunty for Ubuntu Jaunty Jackalope - (9.04) + for Ubuntu Jaunty Jackalope + (9.04) - ubuntu-karmic for Ubuntu Karmic Koala - (9.10) + for Ubuntu Karmic Koala + (9.10) - make -f src/extras/Makefile.install [distribution] + make -f src/extras/Makefile.install This will install a number of packages required by OpenSRF on your system, - including some Perl modules from CPANprogramming languagePerl - CPAN - . You can say no to the initial CPAN + including some Perl modules from CPANPerlCPAN + . You can type 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. + and install Perl modules from CPAN. The CPAN installer will ask you a number of + times whether it should install prerequisite modules - type 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 Pythonprogramming languagePython - and Javaprogramming languageJava - , respectively. - cd /home/opensrf/OpenSRF-1.2.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make + You can include the and configure options if + you want to include support for PythonPython and Java + 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 + As the root user, return to your OpenSRF build directory and install OpenSRF: - cd /home/opensrf/OpenSRF-1.2.2 - make install + 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 + 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 + 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 + + Received Data: 4 + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.007519 + ------------------------------------ + + srfsh# + + If test completed successfully move onto next section. + Otherwise, refer to the troubleshooting chapter of this documentation. @@ -132,130 +132,141 @@ Upgrade <application>Evergreen</application> to 1.6 - As the opensrf user, download and extract Evergreen 1.6 + As the opensrf user, download and extract Evergreen 1.6 - wget http://open-ils.org/downloads/Evergreen-ILS-1.6.0.8.tar.gz - tar xzf Evergreen-ILS-1.6.0.8.tar.gz + wget http://open-ils.org/downloads/Evergreen-ILS-1.6.0.8.tar.gz + tar xzf Evergreen-ILS-1.6.0.8.tar.gz For the latest edition of Evergreen check the Evergreen download page at and adjust upgrading instructions accordingly. - As the root user, install the prerequisites: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 - On the next command, replace [distribution] with one of + As the root user, install the prerequisites: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + On the next command, replace with one of these values for your distribution of Debian or Ubuntu: - debian-etch for Debian Etch (4.0) + for Debian Etch (4.0) - debian-lenny for Debian Lenny (5.0) + for Debian Lenny (5.0) - ubuntu-hardy for Ubuntu Hardy Heron - (8.04) + for Ubuntu Hardy Heron + (8.04) - ubuntu-intrepid for Ubuntu Intrepid Ibex - (8.10) + for Ubuntu Intrepid Ibex + (8.10) - ubuntu-jaunty for Ubuntu Jaunty Jackalope - (9.04) + for Ubuntu Jaunty Jackalope + (9.04) - ubuntu-karmic for Ubuntu Karmic Koala - (9.10) + for Ubuntu Karmic Koala + (9.10) - make -f Open-ILS/src/extras/Makefile.install [distribution] + make -f Open-ILS/src/extras/Makefile.install - As the opensrf user, configure and compile + As the opensrf user, configure and compile Evergreen: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make - As the root user, install + As the root user, install Evergreen: - make STAFF_CLIENT_BUILD_ID=rel_1_6_0_8 install + make STAFF_CLIENT_BUILD_ID=rel_1_6_0_8 install Change to the Evergreen installation directory: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 + cd /home/opensrf/Evergreen-ILS-1.6.0.8 As the root user, change all files to be owned by the opensrf user and group: - chown -R opensrf:opensrf /openils + chown -R opensrf:opensrf /openils - 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: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 - 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, build live-db-setup.pl for the cgi-bin + bootstrapping scripts and offline-config.pl for the offline staff client data uploader: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + + + 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 opensrf user, update server symlink in /openils/var/web/xul/: - cd /openils/var/web/xul/ - rm server - ln -s rel_1_6_0_8/server + As the opensrf user, update server symlink in /openils/var/web/xul/: + cd /openils/var/web/xul/ + rm server + ln -s rel_1_6_0_8/server Update the Evergreen database: it is recommended that you back up your Evergreen database in order to restore your data if anything goes wrong. - 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 -f Open-ILS/src/sql/Pg/1.6.0.3-1.6.0.4-upgrade-db.sql evergreen - psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.0.5-upgrade-db.sql evergreen - psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.5-1.6.0.6-upgrade-db.sql evergreen - psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.6-1.6.0.7-upgrade-db.sql evergreen - psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db.sql evergreen + 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 -f Open-ILS/src/sql/Pg/1.6.0.3-1.6.0.4-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.0.5-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.5-1.6.0.6-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.6-1.6.0.7-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db.sql evergreen Download and run the the billing view hot-fix script - wget http://www.open-ils.org/downloads/1.6.0-mmbxs-cleanup.sql - psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql + wget http://www.open-ils.org/downloads/1.6.0-mmbxs-cleanup.sql + psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql - As the opensrf user, - copy /openils/conf/oils_web.xml.example to /openils/conf/oils_web.xml + As the opensrf user, + copy /openils/conf/oils_web.xml.example to /openils/conf/oils_web.xml + configuration filesoils_web.xml (needed for acquisitions templates). - cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml + 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_core.xml and opensrf.xml by copying the new example files + (/openils/conf/opensrf_core.xml.example and /openils/conf/opensrf.xml). + configuration filesopensrf.xml + cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml + configuration filesopensrf_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 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. + Open-ILS/examples/apache/startup.pl.configuration filesstartup.pl Update /etc/apache2/eg_vhost.conf by copying the example from - Open-ILS/examples/apache/eg_vhost.conf. + Open-ILS/examples/apache/eg_vhost.conf.configuration fileseg_vhost.conf Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ - examples/apache/eg.conf. + examples/apache/eg.conf.configuration fileseg.conf Recover customizations you have made to the ApacheApache - configuration files. For example, if you purchased an SSL certificateSSL certificate, you - will need to edit eg.conf to point to the appropriate SSL certificate files. + 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. + SSLcertificates @@ -263,60 +274,60 @@ Restart Evergreen and Test - As the opensrf user, start all + As the opensrf user, start all Evergreen and OpenSRF services: - osrf_ctl.sh -l -a start_all + 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 + As the opensrf user, run autogen to refresh the static + organizational data files:autogen + cd /openils/bin + ./autogen.sh -c /openils/conf/opensrf_core.xml -u - Start srfsh and try logging in using your Evergreen + Start srfsh and try logging in using your Evergreen username and password: - /openils/bin/srfsh - srfsh% login username password + /openils/bin/srfsh + srfsh% login Start the Apache web server. + + 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. + - - 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. - - + Upgrading PostgreSQL from 8.2 to 8.3 Evergreen 1.6 supports PostgreSQL version 8.3 and it is recommended that you upgrade PostgreSQL when you upgrade Evergreen to 1.6. - The Order of the following steps is very important. + The order of the following steps is very important.databasesPostgreSQL - As opensrf, stop the evergreen and opensrf services: - osrf_ctl.sh -l -a stop_all + As opensrf, stop the evergreen and opensrf services: + osrf_ctl.sh -l -a stop_all - Backup the Evergreen database data + Backup the Evergreen database data Create an empty Evergreen database in postgresql 8.3 by issuing the following commands as the postgres user: - createdb -E UNICODE evergreen - createlang plperl evergreen - createlang plperlu evergreen - createlang plpgsql evergreen - psql -f /usr/share/postgresql/8.3/contrib/tablefunc.sql evergreen - psql -f /usr/share/postgresql/8.3/contrib/tsearch2.sql evergreen - psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen - - - As the postgres user on the PostgreSQL server, create a PostgreSQL user named evergreen for the database cluster: - createuser -P -s evergreen - Enter the password for the new PostgreSQL superuser (evergreen) + createdb -E UNICODE evergreen + createlang plperl evergreen + createlang plperlu evergreen + createlang plpgsql evergreen + psql -f /usr/share/postgresql/8.3/contrib/tablefunc.sql evergreen + psql -f /usr/share/postgresql/8.3/contrib/tsearch2.sql evergreen + psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen + + + As the postgres user on the PostgreSQL server, create a PostgreSQL user named evergreen for the database cluster: + createuser -P -s evergreen + Enter the password for the new PostgreSQL superuser (evergreen) Restore data from backup created in step 1. @@ -324,6 +335,8 @@ To point tsearch2 to proper function names in 8.3, run the SQL script /home/opensrf/Evergreen-ILS*/Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql using the psql command. + cd /home/opensrf/Evergreen-ILS* + psql -f /Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql evergreen Restart Evergreen and OpenSRF services diff --git a/1.6/admin/sip.xml b/1.6/admin/sip.xml index 8877939357..7e8d44d14c 100644 --- a/1.6/admin/sip.xml +++ b/1.6/admin/sip.xml @@ -4,23 +4,28 @@ SIP Server - SIP, standing for Standard Interchange Protocol, was developed by the 3M corporation to be a common protocol for data transfer between ILS' - (referred to in SIP as an ACS, or Automated Circulation System) and a third party device. Originally, the protocol was developed for + SIP, standing for Standard Interchange Protocol, was developed by the + 3Mcorporation to be a common protocol for data transfer between ILS' + (referred to in SIP as an ACS, or Automated Circulation System) + Automated Circulation System and a + third party device. Originally, the protocol was developed for use with 3M SelfCheck (often abbreviated SC, not to be confused with Staff Client) systems, but has since expanded to other companies and devices. It is now common to find - SIP in use in several other vendors' SelfCheck systems, as well as other non-SelfCheck devices. Some examples include: + SIP in use in several other vendors' SelfCheck systemsSelfCheck, as well as other non-SelfCheck devices. + Some examples include: Patron Authentication (computer access, subscription databases) - Automated Material Handling (AMH) - The automated sorting of items, often to bins or book carts, based on shelving location or other programmable criteria + Automated Material Handling (AMH) Automated Material Handling (AMH)- The automated sorting of items, often to bins or + book carts, based on shelving location or other programmable criteria
- Installing the SIP Server + Installing the <systemitem class="protocol">SIP</systemitem> Server - This is a rough intro to installing the SIP server for Evergreen. + This is a rough intro to installing the SIP server for Evergreen. Getting the code - Current SIP code lives at github: + Current SIP code lives at github: cd /opt git clone git://github.com/atz/SIPServer.git SIPServer Or use the old style: @@ -40,7 +45,8 @@ $ cp oils_sip.xml.example oils_sip.xml - Edit oils_sip.xml. Change the commented out <server-params> section to this: + Edit oils_sip.xmlconfiguration filesoils_sip.xml. + Change the commented out <server-params> section to this: <server-params min_servers='1' min_spare_servers='0' @@ -48,14 +54,16 @@ /> - max_servers will directly correspond to the number of allowed SIP clients. Set the number accordingly, but bear in mind that too many connections can - exhaust memory. On a 4G RAM/4 CPU server (that is also running evergreen), I would recommend not exceeding 100 SIP client connections, + max_servers will directly correspond to the number of allowed SIP clients. Set the number accordingly, but + bear in mind that too many connections can + exhaust memory. On a 4G RAM/4 CPU server (that is also running evergreen), I would recommend not exceeding 100 + SIP client connections, give or take. - Adding SIP Users + Adding <systemitem class="protocol">SIP</systemitem> Users Type the following commands from the command prompt: @@ -64,12 +72,14 @@ $ cp oils_sip.xml.example oils_sip.xml - in the <accounts> section, add SIP client login information. Make sure that all <logins> use the same institution attribute, and make - sure the institution is listed in <institutions>. All attributes in the <login> section will be used by the SIP client. + in the <accounts> section, add SIP client login information. Make sure that all <logins> use the + same institution attribute, and make + sure the institution is listed in <institutions>. All attributes in the <login> section will be used by the SIP client. - In Evergreen, create a new profile group called SIP. This group should be a sub-group of Users (not Staff or Patrons). + In Evergreen, create a new profile group called SIP. This group should be a sub-group of Users + (not Staff or Patrons). Set Editing Permission as group_application.user.sip_client and give the group the following permissions: COPY_CHECKIN @@ -99,15 +109,15 @@ For each account created in the <login> section of oils_sip.xml, create a user (via the staff client user editor) that has the same username - and password and put that user into the SIP group. - The expiration date will affect the SIP users' connection, you might want to make a note of + and password and put that user into the SIP group. + The expiration date will affect the SIP users' connection, you might want to make a note of this somewhere. Running the server - To start the SIP server type the following commands from the command prompt: + To start the SIP server type the following commands from the command prompt: $ sudo su opensrf $ oils_ctl.sh -d /openils/var/run -s /openils/conf/oils_sip.xml -a [start|stop|restart]_sip @@ -115,7 +125,7 @@ Logging-SIP Syslog - It is useful to log SIP requests to a separate file especially during initial setup by modifying your syslog config file. + It is useful to log SIP requests to a separate file especially during initial setup by modifying your syslog config file. Edit syslog.conf. @@ -163,7 +173,7 @@ - Testing Your SIP Connection + Testing Your <systemitem class="protocol">SIP</systemitem> Connection In the top level CVS checkout of the SIPServer code. @@ -189,10 +199,10 @@ More Testing - Once you have opened up either the SIP OR SIP2 ports to be accessible from outside you can do some testing via telnet. You can try this with localhost - if you so wish, but we want to prove that SIP2 works from non-localhost. Replace $instid, $server, $barcode, $username, and $password variables below as + Once you have opened up either the SIP OR SIP2 ports to be accessible from outside you can do some testing via telnet. You can try this with localhost + if you so wish, but we want to prove that SIP2 works from non-localhost. Replace $instid, $server, $barcode, $username, and $password variables below as necessary. - We are using 6001 here which is associated with SIP2 as per our configuration. + We are using 6001 here which is associated with SIP2 as per our configuration. $ telnet $server 6001 Connected to $server. Escape character is '^]'. @@ -212,9 +222,9 @@
- SIP Communication + <systemitem class="protocol">SIP</systemitem> Communication - SIP generally communicates over a TCP connection (either raw sockets or over telnet), but can also communicate via serial connections and other methods. In Evergreen, + SIP generally communicates over a TCP connection (either raw sockets or over telnet), but can also communicate via serial connections and other methods. In Evergreen, the most common deployment is a RAW socket connection on port 6001. SIP communication consists of strings of messages, each message request and response begin with a 2-digit command - Requests usually being an odd number and responses usually increased by 1 to be an even number. The combination numbers for the request command and response is often referred to as a @@ -317,7 +327,7 @@ 93/94 Login Yes - 93/94_Login - Must be first command to Evergreen ACS (via socket) or SIP will terminate + 93/94_Login - Must be first command to Evergreen ACS (via socket) or SIP will terminate 97/96 @@ -408,7 +418,7 @@ The request looks like: 17<xact_date>[fields: AO,AB,AC] The request is very terse. AC is optional. - The following response structure is for SIP2. (Version 1 of the protocol had only 6 total fields.) + The following response structure is for SIP2. (Version 1 of the protocol had only 6 total fields.) 18<circulation_status><security_marker><fee_type><xact_date>[fields: CF,AH,CJ,CM,AB,AJ,BG,BH,BV,CK,AQ,AP,CH,AF,AG,+CT,+CS] Example: 1720060110 215612AOBR1|ABno_such_barcode| @@ -433,13 +443,13 @@ 2300120060101 084235AOCONS|AA999999|ACsip_01|ADuserpassword|LY|CQN|BHUSD|BV0.00|AFOK|AOCONS| 24 Y 00120100507 022803AEDoug Fiander|AA999999|BLY|CQY|BHUSD|BV0.00|AFOK|AOCONS| - The BL field (SIP2, optional) is valid patron, so the N value means + The BL field (SIP2, optional) is valid patron, so the N value means bad_barcode doesn't match a patron, the Y value means 999999 does. - The CQ field (SIP2, optional) is valid password, so the N + The CQ field (SIP2, optional) is valid password, so the N value means bad_password doesn't match 999999's password, the Y means userpassword does. - So if you were building the most basic SIP2 authentication client, you would check for |CQY| in the response to know the user's barcode and password + So if you were building the most basic SIP2 authentication client, you would check for |CQY| in the response to know the user's barcode and password are correct (|CQY| implies |BLY|, since you cannot check the password unless the barcode exists). However, in practice, depending on the application, there are other factors to consider in authentication, like whether the user is blocked from checkout, owes excessive fines, reported their card lost, etc. These limitations are reflected in the 14-character patron status string immediately following the 24 code. @@ -512,7 +522,8 @@ Example: 9910302.00 98YYYYNN60000320100510 1717202.00AOCONS|BXYYYYYYYYYNYNNNYN| - The Supported Messages field (BX) appears only in SIP2, and specifies whether 16 different SIP commands are supported by the ACS or not. + The Supported Messages field (BX) appears only in SIP2, and specifies whether 16 different + SIP commands are supported by the ACS or not. Fields diff --git a/1.6/admin/troubleshooting.xml b/1.6/admin/troubleshooting.xml index 79c1c445e0..a5e7aeeecc 100644 --- a/1.6/admin/troubleshooting.xml +++ b/1.6/admin/troubleshooting.xml @@ -1,194 +1,210 @@ - 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 simlar to 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 may 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 correctly, 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 output similar to the following: - Starting OpenSRF Perl - * starting all services for ... - * starting service pid=7484 opensrf.settings - * starting service pid=7493 open-ils.cat - * starting service pid=7495 open-ils.supercat - * starting service pid=7497 open-ils.search - * starting service pid=7499 open-ils.circ - * starting service pid=7501 open-ils.actor - * starting service pid=7502 open-ils.storage - ... - - If the perl services do not start correctly 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 Evergreen 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.shautogen - 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 receive 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 clientsrfsh (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 errors is the Apache error logs - generally located in in the /var/log/Apache2 - 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 login from the staff client - - - Try to access the catalog from the OPAC - - + 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:web serverApachestopping + /etc/init.d/apache2 stop + or + apache2ctl stop + + + Stop OpenSRF:OpenSRF + osrf_ctl.sh -l -a stop_all + You should get either output simlar to 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 may 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:Ejabberd + sudo /etc/init.d/ejabberd restart + sudo /etc/init.d/memcached restartmemcached + + + Start the OpenSRF router and check for errors + OpenSRFservicesrouter + /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 correctly, 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.loglogsrouter + /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 + OpenSRFservicesperl + /openils/bin/osrf_ctl.sh -l -a start_perl + You should see the output similar to the following: + + Starting OpenSRF Perl + * starting all services for ... + * starting service pid=7484 opensrf.settings + * starting service pid=7493 open-ils.cat + * starting service pid=7495 open-ils.supercat + * starting service pid=7497 open-ils.search + * starting service pid=7499 open-ils.circ + * starting service pid=7501 open-ils.actor + * starting service pid=7502 open-ils.storage + ... + + If the perl services do not start correctly or you receive errors, search for errors + in the following log files: + + /openils/var/log/router.log + /openils/var/log/osrfsys.loglogsosrfsys.log + + At this point you can use the grep command to find errors in + any of the Evergreen 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:] + OpenSRFservicesC + /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.shautogen + The autogen tool will take some dynamic information from the database and generate + static JavaScript JavaScript files for use by the OPAC and staff client. It is also able to refresh + the proximity mapproximity 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 receive 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 clientsrfsh (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 logssrfsh.log + .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: + web serverApachestarting + /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.loglogsgateway.log + However, you should check all of the log files for errors: + grep ERR /openils/var/log/*.log + Another place to check for errors is the Apache error logs + generally located in in the /var/log/Apache2 logsApache + Apachelogs + 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 + configuration filesApacheeg.conf + configuration filesApacheeg_vhost.conf + + + Try to login from the staff client + + + Try to search the catalog from the OPAC + + -- 2.43.2