Table of contents

• Overview
• Prerequisite
• Privilege required
• Running the installation program
• Running installed program
• Data input windows
• Uninstall
• Tested platforms
• Known Issues
• Notes for some servers
• Universal
• WebSphere

Advanced topics

• Set your client environment
• Deploy Example EJBs
• Install, run and uninstall demo database
• Use other database as demo database
• Install License
• Command line install
• Common installation errors

Acelet-Scheduler comes with a GUI installation program, the installer. The installer is written entirely in Java. It is operating system neutral. It is an interactive program which guides the installation process.

The installer is user friendly:

• Nothing will go wrong: the choices are very simple. The installer will validate your choices. See Data input windows for examples of screenshots.
• No mess to clean up: if, by any chance, the installation procedure is interrupted, all you need is to re-install.

• Nothing to prepare.

You can get context sensitive help in the installer by pressing the F1 key. F1 shows context sensitive help about the GUI object that currently has focus. If there is no GUI component on focus, try to click on a focusable GUI component.

Prerequisite

Hardware

The requirement for hardware is very low. The smallest hardware configurations tested are: 

• PC with Pentium 233 M CPU, 96 M memory. 
• Sun Ultra 10 with one 450 M CPU, 128 M memory.

These are minimum requirement. You probably need better hardware. 

If you want to run your J2EE application server and Acelet-Scheduler on the same machine, you need bigger hardware configuration. A PC with 500 M CPU and 512 M memory is good enough for evaluation cases.

Disk space requirement is low: Client side is about 10M.

Software

General

JDK (Java) must be installed and ready to run.

We do not support Exceed or Cygwin. If you run installation on Unix environment, please do it on a native Unix machine. You do not really need Exceed/Cygwin: 

• If you directly working on that Unix machine, you do not need Exceed.
• If you access that Unix machine remotely, you can use Command line install.  
• If you access that Unix machine remotely, you can install Acelet-Scheduler on your local machine, either Windows or Unix machine. The Operating System on the client machine does not have to be the same as the one on the serer machine.
• If you install Acelet-Scheduler on a Windows machine, you do not need Exceed.

We encountered core dump when we used Exceed (7.0) with JDK 1.2. It seems okay when we use JDK 1.3 from Sun. Some users have reported problems using IBM JDK 1.4. You can try Exceed, but if you have problem, please go to a native Unix machine instead.

If you want to work with a J2EE server

The prerequisite is automatically satisfied if your J2EE server is installed and ready to run on the computer.

1. The version of JDK must be compatible with the JDK which runs the server. Your application server may have special requirement about the JDK version, for example, WebSphere require IBM's Java. Please consult your application server manual. 

2. A copy of your J2EE server must be available on the computer. Acelet-Scheduler will access some library jar files (client jar). The local installation of your J2EE server does not have to be a complete one. But these client jar files must be on the original directory structure, otherwise Acelet-Scheduler can not find those jar files.  We believe that most of J2EE vendors allow you to use these jar files on client side without charging extra license fee. If you really want to know the names of the client jars, see setEnvironment.bat or setEnvironment.sh under <Acelet-Scheduler Home> (default is acelet-scheduler). 

Important: some modules of Acelet-Scheduler uses IIOP/RMI protocol to talk to your J2EE server. So the protocol and related port must be enabled. This should be the default setting, you do not need to do anything, but do not disable them explicitly.

Privilege required

Sufficient privilege is required for installation and execution.

General

You need write privilege for the installed directory and sub directories.

For execution: You need write privilege for installed directory (default is acelet-scheduler) and sub directories.

If you want to work with a J2EE server

You need read and execution privileges for server home and sub directories. You do not need write privilege for server home or other directories on your file system. You need sufficient privileges for your application server when you access your application server, such as look up JNDI names, deploy, shutdown server. You can easily setup well, so you can use Acelet-Scheduler as a regular user of your operating system.

Running the installation program

The installation process takes about 30 seconds.

