You are on page 1of 44

Service Pack Installation Guide

Version 4.x
Ex Libris Confidential

CONFIDENTIAL INFORMATION
TheinformationhereinisthepropertyofExLibrisLtd.oritsaffiliatesandanymisuseorabuse
willresultineconomicloss.DONOTCOPYUNLESSYOUHAVEBEENGIVENSPECIFIC
WRITTENAUTHORIZATIONFROMEXLIBRISLTD.
Thisdocumentisprovidedforlimitedandrestrictedpurposesinaccordancewithabinding
contractwithExLibrisLtd.oranaffiliate.Theinformationhereinincludestradesecretsandis
confidential.

DISCLAIMER
Theinformationinthisdocumentwillbesubjecttoperiodicchangeandupdating.Pleaseconfirm
thatyouhavethemostcurrentdocumentation.Therearenowarrantiesofanykind,expressor
implied,providedinthisdocumentation,otherthanthoseexpresslyagreeduponinthe
applicableExLibriscontract.ThisinformationisprovidedASIS.Unlessotherwiseagreed,Ex
Librisshallnotbeliableforanydamagesforuseofthisdocument,including,withoutlimitation,
consequential,punitive,indirectordirectdamages.
Anyreferencesinthisdocumenttothirdpartymaterial(includingthirdpartyWebsites)are
providedforconvenienceonlyanddonotinanymannerserveasanendorsementofthatthird
partymaterialorthoseWebsites.ThethirdpartymaterialsarenotpartofthematerialsforthisEx
LibrisproductandExLibrishasnoliabilityforsuchmaterials.

TRADEMARKS
ExLibris,theExLibrisbridge,Primo,Aleph,Alma,Alephino,Voyager,SFX,MetaLib,Verde,
DigiTool,Preservation,Rosetta,URM,ENCompass,EndeavoreZConnect,WebVoyge,Citation
Server,LinkFinderandLinkFinderPlus,andothermarksaretrademarksorregistered
trademarksofExLibrisLtd.oritsaffiliates.
Theabsenceofanameorlogointhislistdoesnotconstituteawaiverofanyandallintellectual
propertyrightsthatExLibrisLtd.oritsaffiliateshaveestablishedinanyofitsproducts,features,
orservicenamesorlogos.
Trademarksofvariousthirdpartyproducts,whichmayincludethefollowing,arereferencedin
thisdocumentation.ExLibrisdoesnotclaimanyrightsinthesetrademarks.Useofthesemarks
doesnotimplyendorsementbyExLibrisofthesethirdpartyproducts,orendorsementbythese
thirdpartiesofExLibrisproducts.
OracleisaregisteredtrademarkofOracleCorporation.
UNIXisaregisteredtrademarkintheUnitedStatesandothercountries,licensedexclusively
throughX/OpenCompanyLtd.
Microsoft,theMicrosoftlogo,MS,MSDOS,MicrosoftPowerPoint,VisualBasic,VisualC++,
Win32,
MicrosoftWindows,theWindowslogo,MicrosoftNotepad,MicrosoftWindowsExplorer,
MicrosoftInternetExplorer,andWindowsNTareregisteredtrademarksandActiveXisa
trademarkoftheMicrosoftCorporationintheUnitedStatesand/orothercountries.
UnicodeandtheUnicodelogoareregisteredtrademarksofUnicode,Inc.
GoogleisaregisteredtrademarkofGoogle,Inc.

CopyrightExLibrisLimited,2013.Allrightsreserved.
Documentreleased:December15,2013
Webaddress:http://www.exlibrisgroup.com

Ex Libris Confidential

Table of Contents
UpdatestoThisGuide..............................................................................5
Chapter1

GettingStarted ...........................................................................................7
Introduction.................................................................................................7
ReleaseNotes ..............................................................................................8
Resources .....................................................................................................8

Chapter2

TheAutomaticSPInstallationMethod...............................................11

Chapter3

TheManualSPInstallationMethod....................................................17
ManuallyInstallingtheSP ......................................................................17
SPInstallationLogFile ............................................................................21
AccessingtheFTPSite .............................................................................21

Chapter4

TheUtilSPInstallationMethod...........................................................23
InstallingtheSP ........................................................................................23
Preparing/UpdatingtheEnvironment...................................................26
UpdatingCustomerDetails..............................................................27
UpdatingFTPSettings.....................................................................28
UpdatingSPDownloadDirectory ...................................................28
ViewingConfigurationSummary ....................................................29
CheckingtheSPDownloadStatus ........................................................29
InstallingThirdPartyProductUpdates................................................30

Chapter5

HotFixes ....................................................................................................33
InstallingHotFixes...................................................................................33
RollingBackHotFixes .............................................................................36

Chapter6

UsingtheSPUtility .................................................................................39
Introduction...............................................................................................39
RunningImplementationScripts ...........................................................40
RollingBacktheSP...................................................................................41

Index

.....................................................................................................................43

December 15, 2013

3
Ex Libris Confidential

Primo Service Pack Installation Guide


Table of Contents

December 15, 2013


Ex Libris Confidential

Updates to This Guide


Thefollowingchangesweremadetothisguide:

Addedasteptoopenanewshellsessionafterrunningtheupgradescript.
Formoreinformation,seeStep15inManuallyInstallingtheSPonpage17.

December 15, 2013

5
Ex Libris Confidential

Primo Service Pack Installation Guide


Updates to This Guide

December 15, 2013


Ex Libris Confidential

1
Getting Started
Thissectionincludes:

Introductiononpage7

ReleaseNotesonpage8

Resourcesonpage8

TheServicePackInstallationGuideprovidestheuserwiththeinstructions
neededtoinstallPrimoupdates.

