40
Automating Voyager Client Upgrades with Voyager AutoUpdate

Automating Voyager Client Upgrades with Voyager AutoUpdate

Embed Size (px)

Citation preview

Automating Voyager Client Upgradeswith Voyager AutoUpdate

Lori Stethers

Systems & Emerging Technologies LibrarianWesleyan University, Middletown, CT

[email protected]

These slides available at:

https://goo.gl/2fFaJKand

https://sites.google.com/site/lstetherswork/

Session AbstractVoyager's AutoUpdate provides the ability to update the Voyager client software without requiring a sys admin to visit each PC, and without overwriting your customized files. This presentation describes how to:

- set up AutoUpdate- define which files to update- install customized config files for some users or departments

Troubleshooting and problem resolution tips will also be included. This presentation covers the AutoUpdate functionality in Voyager 8.x and 9.x only.

Overview● What is AutoUpdate? / What isn’t AutoUpdate?

● Why use AutoUpdate?

● Voyager 7 autoinstall vs. Voyager 8/9 AutoUpdate

● What does an AutoUpdate upgrade look like

● How to do it - server setup and client setup

● Communications, required privileges

● Advanced/Customized Configurations

● Troubleshooting and known problems

● Questions

What is AutoUpdate?Why use it?Save time!● Don’t need to visit every PC, staff can run their own updates with no

training

Customize● Push out customized files (such as config, ini, Reports) as part of the

installation.

Standardize● Can push out same files to all PCs

OR● Can push out different file customizations per department, location, or

whatever grouping you choose

Security requirements● Admin privileges not required

You can still do manual installations on those PCs with different needs.

What ISN’T AutoUpdate?

AutoUpdate canNOT do a brand new install on a PC -- it upgrades an existing installation

It can’t repair a bad or corrupt client installation

It can’t change which clients are installed

----------------------------------------------------

For all of the above you still need the VoyagerInstall.exe or VoyagerInstall.msi

voyager.ini [Upgrade] stanza

Voyager=\\somefileserver\VoyagerInstalls\VoyagerInstall.exeorVoyager=\\somefileserver\VoyagerInstalls\VoyagerInstall.batorVoyager=http://somewebserver.myschool.edu/VoyagerInstalls/VoyagerInstall.exeorVoyager=ftp://somewebserver.myschool.edu/VoyagerInstalls/VoyagerInstall.exe

Install files can be stored on any server.

.bat file can be used to specify detailed install parameters

Voyager 7 & 8 autoinstall

voyager.ini [Upgrade] stanza

Voyager=http://clients:[email protected]:7099/autoupdate-custom/voyager/

Install files are stored on Voyager server in a pre-defined location and downloaded via http on port 7099 (via the apache web server).

Whatever clients are already present on the PC are updated

update.txt on Voyager server defines which files to update on the client (this will allow you to prevent overwriting customized files)

Voyager 8 & 9 AutoUpdate

What an AutoUpdate upgrade looks like➔ User launches Voyager client

➔ Client detects server is at a newer version than client

➔ Client uses voyager.ini [Upgrade] stanza to determine whether AutoUpgrade is available. If yes:

Might be followed up with

Then you wait...

Keep waiting!

CompleteClient downloads and installs newer version from server - it will appear nothing is happening. Just wait until you get a dialog box.

Dialog box pops up to user when install is complete.

Then you can start Voyager as usual.

How can I do this myself?REQUIRED:1. autoupdate files installed on Voyager server as part of VIK upgrade

2. Set up voyager.ini [Update] stanza on the Voyager clients

OPTIONAL (advanced/customized configs):3. Customize autoupdate directory

a. make a copy to autoupdate-custom directoryb. modify autoupdate-custom/update.txt (config) filec. add or edit files to be distributed

4. Set apache password for the AutoUpdate connection

RECOMMENDED:5. Test communication between clients and server

See the Voyager Technical Guide, Chapter 4 for official instructions.

Voyager server setup:install autoupdate filesStep 1: Install the AutoUpdate files on server.

Hooray! This is done for you as part of the VIK.

Autoupdate is automatically installed when running the VIK. The most recent autoupdate files are in:

Voyager: /m1/voyager/clients/autoupdate/voyager/

Media Scheduling Module: /m1/voyager/clients/autoupdate/media/

Voyager client setupStep 2. Set up the Voyager clients - add line in voyager.ini

Add or update the [Upgrade] stanza in voyager.ini file. Do this on all clients where you want to use autoupdate.

[Upgrade]Voyager=http://clients:[email protected]:7099/autoupdate-custom/voyager/Media=

http://clients:[email protected]:7099/autoupdate-custom/media/

Test Communications

All AutoUpdate communication happens over HTTP on port 7099

So 7099 has to be open between the clients and server

Test that you can telnet from client PC to Voyager server on port 7099

telnet voyagerservername.insitution.edu 7099

If you can’t connect, look into institution firewalls, local PC firewalls, and server port blocking (IPtables).

See Voyager Technical User’s Guide, p 4-56