This document assumes that <Acelet-Scheduler Home> (the default installation home directory) is acelet-scheduler.  It could be /usr/local/acelet-scheduler or c:\acelet-scheduler.

Do not install on top of a previously installed directory.

1. Extract software package
If you get the software from our web site, it is a zip file. The file name is either Acelet-Scheduler-eexxx.zip (xxx is a three digit string indicating the version number of Acelet-Scheduler-ee). For example acelet-scheduler-ee700.zip

Extract it to a temporary directory using either of the following:

  > jar xf acelet-scheduler-eexxx.zip
  > unzip acelet-scheduler-eexxx.zip

2. Run GUI installer:

    > install  (for Windows)
    $ . ./install.sh  (for Unix)
 

Follow the instructions to install. If you have any questions, please press F1 key for help. The GUI installer is written in Java (Swing). It is operating system neutral.
 

For upgrade from earlier versions: 

• Please install Acelet-Scheduler on a new directory. Do not install over an old installation.

Running installed program

As the installed instructs you:

Go to <Acelet-Scheduler Home> (the installed directory, default acelet-scheduler) and run:

> as.bat  (Windows)

or

$ sh as.sh   (Unix)

Or click the installed shortcut (desktop icon) to start Acelet-Scheduler.

Data input windows

The followings are example windows during installation. There is a data input window and two confirm windows.

Uninstall

You can the following program to uninstall:

uninstall.bat (Windows)

uninstall.sh (Unix)
 

under <Acelet-Scheduler Home> (the installed directory, default is acelet-scheduler). 

If shortcuts are installed (for Windows), you can launch uninstall program from the shortcut as well.
 

Manually uninstall

If you accidentally uninstalled or deleted the client first and no uninstaller to run. Or you prefer to uninstall manually, please do the following (the order is not important):

1. Uninstall EJBs:

Use the admin console of your J2EE server to undeploy the following EJBs:

For Weblogic: weblogicCasinoExample.

For Websphere: websphereCasinoExample.

2. Uninstall client: 

Delete the directory of <Acelet-Scheduler Home> (default is acelet-scheduler) and all sub-directories. If the demo database is running, you need to shutdown the database first.

3. Remove shortcut menu:

If you installed shortcut, right click them and delete them.

Note: If you do not uninstall any of them, there will be no harm for your system: they take relatively small amount of disk space. If you do not call, they just stay there doing nothing.

Tested platforms

Acelet-Scheduler is written entirely in Java. It runs on any platform which supports Java.

Tested platforms are:

• IBM hardware System I RedHat 4.
• IBM hardware pSeries  AIX 3 5.
• IBM hardware pSeries  RedHat 4.
• IBM hardware xSeries  RedHat 4.
• IBM hardware xSeries  Windows 2003.
• IBM hardware zSeries (mainframe S390)   RedHat 4.
• Linux: RedHat 7.3, server 3.
• Linux: SUSE 8 (kernel  2.4.19-4GB) (IBM xSeries).
• Solaris 7, 8, 9 and 10 (Sparc).
• Windows 2000, XP.

Notes for some servers

Here is some installation related information. Please see Known Issues. for related information.

Universal

The Universal is for any Webservice server, including J2EE server as Webservice server, any Web servers. Or, no server at all. No server log in is required. WSDL and/or URL is required at the time you call them. 
 

WebSphere

WebSphere 5

WebSphere 5.0.1 - 5.1 are supported, not 5.0.

Most of jar files under lib directory of WebSphere 5 on Linux are not readable by other users. You need either change the attributes of those files or install Acelet-Scheduler as a user who has enough privileges.

Set your client environment

This is an advanced topic.

The following files are created by the installation program for setting your environment variables on the client side:
    setEnvironment.bat   (for Windows)
    setEnvironment.sh     (for Unix)

Those files are on Acelet-Scheduler Home (the installed directory).

You need to set additional CLASSPATH to point your EJB's stubs for EasyEJB and related programs. See EJB stubs are needed.

