How to use triggerable

asterisk · December 10, 2018, 4:00pm

Hi, I want to use serviceTask with triggerable and async.But I don’t know how to use it, can anybody give me an example?

I’m confused:

Why “step_one” can not be executed after startProcessInstanceByKey has been called.
If I set “step_one” flowable:async=“false”, the execution variable is null. If set async=“true”, the execution variable is not null (code like this:)

Deployment deployment = repositoryService.createDeployment().addClasspathResource(“bpmn/SendEvent.bpmn”).deploy();
ProcessInstance pi = runtimeService.startProcessInstanceByKey(“SendEvent”);
Execution execution = runtimeService.createExecutionQuery()
.processInstanceId(pi.getId())
.activityId(“step_one”)
.singleResult();
assertNotNull(execution);
Thread.sleep(5000);
runtimeService.triggerAsync(execution.getId());
Thread.sleep(5000);

after triggerAsync called, nothing happened. “sendEventService.sendMessage” has been called.

My bpmn like this:

<?xml version=“1.0” encoding=“UTF-8”?>
<definitions xmlns=“http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=“http://www.w3.org/2001/XMLSchema” xmlns:flowable=“http://flowable.org/bpmn” xmlns:bpmndi=“http://www.omg.org/spec/BPMN/20100524/DI” xmlns:omgdc=“http://www.omg.org/spec/DD/20100524/DC” xmlns:omgdi=“http://www.omg.org/spec/DD/20100524/DI” typeLanguage=“http://www.w3.org/2001/XMLSchema” expressionLanguage=“http://www.w3.org/1999/XPath” targetNamespace="http://www.flowable.org/processdef”>
<process id=“SendEvent” name=“SendEvent” isExecutable=“true”>
<startEvent id=“startEvent1”></startEvent>
<serviceTask id=“step_one” name=“step_one_name” flowable:async=“true” flowable:triggerable=“true” flowable:expression=“#{sendEventService.sendMessage(execution, ‘test_app’, ‘test_firstEvent’)}”></serviceTask>
<sequenceFlow id=“sid-C43EA3A5-7F38-48B8-B091-112C6632B064” sourceRef=“startEvent1” targetRef=“step_one”></sequenceFlow>
<serviceTask id=“step_two” name=“step_two_name” flowable:async=“false” flowable:triggerable=“true” flowable:expression=“#{sendEventService.sendMessage(execution, ‘test_app’, ‘test_secondEvent’)}”></serviceTask>
<sequenceFlow id=“sid-AD35CE48-AB59-4C40-9DA1-91B21F1463F9” sourceRef=“step_one” targetRef=“step_two”></sequenceFlow>
<endEvent id=“sid-FDDCC035-C01D-41D2-9867-39D78F064B50”></endEvent>
<sequenceFlow id=“sid-370A3246-FDBA-467E-86F4-BB131A80DB69” sourceRef=“step_two” targetRef=“sid-FDDCC035-C01D-41D2-9867-39D78F064B50”></sequenceFlow>
</process>
<bpmndi:BPMNDiagram id=“BPMNDiagram_SendEvent”>
<bpmndi:BPMNPlane bpmnElement=“SendEvent” id=“BPMNPlane_SendEvent”>
<bpmndi:BPMNShape bpmnElement=“startEvent1” id=“BPMNShape_startEvent1”>
<omgdc:Bounds height=“30.0” width=“30.0” x=“100.0” y=“163.0”></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement=“step_one” id=“BPMNShape_step_one”>
<omgdc:Bounds height=“80.0” width=“100.0” x=“257.0” y=“135.0”></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement=“step_two” id=“BPMNShape_step_two”>
<omgdc:Bounds height=“80.0” width=“100.0” x=“506.0” y=“130.0”></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement=“sid-FDDCC035-C01D-41D2-9867-39D78F064B50” id=“BPMNShape_sid-FDDCC035-C01D-41D2-9867-39D78F064B50”>
<omgdc:Bounds height=“28.0” width=“28.0” x=“690.0” y=“156.0”></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement=“sid-AD35CE48-AB59-4C40-9DA1-91B21F1463F9” id=“BPMNEdge_sid-AD35CE48-AB59-4C40-9DA1-91B21F1463F9”>
<omgdi:waypoint x=“356.9499999999986” y=“173.995983935743”></omgdi:waypoint>
<omgdi:waypoint x=“505.99999999999847” y=“171.00301204819277”></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement=“sid-370A3246-FDBA-467E-86F4-BB131A80DB69” id=“BPMNEdge_sid-370A3246-FDBA-467E-86F4-BB131A80DB69”>
<omgdi:waypoint x=“605.95” y=“170.0”></omgdi:waypoint>
<omgdi:waypoint x=“690.0” y=“170.0”></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement=“sid-C43EA3A5-7F38-48B8-B091-112C6632B064” id=“BPMNEdge_sid-C43EA3A5-7F38-48B8-B091-112C6632B064”>
<omgdi:waypoint x=“129.9482124561182” y=“177.76565302378518”></omgdi:waypoint>
<omgdi:waypoint x=“256.9999999999982” y=“175.78046875000004”></omgdi:waypoint>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>

