Almost there!

Your account is not fully set up yet or needs updating.
More controls will become available for you here when everything is ready.
This may not happen until a subsequent log in some time later.


by Frank Leja

Average rating:


The jRQL API is a Java based API encapsulating raw RQL commands and XML handling. Think of jRQL API rather of a plaform for developing new plug-ins and batch programs instead of a ready to use plug-in.

jRQL benfits
This difference leads to several benefits explained in detail on the jRQL blog. The main benefits are:

  • speed-up the development of new plug-ins and batch programs
  • no RQL XML handling needed anymore
  • provides high level functions, for instance moving a page from one mutli link to another
  • helps to quick automate administrator's and author's click streams
  • usable even without RQL knowledge
  • provides plausibility checks and exception handling

Please refer to the blog for further jRQL API benefits.

jRQL functionality
I work on jRQL since 2004. Over the years I added functionality from SmartTree, SmartEdit and ServerManager.

To be more precisely I want to list the main areas where jRQL can automate tasks you might find interesting.

  • login via logon GUID and session or via user name and password
  • getting and setting most content element types (default values always considered), StandardFields, Text, Image, Media
  • create,delete and restore pages
  • connect, disconnect, reference and move pages on links
  • browse and manipulate content class elements
  • create and browse publication setup
  • get workflow state and submit, release and reject pages
  • create publishing jobs for LV and PV combinations
  • get and change language variants
  • full internationalisation support, read and write of UTF-8 included
  • simultanously access to different projects on same and on different MSs

For a introductionary tutorial how to work with jRQL API, please refer to categories API* on the jRQL blog. You might also be interested in the general concepts of jRQL.

What you get
jRQL consists of about 110 classes for the core components (see javadoc) of OT MS and 63 utility classes (see javadoc). The range goes from a lightweight class like Plugin (14 methods) to the most extensive class Page (314 methods).

Java developers can browse the javadoc online or download the jRQL Eclipse project with connected javadoc and with all example code used in the tutorial. 

jRQL API's potential

The tutorial and the presentation mentioned below show only a small part of the jRQL API, the most part of the jRQL API is still hidden. You can see the full potential only browsing the javadoc documentation for the classes. Start your javadoc browsing with the following main core and utility classes:

The jRQL API is the basis for all jRQL plug-ins. They can be used without any Java know-how. You found the description of it in the Plug-ins* categories on the jRQL blog. You can download all jRQL plug-ins with an automatic installer routine.

See the most interesting jRQL plug-ins I added to the solution exchange by searching for jRQL.

In the jRQL presentation (in German) starting with slide 31 I give some examples how I use jRQL API inside Hapag-Lloyd

The biggest high level functionality is the possibility to crawl all physical pages below a given page and invoke a self written page action for every page found. I used it for a comprehensive page statistics.

Last update:
Fri, 26 Nov 2010
Contact person:
Frank Leja 

+ Add tag:

Failed to add your tag(s)
If you receive this message persistently, please let us know through the feedback form.

Successfully added tag(s)

Reviews & Ratings

What do you think?

Please do not post bug reports in reviews.

After pressing the button, you will be asked to authenticate yourself.

Failed to add your review
If you receive this message persistently, please let us know through the feedback form.

Successfully added your review


    There are no items available to download

About the Authors

Tweet Exchange

The TweetExchange is managed by @OT_SolEx on Twitter. Please follow and DM or @ mention us to add you to the list. Once added to the list tweets will be unfiltered.

Translate this page to:
What exactly do these controls do?

Feedback ..