Deploy Example EJBs

This is an advanced topic.

The Simple install is for evaluation. The deployment of example EJB is the second phase of installation. When you run Acelet-Scheduler for the first time, the example EJB will be deployed by Acelet-Scheduler. It is:

    <your-server-name>CasinoExample.jar

For example, for Weblogic 8.1 it is:
    weblogicCasinoExample.jar

It comes with embedded SuperLoggingLibrary and SuperLoggingEJB.

Install, run and uninstall demo database

This is an advanced topic.

The Simple install option of the installer installs a local database as part of the installation on sub-directory database of Acelet-Scheduler Home (default is acelet-scheduler), as the demo database. The demo database is  open source Java database Hypersonic SQL.

The demo database is for many components, such as, SuperEnvironment, SuperScheduler and SuperWatchdog. It is for evaluation and demo only. 

For production use, you can replace it with your favorite database in your network.

Run the demo database

When Acelet-Scheduler starts, it starts the local database (the demo one, if it exists). When Acelet-Scheduler is terminated, the local database will not be shutdown by Acelet-Scheduler automatically.

Stop the demo database

Run stopDatabase.bat (for Windows) or stopDatabase.sh (for Unix) under database directory.

Uninstall the demo database

Run uninstall program either:

• Run uninstall from installed shortcut.
• Run uninstall.bat (for Windows) or uninstall.sh (Unix) under installed Acelet-Scheduler Home.

Use other database as default database

This is an advanced topic.

You can use any SQL database as your database. You need database schema for creating tables for that database. Please contact us.

Install License

This is an advanced topic.

Your license file is an XML text file. It should be installed at the same location as the program files in question.

The license file contains installation instructions. Please read the instructions as well.

You need to install Acelet-Scheduler first. Then, go to the main menu > System >  Install License. A JFileChooser will pop up. Choose your license file to install. Acelet-Scheduler will install all applicable licenses. If the new license file contains a server side license, Acelet-Scheduler will prompt you before installing.

Do not modify your license file. If you accidentally modified it and corrupted it, you need delete it and re-install it.

Command line install

This is an advanced topic.

Command line install is for:

• There is no GUI environment. For example, you use telnet to install on remote machine.
• There are many machines, you want to repeat the same installation many times.

The difference between command line install and GUI install:

• Command line install reads a file named install.properties to get input data. It is not interactive.
• Command line install will print error messages on command line window, if anything goes wrong.
• Command line install does not install default local log database. We assume you want use your favorite database.
• Command line install does not run installed program: it is an installer only.
• Command line install does not provide uninstall facility to uninstall client: you just delete that directory.

How to install:

1. Go to a temporary directory.
2. Unzip acelet-scheduler-eexxx.zip (xxx denotes for version number, for example acelet-scheduler-ee700.zip) to this temporary directory.
3. Prepare a file named install.properties and put the file on the current directory.
4. Run: 

java -cp superee.jar com.acelet.s.install.CommandLineInstall

The file install.properties must be on the temporary directory (the current directory). It must contains the following properties:

action
envoyName
serverHomeDir

It may contains the following optional properties, depends on the action:

superHomeDir
domainDir
superLoggingLibraryFile
otherLibraryFile

Available values for actions are:

installClient
installSuperLoggingLibrary

The envoyName is one of the names of supported application servers. The same as you see on GUI installer, for example (without quotation marks):

Universal
"WebLogic 8.1"
"WebSphere 5"

It must be exact spelling. If the envoyName is not valid, a list of supported server name will be printed on your screen.

Example install.properties:

action=installSuperLoggingLibrary
envoyName=WebLogic 8.1
serverHomeDir=d:\\bea\\weblogic81

Common installation errors

This is an advanced topic.

1. The installation never shows up.
The installation window is behind other windows. Please close or minimize other windows before installing.
2. You do not have written privilege under server directory.
Work with your administrators to install server side components.