The Aleph Service
Pack MechanismPost Release SP 21
Version 21
CONFIDENTIAL INFORMATION
The information he re in is the prope rty of Ex Libris Ltd. or its affiliate s and any misuse or abuse will
re sult in e conomic loss. DO NOT COPY UNLES S YOU HAVE BEEN GIVEN SPECIFIC WRITTEN
AUTHORIZATION FROM EX LIBRIS LTD.
This docume nt is provide d for limite d and re stricted purposes in accordance with a binding contract
with Ex Libris Ltd. or an affiliate . The information he rein include s trade secrets and is confide ntial.
DISCLAIMER
The information in this docume nt will be subje ct to pe riodic change and updating. Ple ase confirm that
you have the most current documentation. The re are no warranties of any kind, e xpre ss or implie d,
provide d in this docume ntation, other than those e xpressly agreed upon in the applicable Ex Libris
contract. This information is provide d AS IS. Unle ss otherwise agreed, Ex Libris shall not be liable for
any damages for use of this document, including, without limitation, conse quential, punitive , indire ct or
dire ct damages.
Any re fe rences in this docume nt to third-party material (including third-party We b site s) are provide d
for conve nie nce only and do not in any manne r serve as an e ndorsement of that third-party material or
those Web sites. The third-party materials are not part of the materials for this Ex Libris product and Ex
Libris has no liability for such mate rials.
TRADEMARKS
"Ex Libris," the Ex Libris bridge , Primo, Ale ph, Ale phino, Voyager, SFX, Me taLib, Ve rde, DigiTool,
Pre se rvation, URM, Voyager, ENCompass, Ende avor eZConnect, WebVoyage, Citation Server,
LinkFinde r and LinkFinde r Plus, and othe r marks are trademarks or re gistered trademarks of Ex Libris
Ltd. or its affiliate s.
The abse nce of a name or logo in this list doe s not constitute a waive r of any and all inte lle ctual
prope rty rights that Ex Libris Ltd. or its affiliate s have e stablished in any of its products, fe atures, or
se rvice names or logos.
Trade marks of various third-party products, which may include the following, are re ferenced in this
docume ntation. Ex Libris doe s not claim any rights in the se trademarks. Use of the se marks does not
imply e ndorse ment by Ex Libris of the se third-party products, or e ndorsement by the se third partie s of
Ex Libris products.
Oracle is a re gistered trademark of Oracle Corporation.
UNIX is a re gistered trademark in the Unite d State s and other countries, lice nsed e xclusively through
X/Ope n Company Ltd.
Microsoft, the Microsoft logo, MS, MS-DOS, Microsoft Powe rPoint, Visual Basic, Visual C++, Win32,
Microsoft Windows, the Windows logo, Microsoft Note pad, Microsoft Windows Explore r, Microsoft
Inte rnet Explore r, and Windows NT are re gistered trademarks and Active X is a trademark of the
Microsoft Corporation in the Unite d State s and/or other countrie s.
Unicode and the Unicode logo are re gistered trademarks of Unicode , Inc.
Google is a re gistered trademark of Google , Inc.
Copyright Ex Libris Limite d, 2012. All rights re se rved.
Docume nt re leased: July 25, 2012
We b addre ss: http://www.e xlibrisgroup.com
2
Table of Contents
1
THE ALEPH SERVICE PACK .......................................................................... 5
2
THE SERVICE PACK LEVEL .......................................................................... 5
3
PRE-INSTALLATION STEPS FOR THE ALEPH SERVICE PACK .......... 6
3.1 The Aleph Service Pack Excel Spreadsheet .................................................. 6
4
THE SERVICE PACK INSTALLATION UTILITY ....................................... 8
5
PREPARING/UPDATING THE ENVIRONMENT ......................................... 9
Customer details (util SP 1/1) ........................................................................................................... 10
FTP settings (util SP 1/2) ................................................................................................................... 10
SP Down load Directory (util SP 1/ 3).............................................................................................. 11
View Parameters (util SP 1/ 4) ........................................................................................................... 11
6
DOWNLOADING AND INSTALLING THE SERVICE PACK .................. 11
Downloading the Latest Service Pack (util SP 2)................................................. 11
Checking the Service Pack Download Completion (util SP 3) ............................ 11
Installing the Service pack (util SP 4) .................................................................. 12
7
RUN SERVICE PACK UTILITY (UTIL SP 5 /2 - 5/6 AND 5/9) .................. 13
Service Pack Su mmary (Plain Fo rmat and Excel Format) ........................................................... 14
PC Files Involved ................................................................................................................................ 14
View Optional Implementation Notes ............................................................................................. 14
8
RUNNING THE AUTOMATIC IMPLEMENTATION NOTES (UTIL SP
5/7) ........................................................................................................................ 15
8.1 Running All Implementation Notes (util SP 5/7/2) ..................................... 15
8.2 Running Selected Implementation Notes (util SP 5/7/3) ............................. 15
8.3 Running AIN for a Single rep_change (Util SP 5/7/4) ................................ 15
8.4 Rolling Back Previous AIN changes ( Util SP 5/7/5) .................................. 16
8.5 Updating Configuration (Util SP 5/8) .......................................................... 16
9
DOWNLOADING AND INSTALLING THIRD-PARTY PRODUCT
UPDATES............................................................................................................ 17
9.1 Download the Third-Party Product Updates (util SP 6) .............................. 17
9.2 Check OS Requirements for Third-Party Product Updates (util SP 10)...... 17
3
9.3 Extract Third-Party Product Updates (util SP 8) ......................................... 17
9.4 Install the Third-Party Products (util SP 9).................................................. 17
10 GUI COMPONENTS ......................................................................................... 18
10.1
GUI Distribution ...................................................................................... 18
APPENDIX ................................................................................................................. 21
4
1 The Aleph Service Pack
An Aleph 500 service pack is an update that includes all changes made since the last
Aleph version was made available. It includes bug fixes, refinements, and features,
and it is a combination of many individual fixes, thoroughly tested and delivered in a
coordinated way.
The Aleph Service Pack is based on the concept of “No Regression”. This means that
any change in functionality, which is not a pure bug, is optional, as it needs to be
configured in order to be in effect. In other words, if you install a service pack and
make no manual configuration changes, your system might not benefit from some
elements of the Service Pack, but it will not show any negative effect.
The service pack can be used to download or alter files in the customer’s libraries.
You may choose to change files by performing automatic steps, or change them
manually according to the Implementation Notes as it was done in previous versions
(see section 8 Running the Automatic Implementation Notes
(Util SP 5/7) ).
Minor releases are delivered via the standard Aleph Service Pack mechanism and
include both bug fixes and new development items. Upon installation of a minor
release (as opposed to a standard service pack), the customer’s configuration tables
and data is changed, in some cases, in order to upgrade to the new release.
The SP mechanism supports languages and formats which are integral parts of the
Aleph version. Therefore, files will be updated according to your set up.
The Service Pack installation as described in this document is currently available for
the Aleph 02 release.
Note:
Once you have installed the new Service Pack on the server, you must distribute at least the
executable (.exe) GUI files to all workstations. For further details see section 7 – GUI
Components and section 8 – GUI Distribution.
2 The Service Pack Level
The Service Pack level indicates the number of fixes made since the version was
made available. The Service Pack includes all these changes, but only installs the
fixes you do not have in your current level.
To view your current level, use the ver command from the command prompt. For
example:
il-aleph03-a20(4) >>ver
SUN_OS_2, il-aleph03, Aleph 21.0.1 (118) copy 1, 29-Jan-2012
Oracle 11r2
PDS version: 2.0.2.00006
5
In the example above:
21 - version
0 - mini release,
1 - service pack number
118 - last change number
The Aleph Release Notes are published on the Ex Libris Documentation Center as an
Excel spreadsheet (you can also examine known singular rep changes via the
knowledgebase of the CRM.)
The release notes contain the change number, problem description, solution, module,
Support Incident number, PC files, and the Implementation Notes themselves. The
naming convention of the Excel files is as follows:
ALEPH-<version number>-ServicePack-<Service Pack number>.xls.
For example:
ALEPH-21.0-ServicePack-1.xls
Implementation Notes provide the procedures that should be taken in order to effect a
certain change. These procedures are always optional as stated in the beginning of this
document. You do not need to perform them, or you can postpone them to a future
date. The Aleph Implementation Notes are included in the Aleph Release Notes as
described further on.
3 Pre-Installation Steps for the Aleph Service Pack
Do not start the installation process before making sure that there is sufficient disk
space available. Make sure that your free disk space is at least twice the size of the
sp.tar file (saved to $alephm_scratch/sp by default).
3.1 The Aleph Service Pack Excel Spreadsheet
To decide if you should download the service pack, review the changes that are
included in it before the installation. Check the knowledge base on the CRM or
log on to the Ex Libris Documentation Center and download the Excel
spreadsheet found at Download Center/Service Packs/21.x and examine the sheet:
This spreadsheet includes three sheets as follows:
 The first sheet is an introduction for the current service pack. It contains a
