Sablime® Installation Guide

Sablime® version 6.0u3
August 2004

What This Guide Covers

This guide provides information and instructions for downloading and installing Sablime® version 6.0, update 3.  These same basic instructions are included on the Sablime® download pages as README.download.

Instructions are included for all installers of Sablime®, whether upgrading from earlier versions or for first time installations.

Package Description

Sablime® is packaged as a compressed "tar" file.  "Tar" is a Unix/Linux utility that packages multiple files into one.  This file is then compressed using the Unix/Linux "compress" utility.

There are different packages for each "architecture"   We use "architecture" to mean the hardware type and Operating System of the Sablime® host.   "sparc5", for example, is the architecture designation for a Sun Microsystems machine running the "sparc" processor with Solaris 2.4 or above as the Operating System.

For each Sablime® release, there are two versions of the download "tar" file.  One is the "full" release for first time installations or for users upgrading from v6.0 or earlier, and the other is the "update" release.  The "update" release is for those users upgrading from v6.0u1 or v6.0u2 to v6.0u3.

A license file is required in order to run most Sablime® commands.  This package contains the Sablime® software, but it does not contain the license file.  To acquire a license to use Sablime®, contact the business office at software@lucent.com.

Download

Download either the full (sab60u3_<architecture>_full.tar.Z) or the update (sab60u1u2_<architecture>_update.tar.Z) file.  If your browser renames the file (changing the first "." to a "_"), rename it back to its original name before continuing.

You should also download the accompanying README.download file for future reference.  That file is a plain text version of these instructions.  The "patchlevel" and "whatoutput" are each included within the "tar" file, so you do not need to download them separately.  They are on the web site for reference purposes.

If you are upgrading from v6.0u1 or v6.0u2 to v6.0u3, download the update script "update_sab60u1u2_u3" also.

If you did not download there directly, move or copy the file(s) over to the Unix/Linux Sablime® host machine.

Installation Instructions - Full Installation

This set of instructions is for first time installations or for upgrades from Sablime® v6.0 or earlier.  If you are upgrading from v6.0u1 or v6.0u2 to v6.0u3, skip to the section entitled "Installation Instructions - Update Installation".

Note: The following operations should be done while logged into the Sablime® host machine as the user ID that will own the Sablime® binaries and databases at run time. Please log in as this user instead of using "su".  This user (usually "sablime") should NOT be the "root" user.

The installation instructions and - in particular - the Sablime® software are intended for use with the Korn shell (ksh).

Note for Linux users:  The shell variables SHELL and EXECSHELL must both be set to the location of ksh (normally /bin/ksh) and exported.  The variable PWD must also be exported (pdksh does not export PWD by default). 

1)  Set your "umask" (controls file permissions)

$ umask   022

2) Create a directory on the host machine to be the location of the Sablime® binaries (e.g.: /usr/sablime/bin) and move the downloaded file to that directory.

We'll call the directory SABHOME. When the instructions specify SABHOME, you should enter that full path, for example /usr/sablime/bin.

$ mkdir   SABHOME        # for example mkdir /usr/sablime/bin
$ mv   sab60u3_<architecture>_full.tar.Z   SABHOME

3) Put that directory in your $PATH.

$ cd   SABHOME
$ PATH=$PWD:$PATH

4) Uncompress and unpack the tar file.

$ zcat   sab60u3_<architecture>_full.tar.Z   |   tar  xvof   -

Note: This is a UNIX "compress" file, not a PC "zip" file.  Do not use PC tools to uncompress it.

5) If you want to acquire an evaluation license for Sablime, run the admin_license script to generate the request form. Then fill in the blanks, and send the form (request.txt) to the business office at sablime@lucent.com:

        $ ksh SABHOME/admin_license

Once you have obtained a Sablime® license, copy the license file to SABHOME/.usrid. 
If you already had a Sablime® license, you'll need to copy it to the new installation.

$ cp    <license_file>    SABHOME/.usrid

6) To verify that you have retrieved the correct commands use the "dbhash" command.

      $ dbhash   sablime
      nn <-- sablime

7) If the previous command terminated properly, you can now clean up:

      $ rm   sab60u3_<architecture>_full.tar.Z

