Category Archives: Plug-ins for API developers

Plug-in Show page by GUID

With this plug-in can easily find a page by the GUID. You get the page ID, headline and content class or a message that the GUID is not a valid page. The page could be found, even it is in the recycle bin.

If the page GUID is not valid you will get the RQL error Page GUID missing.

Benefits
This is helpful if you are working intensively with RQL, because often only the page GUID is delivered as result.

Unfortunately the MS search function cannot search by GUID, so this plug-in fills the gap. You get very easy the page details you need to find the page via the Search.

Location in SmartTree
You found the plug-in under Administer Project Structure.

How it works
After starting the plug-in you get a screen presented where you need to paste the page GUID.

After a click on the button Show info you will get the

  • page ID
  • page headline
  • name of the content class

Usually I copy the page ID and use the standard MS search to find the respective page. You will get an error message, if the GUID is not valid or the message “No page for GUID … found.”

If you know how to jump to the page in SmartTree, I would try to add this function in this plug-in.

Installation
This plug-in can be installed using the combined setup routine for all jRQL API based plug-ins. Follow the instructions in this blog to download the installer and configure the plug-ins you want.

For API developers
The functionality is delivered by the method Project > getPageByGuid(). There is a method getPageByID() as well.

The line with the details information can be retrieved simply by calling Page > getInfoText().

Interactive RQL tool

With this plug-in you can execute RQL commands and explore the response delivered from MS at lowest possible level.  The plug-in preserves your request and responses into a re-start of the tool.

In addition you can have several RQL requests in parallel. You need to select the command you want to execute, so there is still space to comment RQL requests. Use the plug-in Show session variables to get the IODATA tag with your current session.

The tool was not written by me. A consultant from the RedDot service handed it over to me after a RQL training session.

Benefits
Without this handy plug-in it’s almost impossible to work intensively with RQL. I uses this plug-in intensively, while developing of the jRQL API.

For me it is and was the basis to investigate all RQL commands. I grab quite often undocumented commands from the common log files and uses this tool to test the core command (remove unavailable attributes).

How to start the interactive RQL tool
You found this plug-in not in SmartTree. Instead open the Windows Start Menu and use the provided link “Interactive RQL”.

The URL in the form http://server/cms/ExecuteXml.asp to the Interative RQL tool can be distributed to your local desktop PC too. You don’t have to work on the server machine to use it!

How it works
After start of this tool you get a separated screen. On top an entry box with your latest used RQL requests and below a text are with your latest response.

You need to select the RQL request and click the button above Execute marked XML.

It’s quite handy, that the tool remember your requests and responses so you can even proceed with your work the next day. The most used RQL commands can be collected and stored this way for easy access.

I strongly recommend to use the plug-in Show session variables in addition to get the IODATA tag with your current logonGUID and sessionKEY.

Installation
This plug-in can be installed using the combined setup routine for all jRQL API based plug-ins. Follow the instructions in this blog to download the installer and configure the plug-ins you want.

Plug-in Show all session variables

This plug-in helps you to investigate all MS session variables. You can easily check the complete session if the needed data are already contained.

If you need to grab only the connection information as RQL tag or Java source code, you are better served by the plug-in Show session variables.

Benefits
This small but fine tool helps you out of the box to search the complete session data for an information you expect there.

This is helpful for RQL and plug-in developers. I used it quite often, when I try to integrate a plug-in into MS SmartTree.

Location in SmartTree
You found the plug-in under Administer Project Structure.

How it works
Immediately after the start you get a quite long list of all current session variables. Please have in mind, that this plug-in is a simple ASP page, means a running Tomcat is not needed to use it.

Installation
This plug-in can be installed using the combined setup routine for all jRQL API based plug-ins. Follow the instructions in this blog to download the installer and configure the plug-ins you want.

Plug-in Show Session Variables

With this plug-in RQL enthusiasts and API developers get the needed connection information (LogonGUID, SessionKey, ProjectGUID) as Java Source code and as RQL command.

For further investigation of the MS session variables, please refer to the plug-in Show all session variables too.

Benefits
Instead of copying and pasting these GUIDs one by one this plug-in combine it all into only one copy step needed.

If you need to explore the RQL command, for instance with the interactive RQL tool, this is the perfect companion to get the first line of every RQL command in a one step copy fashion.

As an API developer you often need to copy the connection information into your Java IDE for a quick try. At my desk this happen quite often within the day.

Location in SmartTree
You found the plug-in under Administer Project Structure.

How it works
When you start the plug-in it immediately opens the result screen. Please have in mind, that this plug-in is a simple ASP page, means a running Tomcat is not needed to use it.

The first 3 lines are Java source code for the API developers. The IODATA tag provided can be copyied directly into the interactive RQL tool and can be supplemented with other RQL tags.

Installation
This plug-in can be installed using the combined setup routine for all jRQL API based plug-ins. Follow the instructions in this blog to download the installer and configure the plug-ins you want.