Introduction
ToinstallSPupdates,Primoprovidesthefollowingmethods:

TheAutomaticSPInstallationMethodonpage11Allowsyoutoinstall
SPupdatesviayourBackOfficeUI.Thismethodcannotbeusedforsites
thatusemultipleBOorFEtopologies.

TheManualSPInstallationMethodonpage17AllowsyoutoinstallSP
updatesfromyourPrimomachines.

TheUtilSPInstallationMethodonpage23AllowsyoutoinstallSP
updatesfromyourPrimomachinesviaamenudrivenutility.Inaddition,it
allowsyoutoupdatesoftwareforthirdpartyproducts.

BeforeyoubeginaSPupdate,makesurethatyouhavereviewedtherelease
notes.Formoreinformation,seeReleaseNotesonpage8.
Onoccasion,itisnecessarytoupdatePrimobetweenSPsviahotfixes.Formore
informationoninstallinghotfixes,seeHotFixesonpage33.

December 15, 2013

7
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 1: Getting Started

Release Notes
TheReleaseNotes(seeFigure1)describeeachfixincludedintheSP.Because
somefixesmayrequireyoutorunimplementationscriptsmanually,reviewthe
descriptionsandimplementationnotesfordetails.
Figure 1:

Figure 1: Release Notes Example

ToviewtheReleaseNotesfromtheBackOffice,clicktheAboutlinkfromthe
BackOfficehomepageandthenclicktheViewSPReleaseNoteslinkonthe
Aboutpage.
ToviewtheReleaseNotesfromawebbrowser,enterthefollowingURL,where
<z>isthePrimoversionoftheSP,<r>istheminorrelease,and<u>istheSP

number:
http://exlibrispublic.exlibrisgroup.com/releasenotes/web/RN?product=
Primo&Major=<z>&Minor=<r>&ServicePack=<u>
Forexample,enterthefollowingURLtoviewtheReleaseNotesforPrimo
Version2(SP1):
http://exlibrispublic.exlibrisgroup.com/releasenotes/web/RN?product=
Primo&Major=2&Minor=0&ServicePack=1

Resources
ThefollowingareotherguidesavailableforthePrimosystem:

PrimoBackOfficeGuide

PrimoSystemAdministrationGuide

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 1: Getting Started

PrimoTechnicalGuide

PrimoInteroperabilityGuide

December 15, 2013

9
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 1: Getting Started

10

December 15, 2013


Ex Libris Confidential

2
The Automatic SP Installation Method
TheAboutpageintheBackOfficeallowstodownload,distribute,andinstallSP
andhotfixfilesautomaticallyonyourPrimosystem.
Ifyouprefertoinstallupdatesmanually,refertothefollowingsections:

TheManualSPInstallationMethodonpage17.

TheUtilSPInstallationMethodonpage23

InstallingHotFixesonpage33

IMPORTANT:
SitesthatusemultipleBOorFEtopologiesmustinstallSPsandhotfixes
manually.Pleaserefertothefollowingprocedures:
ManuallyInstallingtheSPonpage17
InstallingHotFixesonpage33
To install the SP automatically from the Back Office:
1

Fromawebbrowser,entertheURLfortheBackOfficehomepage,for
example:
http://primo.exlibris.com:1602/primo_publishing/admin/acegilogin.jsp

December 15, 2013

11
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 2: The Automatic SP Installation Method

ClicktheAboutlink.Thefollowingpageopens:
Figure 2:

Figure 2: About Page - Check for New SP

ClicktheCheckifthereisanewSPlink.IfanSPisfound,thefollowing
pageopens:
Figure 3:

Figure 3: About Page - Download SP

NOTE:
IfanSPisnotavailable,theAboutpagedisplaysthefollowingmessage
withatimestamp:

There is no new SP - <time> <date>

IfanSPisavailable,clicktheDownloadSP<number>linktodownloadthe
SPpackagetothefollowingdirectoryontheBOserver(seeFigure4),where
<v>isthePrimoversioninwhichPrimowasfirstinstalled,and<x>isthe
Primocopy:
/exlibris/primo/p<v>_<x>/ng/primo/home/system/publish/
service_pack_download

12

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 2: The Automatic SP Installation Method

Whenthedownloadiscomplete,thefollowingpageopens:
Figure 4:

Figure 4: About Page - Distribute SP

NOTE:
Ifthedownloaddoesnotcompleteforanyreason,invokingthedownload
againwillresumethedownloadfromthepointatwhichitwasstopped.
5

ClicktheDistributeSP<number>link.
Whenthedistributioniscomplete,thefollowingpageopens:
Figure 5:

Figure 5: About Page - Install SP

ThedistributionplacesthefilesunderthefollowingdirectoryonallPrimo
serversperinstallation:
/exlibris/primo/p<v>_<x>/service_pack_install

ClicktheInstallSP<number>link.

December 15, 2013

13
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 2: The Automatic SP Installation Method

Whentheinstallationiscomplete,thefollowingpageopens:
Figure 6:

Figure 6: About Page Shutdown Primo System

NOTE:
Theinstallationtimevariespersiteandconfiguration.
7

EnterthefollowingcommandstostopthePrimoApacheserver:
apcb
./apachectl stop

NOTE:
IftheApacheserverisnotrunning,youwillseeandcanignorethe
followingerrormessage:

./apachectl stop: httpd (no pid file) not running

StopallPrimoservers(be_stop,fe_stopand/orse_stop),asdetermined
bytheroles(BE,SE,andFE)supportedonthisserver.Forexample,ifthe
PrimoserversupportstheBE,FE,andSEroles,enterthefollowing
commands:
be_stop
fe_stop
se_stop

