AceQL HTTP
This interface allows you to configure and run the AceQL Web Server that will be accessed by remote clients.

A configuration file is provided with default information for immediate startup.

Configuration

Properties File

Defining properties for most AceQL Web Server configurations are carried out in the aceql-server.properties file, with the exception of the hostname and port.

Click "Edit" to modify the default AceQL properties file that comes with installation. The file is self-documented.
Click "Browse" to choose/use a different file.

The minimum properties to define when starting an AceQL Web Server instance are:
  • The databases property must contain at least a database name.
  • The 4 JDBC properties:
    • database.driverClassName,
    • database.url,
    • database.username,
    • database.password.
Refer to the AceQL Server Guide for detailed information.


Host & Port

The two fields allow you to define the hostname and port of the HTTP URL that is to be accessed by the client side.
Do not prefix the hostname with http:// or https://, as it will be done automatically by AceQL.

Valid values for hostname are:
localhost, www.acme.com, prefix.acme.org, etc.


Display CLASSPATH

This button displays the CLASSPATH that will be used by the AceQL Server at startup.

This allows you to be sure that your JDBC Driver has been added to the CLASSPATH, and/or that your Configurator classes have been added to the CLASSPATH.

Found JDBC Drivers are highlighted to allow you a rapid check-up.


Server Start & Stop

Server may be started within the current JVM, or as a Windows Service.

N.B: Make sure your JDBC Driver is in the CLASSPATH before starting the Server.

If you wish to run the AceQL Web Server as a Windows Service, it is highly recommended to test your configuration by starting the server once in Standard Mode.


Standard Mode

The AceQL Server is started in the same current JVM and a Console is opened to check the success of the start.

If everything is OK, the last line will display: 
[ACEQL HTTP START] SQL Web Server OK. Running on port <port_number>.
If configuration errors occur, they are displayed as Exceptions in red.


Service Mode

You may start and stop the Windows service from this window.
Note that the default start type is "Auto".
This and the other properties of the Windows Service may be changed using Microsoft Management Console. Just click on "Services Console".

After the Windows Service is started, it is recommended to check the success of the run by accessing the Windows service logs:
  • Click on "Service Logs".
  • The 3 following files contain all the necessary info to check if AceQL is successfully running, and to fix configuration errors:
    • aceqlhttpservice-stderr.yyyy-mm-dd.log
    • aceqlhttpservice-stdout.yyyy-mm-dd.log
    • commons-daemon.yyyy-mm-dd.log

If the start is successful, the last line of aceqlhttpservice-stdout.yyyy-mm-dd.log will display: 
[ACEQL HTTP START] SQL Web Server OK. Running on port <port_number>.

Service Mode - Precisions of Java environment values

By default, the Windows Service opens the session with the Local System account.
This can be changed with the Microsoft Management Console ("Services Console" button).

Note: if you change the account, the service must be restarted using the AceQL interface (in order to correctly set the user.home system property).

The value of the user.home system property depends on the account chosen to open the session:
  • Default Local System account: user.home system property value is set to "c:\.aceql-http" for the Java session.
  • Any other account: user.home system property value is the default/regular value. For example, on Windows 10, if the account chosen is ".\Mike", the value of user.home will be "C:\Users\Mike".

In case you want to use your own DatabaseConfigurator or SessionConfigurator instances, you must add the class files to the CLASSPATH.

In Service Mode, the CLASSPATH contains:
  • The paths to the necessary jar files to run the software.
  • The paths to the installed JDBC Drivers.
  • Plus the content of the user CLASSPATH environment when the service is started from this interface (i.e. the environment variable is the one of the user that runs this AceQL interface).
Note: the value of the system environment variable CLASSPATH is never used.


Service Mode - Changing the CLASSPATH

If you have changed your CLASSPATH environment variable, you must do following actions for AceQL to use the new CLASSPATH value:
  • Stop the Windows Service.
  • Quit AceQL completely. (Ctrl-Q or File menu ==> Quit item.)
  • Restart AceQL.
  • Start the Windows Service from the AceQL interface (not from the Windows Services Console).
  • Click "Service Logs" and verify that the displayed CLASSPATH contains the new value in the aceqlhttpservice-stdout.yyyy-mm-dd.log file.

Service Mode - Ensure service restart on server reboot

In order to ensure that the Windows Service is effectively restarted after reboot, change the Startup type from "Automatic" to "Automatic (Delayed Start)" using the Microsoft Management Console ("Services Console" button).