description of the important changes that were done in this service pack. PC
files that were modified and security items are also mentioned on this page.
6


The second sheet contains changes, description, and Implementation Notes
from the first rep change of the current service pack to the last rep change of
the current service pack.
The third sheet contains change description and Implementation Notes from
the first rep change of the version release to the last rep change of the current
service pack.
Note: Technical changes are not included in the reports. Therefore, there might be
gaps in the numbering of the displayed changes. For example, change number 115 is
not displayed due to a technical change.

There might be more sheets that contain specific guidelines for minor releases
or PDS changes.
7
When reviewing the implementation notes, make sure that the whole instruction is
displayed. In old versions of excel you must double click the cell in order to see it.
If you choose to run all of the automatic Implementation Notes (AIN), you may skip
the following instructions.
The Auto column stands for Automation. It is used to indicate if there is an Automatic
Implementation Note for this specific change. To have Aleph implement the
Implementation Note automatically, change the “Auto” column which is set to “No”
to “Yes” so this specific step could be run as will be described further on.
After selecting the relevant changes, save the Excel sheet as type “*.csv”:
The csv file should be sent via FTP to the server’s location /tmp.
The csv file can have any name and must end with the extension .csv.
If there is more than one csv files under /tmp the one with the latest date is taken. For
more information, see Running the Automatic Implementation Notes (Util SP 5/7).
Note: The delimiter for the csv file might change between different PCs, according to the
"List separator" settings in "Regional and Language options". The recommended delimiter is
a comma (,). It is also possible to use a semicolon (;).
4 The Service Pack Installation Utility
The Service Pack Utility (Util SP) is an interactive routine that downloads the latest
Service Pack from the Ex Libris FTP server to the customer’s machine and installs it.
A.
C.
D.
E.
F.
G.
Library Utilities
=================
File Administration and Building
Monitor Batch Jobs
Online Store/Restore Administration
Monitor Background Jobs
View Procedures and Files
Tables for Defining Database Structure
8
H. Library and Installation Report (Files, Tables and Definitions)
I. Formatting Data (PC, WWW, Reports)
J. Web and Server Configuration
K. ILL Tables
L. GUI Tables
M. GUI CATALOGING Tables
N. Z39.50 Management
O. ORACLE Management
P. Unicode Tables
Q. Data Loading, Import and Export Tables
R. Multimedia
S. Statistics
SP. Download and install the latest Aleph Service Pack
W. Server and Daemon Management (Monitor, Stop, Start, Log Files)
X. Clean Up
Y. Node Management
Through the util SP menus you can configure parameters to download the latest
available Service Pack, check the download, and receive an automatic e-mail
confirmation after the download is completed.
Depending on your system setup, the installation process may take a while.
In order to use the Service Pack management utility, log in to the Aleph application.
Make sure to log in to the appropriate slot.
Run:
>>dlib <library-name>
>>util
>>sp
Note that at any step of the menu stage you can select “Exit” or press Enter to return
to the previous menu.
The Service Pack Utility contains 10 options:
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]:
5 Preparing/Updating the Environment
SP.1. Environment Setting
-------------------------0. Exit Procedure
1. Customer details
2. FTP settings
3. SP Download directory
4. View Parameters
9
Please select [exit]:
Customer details (util SP 1/1)
This step configures and updates the following parameters used in later steps.
You are asked to enter values or confirm the default ones. Make sure to receive in
advance the relevant information from Ex Libris:



