Running Ebase Xi Out of the Box

Documentation home

 

Starting Ebase Xi Server 1

Using Windows Explorer 1

From the command line. 1

Starting the Ebase Xi Designer 1

Using windows explorer 1

From the command line. 2

Stopping the Ebase Xi Server 2

Using Windows Explorer 2

From the command line. 2

Running the server as a service under Windows 2

Runtime Logs 3

Server logs 3

Apache Derby Configuration. 3

Apache Derby JDBC Configuration. 3

Using external tools to view/modify the Ebase Xi database. 4

 

 

See also: Ebase Security, Introduction to the Ebase Designer

 

This document describes how to start and stop the Ebase Xi Server and Designer components. The Ebase Xi root installation directory is referred to as EBASE_HOME throughout this document

 

 

Starting Ebase Xi Server

 

Using Windows Explorer

The Ebase Xi Server can be started from Windows Explorer follows:

 

  1. Navigate to EBASE_HOME/UFSServer.
  2. Double click start_ebase_server.bat or start_ebase_server.exe (they do the same thing).

 

From the command line

The Ebase Xi Server can be started from the command line as follows:

 

  1. Change your current directory to EBASE_HOME/UFSServer, for example: cd c:\ufs\UFSServer
  2. Type start_ebase_server

 

 

 

Starting the Ebase Xi Designer

 

Using windows explorer

The Ebase Xi Designer can be started from Windows Explorer follows:

 

  1. Navigate to EBASE_HOME/UFSClient.
  2. Double click start_ebase_designer.bat or start_ebase_designer.exe.

 

From the command line

The Ebase Xi Designer can be started from the command line as follows:

 

  1. Change your current directory to EBASE_HOME/UFSClient, for example: cd c:\ufs\UFSClient
  2. Type start_ebase_designer

 

In both cases, the start_ebase_designer script will launch the Ebase Designer client. You will first be presented with the login screen. Please consult your system administrator to find out what your username and password is.

 

When using Ebase Xi for the first time, the basic installation is provided with a default user:

 

  • Username: ebaseuser
  • Password: ebaseuser

 

(Note that for systems upgraded from a release prior to V3.4.0, this will be ufsuser/ufsuser.)

 

It is strongly recommended to remove this user or change the password once you have entered the system. (See Ebase Security for more information)

 

If you have trouble starting the Ebase Server, make sure there are no instances of Tomcat already running.  In addition, the supplied system uses port 3030 for web connections. Make sure you do not have any other applications already using this port.

 

 

Stopping the Ebase Xi Server

 

Using Windows Explorer

Ebase can be stopped from Windows Explorer as follows.

 

  1. Navigate to EBASE_HOME/UFSServer.
  2. Double click stop_ebase_server.bat.

 

From the command line

Ebase can be stopped from the command line as follows.

 

  1. Change your current directory to EBASE_HOME/UFSServer, for example: cd c:\ufs\UFSServer
  2. Type: stop_ebase_server

 

In both cases, the stop_ebase_server script will cleanly shutdown the Ebase Server. It is recommended always to shutdown the server in this way.

 

Note: The server may be restarted without restarting the Ebase Designer and vice versa.

 

 

Running the server as a service under Windows

 

This information is available as a technical note. Please contact Ebase Technology support.

 

Runtime Logs

Ebase maintains a log of information about all forms which have been run. This is useful for troubleshooting.

 

Server logs

The Ebase Server will by default log to the system console and the file EBASE_HOME/UfsServer/Tomcat/logs/ufsserver.log. Logging to a file can be configured in the UFSSetup.properties file by setting the following properties:

 

  • Ufs.logDirName
  • Ufs.logFileName
  • Ufs.retainOldLogs
  • Ufs.logError
  • Ufs.logInfo

 

Designer logs

Logs for forms executed via the designer can be viewed through Ebase Designer's view menu (View --> Execution log)

 

Note: The Ebase Designer execution log is cleared each time the server is restarted. The log can also be cleared manually using the Clear button on the execution log window.

 

 

 

Apache Derby Configuration

 

Ebase is shipped with Apache Derby database. This database is an embedded database and starts up when the Ebase Xi Server is started. It is a fully relational database implemented in 100% Java. For more information about derby see http://db.apache.org/derby/

 

Apache Derby is the default database when running Ebase Xi out of the box. There is no additional configuration required when starting Ebase Xi for the first time.

 

The physical database is stored in the following directory –

 

<ebase-install-directory>/UFSServer/DB/UFS

 

 

Apache Derby JDBC Configuration

 

The JDBC Connection URL should be configured as follows:

 

      jdbc:derby:UFS;create=false

 

The UFS part of the JDBC URL can be changed to an absolute location of a database e.g

 

      jdbc:derby:c:/mydatabase/UFS;create=false

 

To create the database if it does not exist (useful for creating your own database separate from Ebase Xi), substitute the create=false with create=true

 

 

Using external tools to view/modify the Ebase Xi database

 

There are several client tools that you can use to view/modify the Ebase Xi data or configure a new database.

Note: you cannot connect to the database while the Ebase Xi Server is running as only one client can attach to the database at any one time in embedded mode.

 

  1. Apache Derby IJ – Command Line Client that comes with Apached Derby. Note: You will need the derby.jar file located in the <ebase-install-dir>/tomcat/common/lib directory. See http://db.apache.org/derby/papers/DerbyTut/ij_intro.html
  2. DBUtils -  A Database Client Utility developed by Apache. See http://db.apache.org/derby/integrate/db_ddlutils.html
  3. DBVisualizer – A Database Client Utility to allow many connections to many different databases.. See http://www.minq.se/products/dbvis/