topic Re: Proper way to implement a custom a taskListener in Activiti? in Alfresco Archive

Proper way to implement a custom a taskListener in Activiti?

jpotts — Wed, 08 Feb 2012 14:33:05 GMT

I want to implement a custom taskListener that leverages the ActionService. I have written a Java class that implements TaskListener. The problem I'm having is how to properly inject the dependency and how to refer to the taskListener from the process definition.I tried creating the following in one

Re: Proper way to implement a custom a taskListener in Activiti?

michalwrobel — Tue, 21 Feb 2012 16:21:46 GMT

Hi,

I tried to implement similar thing as you, but using Activiti ServiceTask, and had the same problems as you.

'activiti:class' way worked fine, and delegateExpression had not. I've also implemented my own class which registered in activitiBeanRegistry, without utilizing baseJavaDelegate bean.

The only way I've found to evade this problem was to manually register my bean in activiti-context.xml by adding new entry to activitiBeanRegistry map:


 <util:map id="activitiBeanRegistry" map-class="java.util.HashMap">
        <entry key="services" value-ref="ServiceRegistry" />
    <entry key="simpleLoggerServiceTask" value-ref="simpleLoggerServiceTask" />
        
    </util:map>
‍‍‍‍‍‍‍

Just like classes utilising activitiBeanRegistry couldn't reach runtime updates in this map..

The important thing is that both key and value-ref have to have the same value - id of the bean.

I see you have released workflow tutorial yesterday and just scrolled through it, but haven't found there utilising java classes in workflows the way we are talking here about.
Have you figured out how to do it, or have you given up for the moment?
Or is this issue now officially bug?

Re: Proper way to implement a custom a taskListener in Activiti?

jpotts — Wed, 22 Feb 2012 14:36:51 GMT

In the tutorial I use a taskListener that refers to the class by name:

<activiti:taskListener event="create" class="com.someco.bpm.ExternalReviewNotification"></activiti:taskListener>‍

And then within the class I have a getServiceRegistry method that I stole from ActivitiScriptBase.java. It retrieves the service registry so I can have access to Alfresco's services:

protected ServiceRegistry getServiceRegistry() {
        ProcessEngineConfigurationImpl config = Context.getProcessEngineConfiguration();
        if (config != null) {
            // Fetch the registry that is injected in the activiti spring-configuration
            ServiceRegistry registry = (ServiceRegistry) config.getBeans().get(ActivitiConstants.SERVICE_REGISTRY_BEAN_KEY);
            if (registry == null) {
                throw new RuntimeException(
                            "Service-registry not present in ProcessEngineConfiguration beans, expected ServiceRegistry with key" + 
                            ActivitiConstants.SERVICE_REGISTRY_BEAN_KEY);
            }
            return registry;
        }
        throw new IllegalStateException("No ProcessEngineCOnfiguration found in active context");
    }   ‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Jeff

Re: Proper way to implement a custom a taskListener in Activiti?

amandaluniz_z — Wed, 22 Feb 2012 14:53:19 GMT

I faced the same problem and found the same work around (register the bean manually overriding the activitiBeanRegistry).

This is not the best solution as if you have more than one module, and want to register beans within the AMP file not in shared/classes/alfresco/extension… There'll be a workflow that won't work.

I've already raised a ticket with Alfresco Support, fingers crossed they fix that!

Regards,
Adei

Re: Proper way to implement a custom a taskListener in Activiti?

amandaluniz_z — Fri, 02 Mar 2012 09:29:25 GMT

Alfresco engineers have come back to me in this matter.

According to them, it's not the spring bean id the one we need to put in the delegateExpression property but the base name of the java class (for Jeff's example if would be ExternalReviewNotification)

Re: Proper way to implement a custom a taskListener in Activiti?

pero — Tue, 03 Apr 2012 08:54:00 GMT

According to them, it's not the spring bean id the one we need to put in the delegateExpression property but the base name of the java class (for Jeff's example if would be ExternalReviewNotification)

So has anyone else tried this solution? I've tried it and it still doesn't work.

Re: Proper way to implement a custom a taskListener in Activiti?

amandaluniz_z — Tue, 03 Apr 2012 11:47:21 GMT

I haven't tried it, to be honest.

The previous one, overriding the bean, works.

Adei

Re: Proper way to implement a custom a taskListener in Activiti?

pero — Sun, 08 Apr 2012 23:12:30 GMT

I faced the same problem and found the same work around (register the bean manually overriding the activitiBeanRegistry).

This is not the best solution as if you have more than one module, and want to register beans within the AMP file not in shared/classes/alfresco/extension… There'll be a workflow that won't work.

I've already raised a ticket with Alfresco Support, fingers crossed they fix that!