NOTE:
ForsitesusingamultipleFEconfiguration,youmuststoptheBEserver
beforestoppingtheFEservers.
9

StartallPrimoservers(be_start,fe_startand/orse_start),as
determinedbytheroles(BE,SE,andFE)supportedonthisserver.For

14

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 2: The Automatic SP Installation Method

example,ifthePrimoserversupportstheBE,FE,andSEroles,enterthe
followingcommands:
be_start
fe_start
se_start

NOTE:
Topreventastartupfailure,starttheFEserverbeforetheSEserver.
10 IftheApacheserverwasstoppedinStep7,enterthefollowingcommands
torestartthePrimoApacheserver:
apcb
./apachectl start

NOTE:
Whenport80isconfigured,youmustusethefollowingcommandsasthe
rootusertostarttheApacheserver:

cd /exlibris/primo/p3_1/primoe/apache/bin
./apachectl_auto

11 Runmanualandoptionalimplementationscriptsasdescribedinthe
ReleaseNotes.Formoreinformation,seeRunningImplementationScripts
onpage40.
12 Ifyouneedtoconservediskspace,youcanremovefilesunderthefollowing
directories,butyouwillneedtodownloadtheSPifyoudecidetorollback
theSPandreinstallit:

/exlibris/primo/p<v>_<x>/service_pack_install

/exlibris/primo/p<v>_<x>/ng/primo/home/system/publish/
service_pack_download

IMPORTANT:
Donotremovefilesinthe/exlibris/primo/p<v>_<x>/service_pack
directory.
13 FromthePrimoBackOfficehomepage,clickDeployAlltocompletethe
installation.

December 15, 2013

15
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 2: The Automatic SP Installation Method

16

December 15, 2013


Ex Libris Confidential

3
The Manual SP Installation Method
Thissectionincludes:

ManuallyInstallingtheSPonpage17

SPInstallationLogFileonpage21

AccessingtheFTPSiteonpage21

Manually Installing the SP


Thissectioncontainsthestepsneededtodownload,distribute,andinstallthe
SPfilesmanuallyonyourPrimosystem.
RepeatthefollowingstepsforeachPrimomachineandcopy.Runallstepsas
theprimouserandmakesurethatyouinstalltheSPonthemachinethat
containstheBackOffice(BE)applicationfirst.
NOTE:
IfyourPrimotopologyincludesadedicatedDBserver,donotinstallthe
SPonthatserver.
To install the SP manually:
1

Logontotheserverastheprimouser.

NOTE:
IfyourserverhasmorethanonecopyofPrimo,thesystempromptsyou
toselectacopy.
2

EnterthefollowingcommandtochangetothePrimosoftwaredirectory,
where<v>isthePrimoversioninwhichPrimowasfirstinstalledand<x>is
thePrimocopy:
cd /exlibris/primo/p<v>_<x>

December 15, 2013

17
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 3: The Manual SP Installation Method

CreatetheSPinstallationdirectoryifitisnotalreadycreated.
mkdir service_pack_install

Enterthefollowingcommandtomovetotheservice_pack_install
directory:
cd service_pack_install

EnterthefollowingcommandstodownloadtheSPfilesfromtheFTPsite,
where<z>isthePrimoversionoftheSP,<r>istheminorrelease,and<u>is
theSPnumber.Whenprompted,useprimo4_spfortheuserand4pgrade
forthepassword.
ftp ftp.exlibrisgroup.com
bin
prompt off
mget Primo-<z>.<r>-ServicePack-<u>.tar.gz *
quit

NOTE:
IfyouhavemultiplePrimocopiesonyourserver,youcanjustcopytheSP
filesdirectlyfromyourserver.
6

IftheSPissplitintomultiplefiles,whichisindicatedbythesuffixonthefile
name(suchas_aa,_ab,andsoforth),enterthefollowingcommandto
combineallofthefilesintoasinglegzfile:
cat PRIMO-<z>.<r>-ServicePack-<u>.tar.gz_* > PRIMO-<z>.<r>ServicePack-<u>.tar.gz

Enterthefollowingcommandtoextractthefilesfromthetarfile:
gzip dc PRIMO-<z>.<r>-ServicePack-<u>.tar.gz | tar -xvf -

ThePrimoserversupportsthreePrimoApplicationRoles:BE(BackOffice),
SE(SearchEngine),andFE(FrontEnd).Enterthefollowingcommandto
determinewhichtypesaresupportedonthisPrimoserver:
echo $APP_ROLE

NOTE:
MakesurethatyouupdatetheserverthatcontainsBEfirst.
9

EnterthefollowingcommandstostopthePrimoApacheserver:
apcb
./apachectl stop

NOTE:
IftheApacheserverisnotrunning,youwillseeandcanignorethe
followingerrormessage:

18

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 3: The Manual SP Installation Method

./apachectl stop: httpd (no pid file) not running

10 StopallPrimoservers(be_stop,fe_stopand/orse_stop),asdetermined
bytheroles(BE,SE,andFE)supportedonthisserver.Forexample,ifthe
PrimoserversupportstheBE,FE,andSEroles,enterthefollowing
commands:
be_stop
fe_stop
se_stop

NOTE:
ForsitesusingamultipleFEconfiguration,youmuststoptheBEserver
beforestoppingtheFEservers.
11 EnterthefollowingcommandtoreturntotheSPinstallationdirectory,
where<v>isthePrimoversioninwhichPrimowasfirstinstalledand<x>is
thePrimocopy:
cd /exlibris/primo/p<v>_<x>/service_pack_install