8) To assure the permissions of your Sablime® commands are correct, you need to run the "setperm" command from the Sablime® bin directory.

      $ sabLCB=""   sabVAR=""   sabVER=""  setperm
      Please enter the complete path to Sablime® binaries (sabLCB): SABHOME
      Enter the Sablime® version [5.0/5.1/5.2/6.0]: 6.0

Note: the sabLCB, sabVAR, sabVER part is only necessary if you already have a Sablime® environment.  If this is a first time installation, or if you are otherwise sure that you don't have a Sablime® environment established already, you can just type "setperm". 

9) If this is a first time installation of Sablime®, you are now ready to run "initsab" to complete the initial install (see the Sablime® Administrator's Guide at the Sablime® web site).

If this is an upgrade from v5.x, you are now ready to run "sab6.0conv" to do the Sablime® database conversion.

If you are upgrading from Sablime® v6.0, you do not need to run either of the above.  You just need to replace your existing Sablime® bin with the updated bin.  Assuming you wish to keep the same directory name for the updated Sablime® bin, you should rename your previous $sabLCB, and then move or copy SABHOME to replace it.  For example:

      $ mv   $sabLCB    $sabLCB.old # Assumes $sabLCB is set to previous Sablime® bin
      $ mv   SABHOME   $sabLCB     # Could use "cp" instead of "mv"

If you had any triggers stored under $sabLCB/hooks, you should copy them over to the new Sablime® bin.

Eventually, when you are satisfied that the new installation is running properly, you can remove the $sabLCB.old directory.

10) Lastly, you need to follow the Web Sablime® installation instructions to install or upgrade your Web Sablime® instance to v6.0, Update 3.


Installation Instructions - Update Installation

This set of instructions is for upgrades from Sablime® v6.0u1 or v6.0u2 to v6.0u3 (i.e. update 1 or update 2 to update 3).  First time installations or upgrades from Sablime® v6.0 or earlier should skip to the earlier section entitled "Installation Instructions - Full Installation".

These installation instructions and - in particular - the Sablime® software are intended for use with the Korn shell (ksh).

Note for Linux users:  The shell variables SHELL and EXECSHELL must both be set to the location of ksh (normally /bin/ksh) and exported.  The variable PWD must also be exported (pdksh does not export PWD by default).

Note: The following operations should be done while logged into the Sablime® host machine as the user ID that owns the Sablime® binaries and databases. Please log in as this user instead of using "su".  This user (usually "sablime") should NOT be the "root" user.

1) Verify that the update file ("sab60u3_<architecture>_update.tar.Z") and the update script ("update_sab60u1u2_u3") are present in the current directory.
$ ls   sab60u3*.Z   update*u3
sab60u3_<architecture>_update.tar.Z
update_sab60u1u2_u3

2)  Run your Sablime® setup script for a generic in the v6.0u1/u2 instance you wish to update.
$ .  sablime  <your_generic>

(...Normal Sablime® setup output....)

3)  Make sure a copy of perl (version 5.004_01 or later) is in your  $PATH.
$ perl  -v  

This is perl,  version 5.004_01

...etc...

4)  Run the update script
$  ksh  ./update_sab60u1u2_u3

(The script will display the location of your current Sablime® bin and its current version.  If the version is 6.0u1/u2, the script will ask if you want to proceed.  If so, answer "y" or "yes". )
The script should finish in less than a minute, and wil say "Update complete" after a successful update.

5) Remove the download file and the update script (if desired).
$ rm sab60u3_<architecture>_update.tar.Z   update_sab60u1u2_u3

6) Optional: Remove the working files and backup files.
The update script makes a directory and stores working files there.  Among them is a full "tar" backup of all the files that it replaced or removed  Once you are satisfied that the update is performing properly, you can remove the directory and its contents.

$ cd $sabLCB
$ rm -fr v60u3_update
It is harmless (other than the disk space usage) to keep the directory around indefinitely.

Note: If you experience any difficulties in following these instructions or if the installation process does not seem to be going properly, please feel free to contact the Sablime® helpdesk at sablime@lucent.com

Thanks for using Sablime® !