// you’re reading...


RedDot CMS API – or – RQL in a nutshell – Part 2

There are several ways of accessing the RedDot CMS API. You can use RenderTags or use the RedDot Query Language, also known as “RQL”. This article explains how to use RQL for advanced requirements like event controlled RQL, remote RQL execution, binding RQL to workflows and much more.

Have you already seen this article RQL in a nutshell of the brilliant Manuel Schnitger? Yes? Well, at some point you’ll have questions which are not answered in the formerly mentioned article.
Therefore Manuel is back with this new article full of useful goodness that will help you when creating RQL-based applications (here you can find the original article).

Event controlled RQL

Usually an RQL plugin is called via a link in SmartEdit or SmartTree and will be executed in the second you click on the link…..so user interaction is required.  But what has to be done if you want the plugin/application to be executed when a specific event (e.g.: page released) in the workflow is reached? Let’s  do it step-by-step.
In this sample the goal is that you trigger an RQL application via the workflow. The action that is performed is not important….just the steps that result into performing the action.

Step #1: Creating a user defined job in the Server Manager

a) Go to the Server Manager > User defined jobs and click on "Create user defined job" in the action menu

Figure 1:Server Manager - Administer user defined jobs

Figure 1:Server Manager – Administer user defined jobs

b) in the upcoming dialogue enter a name for this job (e.g.: myNewJob)

Figure #2: Add a name for the job

Figure #2: Add a name for the job

c) in the next dialogue activate the checkbox "call event controlled" and deactivate the other one (important!)

Figure 3: Activating the option "Event controlled"

Figure 3: Activating the option “Event controlled”

d) in the next dialogue choose the option "Open URL" and enter the url to your RQL application

Figure 4: Adding the URL of your application

Figure 4: Adding the URL of your application

Step #2: Assigning the user defined job in the project

a) Enter the SmartTree
b) create a workflow
c) click on "Page released" and then on "add reaction"  (of course jobs can also be triggered when the workflow level is different to "page released" ;-) )

Figure 5: Small sample workflow

Figure 5: Small sample workflow

c) In the opening dialogue click on "Start job" and choose the user defined job you just created in the Server Manager.

Figure 6: Workflow triggers a user defined job (RQL application)

Figure 6: Workflow triggers a user defined job (RQL application)

Ready and good to go!!! Now the RQL application will be triggerred each time a page that is connected to this specific list is being released.

Usually when you wish to start a job – when a specific step in the workflow is reached you also want to let the RQL application do something with the page in workflow. But then there is this:

How do you know the GUID of the page in the workflow?
Read more »

Share and Enjoy:
  • Print
  • email
  • Twitter
  • Digg
  • Reddit
  • StumbleUpon
  • Google Bookmarks
  • del.icio.us
  • MisterWong
  • Facebook
  • LinkedIn

No related posts.


1 2 3 4

About the author:

Markus Giesen Markus Giesen is a Solutions Architect and RedDot CMS Consultant, formerly based in Germany. Travelling around the world to find and offer solutions for a better world (in a very web based meaning). He just found a way to do this as part of a Melbourne based online consultant house. On this blog Markus shares his personal (not his employers) thoughts and opinions on CMS and web development. In his spare time you will find him reading, snowboarding or travelling. Also, you should follow him on Twitter!


3 comments for “RedDot CMS API – or – RQL in a nutshell – Part 2”

  1. Question:
    With this process, is there a way for the plugin/asp to know which page will be published? is it possible to pass the guid by parameter? also I am wondering about the user and session guid that will be used by the asp file

    Thanks in advance.


    Posted by Dennis | February 17, 2011, 9:19 pm
  2. Hi Dennis,

    your first question is answered on the second page of the article: http://www.reddotcmsblog.com/reddot-cms-api-or-rql-in-a-nutshell-part-2/2 Just add a reaction “Write workflow XML” to your workflow and a file that contains the GUID of the page as well as other page related information will be written into the file system. You’ll also find a code snippet that allows you to get the page GUID. The answer to the second question is: You’ll have to write a login functionality and store the login GUID and the Session key into a variable. If that help you…..good. If not, just leave a comment and we’ll see how we can move on.

    Best regards,

    Posted by Manuel Schnitger | February 25, 2011, 7:10 pm
  3. A Healthcare company in Philadelphia, Pa is looking for a developer to work 100percent remote. They are looking for a red dot developer to develop, design and integrate this content management system. Red dot is a system that is commonly found in UK and England. The bill rate will be $80/hr The position will be 3 month plus no possibility of conversion.

    You can work from anywhere in the world
    please contact msant@rmkconsulting.com

    Posted by Meera | April 4, 2011, 9:28 pm

Post a comment

Stay up to date! - Get notified about followup comments

If you don't feel the urge to comment but wish to stay in the loop:
Just enter your email and subscribe to new comments.

Subscribe without commenting

Recent Tweets

  • RT @AirKraft: Transport Canada breakout: they manage 80K pages and 300K assets with WSM(RedDot). Wow! #OTCW 2010-11-11
  • The RedDot usergroup session 'Future of WCM' is in National Harbor 7, now. See you there! #otcw 2010-11-11
  • RT @yttergren: @AirKraft: Calling all WSM(RedDot) devs: share your solutions on http://bit.ly/bgPIof EVERY solution can win an iPad #OTCW 2010-11-10
  • Come to the Solution Exchange session. Enhance your (#reddot) CMS project! Chesapeake 12, 3:20pm #otcw Looking forward to see you there! 2010-11-10
  • More updates...