Ebase Licensing Procedure

Step 1: Determine the Host Id string for the server system. 1

Each Ebase Xi Server system requires a license to operate. This document describes the procedure to obtain and install the license file.

Note that the Ebase Xi Designer does not require a license to operate. The Integrated Test Server supplied with the Ebase Xi Designer does require a license, however the license included with the distribution supports up to 10 concurrent users which should be enough for most development requirements.

You will need to follow this procedure in any of the following circumstances:

You need a new license to increase the number of concurrent users
A new installation of the Ebase Xi Server
An upgrade to the server system hardware which results in a change to the MAC Address, e.g. replacement of the network card

In this document, $EBASE_HOME refers to the directory where the Ebase Xi Server has been installed.

Step 1: Determine the Host Id string for the server system

Start the Server Administration Application either from a designer or using URL http://<hostname>:<port>/<webapp>/ebaseAdmin.eb, click License under Information on the home page, then click the Get host id for this server button.

If for any reason you don’t have access to the Server Administration Application, you can obtain the host id as follows:

Windows systems

Install the Ebase Xi Server if not already done
Open a DOS Command Window and cd to the $EBASE_HOME\UfsServer\admin\licence
Enter command: licencecheck

The system will respond with “Ebase licence string: …………”

Linux and Unix systems

Install the Ebase Xi Server if not already done
cd to directory $EBASE_HOME/UfsServer/admin/licence
Enter command: licencecheck.sh

The system will respond with “Ebase licence string: …………”

Linux and Unix systems important notes:

The licencecheck command runs a standalone Java program that requires Java 1.4 or higher to run. If a lower level of Java is used, it will fail with message:

Exception in thread "main" java.lang.UnsupportedClassVersionError:

com/ebasetech/ufs/licence/GetHostId (Unsupported major.minor version 48.0)

The licencecheck procedure issues operating system commands, and these can fail if access to these commands is restricted. In Linux and Unix systems this can be overcome by running licencecheck as root. However, the same checking procedure is also used by the Ebase Xi Server during its startup checks, therefore access to the operating system commands will also be needed at this point.

Note that for application servers where Ebase is supplied as a .war or an .ear file, the admin directory can be copied separately to the target server system. In addition, the licencecheck.bat or licencecheck.sh scripts may need to be adjusted to set the JAVA_HOME variable.

Step 2: Obtain the license file

Complete the license application form (in UfsServer/admin/licenceform.doc) and email it to Ebase at licensing@ebasetech.com.

Include the following information:

Your Name:
Customer Name:
Your Phone Number:
Your Email Address:
Ebase Xi Version:	Which version of Ebase do you require the license file for?
Host Id:	Ebase license string obtained from step 1 above
System Type:	Development, Test or Production (see below)
System Id:	A unique id for this instance (optional)

The system types have the following characteristics:

Development:

Allows unrestricted use of designer and runtime.

Test:

Creation of new elements or copying existing elements in the Ebase Designer is not allowed.

When running forms, all HTML pages contain an additional header:

* T E S T * T E S T * T E S T * T E S T * T E S T * T E S T *

Production:

From Ebase Xi V5.0, this is the same as a Development license

Step 3: Install the license file

Copy the supplied licence file ebaselicence.properties to the ebaseConf folder within the Ebase web application. For Tomcat and Jboss/Tomcat systems this will normally be $EBASE_HOME/UfsServer/tomcat/webapps/ufs/ebaseConf.

Note that the license file must not be renamed or modified in any way. Also license files cannot be copied between server systems.

Step 4: Start the Ebase Xi Server

This concludes the license installation procedure.

Additional Notes:

1. For any queries regarding outstanding license application requests or on the licensing procedure, please send an email to licensing@ebasetech.com or call +44 (0)1767 654987.

2. If you are an existing customer and you have an emergency, e.g. a server is down and you need to start the Ebase Xi Server on another system, please call +44 (0)1767 654987. An emergency licence can be supplied immediately that will allow the system to operate.