12 EnterthefollowingcommandtoinstalltheSP:
./sp.install

NOTE:
FornonactiveBOserversinamultipleBOconfiguration,usethe
followingcommandinstead:

./sp.install -i

Aftertheservercheckssomeconditions(suchasdatabaseaccessisavailable
andprimoserversaredown),thefollowingmessagedisplays:
You are about to install Primo Service Pack 3.0.1
Are you sure you want to continue? Y/[N]

13 EnterYtocontinue.
Theinstallationutilityrunsallmandatoryimplementationscripts
automatically.Theywilltakelessthan5minutestocomplete.When
complete,thefollowingmessagedisplays:
The Service Pack was installed successfully.
The Service Pack utility - sp.utility - can be found on /exlibris/
primo/p1_1/service_pack/sp.3.0.1
Do you want to run it now? Y/[N]

December 15, 2013

19
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 3: The Manual SP Installation Method

14 Ifyouwouldliketorunthemanualimplementationscriptsnow,enterY.
Otherwise,enterNandrunthemlaterusingthesp.utilitycommand.See
UsingtheSPUtilityonpage39.
NOTE:
Todeterminewhichimplementationscripts,ifany,requireyoutorun
themmanually,reviewtheReleaseNotesandrunthescriptsthatapplyto
yourconfiguration.SeeReleaseNotesonpage8formoreinformation.
15 WhenthePrimo4.5upgradeprocesshasfinished,youmustopenanew
shellsessioninordertoexecutetheupdatedstartupscriptsthatareusedin
theremainingsteps.
16 StartallPrimoservers(be_start,fe_startand/orse_start),as
determinedbytheroles(BE,SE,andFE)supportedonthisserver.For
example,ifthePrimoserversupportstheBE,FE,andSEroles,enterthe
followingcommands:
be_start
fe_start
se_start

NOTE:
Topreventastartupfailure,starttheFEserverbeforetheSEserver.
17 IftheApacheserverwasstoppedinStep7,enterthefollowingcommands
torestartthePrimoApacheserver:
apcb
./apachectl start

NOTE:
Whenport80isconfigured,youmustusethefollowingcommandsasthe
rootusertostarttheApacheserver:

cd /exlibris/primo/p3_1/primoe/apache/bin
./apachectl_auto

18 Ifyouneedtoconservediskspace,youcanremovefilesunderthefollowing
directory,butyouwillneedtodownloadtheSPifyoudecidetorollbackthe
SPandreinstallit:
/exlibris/primo/p<v>_<x>/service_pack_install

IMPORTANT:
Donotremovefilesinthe/exlibris/primo/p<v>_<x>/service_pack
directory.

20

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 3: The Manual SP Installation Method

19 FromthePrimoBackOfficehomepage,clickDeployAlltocompletethe
installation.

SP Installation Log File


Theinstallationutility(sp.install)logsthedetailsoftheinstallationinthe
implementation_notes.logfile.Youmayviewthislogfileunderthe/exlibris/
primo/p<v>_<x>/service_packdirectory(where<v>isthePrimoversionin
whichPrimowasfirstinstalledand<x>isthePrimocopy).

Accessing the FTP Site


TheFTPSite(ftp.exlibrisgroup.com)containstheSPfilesforthelatestupdate.If
youwanttodownloadthefilesdirectlyfromtheFTPsite,entertheURLintoa
webbrowserandlogontotheFTPsitewiththefollowinglogoninformation:
User:primo4_sp
Password:4pgrade
Dependingonthesizeoftheupdate,theSPmayrequiremorethanonetarfile,
whichisindicatedbyasuffixof_aa,_ab,andsoforth.Combinethesetarfiles
intoasingletarfilebeforerunningtheinstallationutility(sp.install).
Figure 7:

Figure 7: FTP Site

December 15, 2013

21
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 3: The Manual SP Installation Method

22

December 15, 2013


Ex Libris Confidential

4
The Util SP Installation Method
ThismethodissimilartothemanualSPinstallationmethod,butitprovidesa
menudrivenutilitythatsimplifiesthedownloadandinstallationstepsofthe
process.Inaddition,thisutilityallowsyoutodownloadandinstallthirdparty
productupdates.
Thissectionincludes:

InstallingtheSPonpage23

InstallingThirdPartyProductUpdatesonpage30

Installing the SP
ThismethodusesUtilSPtoinstalltheSPonyourPrimomachines.
NOTES:

RepeatthefollowingstepsforeachPrimomachineandcopy.Runall
stepsastheprimouserandmakesurethatyouinstalltheSPonthe
serverthatcontainstheBackOffice(BE)applicationfirst.

YoumaywanttodownloadtheSPfilestoeachserverbeforeshutting
downthemachinesandstartingtheinstallationoftheSPfiles.

IfyourPrimotopologyincludesadedicatedserverfortheDB,donot
installtheSPonthatserver.

To install the SP using Util SP:


1

Logontotheserverastheprimouser.

NOTE:
IfyourserverhasmorethanonecopyofPrimo,thesystempromptsyou
toselectacopy.

December 15, 2013

23
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

EnterthefollowingcommandtodisplayServicePackManagementmenu:
util sp

SP.

Service Pack Management


---------------------------0. Exit Procedure
1. Prepare/Update Environment
2. Download latest SP
3. Check SP Download status
4. Install SP
5. Run SP Utility (view implementation notes)
6. Download 3rd party products update
7. Check 3rd party product download status
8. Extract products updates
9. Update 3rd party soft links
10. Run Third party product OS pre checks

Please select [exit]:


Figure 8: Service Pack Management Menu (util sp)