Your Ex Libris customer code
Your mail address
Language
These parameters are saved in case you want to use util_sp again at a later date.
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 Press
Note that after running util SP 1/1 the sp.config file is created under the $alephe_root
directory. This file should not be edited. If there is a need to modify the file such as
when there is a need to define special FTP conditions, consult the Ex Libris Office
before implementing the change.
FTP settings (util SP 1/2)
Select the FTP server for SP download:
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 [ver21_sp]:
FTP special options []:
10
*** for firewall connection problems try 'passive'
For details check the utility documentation
Configuration summary:
---------------------FTP server:
FTP user:
FTP options:
ftp.exl.de
ver2 1_sp
If you want to insert new FTP password please type it now
Or press ENTER to keep current password
Press <Enter> to continue
SP Download Directory (util SP 1/3)
It is possible to configure the SP Download directory. Enter the path for SP download.
View Parameters (util SP 1/4)
You may view the your defined settings
Configuration summary:
---------------------FTP server:
FTP user:
FTP options:
Language:
Service pack download dir:
Customer code:
Notification address:
ftp.exl.de
ver21_sp
english
/exlibris/aleph/a21_3/alephm/scratch/sp_118
972DAN
X.Y@exlibrisgroup.com
Press <Enter> to continue
6 Downloading and Installing the Service Pack
Downloading the Latest Service Pack (util SP 2)
This step runs the download according to the parameters defined in the previous step.
The latest available Service Pack is downloaded.
You receive an e-mail when the download is complete.
Dear Customer,
The ALEPH Service Pack download has been successfully
completed.
Service Pack 118.
il-aleph03 ALEPH 21 copy 9
You may continue with the SP installation steps
Checking the Service Pack Download Completion (util SP 3)
Check the integrity of the downloaded files and monitor the download progress by
performing util sp 3.
For example,
FTP still running
1 file(s) of total 5 completed (20 %)
press <Enter> to continue
11
At the end of the download process, a message is sent by the system. This message
reports if the process succeeded or failed. If it failed, the message specifies the reason.
Note:
If there is a delay between setting the service pack download steps and the actual
service pack installation, do not delete the SP download directory and do not
remove the service pack configuration file $alephe_root/sp.config.
Only edit this file with util SP.
Installing the Service pack (util SP 4)
This step runs the Service Pack installation. The latest Service Pack is installed.
Welcome to Service Pack 1-118 installation utility.
Your current Service Pack level is .
Options fast = N
initial = N.
0.
1.
2.
3.
4.
5.
6.
Exit Procedure
Install Service Pack 118
View Service Pack summary (Excel format)
View Service Pack summary (plain format)
View PC files involved
View optional implementation notes
Update Configuration
Before running this step, make sure that Apache is down and that
aleph_shutdown has been performed.
It is required for the first SP installation, to fill in several parameters regarding the
library set up.
This is essential for the SP mechanism (some of the SP utilities use the configuration;
e.g. AIN functionality).
If you have not yet filled in all required details, the following message is displayed:
Please select [0]: 1
Please set up the configuration first (menu item 6). Press any key
...
The set up configuration menu can be found under menu item 6:
Welcome to Service Pack 1-118 installation utility.
Your current Service Pack level is .
Options fast = N
initial = N.
0.
1.
2.
3.
4.
5.
6.
Exit Procedure
Install Service Pack 67
View Service Pack summary (Excel format)
View Service Pack summary (plain format)
View PC files involved
View optional implementation notes
Update Configuration
The following menu is displayed:
12
Define configuration parameters
------------------------------0. Exit
1. View Current Parameters
2. Update Parameters
Please select [0]:
It is possible to view the set up or to update it.
When choosing to update the parameters you will be asked to fill in:



