Upgrade SFX V3 to V4 Lieve Rottiers

Agenda Introduction Pre-upgrade preparation V4 installation Upgrade kit Post-upgrade checking and going live

Introduction Customers should be able to run upgrade themselves following these 5 basic steps: Pre-upgrade preparation V4 installation Upgrade kit – source menu – exporting localizations from V3 Upgrade kit – target menu – importing localizations into V4 Post-upgrade checking + going live

Pre-upgrade Step Customers should: check server Operating System and system requirements for V4 make list of v3 instances to get v4 license for get new V4 licenses from Ex Libris Do some general ‘cleaning’ of SFX V3 environment Customers can perform upgrade themselves – but are advised to coordinate upgrade with ExL support. SFX V3 and V4 environment should be up to date with same revision – we recommend to be up to date with the latest revision released for SFX V3 before starting the upgrade.

V3 Cleaning We recommend to do the following cleaning – check for: redundant Institutes, Instances, AZ profiles Local files and Broken symbolic links Stats archiving and files logs (apache and other) backups no longer needed Scratch directory Tmp directory from old downloads Archive and home directories

V4 Licenses Each license will contain following information: Instance name in V4 Instance name in V3 (only for upgraded instances) Server IP information Instance specific ID prefix Customer code (new) Customer will receive file with V4 licenses – which can be used as input to V4 installer program.

V4 Installation Standard SFX V4 Installation Kit Using new V4 licenses (to have same set-up of instances as in V3) V4 installation should be be up to date with the latest SFX revision released for both V3 and V4 – it may be necessary to run rev-up after installation At the end of this step, the customer will have a fully-functioning but non-localized SFX V4 environment. Note: The SFX Installation Kit should be run as root.

SFX V4 Installer Program Same as in V3 – except for: Option to use file with V4 licenses instead of prompting for each license Multiple installations of SFX v4 can exist on the same server Separation of local/global: the sfxglb4x instance DB will be populated with global KB, local instance DB tables will be empty

SFX V3 and SFX V4 on Same Server /exlibris/sfx_ver sfx_version_3/ sfx4_1/ sfxglb3 sfxlcl3 sfxtst3 sfxglb41 sfxlcl41 sfxtst41 Different apache port for V3 and V4 Different UNIX users and instance names for V3 and V4 Renaming of instances in reverse proxy Apache will be needed to make sure that base-URL stays the same in SFX V4

SFX Upgrade Kit – What? Consists of Source and target menus – with step-by-step guidance through different upgrade steps Customers should start with the Source menu in SFX V3, then move to the Target menu in SFX V4 The upgrade kit should be run as sfxglb3 (for source) and sfxglb4X (X is the SFX copy, for target); both global users (of SFX V3 and SFX V4) should have “sudo root” permissions in order to run the upgrade The Upgrade kit is downloaded from ExL FTP server. If a new version of the kit is available, this will be detected at the start of the Upgrade kit, and user will be advised to download the latest version.

SFX Upgrade Kit – How? Upgrade kit will: Allow customer to configure the upgrade Check requirements before starting the source and target sections of the upgrade Provide a visual indication of which steps have been completed successfully and which ones are currently running Not allow customers to skip required upgrade steps Not allow customers to proceed with the next step after the previous required step failed or in case required steps are run out of order

Upgrade Kit - Options Upgrade can be done on the same server or while moving to a different server in SFX V4 Menu allows configuring which instances to upgrade – both in target and source menus The upgrade kit also provides options for: Copying V3 statistics only in V4 – this option is needed to move all statistics information into V4 right before going live Database re-localization before going live - this option is needed in case the customer continued work in the V3 database after running the Upgrade kit, and wants this localization to be included in V4 before going live

Upgrade Kit – Flow 1 SFX v3 server SFX v4 server Pre-upgrade preparation SFX v4 Installation Packaging DB and SW files Optional back-up of installation FTP upgrade package Importing DB and SW files Post Upgrade actions and adjustments Testing Packaging DB or Statistics only Importing DB or Statistics only FTP upgrade package Switch to production (switch Apache port if on same server)

