From 1b29748fea7c2dd3b25fdd3fd06e6489b2dc51af Mon Sep 17 00:00:00 2001 From: Alex Buckley Date: Sun, 29 Jan 2017 04:08:40 +0000 Subject: [PATCH] Bug 17956 - Added new onboarding tool template named onboardingstep6.tt to allow the users to learn about how to set up SIP, LDAP and z-targets Test plan: 1. Apply bug 17855 2. Drop and recreate your Koha database 3. Restart memcached 4. Go through the web installer and onboarding tool (up to the second 'Create circulation rule' screen 5. Click 'Learn more' button 6. The onboardingstep6.tt screen will appear. Click on LDAP radiobutton and click 'Submit' and further instructions on installing LDAP will appear. 7. Click browsers back button and do step 6 for SIP 8. Click the z-target button and login using the patron administrator account you created with the onboarding tool and the 'New Z39.50 Server' screen will appear --- installer/onboarding.pl | 30 +++++- .../prog/en/modules/onboarding/onboardingstep5.tt | 17 ++- .../prog/en/modules/onboarding/onboardingstep6.tt | 114 +++++++++++++++++++++ 3 files changed, 149 insertions(+), 12 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt diff --git a/installer/onboarding.pl b/installer/onboarding.pl index 49f4e84..0e1608f 100755 --- a/installer/onboarding.pl +++ b/installer/onboarding.pl @@ -2,7 +2,7 @@ # This file is part of Koha. # -# Copyright (C) 2017 Catalyst IT +# Copyright (C) 2017 Alex Buckley Catalyst IT # # Koha is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by @@ -76,11 +76,15 @@ $template->param( 'op' => $op ); my $schema = Koha::Database->new()->schema(); -if ( $op && $op eq 'finish' ) +if ( $op && $op eq 'Finish' ) { #If the value of $op equals 'finish' then redirect user to /cgi-bin/koha/mainpage.pl print $input->redirect("/cgi-bin/koha/mainpage.pl"); exit; } +elsif ( $op && $op eq 'Configure z-targets') { + print $input->redirect("/cgi-bin/koha/admin/z3950servers.pl?op=add&type=zed"); + exit; +} my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, ); $template->param( @@ -114,6 +118,11 @@ $template->param( my $itemtypes = Koha::ItemTypes->search(); $template->param( 'itemtypes' => $itemtypes, ); +#Select all the ztarget records in the z3950server table and give them to the template + my $existingztargets = $schema->resultset('Z3950server')->count; + $template->param(existingztargets => $existingztargets); + + if ( $step && $step == 1 ) { #store inputted parameters in variables my $branchcode = $input->param('branchcode'); @@ -600,4 +609,21 @@ elsif ( $step && $step == 5 ) { } } +elsif ( $step && $step == 6 ){ + my $service = $input->param('service'); + $template->param( service => $service ); + my ( $template, $loggedinuser, $cookie ) = + C4::InstallAuth::get_template_and_user( + { + template_name => "/onboarding/onboardingstep6.tt", + query => $input, + type => "intranet", + authnotrequired => 0, + flagsrequired => { parameters => 'manage_circ_rules' }, + debug => 1, + } + ); +} + + output_html_with_http_headers $input, $cookie, $template->output; diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt index 81ba89c..e3fda97 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt @@ -1,31 +1,28 @@ [% INCLUDE 'doc-head-open.inc' %] Create Circulation rule -[% IF ( finish ) %][% END %] [% INCLUDE 'installer-doc-head-close.inc' %]

Koha Welcome to Koha

-[% IF (finish) %] -

Congratulations you have finished and ready to use Koha

-Start using Koha - -[% END %] - [% IF op == "add_validate" %]
- +

New circulation rule

Success: circulation rule created!

To create circulation rule, go to
More -> Administration -> Circulation and Fine Rules

- Next up: - +

Next steps:

+ Log into Koha:
+

+ To learn about other services you can integrate with Koha:
+ +

[% ELSE %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt new file mode 100644 index 0000000..f3eefc3 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep6.tt @@ -0,0 +1,114 @@ +[% INCLUDE 'doc-head-open.inc' %] +Learn about other services +[% IF ( Finish ) %][% END %] +[% INCLUDE 'installer-doc-head-close.inc' %] + + +
+

Koha Other services Koha supports

+
+ +
+[% IF op == "Learn more" %] + Koha supports the integration of different library services with it.
+

LDAP user authentication

+ LDAP (Lightweight Directory Access Protocol) can be used to authenticate (login/logout) users. If your organisation has an existing authenication system this can be integrated with the Koha ILS, and so when users enter their credentials into Koha their username and password as compared against the user records in your existing user database to find a match.
+

SIP communication protocol between self checkout machines and server

+ SIP (Session Initiation Protocol) is a communication protocol used between ACS (Automated Circulation System in this case the Koha server) and SC (Self Checkout machines). If your library/institution has self checkout machines to checkin/checkout items then you will need to configure Koha to use SIP.

+
+
+
+ + +

Does your institution use SIP, or LDAP?

+
+ LDAP
+ SIP
+
+ +
+[% END %] + +
+[% IF (op == "learnservice") && (service == "LDAP") %] +

Setting up LDAP with Koha

+ If your organisation has an existing database of user records that are used for authentication then setting up the LDAP service with Koha is a good idea because all user records would be stored in a single central location.
+ LDAP can be used to log into both the Koha staff interface and OPAC.

+ Follow these steps to set up LDAP with Koha:

+ 1. In your Linux terminal navigate to the directory containing the koha-conf.xml file. This will be either:
+ + cd /etc/koha/sites/kohadev/

+ 2. Open the koha-conf.xml file as root
+ sudo vi koha-conf.xml

+ 3. Scroll down to line 295 and change it to:
+ <useldapserver>1</useldapserver>

+ 4. Write in the follwing information:
+ <ldapserver id="ldapserver">
+ <hostname>localhost</hostname>
+ <base>dc=metavore,dc=com</base>
+ <user>cn=Manager,dc=metavore,dc=com</user>
+ <pass>metavore</pass>
+ <replicate>1</replicate>
+ <update>1</update>
+ <auth_by_bind>0</auth_by_bind>
+ <anonymous_bind>0</anonymous_bind>
+ <principal_name>%s@my_domain.com</principal_name>
+ <update_password>1</update_password>

+ 5. The following fields to write in (called maping fields) are optional. What they do is link the Koha database columns with the columns in your organisations user database.
+ e.g. the database column firstname is matched with the LDAP element givename
+ <mapping>
+ <firstname is="givenname" ></firstname>
+ <surname is="sn" ></surname>
+ <address is="postaladdress" ></address>
+ <city is="l" >Athens, OH</city>
+ <zipcode is="postalcode" ></zipcode>
+ <branchcode is="branch" >MAIN</branchcode>
+ <userid is="uid" ></userid>
+ <password is="userpassword" ></password>
+ <email is="mail" ></email>
+ <categorycode is="employeetype" >PT</categorycode>
+ <phone is="telephonenumber"></phone>
+ </mapping>
+ +

Learn about further LDAP configuration

+ LDAP documentation + +[% ELSIF (op == "learnservice") && (service == "SIP") %] +

Setting up SIP with Koha

+ If you installed Koha using debain packages then setting up SIP is easy, simply follow these steps:

+ 1. In your Linux terminal (in the Koha root directory) write in:
+ sudo koha-enable-sip

+ 2. Navigate to the directory containing SIPConfig.xml
+ In your Koha home directory write in:
+ cd /etc/koha/sites/

+ 3. Edit your SIPconfig.xml file
+ sudo vi SIPconfig.xml

+ 3.1. Edit the port values in the service sections at the top of the SIPconfig.xml file, making sure that the two port values have the same IP address but different port numbers.

+ 3.2. Enter an account. This account must have the same username and password as an account you have created in the Koha staff interface. Also make sure that the account is set to having 'circulate' permissions only.

+ 3.3. Enter an institution. As with account this institution's ID must match the branchcode of a library created in the Koha staff interface

+ 4. In your Linux terminal start SIP by writing in:
+ sudo koha-start-sip

+

Learn how to test SIP at:

+ Evergreen SIP support

+

Important security notice about using SIP

+ To ensure your SIP traffic (the request and response messages sent between you and the SIP server) are secure you must use a stunnel or VPN. +[% END %] + + +[% IF (existingztargets == 0) %] +

Configure z-targets

+ What are z-targets?
+ Z-targets (also known as z39.50 servers) speed up the library cataloging process because you can query these servers for a specific MARC record (bibliographic record) and then import the record if a match is found saving you having to manually enter the bibliographic information. These servers are run by other libraries and institutions around the world, for example the Library of Congress.

+ Login to Koha and configure a z-target
+
+

+
+[% END %] + +Finish and log into Koha
+
+

+
-- 2.1.4