Libraries definition – Specify the customer libraries in the u-tree (types ADM,
BIB, USR etc.). It is possible to set up the list of libraries to be handled by the
"Automatic Implementation Notes" mechanism. You can edit the space-delimited
list with the "vi" editor instead of editing it manually.
Notification e-mail addresses definition – Where to send log files or error
messages.
Languages definition – Specify the code of the languages used on the server language files (.lng) and language directories (_lng).
You may return and update the configuration whenever it is required by performing
util SP 5/8.
7 Run Service Pack Utility (util SP 5 /2 - 5/6 and 5/9)
This step runs the sp.utility routine which enables the following:
Welcome to Service Pack utility.
Your current Service Pack level is 118.
0.
2.
3.
4.
5.
6.
7.
8.
9.
Exit Procedure
View Service Pack summary (Excel format)
View Service Pack summary (Plain format)
View PC files involved
View optional implementation notes
View installation log
Run Automatic Implementation Notes
Update Configuration
Uninstall Service Pack 3556
When choosing one of the reporting options (menu options 2, 3, 4, and 5), the
following menu appears:
View Service Pack summary (Plain format)
0. Exit Procedure
1. Create report for levels 1-320
2. Create report for this Service Pack (118 - 320)
Please select [0]:
To create a report for the entire Service Pack, select option 1.
13
To create a report of the fixes of the recent Service Pack only, select option 2. While
Plain Format, PC Files, and Implementation Notes Reports can be viewed on the
server, the Excel report produced should be sent via FTP to the PC. The Excel sheet is
created on the server in the directory $aleph_dev/service_pack/[nnnn-yyyy]
where nnnn and yyyy are the range of rep changes in the service pack. It is
recommended to view the Implementation Notes in the documentation center.
Alternatively, you can view the changes in the CRM knowledgebase.
Service Pack Summary (Plain Format and Excel Format)
This report creates a text file with a description of the corrections.
PC Files Involved
This report shows all GUI files that are involved. They are classified under two
categories:
 Executable files (To be distributed)
 Configuration files (Not to be distributed)