Test AutoUpdateHow to test ahead of time with no test server?To test how AutoUpdate works, if you are Voy 8.1 or higher, you can downgrade a PC to the prior version and run AutoUpdate for your CURRENT version of Voyager.

Recommendation for testing production installs:The first time you run AutoUpdate after any upgrade, run it yourself on a few client PCs.● Check that the files you wanted updated were updated and the files you

wanted untouched are untouched.● Launch all client modules to ensure no errors.● Adjust as needed before telling the staff to launch Voyager and run

AutoUpdate.

Otherwise you have to go to every PC to fix whatever you missed, diminishing the benefits doing the updates automatically.

Do clients need admin privileges to run AutoUpdate?

No, not necessarily.

Voyager Technical User’s Guide, p 4-51: “Once the initial installation of the clients has been performed as an administrative user, this feature does not require administrative privileges”

Technical Note from Ex Libris - Voyager 8.x only:docs.exlibrisgroup.com -> Voyager -> Upgrade Release Planning -> Client Auto Update Notes - November 2012 [ It says that standard users can run the autoinstall if you “whitelist” the C:\voyager\system\VerUpdate.exe or C:\voyager\system\VoyDownload.exe file. This is only necessary on Voyager 8, fixed in Voyager 9. ]

Now moving into Advanced Config / Customized Setups

- not everyone needs this!

Voyager server setup:DirectoryStep 3a: Customize the AutoUpdate directory - make a copy of the autoupdate directory

Make a copy of the installed autoupdate directory. This is where you will make your customized setup. We’ll be using this one throughout the examples:

/m1/voyager/clients/autoupdate-custom/

Voyager server’s autoupdate folder

matches contents and structure of client’s C:\Voyager

and has update.txt file

default update.txt for Voyager 9.1

files=\Access Reports\Reports.mdb,\Acq.chm,\Acquisitions.exe,\AcquisitionsStart.exe,\Callslip.chm,\Callslip.exe,\Catalog.chm,\Catalog.exe,\Catalog\TagTable\Bmarcfix.cfg,\Catalog\TagTable\Country.cfg,\Catalog\TagTable\Marc21\Amarc0xx.cfg,\Catalog\TagTable\Marc21\Amarc3xx.cfg,\Catalog\TagTable\Marc21\Bmarc0xx.cfg,\Catalog\TagTable\Marc21\Bmarc2xx.cfg,\Catalog\TagTable\Marc21\Bmarc3xx.cfg,\Catalog\TagTable\Marc21\Bmarc5xx.cfg,\Catalog\TagTable\Marc21\Bmarcfix.cfg,\Catalog\TagTable\Marc21\Master.cfg,\Catalog\TagTable\Oclc\Amarc0xx.cfg,\Catalog\TagTable\Oclc\Amarc2xx.cfg,\Catalog\TagTable\Oclc\Amarc3xx.cfg,\Catalog\TagTable\Oclc\Amarc6xx.cfg,\Catalog\TagTable\Oclc\Amarc7xx.cfg,\Catalog\TagTable\Oclc\Bmarc0xx.cfg,\Catalog\TagTable\Oclc\Bmarc1xx.cfg,...\System\Voyager2009-10.dll

Voyager server setup:update.txtStep 3b: Customize the AutoUpdate directory - modify update.txt This is your autoupdate customization file. It tells autoupdate which files to install. Review this file. Make any changes you need for your environment.

/m1/voyager/clients/autoupdate-custom/voyager/update.txt

- REMOVE files from update.txt that you don’t want to overwrite on the clients (e.g. Reports.mdb, Circ.ini, catalog.ini)

- you can also ADD files that you want installed on all clients in the Voyager folder (e.g. Gil-gc.exe, voyager.ini)

Refer to Voyager Technical User’s Guide page 4-48 - 4-50 for files installed with client.

Voyager server setup:other files in autoupdate dirStep 3c: Customize the AutoUpdate directory - add or edit the files to be distributed

/m1/voyager/clients/autoupdate-custom/voyager/

If you made changes to the update.txt because you want to ADD files to be distributed, make sure you add them to the autoupdate-custom directory.

Don’t worry about REMOVED files

If you want to REPLACE the default Voyager file with a customized local version, make sure you add the customized version into the autoupdate-custom directory.

NOTE: the autoupdate directory structure echoes that of the C:\Voyager directory on the client. So make sure you stick the files in the correct directories within autoupdate-wesleyan.

Example: Wesleyan’s modifications to AutoUpdate dir for Voyager 9.1

Added to update.txt and the autoupdate-custom folder:\Gil-qc.exe,\Gil-qc\wesleyan.bmp,\Gil-qc.exe,\Prompt.exe,

Reason: this is an additional tool we need on all of our Voyager clients

Removed from update.txt:\Circulation\Circ.ini,\Catalog\catalog.ini,\Catalog\TagTable\Oclc\*,\Reporter\Acqnotes.mdb,\Reporter\Acqrprts.mdb,