Enteroption1toconfigureyourenvironmentfortheSPinstallation.For
moreinformation,seePreparing/UpdatingtheEnvironmentonpage26.

Enteroption2todownloadtheSPfilesfromtheFTPsitetoyourPrimo
machine.

NOTES:

Youwillreceiveanemailmessagewhenthedownloadiscomplete.Ifyou
wouldliketomonitorthedownloadsprogress,refertoCheckingtheSP
DownloadStatusonpage29.

Toreducesomedowntime,youmaywanttodownloadtheSPonall
machinesbeforecontinuingwiththefollowingsteps.

EnterthefollowingcommandstostopthePrimoApacheserver:
apcb
./apachectl stop

NOTE:
IftheApacheserverisnotrunning,youwillseeandcanignorethe
followingerrormessage:

./apachectl stop: httpd (no pid file) not running

Ifyouhavenotalreadydoneso,stopallPrimoservers(be_stop,fe_stop
and/orse_stop),asdeterminedbytheroles(BE,SE,andFE)supportedon

24

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

thisserver.Forexample,ifthePrimoserversupportstheBE,FE,andSE
roles,enterthefollowingcommands:
be_stop
fe_stop
se_stop

EnterthefollowingcommandtostarttheSPutility:
util sp

Whenthedownloadiscomplete,enteroption4toinstalltheSPfiles.

Atthefollowingprompt,enterYtocontinuewiththeinstallation:
Download successful
getopt: invalid option -- h
Usage : sp.install -bfi
Checking Configuration status...

Checking Data Base status...


Checking Primo version...
The last installed Primo Service Pack number is 3.1.2
The last installed Primo Service Pack number on Back End machine is
3.0.0
Starting installation of Primo Service Pack
You are about to install Primo Service Pack 3.1.3
Are you sure you want to continue? Y/[N]

10 OncetheSPfileshavebeeninstalled,youcanperformthefollowingstepsin
ordertorunthemanualimplementationscripts:
a

Enteroption5intheServicePackManagementmenutoopentheSP
Utilitymenu.
Formoreinformationonsp.utility,seeUsingtheSPUtilityon
page39.

Enteroption2intheSPUtillitymenutoopentheRunImplementation
Scriptssubmenu.
Formoreinformationonrunningimplementationscripts,seeRunning
ImplementationScriptsonpage40.

December 15, 2013

25
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

NOTE:
Todeterminewhichimplementationscripts,ifany,requireyoutorun
themmanually,reviewtheReleaseNotesandrunthescriptsthatapplyto
yourconfiguration.SeeReleaseNotesonpage8formoreinformation.
11 Beforecontinuingwiththenextstep,downloadandinstalltheSPonthe
remainingPrimomachinesandcopiesinyourtopology.
12 StartallPrimoservers(be_start,fe_startand/orse_start),as
determinedbytheroles(BE,SE,andFE)supportedonthisserver.For
example,ifthePrimoserversupportstheBE,FE,andSEroles,enterthe
followingcommands:
be_start
fe_start
se_start

NOTE:
Topreventastartupfailure,starttheFEserverbeforetheSEserver.
13 IftheApacheserverwasstoppedinStep5,enterthefollowingcommands
torestartthePrimoApacheserver:
apcb
./apachectl start

NOTE:
Whenport80isconfigured,youmustusethefollowingcommandsasthe
rootusertostarttheApacheserver:

cd /exlibris/primo/p3_1/primoe/apache/bin
./apachectl_auto

14 FromthePrimoBackOfficehomepage,runDeployAlltocompletethe
installation.

Preparing/Updating the Environment


TheEnvironmentSettingsubmenuallowsyoutoconfigureparametersthatare
neededinordertoinstalltheSP.Theseconfigurationparametersinclude
customerdetails,FTPsettings,anddownloaddirectory.

26

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

SP.1. Environment Setting


-------------------------0. Exit Procedure
1. Customer details
2. FTP settings
3. SP Download directory
4. View Parameters
Please select [exit]:
Figure 9: Environment Settings Submenu

Toaccessthissubmenu,enteroption1intheServicePackManagementmenu.

Updating Customer Details


TheSPCustomerDetailsscreenallowsyouconfigurethecustomerparameters.
Foreachparameter,thesystempromptsyouforanewvalue.Tokeepthe
currentvalue,typeENTERandcontinuewiththenextparameter.
SP Customer details
-------------------------Enter new values or press <Enter> to keep existing
Ex Libris customer code (country code + customer) [972DAN]:
Customer mail address for download status notifications (leave empty
for none) [Danny.Perlman@exlibrisgroup.com]
If you want to change the language please type it now [english]:
(This is an option for future usage)

Configuration summary:
---------------------Language:
Customer code:
Notification address:

english
972DAN
X.Y@exlibrisgroup.com

Press <Enter> to continue


Figure 10: SP Customer Details Screen

Toaccessthisscreen,enteroption1intheEnvironmentSettingssubmenu.
NOTE:
Afterthisscriptisrunthefirsttime,thesystemwillcreateansp.config
fileunderthe$primoe_rootdirectory.Thisfileshouldnotbeedited.If

December 15, 2013

27
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

thereisaneedtomodifyit(suchasforaspecialFTPcondition),consult
ExLibrisSupportbeforeimplementingthechange.

Updating FTP Settings


TheSPFTPSettingsscreenallowsyouconfiguretheparametersassociatedwith
theFTPserver.Foreachparameter,thesystempromptsyouforanewvalue.To
keepthecurrentvalue,typeENTERandcontinuewiththenextparameter.
SP FTP settings
-------------------------Enter new values or press <Enter> to keep existing
Select FTP server number for SP download:
1) USA/Asia Pacific
ftp.exlibris-usa.com
2) HQ/Middle east
ftp.exlibrisgroup.com
3) Europe
ftp.exl.de
4) internal HQ
il-ftp01
<Enter> to keep current (ftp.exl.de)
FTP user for SP download [ver20_sp]:
FTP special options []:
*** for firewall connection problems try 'passive'
For details check the utility documentation