For more information, see the section on GUI components below.
View Optional Implementation Notes
As stated above, the optional Implementation Notes contain instructions for the
actions required for some of the corrections. The report contains only those changes
that have Implementation Notes.
The service pack utility also includes an Uninstall option (util SP 5/9). This option
restores the system to its configuration prior to the installation of the Service Pack.
After a Service Pack is uninstalled, the installation log is saved under directory
$aleph_dev/service_pack/[nnnn-yyyy] where nnnn and yyyy are the range of rep
changes in the service pack.
14
8 Running the Automatic Implementation Notes
(Util SP 5/7)
Most of the Implementation Notes (which provide the procedures that should be taken
in order to effect a certain change) have automatic steps. This Utility runs those steps.
Welcome to the AIN (Automatic Implementation Notes) main menu
You may choose to run all imp. notes since rep_change 118 or only
selected steps.
0. Exit
2. Run ALL Implementation Notes
3. Run Selected Implementation Notes (as marked
Sheet)
4. Run Implementation Notes for a single rep_change
5. Rollback previous AIN changes
Please select [0]:
in
the
Excel
Note that not all Implementation Notes have AIN steps. Review the Excel sheet and
implement the changes manually.
8.1 Running All Implementation Notes (util SP 5/7/2)
This option relates to all rep_changes where the IN Automation field is set to Y only
in the “customer’s increment”. For example, if the customer was in Service Pack level
#50 before installing Service Pack #100, this option considers only rep_changes #51 #100.
8.2 Running Selected Implementation Notes (util SP 5/7/3)
The Excel sheet for selecting what Implementation Notes to run is created by util SP
5/2 (see Service Pack Summary (Plain Format and Excel Format)). Alternatively, you
can use the second sheet of the aleph service pack Excel spreadsheet.
Change “No” to “Yes” in the Auto column for the Implementation Notes you want to
have implemented automatically. Only the Implementation Notes with “No” in
“Auto” column are relevant.
After selecting the relevant changes, save the Excel sheet in csv format. For more
information, see The Aleph Service Pack Excel spreadsheet section.
The selected Implementation Notes from the Excel sheet (in “csv”) should be sent via
FTP to the server under /tmp.
The filename is not important. The last updated file in the /tmp directory with the .csv
extension is taken.
8.3 Running AIN for a Single rep_change (Util SP 5/7/4)
The user provides a single rep_change number with which to perform AIN. This
number has to be within the customer’s Service Pack increment.
15
Whenever an AIN is executed for a single rep_change, selected rep_changes or ALL
rep_changes, a summary report e-mail is sent:
Some steps might fail due to configuration changes in the files involved. If this
happens, manually implement the changes.
8.4 Rolling Back Previous AIN changes ( Util SP 5/7/5)
When an AIN is executed, the state before execution is preserved, such as backup of
u-tree configuration files. At the same time, a rollback script is prepared, containing
the necessary actions to reverse any changes done by the AIN mechanism. The
rollback action covers all AINs performed before its activation – be it a single
rep_change, selected ones, or ALL.
Note:
The AIN log directory is located under the Automatic Implementation Notes (AIN)
directory. For example:
/exlibris/aleph/a20_1/service_pack/3557-3632/ain/logs/
This directory contains information about the changes that were implemented by the
AIN that are included in the summary report e-mail that is sent after AIN
implementation.
8.5 Updating Configuration (Util SP 5/8)
This step configures and updates the parameters used in the AIN.
You are asked to enter the values or confirm the default ones for the following
parameters. Make sure to receive in advance the relevant information from Ex Libris:

