kiegroup / jbpm-work-items

Collection of jBPM work items and handlers

jBPM WorkItem Repository

Collection of jBPM workitem (service task) implementations which you can use in your business processes to integrate with different services.

Hosting the repository

Workitem Repository can be hosted in three different modes:

1. File System mode: Clone this github repo:

git clone https://github.com/kiegroup/jbpm-work-items.git

and build it:

cd jbpm-work-items
mvn clean install

then you can point your browser directly to for example:

file://PATH_TO_WORKITEM_REPO/repository/target/repository-VERSION

where VERSION is the version of the workitem repository you have built locally. You can also copy the contents of this directory anywhere else and access its contents from there.

2. Spring Boot app: Clone this github repo:

git clone https://github.com/kiegroup/jbpm-work-items.git

and build it:

cd jbpm-work-items
mvn clean install

now you can start the repo as a spring-boot application:

cd repository-springboot
mvn spring-boot:run

and can access your repository with

http://localhost:8090/repository/

3. Embedded WidlFly: Clone this github repo:

git clone https://github.com/kiegroup/jbpm-work-items.git

and build it:

cd jbpm-work-items
mvn clean install

get the repository server zip and extract it somewhere (this creates a tmp directory in /target, you would want to unzip it somewhere else maybe)

cd repository-wildfly/target/
mkdir tmp
cd tmp
unzip ../repository-server-VERSION.zip

where VERSION is the version of the repository you have built locally Now you can start your repo in wildfly

cd bin
./standalone.sh  (or standalone.bat for windows)

and access it in your browser with:

http://localhost:8080/repository/

Workitem Display and Documentations

Repository displays all available workitems. Clicking on the workitem name (e.g "Google Maps") will display all the workitem handlers associated with that workitem:

Clicking on the "View" button next to each of the handlers will show you documentation for that handler:

Workitem Search by functionality

The repository allows your users to search its content by functionality:

This will filter your workitem display to only those which include the searched term

Downloading workitem artifacts

For each workitem displayed the repository has a Downloads dropdown where you can easily get all the needed artifacts for that workitem:

Installing onto workbench

Note this is an experimental functionality and you will need to read the blog post: http://mswiderski.blogspot.com/2018/07/easy-workitem-installation-jbpm.html for more info.

Repository REST api

If hosted as spring-boot app or wildfly app the repository exposes a rest api for querying. It includes the following endpoints:

/repository/rest/services
/repository/rest/services/{name}
/repository/rest/services/{name}/parameters
/repository/rest/services/{name}/results
/repository/rest/services/{name}/mavendepends
/rest/services/category/{category}
/rest/servicetriggers
/rest/servicetriggers/count
/rest/serviceactions
/rest/serviceactions/count

Contributing

Yes Please!! :)

We are always looking for contributions from the community. If you would like to contribute your integration service (workitem) the best way is to look at some of the existing ones and pretty much copy its structure and go from there. We are available on google groups: https://groups.google.com/forum/#!forum/jbpm-setup for help and will help to get you started and guide you through the contribution process.

jbpm-work-items's Issues

org.jbpm.contrib:workitems as a parent pom results in broken version handling

When creating a work item handler using the parent results in broken versioning.

  <parent>
    <groupId>org.jbpm.contrib</groupId>
    <artifactId>workitems</artifactId>
    <version>7.40.0.20200703</version>
  </parent>

It is impossible to actually use your own version numbers because they will break resolution of dependencies within the parent, many of which are missing version numbers of any kind. This makes version management of the actual project completely broken, its not possible to have "different" published versions of the same work-item because they wont build.

repository-springboot (7.39.0-SNAPSHOT) localhost:9080/repository doesnt show work at all

• version: 7.39.0-SNAPSHOT
• Set logging level for everything to DEBUG
• /repository errors, no list of "work item handlers"
• The rest apis at "/actuator" respond with json.
• Logging output shows nothing registers for "/repository"
• There are no web app.

Switched to following repository-wildfly/README,

• run the server inside
• load http://localhost:8090/repository/ works
• work item handlers list
• so far so good.

The /README repository-springboot section doesnt currently work :( should be temporarily removed as its misleading.

Build Failure : Java 11 - Maven 3.6.0

WIth a fresh copy of tag 7.38.0.Final and the following config:

$ java -version
openjdk version "11.0.1" 2018-10-16 LTS
OpenJDK Runtime Environment Zulu11.2+3 (build 11.0.1+13-LTS)
OpenJDK 64-Bit Server VM Zulu11.2+3 (build 11.0.1+13-LTS, mixed mode)

$ mvn -v
Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-24T11:41:47-07:00)
Maven home: /Users/bsb/.sdkman/candidates/maven/current
Java version: 11.0.1, vendor: Azul Systems, Inc., runtime: /Users/bsb/.sdkman/candidates/java/11.0.1-zulu
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.15.5", arch: "x86_64", family: "mac"

Running a mvn clean install produces:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  7.173 s
[INFO] Finished at: 2020-06-23T13:05:31-07:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project archive-workitem: Compilation failure
[ERROR] Error post-processing workitem annotations: Incorrectly typed data found for annotation element public abstract org.jbpm.process.workitem.core.util.service.WidAuth org.jbpm.process.workitem.core.util.service.WidService.authinfo() (Found data of type org.jbpm.process.workitem.core.util.service.WidAuth).

ClassNotFound for jira.AddCommentOnIssue

I've been trying to get the Jira work items going, but run into the following:

java.lang.ClassNotFoundException: org.jbpm.process.workitem.jira.AddCommentOnIssueWorkitemHandler from [Module "deployment.kie-server.war" from Service Module Loader]

Is this a known problem with 7.25.0.Final? I've tried redoing everything (including the entire jbpm installation) multiple times, some other work items work fine, but the Jira ones do not :-/
Also, the default "Log" work item does not seem to work either...

SLF4J Issue

Hi,

I am trying to install jbpm-work-items with with

C:\Verano\dev\gitdownloads\jbpm-work-items>mvn clean install

However I found next error:

[INFO] Running org.jbpm.process.workitem.archive.ArchiveWorkitemIntegrationTest
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
[ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 4.733 s <<< FAILURE! - in org.jbpm.process.workitem.archive.ArchiveWorkitemIntegrationTest
[ERROR] testWorkitemValidity(org.jbpm.process.workitem.archive.ArchiveWorkitemIntegrationTest) Time elapsed: 4.591 s <<< FAILURE!
java.lang.AssertionError: expected:<1> but was:<0>
at org.jbpm.process.workitem.archive.ArchiveWorkitemIntegrationTest.testWorkitemValidity(ArchiveWorkitemIntegrationTest.java:38)

[INFO]
[INFO] Results:
[INFO]
[ERROR] Failures:
[ERROR] ArchiveWorkitemIntegrationTest.testWorkitemValidity:38 expected:<1> but was:<0>
[INFO]
[ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0
[INFO]