Regards,
Adei

Could you post a link to that Jira ticket so we can vote on it?

Re: Proper way to implement a custom a taskListener in Activiti?

amandaluniz_z — Tue, 10 Apr 2012 12:34:16 GMT

Sorry, didn't create a JIRA ticket, I meant an Alfresco Support ticket

Re: Proper way to implement a custom a taskListener in Activiti?

pero — Tue, 10 Apr 2012 13:42:11 GMT

Sorry, didn't create a JIRA ticket, I meant an Alfresco Support ticket

Ah. Ok then. You let us know when they fix it

Re: Proper way to implement a custom a taskListener in Activiti?

checco — Mon, 11 Jun 2012 10:51:45 GMT

Hi all,
i have found this topic very interesting, i think that you can help me especially when i read this:

I tried to implement similar thing as you, but using Activiti ServiceTask, and had the same problems as you.

'activiti:class' way worked fine….

because i can't run any Activiti ServiceTask using activiti:class attribute.

Let me explain, my process definition is very simple:


<process id="MySampleServiceTask" name="MySampleServiceTask">
    <startEvent id="alfrescoStartevent1" name="Alfresco start" activiti:formKey="bpm:startTask"></startEvent>
    <serviceTask id="servicetask1" name="Service Task" activiti:class="workflow.sample.serviceTask.HelloWorldServiceTask"></serviceTask>
    <endEvent id="endevent1" name="End"></endEvent>
    <sequenceFlow id="flow1" name="" sourceRef="servicetask1" targetRef="endevent1"></sequenceFlow>
    <sequenceFlow id="flow2" name="" sourceRef="alfrescoStartevent1" targetRef="servicetask1"></sequenceFlow>
  </process>
‍‍‍‍‍‍‍‍‍

and the HelloWorldServiceTask is even simpler:


package workflow.sample.serviceTask;

import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.delegate.JavaDelegate;

public class HelloWorldServiceTask implements JavaDelegate {

   public HelloWorldServiceTask() {
      System.out.println("HelloWorldServiceTask created");
   }

   @Override
   public void execute(DelegateExecution arg0) throws Exception {
      System.out.println("Hello Wolrd!");
   }

}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I have put my HelloWorldServiceTask class in a jar in the folder $TOMCAT_HOME/shared/lib/
Started Alfresco and deployed process definition using Activiti Workflow Console
But when i try to start the workflow from Alfresco Share web application it doesn't work: the workflow doesn't start and a pupup is opened with the message 'Impossible to start workflow'.
I have try to set the logging level to debug (log4j.logger.org.alfresco.repo.workflow=debug) to have more information but nothing is logged.

Do you have any idea what i'm doing wrong? I missing some configuration?
How can i have a more detailed error message?

Thanks,
Francesco

Re: Proper way to implement a custom a taskListener in Activiti?

checco — Mon, 11 Jun 2012 14:54:32 GMT

I have partially resolved my problem. I have Used Alfresco workflow console (http://localhost:8080/alfresco/faces/jsp/admin/workflow-console.jsp) to start my process and a ClassNotfoundException was raised so i have moved my jar with my classes in $TOMCAT_HOME/webapps/alfresco/WEB-INF/lib.

Now when i try to start a new instance of the process the HelloWorldServiceTask is created and his execution(…) method is invoked because i can see the output in the console, but after that an exception is raise and the Alfresco Workflow Console shows the message: org.alfresco.service.cmr.workflow.WorkflowException: 05110007 Workflow path activiti$3205 does not exist.
It seems that the problem is between the serviceTask and the endEvent transition…

The message is not logged in alfresco.log file, is there another configuration in addition to log4j.logger.org.alfresco.repo.workflow=debug in order to log also that message?

Francesco

Re: Proper way to implement a custom a taskListener in Activiti?

kavilash23 — Tue, 12 Jun 2012 07:28:58 GMT

Hi Francesco,

Try adding this line in log4j.properties

log4j.logger.workflow.sample.serviceTask.HelloWorldServiceTask=debug

Re: Proper way to implement a custom a taskListener in Activiti?

checco — Tue, 12 Jun 2012 09:45:15 GMT

Thanks,
I have just resolved the problem by adding only a userTask after the serviceTask and everything works fine!

Now i facing the problem of the delegate expression: i have tried either the bean id and the base name of the executor class but it dosen't works.

I finally adopted the jeff's solution, using the activiti:class attribute and the getServiceRegistry method.

Re: Proper way to implement a custom a taskListener in Activiti?

wgcox — Thu, 28 Jun 2012 19:19:51 GMT

We ran into the issue of trying to call 'delegate' from an Activiti workflow in Alfresco 4.0.1 (haven't tried this in 4.0.2 yet). I looked at the 'invitation-nominated' workflow as an example, as it makes use of delegates. However, our delegate was not accessible from the workflow. We worked through a couple of issues and got it to work, and hopefully this is helpful to folks:

1) Your bean must be registered in the activitiBeanRegistry. This is a Map that uses the class name (as a String) as the key, with the class object as the value in the Map. The important thing here is that your bean id name should exactly match your class name (e.g. - case sensitive) so that it matches in the Map.

2) If your class extends the BaseJavaDelegate class, your class should get added to the activitiBeanRegistry. However, this was not working for us. I attached a debugger, and I never saw my class getting added to the map. We resolved this by making our custom class' bean dependent on the activitiBeanRegistry. So, it looks like there is an order of initialization issue here if you don't do this.