Configuration summary:
---------------------FTP server:
FTP user:
FTP options:

ftp.exl.de
ver20_sp

If you want to insert new FTP password please type it now


Or press ENTER to keep current password
Press <Enter> to continue
Figure 11: SP FTP Settings Screen

Toaccessthisscreen,enteroption2intheEnvironmentSettingssubmenu.

Updating SP Download Directory


TheSPDownloadDirectoryscreenallowsyouconfigurethetargetdirectoryfor
thedownloadedSPfiles.EnteranewvalueortypeENTERtokeepthecurrent
directory.

28

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

SP Download Directory
---------------------Current SP Download directory is /exlibris/primo/p3_3/ng/primo/
home/system/publish/service_pack_download
If you wish to change it enter the new path now
Press enter to keep current definition
Press <Enter> to continue
Figure 12: SP Download Directory Screen

Toaccessthisscreen,enteroption3intheEnvironmentSettingssubmenu.

Viewing Configuration Summary


TheConfigurationSummaryscreendisplaysthecurrentconfiguration
parametersettings.
Configuration summary:
---------------------FTP server:
ftp.exlibrisgroup.com
FTP user:
primo4_sp
FTP options:
Language:
english
Service pack download dir: /exlibris/primo/p3_3/ng/primo/home/
system/publish/service_pack_download
Customer code:
Notification address:
Press <Enter> to continue
Figure 13: Configuration Summary Screen

Toaccessthisscreen,enteroption4ontheEnvironmentSettingssubmenu.

Checking the SP Download Status


Thisoptionallowsyoutochecktheintegrityofthedownloadedfilesand
monitorthedownloadprogress.
Ifthedownloadhasnotcompleted,youwillreceiveastatusmessagethatis
similartothefollowingmessage.
FTP still running
1 file(s) of total 5 completed (20 %)
press <Enter> to continue

December 15, 2013

29
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

Attheendofthedownloadprocess,thesystemwillsendanemailmessagethat
reportswhethertheprocesssucceededorfailed.Ifithadfailed,themessagewill
containthespecificreason.
NOTE:
IfthereisadelaybetweentheSPdownloadstepsandtheactual
installationoftheSPfiles,donotremovetheSPdownloaddirectoryand
the$primoe_root/sp.configfile.OnlyeditthisfilewithUtilSP.

Installing Third-Party Product Updates


To install the third-party product updates:
1

Logontotheserverastheprimouser.

NOTE:
IfyourserverhasmorethanonecopyofPrimo,thesystempromptsyou
toselectacopy.
2

EnterthefollowingcommandtodisplayServicePackManagementmenu:
util sp

SP.

Service Pack Management


---------------------------0. Exit Procedure
1. Prepare/Update Environment
2. Download latest SP
3. Check SP Download status
4. Install SP
5. Run SP Utility (view implementation notes)
6. Download 3rd party products update
7. Check 3rd party product download status
8. Extract products updates
9. Update 3rd party soft links
10. Run Third party product OS pre checks

Please select [exit]:


Figure 14: Service Pack Management Menu (util sp)

Enteroption6todownloadthelatestavailablethirdpartyproductupdates.

30

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

Atthefollowingprompt,enterthefullpathoftheFTPdirectoryortype
ENTERtokeepthecurrentdirectory:

The third party download utility will use wget to download the
required packages
Download directory will be /exlibris/ftp_from_exlibris
If you want to change it please enter the new path now or <ENTER> to
keep

Enteroption7tocheckthestatusofthedownload.Donotcontinuewiththe
nextstepuntilthedownloadcompletes.

Enteroption8toextractthedownloadedproductfilesfromtheFTPsiteto
yourPrimomachine.Thesystemwillinstallalloftheproductsinthe
followingdirectory:
/exlibris/ftp_from_exlibris

Enteroption10tomakesurethatallOSpackagesneededfornormal
operationoftheupdatedthirdpartyproductsareinstalled.

NOTE:
Itisrecommendedthatthischeckisrunafterthedownloadcompletesand
beforethethirdpartyproductsareinstalled.IfanyOSpackagesare
missing,askyourlocalITstafftoinstallthem.
8

Enteroption9toinstallthethirdpartyproduct.
Thisoptionreplacesthesoftlinkstothecurrentthirdpartyproductswith
softlinkstothetothenewinstallationofthethirdpartyproducts.

IMPORTANT:
Beforerunningthisstep,makesurethatyoushutdowntheApacheand
performPrimo_shutdown.

December 15, 2013

31
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 4: The Util SP Installation Method

32

December 15, 2013


Ex Libris Confidential

5
Hot Fixes
Patchesthatarereleasedbetweenservicepackreleasesarecalledhotfix
packages.Ahotfixpackageisnormallyreleasedinthesamewayasservice
packs.Onsomeoccasions,hotfixpackagesarereleasedinternallytoSupport
representativeswhocontactcustomerstocoordinatespecifichotfixpackage
installations.
Thissectionincludes:

InstallingHotFixesonpage33

RollingBackHotFixesonpage36

Installing Hot Fixes


Thissectioncontainstheproceduretoapplyhotfixes.
NOTES:

IfyoursitedoesnothavemultipleBOandFEmachinesandyoupreferto
installthehotfixesautomatically,usetheinstructionsprovidedin
sectionTheAutomaticSPInstallationMethodonpage11.