Upgrade Kit – Flow 2 SFX v3 server SFX v4 server Pre-upgrade preparation SFX v4 Installation Packaging DB and SW files Back-up of installation FTP upgrade package Importing DB and SW files Post Upgrade actions and adjustments Testing Repackaging DB and SW files Restoring the original V4 installation Highlight Restore the original V4 installation FTP upgrade package Importing DB and SW files Post Upgrade actions and adjustments Switch to production (switch Apache port if on same server

Checking V3 and V4 Revision Status In V3 – the Upgrade kit will: check that V3 KBDB revision is at least as update as the version in the currently available V4 installer This will be done by comparing .sfx_history with a file with V4 installer information on ExL FTP server Make sure that the KBDB revision number is the same for all of the instances Save the KBDB revision number together with the upgraded data In V4: the Upgrade kit will: download a file from the FTP server which has a table with the revision number in SFX3 and the corresponding number in SFX4 If the revision (of the GLB) in SFX4 is higher that the revision number in SFX3 -> error. If the revision (of the GLB) in SFX4 is the same as the revision number in SFX3 ->  continue with the import and upgrade If the revision (of the GLB) in SFX4 is lower that the revision number in SFX3 -> perform rev_up in V4 (but only until the revision in SFX3)

Upgrade Kit – Source Menu On the source installation, the localized data and configuration will be exported.

Source Menu - Configuration At appropriate time, highlight instances=sfxlcl3

Pack DB and Configuration Files

Pack DB and Configuration Files

V3 Database Content – Moved to V4? Following local instance DB content will be upgraded to V4: local targets, target services, portfolios, sources, source services, objects activation settings for default and institutes local thresholds, target parser and parse_param info for global entries local MULTILANGUAGE table entries CONTROL, USERS table entries

V3 Localized Files – Moved to V4? Will be part of V4 upgrade – in case of local or localized files Not included in upgrade – will be reported in list of not-upgraded files in case of localization Will be ignored during upgrade – not reported admin archive cgi/public cgi/core config – localized config files + files in the following subdirectories: source target config - subdirectories: admin, express, headers, identifiers, keys, onix, unicode_dictionary dbs/scratch/e_collection_update dbs/sqltab dbs/scratch (excluding dbs/scratch/e_collection_update) export files lib/Parsers – all localized lib - All content and subdirectories except for lib/Parsers home

V3 Localized Files – Moved to V4? Will be part of V4 upgrade – in case of local or localized files Not included in upgrade – will be reported in list of not-upgraded files in case of localization Will be ignored during upgrade – not reported logs sfxadmin templates – following subdirectories: azlist_ver3 citation css gif http_errors img js multiobject sfxmenu simplified_template1 targets templates - All directory content and following subdirectories: azlist E-collection-html a-z admin autocomplete bx e-journals express generator kbadmin me_report p3p_samples registration reports reports_prev sfxctrl

V3 Localized Files – Moved to V4? Will be part of V4 upgrade – in case of local or localized files Not included in upgrade – will be reported in list of not-upgraded files in case of localization Will be ignored during upgrade – not reported admin archive cgi/public cgi/core config – localized config files + files in the following subdirectories: source target config - subdirectories: admin, express, headers, identifiers, keys, onix, unicode_dictionary dbs/scratch/e_collection_update dbs/sqltab dbs/scratch (excluding dbs/scratch/e_collection_update) export files lib/Parsers – all localized lib - All content and subdirectories except for lib/Parsers home

V3 Localized files – Moved to V4? Will be part of V4 upgrade – in case of local or localized files Not included in upgrade – will be reported in list of not-upgraded files in case of localization Will be ignored during upgrade – not reported logs sfxadmin templates – following subdirectories: azlist_ver3 citation css gif http_errors img js multiobject sfxmenu simplified_template1 targets templates - All directory content and following subdirectories: azlist E-collection-html a-z admin autocomplete bx e-journals express generator kbadmin me_report p3p_samples registration reports reports_prev sfxctrl

FTP Source Files

Upgrade Kit – Source Menu On the source installation, the localized data and configuration will be exported.

Target Menu

Backup/Restore the Initial V4 Installation Backup is an optional step – it is advisable to restore initial installation easily

Unpacking DB and Files

Target Menu

Unpacking DB and Files

Software Files Upgrade

Post-Upgrade Actions

Refreshing DB-only or Statistics-Only

Creating an Additional Instance

Post-Upgrade Testing & Going Live This step includes a script for switching the SFX version 4 port to use the one formerly occupied by SFX Version 3 - when going ‘live’ with SFX Version 4.

Switching V3 and V4 Ports

Renaming Instances via Apache Configuration Needs to be done manually Instructions include changes to: config/reverse_proxy.config__ of sfxglb41 instance config/local_httpd.config_ of the local instance

learn@exlibrisgroup.com