Libraries to be handled for AIN
16


Your email address - for notification about AIN implementation
Languages for implementing AIN
These parameters are saved in case you want to use util_sp again at a later date.
Note:
When updating the Libraries to be handled parameter with option E – edit the list
using VI – use the following format:
setenv uk_libraries "loc10 tst01 tst10 tst40 tst50 tst60"
Do not remove the text setenv uk_libraries. Enter the space delimited list of
libraries within the quotation marks.
9 Downloading and Installing Third-Party Product
Updates
9.1 Download the Third-Party Product Updates (util SP 6)
This step runs the download according to the version of Aleph and the operating
system that you are using. The latest available package is downloaded.
Select option 6 in the main util_sp menu to start the download. You are asked if you
want to change the default ftp directory:
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
Select option 7 from the main util_sp menu to see the download progress log. Press :q
to quit the log.
9.2 Check OS Requirements for Third-Party Product Updates
(util SP 10)
Step 10 checks for the existence of all operating system packages necessary for the
normal functioning of updated third-party products. This check can only run after the
download is completed. It is recommended to run this step before installing the thirdparty products.
If some OS packages are missing, request from your local IT staff to install them.
9.3 Extract Third-Party Product Updates (util SP 8)
Select option 8 from the main util_sp menu to extract the downloaded products. All
products are installed in the /exlibris/ftp_from_exlibris directory.
9.4 Install the Third-Party Products (util SP 9)
This step moves the soft links from the previously existing third-party products to the
newly installed products.
17
Before running this step, make sure that Apache is down and that
aleph_shutdown has been performed.
Select option 9 in the main util_SP menu to complete the installation of the
downloaded products. Start up Apache and the application.
10 GUI Components
All PC-related files are downloaded under the server-side ./aleph/pc_exe directory.
Usually, there are three files in the pc_exe directory:



- GUI installation package
net500.exe - Network GUI installation package
off500.exe - Offline Circulation module
gui500.exe
When a Service Pack is installed, these three files are replaced and the old files are
backed up with an sp.NN extension.
In addition, individual GUI files are downloaded to two directories:


./aleph/pc_exe/sp_exe
./aleph/pc_exe/sp_conf
GUI files that have changed are placed under these directories with a full path, for
example, ./aleph/pc_exe/sp_exe/catalog/bin/catalog.exe . Executable files
are placed under the sp_exe directory and configuration files are placed under the
sp_conf directory.
If the file already exists from previous Service Pack installations, it is backed up with
an sp.NN extension.
Note than once you have installed the new Service Pack on the server, it is highly
recommended to distribute at least the executable (.exe) GUI files to all workstations.
10.1 GUI Distribution
The easiest way to distribute the changed GUI executable files is to use Version
Control. In this case, make sure that the definition in alephcom.ini is set up as
follows:
[VersionControl]
Type=sp_exe
VersionCheck
Version Check is a tool used to distribute GUI client files from a central server to an
individual workstation. Integrated inside all GUI modules, it automatically informs
you about the latest updates and replaces the older files with the new ones at your
request.
There are two ways of accessing Version Check:
18