jorge.mora · December 10, 2018, 5:31pm

Hi,

The “triggerable” setting currently works for a Java delegate implementing the TriggerableActivityBehavior interface.

Please, have a look at this unit test:

github.com

flowable/flowable-engine/blob/master/modules/flowable-engine/src/test/java/org/flowable/engine/test/bpmn/servicetask/TriggerableServiceTaskTest.java

/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.flowable.engine.test.bpmn.servicetask;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.flowable.engine.impl.jobexecutor.AsyncContinuationJobHandler;

This file has been truncated. show original

Also, to the associated process diagram

github.com

flowable/flowable-engine/blob/master/modules/flowable-engine/src/test/resources/org/flowable/engine/test/bpmn/servicetask/TriggerableServiceTaskTest.testAsyncJobs.bpmn20.xml

<?xml version="1.0" encoding="UTF-8"?>
<definitions 
  xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
  xmlns:flowable="http://flowable.org/bpmn"
  targetNamespace="Examples">

  <process id="process">
  
    <startEvent id="theStart" />
    <sequenceFlow sourceRef="theStart" targetRef="service1" />

    <serviceTask id="service1" flowable:class="org.flowable.engine.test.bpmn.servicetask.TriggerableServiceTask" flowable:async="true" flowable:triggerable="true"/>
    <sequenceFlow sourceRef="service1" targetRef="usertask1" />

    <userTask id="usertask1" name="Task A"/>
    <sequenceFlow sourceRef="usertask1" targetRef="theEnd" />

    <endEvent id="theEnd" />
    
  </process>

This file has been truncated. show original

I hope this helps to clarify the triggerable service task .

Regards,
Jorge Mora.

wberges · December 11, 2018, 8:40am

Hello,
You can have a look at this topic:

HTH
Best Regards
William

asterisk · December 11, 2018, 2:38pm

Thank you for reply. I got it. My UT is passed

reshmo · December 16, 2019, 7:34am

@ jorge.mora With reference to your mention about triggerable works only for Java delegate, can you please let me know how to use triggerable for a http service task . I don’t have any java classes . Everything is handled in bpmn alone. Also in flowable doc there is no detailed explanation about trigger can be used with only java delegate implementing the TriggerableActivityBehavior. Can you throw some pointers on this. Thanks in advance

jorge.mora · December 16, 2019, 8:26am

I think that you can have a look at the answer from @pstapleton for Camel tasks. You can try creating your own ActivityBehavior based on the original HttpActivityBehavior and add the triggerable behavior. I have not tried that by myself but it must work.

reshmo · December 18, 2019, 4:57am

Thank you Jorge! I will try with your approach .

donkon · February 18, 2020, 3:09pm

Will there be support for serviceTasks with expressions? We heavily rely on expressions (${bean.method()}) and would also need the triggerable flag.

donkon · February 18, 2020, 5:03pm

As I see, the org.flowable.engine.impl.bpmn.behavior.ServiceTaskExpressionActivityBehavior
class does not use the triggerable attribute. Would it be fine to just not call leave when triggerable is true (in execute()) and do nothing in trigger()?

filiphr · February 19, 2020, 7:23am

@donkon, that would most certainly be doable. However, how do you plan do call the trigger method? In order to trigger an instance you would need to know the executionId

donkon · February 19, 2020, 7:43am

I have the executionId and would use the runtimeService.trigger() method. Would that work?

donkon · February 20, 2020, 1:41pm

@filiphr it works this way:

public class ServiceTaskExpressionTriggerableActivityBehavior extends ServiceTaskExpressionActivityBehavior {

/** Serial. */
private static final long serialVersionUID = 9175468903749206291L;

private boolean triggerable;

public ServiceTaskExpressionTriggerableActivityBehavior(ServiceTask serviceTask, Expression expression, Expression skipExpression) {
	super(serviceTask, expression, skipExpression);
	this.triggerable  = serviceTask.isTriggerable();
}

@Override
public void trigger(DelegateExecution execution, String signalName, Object signalData) {
	super.leave(execution);
}

@Override
public void leave(DelegateExecution execution) {
	if (!this.triggerable) {
		super.leave(execution);
	}
}

}

Could this functionality be integrated in the flowable code base (nothing special here)?

filiphr · February 20, 2020, 8:25pm

Thanks for the snippet @donkon. I think that adding support for triggerable in the ServiceTaskExpressionTriggerableActivityBehavior. Seems like you already know what needs to be done. Would you be interested in providing a PR with this addition?

donkon · February 23, 2020, 10:25am

sure:

github.com/flowable/flowable-engine

ServiceTask with expression triggerable

flowable:master ← donkon:triggerable-service-task-with-expression

opened 09:58AM - 23 Feb 20 UTC

donkon

+55 -2

