Easy Workitem installation (jBPM WorkItem Repository)

We added the ability to install workitems hosted by the  jBPM Workitem Repository on any running KIE Worbench instance directly from the repository. itself This lifts some limitations of installing workitems which was so far only possible from within process editors inside each running workbench. It also allows for future integrations with other runtime systems that can take advantage of the hosted workitems.

When browsing workitems inside the repository you will now find the "Install" column:

Install column - Repository homepage

Selecting "Kie Workbench" will trigger the installation modal:

Workitem installation modal

Here you can enter specific information about the running KIE Workbench instance such as URL, Username, Password, Space name, and Project info where this workitem should be installed in.

Clicking the Install button will install all workitem handlers from the selected workitem group to your workbench instance. Upon successful installation you should be able to see the installed workitem handlers inside the selected workbench project.

Install success message

Archive workitem installed in "myproject"

Once installed you can start using your workitems when modeling your business processes:

Start using the installed workitem!

Note that this feature is available only if you are running the workitem repository in "hosted" mode, so by hosting it via the repository-springboot, or the repository-wildfly modules. When serving the repository content from the file system the Install column will not be displayed. 

Another thing to note is that since in almost all cases your hosted repository will have a different origin(domain) than the running workbench instances you are installing workitems to we need to enable CORS on the servers the workbench is running on. If you are running on Wildfly, this can simply be done inside your standalone.xml config:

Wildfly CORS config

Don't forget to change the value of the "Access-Control-Allow-Origin" header to the domain where you are hosting your workitem repository. In this case we use the default http://localhost:8090 which is used when running spring-boot repository setup. 

Last thing to mention is that currently the KIE Workbench servlet filters do not handle CORS preflight requests unfortunately (hopefully this will be changed in the future). Because of this by default the workitem repository is not able to issue CORS requests to the workbench intances. To lift this limitation add this filter definition to your workbench web.xml and restart the server:

Filter definition within KIE workbench

As always feel free to leave any comments and suggestions. Enjoy!


  1. Hi
    I have tried to install some work item from local repository (I have downloaded the latest version), hosted by springboot. I am getting a notification of success, but nothing changes. I am using workbench 7.9.0 stand alone. And I have created project and trying to install into that project.

    Thanks in advance


  2. hi
    I have followed the above steps and able to install workitem example weather. But in validation i am getting error :
    Verification of class retrofit2.Platform$Android$MainThreadExecutor failed and will not be available for authoring. Underlying system error is: Landroid/os/Handler;. Please check the necessary external dependencies for this project are configured correctly.

    Because of this i am not able to deploy the project.

  3. Hi,

    i followed this guide: https://github.com/kiegroup/jbpm-work-items and installed and compiled the repository on my mac (the running KIE Workbench instance is on a remote server).

    I could successfully access to http://localhost:8080/repository/ and I tried to install on the running KIE Workbench the execute-sql-workitem.

    I got the success message but no workitem was installed...

    So I tried to install manually uploading execute-sql-workitem-7.21.0-SNAPSHOT.jar as an artifact, but i got this error:

    [FATAL] Non-resolvable parent POM for org.jbpm.contrib:execute-sql-workitem:[unknown-version]: Could not find artifact org.jbpm.contrib:workitems:pom:7.21.0-SNAPSHOT @ line 6, column 11

    please help.


  4. Gracefully written information on this blog are going to support me for my coming assignments. Every point was very clear and taught me few new parameters. I would like to use this information in coming future.
    ZBook 15 G5