We have bunch of classes that we're calling, so we just used an abstract bean that was dependent on the 'activitiBeanRegistry', and then our classes had the abstract bean as a parent (your Java class still extends BaseJavaDelegate, though).

Here is a snippet of the Spring config:

<bean id="AbstractWorkflowDelegate" parent="baseJavaDelegate" abstract="true" depends-on="activitiBeanRegistry"/>
    
    
    <bean id="MyCustomClass" parent="AbstractWorkflowDelegate" class="com.bluefishgroup.alf.workflow.MyCustomClass"/>
     
    <!– A bunch of additional classes defined as well –>
‍‍‍‍‍‍‍

And then, in the source code, my class needs to still extend BaseJavaDelegate:


import org.alfresco.repo.workflow.activiti.BaseJavaDelegate;

public class MyCustomClass extends BaseJavaDelegate
‍‍‍‍‍

Re: Proper way to implement a custom a taskListener in Activiti?

ungawunga — Tue, 19 Mar 2013 20:54:21 GMT

Thanks for posting that, but it hasn't solved my problem. All the combinations I've found in the forums and tried has not gotten me a reference to the ServiceRegistry. I am implementing an ExecutionListener, and my object does get called from the workflow, so I know that part is correct. But when my object's 'notify' method is called, it never gets a non-null return from BaseJavaDelegate.getServiceRegistry().

What is the magic Spring incantation I'm missing here?


<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>

<beans>
   <bean id="AbstractWorkflowDelegate" parent="baseJavaDelegate" abstract="true" depends-on="activitiBeanRegistry" />
 
   <bean id="MyIssuePost" class="com.epnet.alfresco.metadata.listener.MyIssuePost" parent="AbstractWorkflowDelegate">
      <property name="serviceRegistry" ref="ServiceRegistry" />
   </bean>

<!–  this didn't work either    
    <bean id="com.epnet.metadata.listener.MyIssuePost" class="com.epnet.alfresco.metadata.listener.MyIssuePost">
      <property name="serviceRegistry" ref="ServiceRegistry" />
   </bean>
 –>
</beans>

‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Proper way to implement a custom a taskListener in Activiti?

scundall — Mon, 21 Oct 2013 07:38:51 GMT

I am facing same problem as UngaWUnga do

My code is…


public abstract class DmsCommonListener {

   final static protected String DMS_LOG_MARKER = "### DMS ###";

   @Autowired
   @Qualifier("ServiceRegistry")
   private ServiceRegistry serviceRegistry;
   
   /**
    * @param serviceRegistry
    *            the serviceRegistry to set
    */
   @Required  //I combined it to just somehow make it work:-)
   public void setServiceRegistry(ServiceRegistry serviceRegistry) {
      this.serviceRegistry = serviceRegistry;
   }

   /**
    * @return the serviceRegistry
    */
   public ServiceRegistry getServiceRegistry() {
      return serviceRegistry;
   }

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
   xsi:schemaLocation="http://www.springframework.org/schema/beans 
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
   http://www.springframework.org/schema/context 
   http://www.springframework.org/schema/context/spring-context-3.0.xsd">

   <context:annotation-config />
   <context:component-scan base-package="com.tieto" />

   <bean id="DmsCustomMailer" class="com.tieto.workflow.util.DmsCustomMailer"></bean>
   <bean id="DmsCommonListenerBean" class="com.tieto.workflow.DmsCommonListener" abstract="true">
      <property name="workflowService">
         <ref bean="WorkflowService" />
      </property>
      <property name="serviceRegistry">
         <ref bean="ServiceRegistry" />
      </property>
   </bean>

<bean id="DmsCommonTaskListenerBean" class="com.tieto.workflow.DmsCommonTaskListener" abstract="true" parent="DmsCommonListenerBean" />
   <bean id="DmsCommonExecutionListenerBean" class="com.tieto.workflow.DmsCommonExecutionListener" abstract="true" parent="DmsCommonListenerBean" />

