Hacking BPM Suite/jBPM 6.0.x to make REST endpoints available as a Javascript API

You might know that BPM Suite/jbpm 6.0.x(which difference I explained in this post, from now I will only mention BPM Suite) has a great REST API to interact with processes and tasks. If you want to explore the API endpoints, there's a "hidden" page with a summary of all endpoints at http://localhost:8080/business-central/rest-api.jsp:

If you want to consume this API you must either create a client and/or use the remote Java API. If you want to consume it from javascript, you need to do some coding in order to get the data from the API. But there's a short way using the RESTEasy Javascript servlet.

In my example I am using JBoss EAP 6.1, although this should be possible with other application servers, I will focus only in BPM Suite 6.0.3 installed in JBoss EAP.

To enable the servlet, first edit the file standalone/deployments/business-central.war/WEB-INF/web.xml and add the RESTEasy javascript servlet declaration:

Now after you start BPM Suite the API should be available already and you should be able to call the REST API directly in your code with two warnings:

As the information is retrieved from JAX-RS resources, you must eager start resteasy or reach the REST API endpoint at least one time in order to start resteasy, otherwise you will face errors when accessing the javascript for the first time;
The API calls requires credentials. You can decided to either ask for them in your app that uses the javascript API or be logged in the business central before.

In my installation, here is the generated Javascript API. Having this in mind, you are free to use the javascript API! Here is a very simple page that lists all the tasks for the user "jesuino":

Conclusion

Notice that this is just the start to explore this generated API. Also, please notice this might expose your BPM Suite installation, so be careful with this feature

Keep in mind that BPM Suite is a product supported by Red Hat and this is not a feature supported by Red Hat, it is my personal experience with the API.

Comentários

Postagens mais visitadas deste blog

Creating custom Work Item Handler in BPM Suite/jBPM 6

Hi all! In this post I am going to share my experience creating a work item handler for BPM Suite 6.0.3 (which is very similar to jbpm as explained in a previous post ). The Hello World Work Item Handler Let's create a really simple WorkItemHandler just to print "Hello World" in the console. Of course you can implement more feature and make it receive parameters, access database, web services, etc. But in this post we will keep it simple. Really simple. First thing to do is to create a maven project for my WorkItemHandler. Here's the pom.xml of my Maven project: Notice that we are importing jbpm dependency so we can find the java interface that is used to create work item handlers. Now we can start coding. Let's create a class name HelloWorkItemHandler in package org.jugvale.jbpm, here is the simple code: Now we can build our project and go to BPM Suite to configure it so we can use this workitem. Registering the WorkItemHandler UPDATE...

Using the REST Task from jBPM 6

In this post I am going to share my experience using the BPM Suite 6 REST Task. BPM Suite X jBPM jBPM is a JBoss community project to offer an open source and efficient BPM Suite and BPM Suite is a product created by Red Hat based on jBPM. In this post I will be using BPM Suite because I have it installed already, but what I am going to described should work for jBPM as well. REST Task The REST Task is used to invoke a REST resource (or perform an HTTP Request) from your Business Process. You can set the URL, HTTP Method, timeout and credentials from the Process Modeller interface and when the process gets into that task, it will generate a HTTP Request and return the response as String. It is available on the left side pallet under the "Service Tasks" tab: The Target REST Web Service The service we are going to access from our process is a really simple one, that's why it is called simple-hello-rs and it is based on JBoss helloworld-rs qu...

Simplest JavaFX ComboBox autocomplete

Based on this Brazilian community post , I've created a sample Combobox auto complete. What it basically does is: When user type with the combobox selected, it will work on a temporary string to store the typed text; Each key typed leads to the combobox to be showed and updated If backspace is type, we update the filter Each key typed shows the combo box items, when the combobox is hidden, the filter is cleaned and the tooltip is hidden: The class code and a sample application is below. I also added the source to my personal github , sent me PR to improve it and there are a lot of things to improve, like space and accents support.

FXApps

Pesquisar este blog