Reason: these are files we have customized but they are not the same in all departments

Changed filename in update.txt and in the autoupdate-custom folder:\Access Reports\Reports-default.mdb,

Reason: don’t want to overwrite local Reports.mdb, but want to have the latest version available for reference.

More Advanced ConfigMultiple autoupdate directories - different files distributed to different departments, locations, or user types.

e.g./m1/voyager/clients/autoupdate-cataloging/voyager/

/m1/voyager/clients/autoupdate-specialcoll/voyager/

/m1/voyager/clients/autoupdate-mainbranch/voyager/

Each can have its own customized files and update.txt.

Make sure the directory matches the value you put in the client’s voyager.ini [Upgrade] stanza (more on that later.)

Handling subsequent upgrades with customizationsNext Voyager upgrade:

1. When Voyager is upgraded using the VIK, it will update the /m1/voyager/clients/autoupdate directory with new version. It will not update your autoupdate-custom directory.

2. Compare the new autoupdate update.txt with your customized update.txt. a. See if there are any changes that you need to merge into your customized version (new

files added, filename changes → that System/Voyager2009-10.dll file changes name with every release!)

b. update your update.txt file accordinglyc. Refer back to your README file to help you remember what you changed!

3. Compare other files between the new autoupdate directory and your autoupdate-custom directory. Bring your autoupdate-custom directory up to date (I usually make a copy of the new autoupdate directory and merge my customizations back onto it)

4. TEST

Step 4: Set apache password for the AutoUpdate connection

AutoUpdate communicates with the clients via HTTP on port 7099. The VIK adds configuration lines in the apache clients.conf file for you.

The Voyager client needs a username and password to connect to the server and complete the AutoUpdate. A username and password is set for this connection at install, but I advise changing the password.

How to change the password for the “clients” user:● log in to the Voyager server as root● cd /m1/shared/apache2/bin● ./htpasswd /m1/shared/apache2/conf/AuthorizedUsers/clients_access

clients

You will be prompted twice for a new password for the “clients” user.

Voyager server setup:Apache

Use your usual Voyager 7 auto-install method to upgrade to Voyager 8

Anytime before your next upgrade after upgrading to version 8.0:

Server: ● set up AutoUpdate on the server as already described

Clients:● Modify the [Upgrade] stanza in voyager.ini on all your clients to use the

new AutoUpdate method● Ensure Acquisitions and Cataloging clients are using

AcquisitionsStart.exe and CatalogStart.exe (this happens by default with Voyager 8 and later installations)

Transitioning from Voyager 7 to Voyager 8 auto-install

TroubleshootingInstall won’t launch or you see this error during AutoUpdate:

Solution: add [Upgrade] stanza to voyager.ini

TroubleshootingAutoUpdate error:

Solutions: ● You have a Voyager 7 style [Upgrade] stanza format in voyager.ini.

Update to Voyager 8/9 style stanza.● Verify connectivity from client to server on port 7099

TroubleshootingAutoUpdate error:

Solutions: ● Make sure update.txt is present on server and starts with files=● fix password in voyager.ini so it matches password set in apache server.

See article #000021944 ● Make sure the Voyager= entry in voyager.ini ends with a / . See article #

000003372

TroubleshootingAutoUpdate error:

(I don’t have a screenshot or the text of this error, but it references a specific filename in your update.txt.The installation will usually continue after this error.)

Solution:You probably have errors or typos in your update.txt - look for misspelled filenames, missing directory names, missing comma after filename.

Troubleshooting

AutoUpdate upgrade completes but Voyager runs with errors.

Solution: You may have forgotten a necessary file in the upgrade.txtIf you can identify the missing file, copy it onto the PC by hand. Fix your update.txt for future upgrades.

Troubleshooting

Voyager error appears when starting Voyager after a AutoUpdate has completed:

Solution:Something got corrupted during the installation. Reinstall Voyager from scratch on this PC.

Troubleshooting

After Voyager 9.0.0 to 9.1.0 autoupdate appeared successful, quite a few clients received these messages upon starting Voyager.

??? I’m not sure of cause.

Solution: Voyager seemed to think it had an incomplete 8.2.2 installation.I uninstalled and reinstalled 9.1.1 to remedy it. Also doing a 8.2.2 “Repair” installation seemed to work.

Known Problems(When upgrading from 8.x.x version to 9.1.0 only, I think)

"Run-time error 53: file not found"

Reason: The client update file was renamed from VerUpdate.exe to System/VoyDownload.exe and there is nothing in the AutoUpdate process to accommodate for that change.

Solution: Rename System/VerUpdate.exe to System/VoyDownload.exe on all client PCs, then launch the AutoUpdate by starting Voyager.

See article #000024310

Known ProblemsAutoUpdate does not update the Windows programs version number.See article # 000022077.

Questions?

Lori StethersSystems & Emerging Technologies LibrarianWesleyan University, Middletown, CT

[email protected]

These slides available at:

https://goo.gl/2fFaJKand

https://sites.google.com/site/lstetherswork/