EachHotFixpackageincludesallfixesprovidedinpreviousHotFix
packages.

Forspecialinstructionsoninstallingahotfixpackage,enterthe
followingcommandstoviewtheREADMEfile:
cd /exlibris/primo/p<r>_<c>/service_pack_install/
primo_hotfix.<v>.<date>
vi README

where<r>isthePrimorelease,<c>isthePrimocopy,<v>isthefull
Primoversion(suchasv3.0.2),and<date>isthebuilddateofthehotfix
package.

December 15, 2013

33
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 5: Hot Fixes

To install the Hot Fix package:


1

Logontotheserverastheprimouser.

EnterthefollowingcommandtomovetotheSPinstallationdirectory,where
<v>isthePrimoversioninwhichPrimowasfirstinstalledand<x>isthe
Primocopy:
cd /exlibris/primo/p<v>_<x>/service_pack_install

Enterthefollowingcommandstodownloadthehotfixpackagefromthe
FTPSite,where<v>isthecurrentPrimoversion,<x>istheminorrelease
number,<y>istheupdatenumber,and<date>isthebuilddateofthehot
fixpackage.Whenprompted,useprimo_hf3fortheuserand4pgradefor
thepassword.
ftp ftp.exlibrisgroup.com
bin
prompt off
mget PRIMO-<v>.<x>-HotFix-<y>.<date>.tar.gz_*
quit

EnterthefollowingcommandstostopthePrimoApacheserver:
apcb
./apachectl stop

NOTE:
IftheApacheserverisnotrunning,youwillseeandcanignorethe
followingerrormessage:

./apachectl stop: httpd (no pid file) not running

StopallPrimoservers(be_stop,fe_stopand/orse_stop),asdetermined
bytheroles(BE,SE,andFE)supportedonthisserver.Forexample,ifthe
PrimoserversupportstheBE,FE,andSEroles,enterthefollowing
commands:
be_stop
fe_stop
se_stop

NOTE:
ForsitesusingamultipleFEconfiguration,youmuststoptheBEserver
beforestoppingtheFEservers.
6

EnterthefollowingcommandtoreturntotheSPinstallationdirectory:
cd /exlibris/primo/p<v>_<x>/service_pack_install

34

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 5: Hot Fixes

Enterthefollowingcommandstorunthehotfixpackage,where<v>isthe
currentPrimoversion,<x>istheminorreleasenumber,<y>istheupdate
number,and<date>isthebuilddateofthehotfixpackage:
cat PRIMO-<v>.<x>-HotFix-<y>.<date>.tar.gz_* > PRIMO-<v>.<x>HotFix-<y>.<date>.tar.gz
tar -xzvf PRIMO-<v>.<x>-HotFix-<y>.<date>.tar.gz
./hf.install

StartallPrimoservers(be_start,fe_startand/orse_start),as
determinedbytheroles(BE,SE,andFE)supportedonthisserver.For
example,ifthePrimoserversupportstheBE,FE,andSEroles,enterthe
followingcommands:
be_start
fe_start
se_start

NOTE:
Topreventastartupfailure,starttheFEserverbeforetheSEserver.
9

IftheApacheserverwasstoppedinStep4,enterthefollowingcommands
torestartthePrimoApacheserver:
apcb
./apachectl start

NOTE:
Whenport80isconfigured,youmustusethefollowingcommandsasthe
rootusertostarttheApacheserver:

cd /exlibris/primo/p3_1/primoe/apache/bin
./apachectl_auto

10 Ifyouneedtoconservediskspace,youcanremovefilesunderthefollowing
directory,butyouwillneedtodownloadtheSPifyoudecidetorollbackthe
SPandreinstallit:
/exlibris/primo/p<v>_<x>/service_pack_install

IMPORTANT:
Donotremovefilesinthe/exlibris/primo/p<v>_<x>/service_pack
directory.
11 FromthePrimoBackOfficehomepage,clickDeployAlltocompletethe
installation.

December 15, 2013

35
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 5: Hot Fixes

Rolling Back Hot Fixes


Thissectioncontainstheproceduretorollbackthehotfixtotheprevious
version.
To roll back the hot fix package:
1

EnterthefollowingcommandstostopthePrimoApacheserver:
apcb
./apachectl stop

NOTE:
IftheApacheserverisnotrunning,youwillseeandcanignorethe
followingerrormessage:

./apachectl stop: httpd (no pid file) not running

StopallPrimoservers(be_stop,fe_stopand/orse_stop),asdetermined
bytheroles(BE,SE,andFE)supportedonthisserver.Forexample,ifthe
PrimoserversupportstheBE,FE,andSEroles,enterthefollowing
commands:
be_stop
fe_stop
se_stop

NOTE:
ForsitesusingamultipleFEconfiguration,youmuststoptheBEserver
beforestoppingtheFEservers.
cd /exlibris/primo/p<v>_<x>/service_pack/hf.<ver>.<date>

EnterthefollowingcommandstostarttheHotFixutility,where<date>is
thebuilddateofthehotfixpackageand<ver>istheupdateversion(such
as3.0.2):
cd /exlibris/primo/p<v>_<x>/service_pack/hf.<ver>.<date>
./hf.utility

Torollbackthehotfix,enteroption9.

StartallPrimoservers(be_start,fe_startand/orse_start),as
determinedbytheroles(BE,SE,andFE)supportedonthisserver.For

36

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 5: Hot Fixes

example,ifthePrimoserversupportstheBE,FE,andSEroles,enterthe
followingcommands:
be_start
fe_start
se_start

NOTE:
Topreventastartupfailure,starttheFEserverbeforetheSEserver.
6

