nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

As we transition to the new Hyland Community, some post links may be temporarily disrupted as we finalize redirects. We apologize for the inconvenience and are working to resolve this as quickly as possible. Details.

UserTask + ServiceTask

vire7777

Hi dear Activiti members

I'm searching for a way to solve one of my problem.
I would love to create a task that would be a mix of a userTask and a serviceTask
In fact I want to find a solution to let my workflow ask some parameters to the user with an interface and, when the parameters are in and the user is ok, then launch a java class treatment.

I know this is possible with 2 tasks but is that possible too with one ?

Further, could it be possible to create a task like that in the palette.
I need it for my company as we want to let the clients create their own workflow with our own palette tasks. And all these tasks need to launch a java treatment with some informations the user has to enter first.

Can you help me ?

Vivien

Find more posts tagged with

Comments

jbarrez

Sure, you would need to implement a custom ActivitiBehaviour and use it as a service task. The behaviour should mimic the user task ActivityBehaviour and add the extra logic afterwards.

Yes, adding to the palette in the Eclipse designer is possible.

vire7777

Where can i find a documentation about it ? Because i find no clue about ActivitiBehaviour or custom ActivitiBehaviour in the userguide…
I mean, how to create some in my palette as every components have to implements AbstractCustomServiceTask ?
Could you give me an example ?

jbarrez

The user guide does not document it, cause for 99% of the people it is not a use case they need.
The userguide does mention it:

<code>
[INTERNAL: non-public implementation classes] It is also possible to provide a class that implements the org.activiti.engine.impl.pvm.delegate.ActivityBehavior interface. Implementations have then access to the more powerful ActivityExecution that for example also allows to influence the control flow of the process. Note however that this is not a very good practice, and should be avoided as much as possible. So, it is advised to use the ActivityBehavior interface only for advanced use cases and if you know exactly what you're doing.
</code>

Activiti is open source. Open up for example the UserTaskActivityBehaviour to see how it can be done.

vire7777

Ok thanks a lot
I ll try it
But maybe i ll need your help as i m not an "advanced" activiti and java user ^^
So this advice is so important for me :

"Note however that this is not a very good practice, and should be avoided as much as possible. So, it is advised to use the ActivityBehavior interface only for advanced use cases and if you know exactly what you're doing."

jbarrez

The reason that those lines are in the userguide is because basically when you use that interface (instead of the regular JavaDelegate), you've got access to all the internals of the engine. You can do cool stuff with it, but you can also break your process if you don't know what you're doing.

In reality, it'll be ok. Simply let you inspire by all the ones that are shipped in the Activiti code. And if you're stuck somewhere, come back here with your questions.

vire7777

Thanks

I'll try it
i m downloading the last Activiti version to see the sources and have a look to UserTaskActivityBehaviour

Thanks for your support and if i have question, be sure i ll come back ^^

vire7777

I tried something like this
As i want a mix between the two tasks usertask and servicetask i just copy the servicetask code to implement it after th usertask :

<code>
package com.effisoft.designer.tasks;

import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.delegate.ExecutionListener;
import org.activiti.engine.delegate.JavaDelegate;
import org.activiti.engine.impl.bpmn.behavior.UserTaskActivityBehavior;
import org.activiti.engine.impl.context.Context;
import org.activiti.engine.impl.delegate.JavaDelegateInvocation;
import org.activiti.engine.impl.el.ExpressionManager;
import org.activiti.engine.impl.pvm.delegate.ActivityBehavior;
import org.activiti.engine.impl.pvm.delegate.ActivityExecution;
import org.activiti.engine.impl.task.TaskDefinition;

/**
* activity implementation for the user/service task.
*
* @author Vivien René
*/
public class EffiTaskActivityBehavior extends UserTaskActivityBehavior implements ActivityBehavior, ExecutionListener {

protected TaskDefinition taskDefinition;
protected JavaDelegate javaDelegate;

public EffiTaskActivityBehavior(ExpressionManager expressionManager, TaskDefinition taskDefinition) {
super(expressionManager, taskDefinition);
}

public EffiTaskActivityBehavior(ExpressionManager expressionManager, TaskDefinition taskDefinition, JavaDelegate javaDelegate) {
super(expressionManager, taskDefinition);
this.javaDelegate = javaDelegate;
}

public void execute(ActivityExecution execution) throws Exception {
execute(execution);
execute((DelegateExecution) execution);
leave(execution);
}

public void signal(ActivityExecution execution, String signalName, Object signalData) throws Exception {
leave(execution);
}

public void notify(DelegateExecution execution) throws Exception {
execute((DelegateExecution) execution);
}

public void execute(DelegateExecution execution) throws Exception {
Context.getProcessEngineConfiguration().getDelegateInterceptor().handleInvocation(new JavaDelegateInvocation(javaDelegate, execution));
}
}
</code>