Automatically: The Aleph version check message appears once a day when
starting the first Aleph application.
Manually: From the update version window located under the Aleph menu.
Type=sp_conf
SP_conf can be used whether the GUI Configuration such as *.dat and *.ini files were
changed or not by the customer.
The mechanism of the version check merges the updated file with the customer’s file.
The Version check for updating configuration files works as follows:
1. Inserts new lines.
2. Updates lines but does not alter the strings that were changed by customers.
3. Deletes lines that are not relevant.
For more information regarding the Version Check, refer to the Aleph 21 Staff User’s
Guide - General.
Note : It is possible to override existing configuration files with the service pack files,
by placing the files in the $aleph_dev/aleph/pc_exe/local_conf directory. After setting
the Version Check Type to local_conf, and clicking Update All or Update, the target
files are overridden with the server side files.
[VersionControl]
RunAtStartup= Y/N
The RunAtStartup parameter controls whether the version control check is run once a
day when opening the first Aleph application. Selecting the Run Version at Startup
option in the Update Version window automatically sets this value to Y. Clearing the
Run Version at Startup option in the Update Version window automatically sets this
value to N.
In order to distribute customized library-specific GUI configuration files such as
circ.ini or print.ini via the Version Check (this may be necessary when there are
multiple groups of librarians each using unique setup files), refer to Appendix .
Clicking Help > About in the GUI displays the GUI and server version that you are
using.
19
After installing the service pack, it is recommended to examine, the Help/About
dialog box. The information provided there indicates whether the GUI and server are
synchronized, meaning that they both have the same service pack number.
20
Appendix
GUI Distribution
After the installation of the service pack, the update of the GUI PC files from the
server works as follows:
The service pack places new PC files on the server under the directory:
$aleph_dev/aleph/pc_exe . The executable files are under
$aleph_dev/aleph/pc_exe/sp_exe, while the configuration files are under
$aleph_dev/aleph/pc_exe/sp_conf . The entire GUI tree, as it appears on the PC,
exists under each of the above directories.
For example, if a new catalog.exe file is included in the service pack then it is placed
on the server as follows:
$aleph_dev/aleph/pc_exe/sp_exe/catalog/bin/catalog.exe
Similarly, if a new print.ini file for the acquisitions module is included in the service
pack then it is placed on the server as follows:
$aleph_dev/aleph/pc_exe/sp_conf/acq/tab/print.ini
Version Check works as follows:
If the user has the following in file AL500/alephcom/tab/alephcom.ini:
[VersionControl]
Library=ABC01
Type=sp_exe
and Version Check is run, files are taken from the server under directory
$aleph_dev/aleph/pc_exe/sp_exe/
The files come from whichever server is defined in
AL500/alephcom/tab/library.ini for library ABC01
Likewise, if the user has the following in file AL500/alephcom/tab/alephcom.ini :
[VersionControl]
Library=DEF01
Type=sp_conf
and version control is run, then files are taken from the server under directory
$aleph_dev/aleph/pc_exe/sp_conf/
The files come from whichever server is defined in AL500/alephcom/tab/library.ini
for library DEF01
In most cases, the Library parameter is the name of the bibliographic library. In
cases where service pack is installed first on a test server and later on the production
21
server, note that the new PC files come to the PC only if the library.ini includes
the IP of the server on which the service pack is installed.
Version control, as described above, automatically downloads the files from the
server to the PC and in doing so overwrites existing files on the PC excluding *.dat
files and *.ini files which are automatically synchronized as described above. It is
possible, but not necessary, to do as follows in order to be sure that only certain
configuration files are downloaded to PC. Usually this is performed by the systems
librarian.
1. Create directory on server such as $aleph_dev/aleph/pc_exe/sp_final/
2. Copy executable files from sp_exe to sp_final
3. Edit (if desired) configuration files on server under sp_conf and copy to
sp_final
4. Users have the following defined in alephcom.ini
[VersionControl]
Type=sp_final
In this case the following are updated to the PC:


All executable files.
Only configuration which have been edited by or approved by the systems
librarian.
If the systems librarian first edits the file and then decides which files to copy to
sp_final, then only certain files, some possibly edited, arrive at the PC.
In addition, it is possible to accept or reject executable and configuration files when
version check is run. For example, if catalog.ini and acq/tab/print.ini are
updated in the service pack and the user does version check, then the following screen
appears.
22
The two files which the service pack updated and the systems librarian copied to
sp_final appear above. The default Type above is sp_final because this is what is
defined in alephcom.ini. It may be changed on the fly by clicking the Change Type
button. It is possible to choose to update only one of these files by clicking the
Advance button. After clicking the Advance button the following screen appears:
From this dialog box, you can choose just one file and then click Update. In the
above case, Catalog.exe is updated to the PC but print.ini is not. This is because
the user has selected Catalog.exe and not print.ini.
Additional information on the version check is available in the Aleph 21 Staff User’s
Guide - General.
23