Java API for Management Server - easier RQL - faster results
written by Frank Leja:
This blog is about a Java API for the OpenText Management Server (MS), formerly known as RedDot CMS (OpenText bought RedDot).
The jRQL Java API encapsulate all basic RQL request and response handling (XML handling) and offer high level functions from SmartEdit, SmartTree and ServerManager area. About 160 RQL commands are implemented currently, not all of them are documented officially.
For every MS administrator – jRQL plug-ins for admins
Every MS administrator might be interested in the jRQL plug-ins for admins which comes as an easy to handle setup program. No Java know-how is neededto get them up and running!
I developed the jRQL API to make the MS functions handy available on an higher level as the provided RQL commands. jRQL completely frees you from raw RQL request / response handling. jRQL encapsulates every RQL command only once, which makes it easy to adjust, if it is changed in releases.
I focused on flexibility, because I often need to automate changes in SmartTree and SmartEdit area which are to heavy to do the normal way. Browse the categories right to get an impression, what’s possible.
Please refer for further information on general concepts to the general concepts category. I started the development about 2004.
jRQL what you get
jRQL consists of about 120 classes for the core components of OT MS and 63 utility classes. The range goes from a lightweight class like Plugin (14 methods) to the most extensive class Page (329 methods).
To get an overview of the provided functionality, please browse the samples categorized (API *) in the sidebar.
I use it currently with MS V9, but the RQL commands are almost the same as in RedDot CMS V7.5.
For Java developers
jRQL API is Open Source now! Even the downloads in this blog are not injected with the source code, you can find it at the jRQL sourceforge project.
As a Java developer you should have a look at the jRQL Eclipse project download (still lack source). To get in touch with jRQL please read the getting started post or use the categories in the sidebar if you are interested in special areas.
Still you can see the full potential only in the javadoc, the tutorial is rather an introduction as a reference. Start your javadoc browsing with the following main core and utility classes:
- MultiLink superclass of List and Container
If you are interested in project migration or export and import of data I want to recommend the post jRQL ideal suited for project migration which addresses this issue in detail.