Download jRQL API

jRQL is now Open Source

The source for the jRQL API is available at sourceforge.net. A SVN repository of the Eclipse project is available too, if you plan to join further development. Please have in mind, that all downloads in this wordpress blog did not contain the jRQL API sources so far.

Introduction

You can download jRQL as a pre-configured Eclipse V3.3.2 project.  Unzip this archive and within Eclipse use File | Import to start import dialog. As type choose “Existing project into Workspace”. For all details see the version history.

Within the download you get the following:

• sample classes with all source code mentioned in articles
• jRQL API jar (without source code, but compiled with debug attributes)
• javadoc already connected to jRQL API base classes
• all pre-requisite jars

Connect to your Management Server (MS)

To connect to your MS, please follow these steps:

1. Download and place the bridge ASP hlclRemoteRql.asp on your server in folder CMS\ASP.
2. Connect jRQL to that bridge ASP on your server in src/com.hlcl.rql.as.rql_fw.properties  by replacing the variable @cms-server@ with your MS domain name.

Where to start?

Start browsing and investigating the usage example classes in package com.hlag.jrql.examples. In all these examples you need your current loginGuid and sessionKey for interactive testing.

I recommend to install the jRQL plug-ins for admins additionally to get the following tools which ease your RQL and jRQL development:

• plug-in show session variables to get the Java code lines for logonGuid, sessionKey and projectGuid
• plug-in show all session variables to see all current IIS session data
• interactive RQL tool to execute raw RQL commands and see the response

Further information

As described in article handling parameters you can download the parameter content classes.

Even you use another development environment you should download the Eclipse project, because all needed jars are included. Afterwards you need to import and configure your project manually.

jRQL is using Java 5 you need to enable the new jRQL project with a Java 5 compiler (generally in workspace or per project – use jRQL project’s properties).

Restrictions

Error handling is limited to English or German user interface language. Quite often RedDot CMS return only a simple text instead of a real error code. Therefore I need to check for it (see settings in rql_fw.properties), but this check is user interface language dependent.