In addition a little question :
Is it Activiti or Activity ?

jbarrez

It sure is Activiti 😉

Activity is used internally as it is a BPMN concept for a step in the process.

And yes, this is one way to do it. Probably the more 'clean' Java approach would be to use composition instead inheritance (ie have both the UserTaskActivityBehaviour and the ServiceTaskActivityBehaviour as members - but thats nitpicking).
But the most important thing: does it do what you expected it to do?

vire7777

1) About the palette
I really don't know if that does what i want because i don t know how to put this in the palette and test it.
Normally it would as i want a component which is both a human and service task.
Before my classes inherited AbstractCustomServiceTask and i had all to create a new element in the palette as
- getName
- contributeToPaletteDrawer
- getSmallIconPath
- etc…
.
Maybe i have to implement the interface CustomServiceTask with the same methods like in AbstractCustomServiceTask
.
But with this system, i realy don t know how to do to it in the designer
.
.
2) About the best implementation method
In addition, about what you told, how can you have both the UserTaskActivityBehaviour and the ServiceTaskActivityBehaviour as members ?
Because if my remembers are good, java has no multiple inheritance, hasn t it ?
.
In all cases, thanks a lot for your time as it helps me a lot

jbarrez

No Java, doesn't have multiple inheritance. What I mean you have two fields, like the javadelegate field you now have. But dont worry about it, it's only a suggestion.

Now, to customize the palette, thats quite a different beast, which is described here: http://activiti.org/userguide/index.html#eclipseDesignerCustomizingPalette

vire7777

Yes i did it first with my last classes extending AbstractCustomServiceTask
But with the new one, i tried it but without success… i can t see it in the palette

