EsiObjects Files

EsiObjects V4.2.1.0  for GT.M-I86-Linux 
Release Notes
October 21, 2009

LICENSE
Please read the 'License' file before proceeding. The EsiObjects Public License (EOPL) license is based on the Mozilla Public License (MPL). The 'License Explained' file describes the license.

KIT CONTENTS
The GT.M-I86-Linux Server kit consists of a .tar file containing the following files:

1. The esiobjects.tar.gz file contains all files and directories of the EsiObjects system.
2. Installation files.
3. The readme_GTM_Linux files.
4. License file contains the actual EOPL license.
5. License Explained file contains a short description of what the License means.

The base kit is approximately 7.6 megabytes in size. 

To install EsiObjects you will need at least 75 megabytes of space.

The total space used by an EsiObjects installation is 70 megabytes.

NEW FEATURES

This release contains the following enhancements and changes:

1. New Install and uninstall scripts that replace the old setup and upgrade scripts that were Red Hat specific. The new install and uninstall are generic and should work on all Linux implementations.
2. Bug fixes.
3. Enhanced ESI$IndextedTable class.
4. Session connections will now be created via the xinetd service. The old EsiObjects session management will not be used. 
5. All new functions, commands and special variables added to the compile table for GT.M

DESCRIPTION
This set of release notes documents installation of the runtime support for EsiObjects v4.2 on a GT.M-I86-Linux server.  The runtime support consists of one GT.M database.
As of this release, the GT.M database server running on Linux is the only platform supported. The EsiObjects client runs on Windows Vista and Windows XP. The EsiObjects IDE is Windows based should be run on a Linux box using VMWare.

REQUIREMENTS
A GT.M-I86-Linux database server for EsiObjects V4.2 must run on GT.M-I86-Linux V5 or newer.
Disk space required:  70 MB for installation of the GT.M-I86-Linux runtime support databases. Expansion space will depend on what data is added to the database.

LOCATING AND DOWNLOADING THE KIT
EsiObjects V4.2 consists of a client side and a server side kit. It is assumed that you have access to the kits if you are reading this. Read the two Documents on SourceForge (Docs) that explains how to locate and download the kits.

INSTALLATION
The following Client and Server sections describe the client and server installations.

Note: Make sure your current system is backed up before doing these installations!

CLIENT SIDE
The EsiObjects client must be installed on a Windows Vista or XP system. To install the client, download the eo_client_kit_4_2_0_0.zip . Unzip the kit into a work directory. Execute the Setup.exe file. Follow the installation wizards instructions. Note that the EsiObjects icon will be placed on your desktop.

SERVER SIDE

DIRECTORY STRUCTURE
Installation of EsiObjects is now LANANA (http://www.lanana.org) compliant. The package name is 'esiobjects'

The following lists the directory structure of esiobjects.

/opt/lsb-esiobjects/user/data - the user.dat file. This file contains all user globals.
/opt/lsb-esiobjects/user/source - all user routine .m and .o files.
/opt/lsb-esiobjects/<version> - all esiobjects scripts, license and readme files. <version> is in the format: VMajor_Minor_Release_Build. For example: V4.2.1.0.
/opt/lsb-esiobjects/<version>/data - the global directory (esiobjects.gld) and the EsiObjects globals file (esi.dat)
/opt/lsb-esiobjects/<version>/scripts - all original scripts for easy reference.
/opt/lsb-esiobjects/<version>/source - all EsiObjects .m and .o routines.

All user data is outside the EsiObjects specific directory structure.

INSTALLATION INSTRUCTIONS
To install or upgrade the server side, download the eo_server_gtm_4_2_1_0.tar server kit and follow the instructions listed below. 

1. Unpack the basic kit using tar: 
	   tar -xvf eo_server_gtm_4_2_1_0.tar
2. If you are not logged in as super user, use the "sudo" command to become the super user.
3. Now run the install script file:
   	bash install
4. First the install script will check for the installation of GT.M. Note that it checks the /usr/local/gtm directory. If it does not fine GT.M installed in that directory, it will ask if you have installed it. If you did not, it will tell you to install GT.M and quit. It is an EsiObjects requirement. If you did install it, it will ask for the directory path and continue with the installation.
5. Additionally, the script makes sure the xinetd service is installed and executable. If it is not, execution will halt and you will have to install the xinetd service and make it executable.
6. Now, the install script determines whether your are installing for the first time or doing an upgrade. 
	* If it is a new install, all directories and files will be loaded and initialized.
	* If it is an upgrade, specific files will be loaded and initialized. Files usr/local/data/user.dat, usr/local/data/esiobjects.gld and usr/local/user/* will not be modified or lost. However, scripts and configuration files will change.
8. Once the install has completed, sign off and back on again. Doing this will active EsiObjects.

Note: The /usr/local/esiobjects/user directory is empty for a first time installation of EsiObjects. This is where all the generated routines for user written libraries is stored. It will not be touched on an upgrade.

STARTING THE PORT SERVICE

EsiObjects sessions (port service) is controlled by the Linux xinetd service.

The xinetd service, (eXtended InterNET Daemon), is an open-source daemon which runs on many Linux and Unix systems and manages Internet-based connectivity.

The xinetd script resides in the /etc/init.d directory. When run it acivates the esiobject service. The EsiObjects service is dependent upon 3 files:

	* /etc/xinetd.conf - The default configuration file. Normally this file is left alone. This configuration file is common to all services.
	* /etc/xinetd.d/esiobjects - The specific EsiObjects configuration file. This file contains the basic configuration needed by EsiObjects to run the port service.
	* /usr/local/xinetd_startup - This file contains the specific startup script for the EsiObjects Port Service.

Read man pages of xinetd.conf and xinetd for more information.

To manually start the EsiObjects connection service, follow the instructions below:

1. If not already super user, use the "sudo" command to become the super user.
2. Use the xinetd command below to start the service:

	 /etc/init.d/xinetd restart
	 
3. This command will first stop the service and then start it. It will activate the TCP listener on the port specified in the /etc/xinetd.d/esiojbects file. By default the listener is on port 9000. You can change this by editing the file:
4. To stop the listener, enter:

	/etc/init.d/xinetd stop
	
5. If the service is stopped, enter this command to start it:

	 /etc/init.d/xinetd start
	 
6. To determine whether the service is running, enter this command:

	 /etc/init.d/xinetd status
	 
To automatically start the xinetd service at boot time, create a logical link to the /etc/init.d/xinetd file within the approprioate /etc/rc*.d directory (where * is 0 - 6 or S).

To check the log file after starting the server, enter the following command as root:

tail -f /var/log/daemon.log

DIRECT PROGRAMMING MODE

To enter direct programming mode, enter the following commands:

cd /opt/lsb-esiobjects/V4.2.1.0/esiobjects
esiobjects -di

To avoid changing to the /usr/local/esiobjects directory, you can create an alias:

alias esiobjects=/opt/lsb-esiobjects/V4.2.1.0/esiobjects

KNOWN PROBLEMS

None