   <!– INIT –>
   <bean id="InitTaskListenerBean" class="com.tieto.workflow.init.TaskListener" parent="DmsCommonTaskListenerBean" />
   <bean id="InitExecutionListenerBean" class="com.tieto.workflow.init.ExecutionListener" parent="DmsCommonExecutionListenerBean" />
   <!– ELABORATION –>
   <bean id="ElaborationTaskListenerBean" class="com.tieto.workflow.elaboration.TaskListener" parent="DmsCommonTaskListenerBean" />

‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Proper way to implement a custom a taskListener in Activiti?

cafebabe — Tue, 17 Dec 2013 07:08:34 GMT

By registering the bean with activeRegistry, I was able to invoke it using the "delegateExpression" attribute as shown above.
But if I try to auto-wire a custom service class inside ExternalReviewNotification, then that class is not getting instantiated.
<blockcode>
<util:map id="activitiBeanRegistry" map-class="java.util.HashMap">
    <entry key="services" value-ref="ServiceRegistry" />
    <entry key="externalReviewNotification" value-ref="externalReviewNotification" />
    </util:map>

<bean id="externalReviewNotification" class="com.someco.bpm.ExternalReviewNotification"
depends-on="activitiBeanRegistry">
   <property name="myActionService">
      <ref bean="myActionService" />
   </property>
</bean>
<bean id="myActionService" class="com.someco.bpm.service.MyActionService"/>
</blockcode>
Please advise.

Re: Proper way to implement a custom a taskListener in Activiti?

dmralfing — Thu, 20 Mar 2014 14:26:00 GMT

Sorry Jeff, but I´m afraid I didn´t understand the solution you suggested due to I´m a beginner in activity.
Please, may you tell me what I'm doing wrong in this code or else what´s the best way to get
the service registry having Alfresco 4.2.x?
This is my wf:


<?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:activiti="http://activiti.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="Examples">
  <process id="MyTest" name="MyTest">
   <startEvent id="theStart" name="Start">
   </startEvent>
    <serviceTask id="javaService" name="Java service invocation" activiti:class="org.activiti.examples.bpmn.test.manager2.SetterTest">
      <extensionElements>
        <activiti:field name="text">
          <activiti:string>Success</activiti:string>
        </activiti:field>
        <activiti:taskListener event="create" class="org.activiti.examples.bpmn.test.manager2.SetterTest">
        </activiti:taskListener>
      </extensionElements>
    </serviceTask>
   <userTask id="usertask1" name="User Task" activiti:candidateGroups="user"></userTask>
    
   <endEvent id="theEnd" name="End"></endEvent>
    <sequenceFlow id="flow1" name="" sourceRef="theStart" targetRef="javaService"></sequenceFlow>
    <sequenceFlow id="flow2" name="" sourceRef="javaService" targetRef="usertask1"></sequenceFlow>    
    <sequenceFlow id="flow4" name="" sourceRef="usertask1" targetRef="theEnd"></sequenceFlow>
  </process>
</definitions>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

..and this is my class that unaffortunately doesn´t get the serviceRegistry..


package org.activiti.examples.bpmn.test.manager2;
import …
……….
public class SetterTest implements JavaDelegate {
 
   private static final String VARIABLE_NAME = "testVariable";
   private Expression text;
   ServiceRegistry serviceRegistry=null;
   //public ServiceRegistry getServiceRegistry() {return serviceRegistry;}
   protected ServiceRegistry getServiceRegistry() {

        ProcessEngineConfigurationImpl config = Context.getProcessEngineConfiguration();
        if (config != null) {
            ServiceRegistry registry = (ServiceRegistry) config.getBeans().get(ActivitiConstants.SERVICE_REGISTRY_BEAN_KEY);
            if (registry == null) {
                throw new RuntimeException(
                            "Service-registry not present in ProcessEngineConfiguration beans, expected ServiceRegistry with key" + 
                            ActivitiConstants.SERVICE_REGISTRY_BEAN_KEY);
            }
            else
               System.out.println("————— config =null");
            return registry;
        }

        throw new IllegalStateException("No ProcessEngineCOnfiguration found in active context");

    }   
   public void setServiceRegistry(ServiceRegistry serviceRegistry) {this.serviceRegistry = serviceRegistry;}
   public void execute(DelegateExecution execution) 
   {
         if (serviceRegistry==null)
            System.out.println("serviceRegistry is null!!");
   }
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Thank you so much!

Re: Proper way to implement a custom a taskListener in Activiti?

rasm — Tue, 12 Aug 2014 08:47:34 GMT

I described an example of doing above here: http://experiencewithalfresco.blogspot.dk/2014/08/using-bean-instanciated-tasklistener-in.html