IftheApacheserverwasstoppedinStep1,enterthefollowingcommands
torestartthePrimoApacheserver:
apcb
./apachectl start

NOTE:
Whenport80isconfigured,youmustusethefollowingcommandsasthe
rootusertostarttheApacheserver:

cd /exlibris/primo/p3_1/primoe/apache/bin
./apachectl_auto

December 15, 2013

37
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 5: Hot Fixes

38

December 15, 2013


Ex Libris Confidential

6
Using the SP Utility
Thissectionincludes:

Introductiononpage39

RunningImplementationScriptsonpage40

RollingBacktheSPonpage41

Introduction
DuringtheinstallationoftheSP,theinstallscriptautomaticallyrunsthe
mandatoryimplementationscriptstoupdateyourPrimoservers.
Installationscripts,whicharedependentonyourPrimotopologyor
configuration,cannotbeperformedbytheinstallationscript.Thesescripts,if
any,requireyoutorunthemmanuallyviathesp.utilitycommand,whichis
locatedunderthefollowingdirectory,where<v>isthePrimoversioninwhich
Primowasfirstinstalled,<r>istheminorrelease,<x>isthePrimocopy,and
<u>istheSPnumber:
/exlibris/primo/p<v>_<x>/service_pack/sp.<v>.<r>.<u>

Todetermineifanyimplementationscriptsrequireyoutorunthemmanually,
reviewtheReleaseNotesandrunthescriptsthatapplytoyourconfiguration.
NOTE:
Althoughthescriptsareoptional,thebenefitofsomeupdatesmaynotbe
ineffectuntilyourunthescripts.
Fromthemainmenu(seeFigure15)oftheSPUtility,youcanperformthe
followingtasks:

Runimplementationscripts

RollbacktheSP

December 15, 2013

39
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 6: Using the SP Utility

Welcome to Service Pack utility.


Your current Service Pack is 2.0.1.
0. Exit Procedure
2. Run Implementation Scripts

9. Rollback
Please select [0]:
Figure 15: SP Utility - Main Menu

Running Implementation Scripts


FromtheRunImplementationScriptsmenu(seeFigure16)oftheSPUtility,
youcanrunoptionalscriptsallatonceorindividuallybyspecifyingascript
number,indicatedbytheIssueIDcolumnintheReleaseNotes.
Run Implementation Scripts
0. Exit Procedure
1. Run a specific implementation script
2. Run all implementation scripts automatically

Please select [0]:


Figure 16: SP Utility - Run Scripts Menu

To install all implementation scripts:


1

Enteroption2fromtheRunImplementationScriptsmenu.

Atthefollowingprompt,entertheSPnumber:
Please enter the number of service pack you want to start
with automatic run:

Atthefollowingprompt,enteranykeytocontinue:
Implementation script run ended - press any key to continue

Enteroption0toexitthemenu.

40

December 15, 2013


Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 6: Using the SP Utility

To install a specific implementation script:


1

Enter1fromtheRunImplementationScriptsmenu.Thefollowingprompt
displays:
Enter the service pack number to which the script belongs (e.g.
enter "5" for 1.2.5):

EntertheSPnumber.Thefollowingpromptdisplays:
Enter the number of the defect number whose script you want to run:

Enterthedefectnumberforwhichyouwanttoruntheimplementation
script.TheSPutilitydisplaysthestatus.Forexample,thestatusof
implementationscript2368displaysasfollows:
You chose to run implementation script 2368 of service pack 6
>>>> Now running implementation script 2368 of service pack 6
Implementation script 2368 of service pack 6: updates the OpenURL
templates
>>>> Implementation script 2368 of service pack 6 execution finished
successfully Thu Nov 29 16:23:20 IST 2007
Implementation script run ended - press any key to continue

Enteranykeytocontinue.

Enter0toexitthemenu.

Rolling Back the SP


Therollbackoptionfromthemainmenu(seeFigure15)oftheSPUtilityreturns
theinstallationtothepreviousSP.TorollbacktheSP,enteroption9.
NOTE:
YoumuststoptheApache,BE,FE,andSEserversbeforerollingbackthe
SP.
ToreinstalltheSP,youmustusethesp.installcommand.

December 15, 2013

41
Ex Libris Confidential

Primo Service Pack Installation Guide


Chapter 6: Using the SP Utility

42

December 15, 2013


Ex Libris Confidential

Index
A

Aboutlink, 8, 12
Apache, 14, 34, 35, 36, 37
apachectl, 14, 15, 20, 26, 34, 35, 36, 37
apcb, 15, 20, 26, 35, 37

logfile, 21

B
be_start, 15, 20, 26, 35, 37
be_stop, 14, 19, 25, 34, 36

M
mget, 18

R
ReleaseNotes
viewing, 8
Resources, 8
rollback, 41

CheckingforSP, 12

S
D
defect, 41
DeployAll, 15, 21, 26, 35
distribute, 17
distributeSP, 13
download, 17
automatic, 12
manual, 18, 24

service_pack_install, 34, 36
se_start, 15, 20, 26, 35, 37
se_stop, 14, 19, 25, 34, 36
sp.install, 19, 21

F
fe_start, 15, 20, 26, 35, 37
fe_stop, 14, 19, 25, 34, 36
FTPSite
download SP, 34
service packs, 21

H
hf_install.sh, 35, 36
HotFix
installing, 33

I
implementationnotes, 8
Implementationscripts
running, 40
install, 17
InstallSP, 13

December 15, 2013

43
Ex Libris Confidential

Primo Service Pack Installation Guide


Index

44

December 15, 2013


Ex Libris Confidential

You might also like