Here my new Abstract class code :
<code>
public abstract class EffiTaskActivitiBehavior extends UserTaskActivityBehavior implements CustomServiceTask, ActivityBehavior, ExecutionListener {

protected TaskDefinition taskDefinition;
protected JavaDelegate javaDelegate;
private static final String DEFAULT_EXTENSIONS_DRAWER_NAME = "Extensions";

public String contributeToPaletteDrawer() {
return DEFAULT_EXTENSIONS_DRAWER_NAME;
}

public final String getId() {
return getClass().getCanonicalName();
}

public final DelegateType getDelegateType() {
return getDelegateType(getRuntimeAnnotation());
}

private DelegateType getDelegateType(final Runtime annotation) {

DelegateType result = DelegateType.NONE;

if (annotation != null) {
   if (isDelegateDefined(annotation.javaDelegateClass())) {
    result = DelegateType.JAVA_DELEGATE_CLASS;
   } else if (isDelegateDefined(annotation.expression())) {
    result = DelegateType.EXPRESSION;
   } else if (isDelegateDefined(annotation.javaDelegateExpression())) {
    result = DelegateType.JAVA_DELEGATE_EXPRESSION;
   }
}

return result;
}

private boolean isDelegateDefined(final String definition) {
return definition != null && !definition.isEmpty() && !"".equals(definition);
}

public final String getDelegateSpecification() {

String result = "";

final DelegateType delegateType = getDelegateType();

if (!DelegateType.NONE.equals(delegateType)) {

   Runtime runtimeAnnotation = getRuntimeAnnotation();
   if (runtimeAnnotation != null) {
    switch (delegateType) {
    case JAVA_DELEGATE_CLASS:
     result = runtimeAnnotation.javaDelegateClass();
     break;
    case EXPRESSION:
     result = runtimeAnnotation.expression();
     break;
    case JAVA_DELEGATE_EXPRESSION:
     result = runtimeAnnotation.javaDelegateExpression();
     break;
    default:
     break;
    }
   }

}

return result;
}

private Runtime getRuntimeAnnotation() {

Runtime result = null;

final Annotation annotation = this.getClass().getAnnotation(Runtime.class);

if (annotation != null && Runtime.class.isAssignableFrom(annotation.getClass())) {
   result = ((Runtime) annotation);
}

return result;
}

public abstract String getName();

public String getDescription() {
return getName();
}

public String getSmallIconPath() {
return null;
}

public String getLargeIconPath() {
return getSmallIconPath();
}

public String getShapeIconPath() {
return getSmallIconPath();
}

public DiagramBaseShape getDiagramBaseShape() {
return DiagramBaseShape.ACTIVITY;
}

public Integer getOrder() {
return 1;
}

@SuppressWarnings("rawtypes")
public String toString() {
StringBuilder builder = new StringBuilder();

final Class clazz = this.getClass();
final Field[] fields = clazz.getDeclaredFields();

builder.append("Custom Service Task ").append(this.getClass().getSimpleName()).append("\n\tID:\t").append(this.getId()).append("\n\tProvider class:\t").append(this.getClass().getCanonicalName()).append("\n\tPalette drawer:\t").append(contributeToPaletteDrawer()).append("\n\tProperties:\n");

for (final Field field : fields) {
   final Annotation[] annotations = field.getAnnotations();
   for (final Annotation annotation : annotations) {
    if (annotation instanceof Property) {
     builder.append("\t\t").append(field.getName()).append(" (").append(((Property) annotation).type().name()).append(")\n");
    }
   }
}

boolean hierarchyOpen = true;
Class currentClass = clazz;
while (hierarchyOpen) {
   currentClass = currentClass.getSuperclass();
   if (CustomServiceTask.class.isAssignableFrom(currentClass)) {
    for (Field currentSuperclassField : currentClass.getDeclaredFields()) {
     final Annotation[] currentSuperclassFieldAnnotations = currentSuperclassField.getAnnotations();
     for (final Annotation currentSuperclassFieldAnnotation : currentSuperclassFieldAnnotations) {
      if (currentSuperclassFieldAnnotation instanceof Property) {
       builder.append("\t\t").append(currentSuperclassField.getName()).append(" (").append(((Property) currentSuperclassFieldAnnotation).type().name()).append(") (inherited from ").append(currentClass.getSimpleName()).append(")\n");
      }
     }
    }
   } else {
    hierarchyOpen = false;
   }
}

return builder.toString();
}

public EffiTaskActivitiBehavior(ExpressionManager expressionManager, TaskDefinition taskDefinition) {
super(expressionManager, taskDefinition);
}

public EffiTaskActivitiBehavior(ExpressionManager expressionManager, TaskDefinition taskDefinition, JavaDelegate javaDelegate) {
super(expressionManager, taskDefinition);
this.javaDelegate = javaDelegate;
}

public void execute(ActivityExecution execution) throws Exception {
execute(execution);
execute((DelegateExecution) execution);
leave(execution);
}

public void signal(ActivityExecution execution, String signalName, Object signalData) throws Exception {
leave(execution);
}

public void notify(DelegateExecution execution) throws Exception {
execute((DelegateExecution) execution);
}

public void execute(DelegateExecution execution) throws Exception {
Context.getProcessEngineConfiguration().getDelegateInterceptor().handleInvocation(new JavaDelegateInvocation(javaDelegate, execution));
}
}
</code>

And here my class code i want to see in the palette :

<code>
@Help(displayHelpShort = "Send a new mail to the different owners")
@Runtime(javaDelegateClass = "com.effisoft.orion.fw.workflow.MailTask2")
public class MailTask2 extends EffiTaskActivitiBehavior {

public MailTask2(ExpressionManager expressionManager, TaskDefinition taskDefinition) {
super(expressionManager, taskDefinition);
}

public MailTask2(ExpressionManager expressionManager, TaskDefinition taskDefinition, JavaDelegate javaDelegate) {
super(expressionManager, taskDefinition, javaDelegate);
}

@Property(type = PropertyType.TEXT, displayName = "Recipient List", required = true)
private String recipients;

@Property(type = PropertyType.TEXT, displayName = "Subject", required = true)
private String subject;

@Property(type = PropertyType.TEXT, displayName = "Body", required = true)
private String body;

@Property(type = PropertyType.TEXT, displayName = "Attachment List")
private String attachments;

@Override
public String getName() {
return "MailTask2";
}

@Override
public String contributeToPaletteDrawer() {
return "Effisoft Corporation";
}

@Override
public String getSmallIconPath() {
return "icons/icon.gif";
}

}
</code>

Can you tell me where i m wrong ?
I just want to create an example to work with and implement my own class then

vire7777

Well i try to create the same than the human task just by copying the activiti code and i can t see it in the palette too…
Seems really strange. I think i miss something.