A ServiceTask with an expression should also be triggerable: The org.flowable….engine.impl.bpmn.behavior.ServiceTaskExpressionActivityBehavior class would just not call leave when triggerable is true (in execute()) and leaves in trigger(). https://forum.flowable.org/t/how-to-use-triggerable/3016 #### Check List: * Unit tests: YES * Documentation: YES

filiphr · February 24, 2020, 7:57am

Thanks a lot @donkon. This has been merged into master.

bipinbn · March 31, 2020, 10:32am

Hi All,

We have a requirement where in we need to call custom java code from service task. This custom java code does some business logic. We want the process to wait when this happens and we plan to trigger the process again after our business logic is done.

I figured that using service task with flowable:triggerable=“true” flowable:async=“true” set. Below is the sample BPMN I have . This is just a POC which depicts what we want to achieve.

<?xml version="1.0" encoding="UTF-8"?>
<definitions typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.flowable.org/test" xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:flowable="http://flowable.org/bpmn" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI">
	<process id="ApprovalProcessSimple" isExecutable="true">
		
		<startEvent id="Start_Default"/>
		
		<serviceTask id="Start" flowable:delegateExpression="${serviceDelegate}">
			<extensionElements>
				<flowable:field name="taskDescription" stringValue="StartTask"/>
			</extensionElements>
		</serviceTask>

		<serviceTask id="ApprovedNode" flowable:delegateExpression="${asyncServiceDelegate}"  flowable:triggerable="true" flowable:async="true">
			<extensionElements>
				<flowable:field name="taskDescription" stringValue="AsynNodeTaskTriggerSync"/>
			</extensionElements>
		</serviceTask>
		
			<serviceTask id="ConfirmNode" flowable:delegateExpression="${serviceDelegate}">
			<extensionElements>
				<flowable:field name="taskDescription" stringValue="ConfirmNode"/>
			</extensionElements>
		</serviceTask>
		
		<endEvent id="End"/>
		
		<sequenceFlow sourceRef="Start_Default" targetRef="Start"/>
		<sequenceFlow sourceRef="Start" targetRef="ApprovedNode"/>
		<sequenceFlow sourceRef="ApprovedNode" targetRef="ConfirmNode"/>
		<sequenceFlow sourceRef="ConfirmNode" targetRef="End"/>
	</process>
	<bpmndi:BPMNDiagram id="BPMNDiagram_ApprovedNodeManually">
		<bpmndi:BPMNPlane bpmnElement="ApprovedNodeManually" id="BPMNPlane_ApprovedNodeManually"/>
	</bpmndi:BPMNDiagram>
</definitions>

The delegate for async task is :

@Component
public class AsyncServiceDelegate implements TriggerableActivityBehavior, JavaDelegate, Serializable {

private static final long serialVersionUID = 1L;

private final Logger logger = LoggerFactory.getLogger(AsyncServiceDelegate.class);

private Expression taskDescription;

@Override
public void execute(DelegateExecution execution) {

    String taskDescriptionValue = ((String) taskDescription.getValue(execution));
    logger.debug(LogMarker.ENTRY, "In execute method of AsynServiceDelegate");
    logger.debug("Current activity id is : {} ", execution.getCurrentActivityId());
    logger.debug("Current task descrption is {}", taskDescriptionValue);
    logger.debug("Current process id is : {}", execution.getProcessInstanceId());
    logger.debug("Execution id is : {}", execution.getId());

}

@Override
public void trigger(DelegateExecution execution, String signalEvent, Object signalData) {
    logger.debug("In trigger code inside delegate");

}

After we deploy and start the process and I see that the process reaches
till AsyncServiceDelegate and does execute() and goes to wait state. It does not reach the ConfirmNode which is correct.

Now I am doing the below to trigger the process so that it continues execution . However this is not happening.

Execution execution = runtimeService.createExecutionQuery().processInstanceId(processId).activityId(actvityId).singleResult();
logger.debug("Execution id for triggering is : {} ", execution.getId());
runtimeService.trigger(execution.getId());

I see the call reaches AsyncServiceDelegate.trigger() method but nothing happens after that. How do I make the process continue to the ConfirmNode.

a> Is this because leave(execution) is not called?
b> Will the above fix help us?
c> Is there a workaround for this if we are not able to take the above mentioned code fix?

joram · April 13, 2020, 11:27am

Correct. Once you implement one of the *ActivityBehavior interface, you’re responsible for the routing logic (see the ‘internal’ section at BPMN 2.0 Constructs · Flowable Open Source Documentation)

Topic		Replies	Views
Multi-instance collection and triggerable tasks Flowable Engine	1	7	December 18, 2024
Request for help with Receive Task Flowable Engine	1	451	December 18, 2019
Problem on task execution after stop/start process engine using flowable 6.6.0 Flowable Engine	0	277	March 2, 2021
Async, Triggerable, and basic task design Flowable Engine	5	2274	September 13, 2020
How to re-execute a failed async and triggerable service task Flowable Engine	3	875	March 14, 2019

How to use triggerable

Related topics