topic Re: send email to each assegnee on serial workflow in Alfresco Archive

send email to each assegnee on serial workflow

mirkomane — Tue, 08 Mar 2011 16:04:05 GMT

Hi all,I'm trying to modify the serial review and approve workflow, to send email to each assegnee on reviewers list, when it is his turn to approve the submitted content.Below my serialreview_processdefinition.xml:<?xml version="1.0" encoding="UTF-8"?><!– Filename: serialreview_processdef

Re: send email to each assegnee on serial workflow

lucille_arkenst — Tue, 08 Mar 2011 18:05:02 GMT

Underneath "Users and their Roles" do you get a text box and some kind of method of selection? If you don't, that could be the problem.
What does your web-client-config-custom.xml look like?
What does your workflowModel.xml look like?

Grazie

Re: send email to each assegnee on serial workflow

mirkomane — Wed, 09 Mar 2011 08:17:22 GMT

Underneath "Users and their Roles" do you get a text box and some kind of method of selection? If you don't, that could be the problem.

Hi lucille,
thank you for your reply. I don't have defined any role for the users. Just my code should be send out an email when user approve the submitted content.

What does your web-client-config-custom.xml look like?

This is my web-client-config-customs.xml:


<alfresco-config>
<config evaluator="node-type" condition="wf:submitSerialReviewTask" replace="true">
      <property-sheet>
         <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
         <show-property name="bpm:workflowDescription" component-generator="TextAreaGenerator" />
         <show-property name="bpm:workflowPriority" display-label-id="wf_review_priority" />
         <show-property name="bpm:workflowDueDate" display-label-id="wf_review_due_date" />
         <separator name="sep2" display-label-id="users_and_roles" component-generator="HeaderSeparatorGenerator" />
         <show-association name="bpm:assignees" display-label-id="wf_reviewers" />
      </property-sheet>
   </config>

   <config evaluator="node-type" condition="wf:rejectedSerialTask" replace="true">
      <property-sheet>
         <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
         <show-property name="bpm:taskId" />
         <show-property name="bpm:description" component-generator="TextAreaGenerator" read-only="true"/>
         <show-property name="bpm:dueDate" read-only="true" />
         <show-property name="bpm:priority" read-only="true" />
         <show-property name="bpm:status" />
         <show-property name="bpm:comment" component-generator="TextAreaGenerator" />
         <separator name="sep2" display-label-id="users_and_roles" component-generator="HeaderSeparatorGenerator" />
         <show-association name="bpm:assignees" display-label-id="wf_reviewers" read-only="true"/>
      </property-sheet>
   </config>
</alfresco-config>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

What does your workflowModel.xml look like?

This is the modified workflowModel.xml in C:\Alfresco\tomcat\webapps\alfresco\WEB-INF\classes\alfresco\workflow


<?xml version="1.0" encoding="UTF-8"?>
<!–  Filename: workflowModel.xml
     Description: This altered file describes additional entries for the serial review workflow
     Usage: Overwrite the existing workflowModel.xml file in \Alfresco\tomcat\webapps\alfresco\WEB-INF\classes\alfresco\workflow
     Version: Alfresco Community 3.3
     Author: Karel Jordaan
–>

<model name="wf:workflowmodel" xmlns="http://www.alfresco.org/model/dictionary/1.0">

   <imports>
      <import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
      <import uri="http://www.alfresco.org/model/bpm/1.0" prefix="bpm"/>
   </imports>

   <namespaces>
      <namespace uri="http://www.alfresco.org/model/workflow/1.0" prefix="wf"/>
   </namespaces>
     
   <types>

      <!–                               –>
      <!–  Basic Review & Approve Tasks –>               
      <!–                               –>
     
      <type name="wf:submitReviewTask">
         <parent>bpm:startTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>

      <type name="wf:submitConcurrentReviewTask">
         <parent>bpm:startTask</parent>
         <properties>
            <property name="wf:requiredApprovePercent">
                <type>d:int</type>
                <mandatory>true</mandatory>
                <default>50</default>
                <constraints>
                    <constraint type="MINMAX">
                        <parameter name="minValue"><value>1</value></parameter>
                        <parameter name="maxValue"><value>100</value></parameter>
                    </constraint>
                </constraints>
            </property>
         </properties>
      </type>

      <!–  Submit review to multiple people (explicit list) –>
      <type name="wf:submitParallelReviewTask">
         <parent>wf:submitConcurrentReviewTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignees</aspect>
         </mandatory-aspects>
      </type>
      
      <!–  This is the added type for serial review workflow –>
      <!–  Submit Serial review to multiple people (explicit list) –>
      <type name="wf:submitSerialReviewTask">
         <parent>bpm:startTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignees</aspect>
         </mandatory-aspects>
      </type>

      <!–  Submit review to multiple people (as included in a group) –>
      <type name="wf:submitGroupReviewTask">
         <parent>wf:submitConcurrentReviewTask</parent>
         <mandatory-aspects>
            <aspect>bpm:groupAssignee</aspect>
         </mandatory-aspects>
      </type>

      <type name="wf:reviewTask">
         <parent>bpm:workflowTask</parent>
         <overrides>
            <property name="bpm:packageItemActionGroup">
               <default>edit_package_item_actions</default>
            </property>
         </overrides>
      </type>

      <type name="wf:approvedTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>

      <!–  This is the added type for serial review workflow –>
      <type name="wf:approvedSerialTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignees</aspect>
            
         </mandatory-aspects>
      </type>
      
      <type name="wf:rejectedTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>

      <!–  This is the added type for serial review workflow –>
      <type name="wf:rejectedSerialTask">
         <parent>bpm:workflowTask</parent>
         <overrides>
            <property name="bpm:packageItemActionGroup">
               <default>edit_package_item_actions</default>
            </property>
         </overrides>
         <mandatory-aspects>
            <aspect>bpm:assignees</aspect>
         </mandatory-aspects>
      </type>
      
      <type name="wf:rejectedParallelTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>wf:parallelReviewStats</aspect>
         </mandatory-aspects>
      </type>

      <type name="wf:approvedParallelTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>wf:parallelReviewStats</aspect>
         </mandatory-aspects>
      </type>


      <!–                               –>
      <!–  Adhoc Tasks –>               
      <!–                               –>
     
      <type name="wf:submitAdhocTask">
         <parent>bpm:startTask</parent>
         <properties>
            <property name="wf:notifyMe">
               <type>d:boolean</type>
               <default>false</default>
            </property>
         </properties>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>

      <type name="wf:adhocTask">
         <parent>bpm:workflowTask</parent>
         <overrides>
            <property name="bpm:packageActionGroup">
               <default>add_package_item_actions</default>
            </property>
            <property name="bpm:packageItemActionGroup">
               <default>edit_package_item_actions</default>
            </property>
         </overrides>
      </type>

      <type name="wf:completedAdhocTask">
         <parent>bpm:workflowTask</parent>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>
       
      <!– Deprecated workflow task from Alfresco 3.0 –>
      <!– Needs to be defined for patch.InvitationMigration which gets rid of it.  –>
     
      <type name="wf:inviteToSiteTask">
         <parent>bpm:startTask</parent>
         <properties>
            <property name="wf:serverPath">
               <type>d:text</type>
            </property>
            <property name="wf:acceptUrl">
               <type>d:text</type>
            </property>
            <property name="wf:rejectUrl">
               <type>d:text</type>
            </property>
            <property name="wf:inviteTicket">
               <type>d:text</type>
            </property>
            <property name="wf:inviterUserName">
               <type>d:text</type>
            </property>
            <property name="wf:inviteeUserName">
               <type>d:text</type>
            </property>
            <property name="wf:inviteeFirstName">
               <type>d:text</type>
            </property>
            <property name="wf:inviteeLastName">
               <type>d:text</type>
            </property>
            <property name="wf:inviteeGenPassword">
               <type>d:text</type>
            </property>
            <property name="wf:siteShortName">
               <type>d:text</type>
            </property>
            <property name="wf:inviteeSiteRole">
               <type>d:text</type>
            </property>
         </properties>
         <mandatory-aspects>
            <aspect>bpm:assignee</aspect>
         </mandatory-aspects>
      </type>

   </types>
   
   <aspects>
      <aspect name="wf:parallelReviewStats">
         <properties>
            <property name="wf:reviewerCount">
               <type>d:int</type>
            </property>
            <property name="wf:requiredPercent">
               <type>d:int</type>
            </property>
            <property name="wf:approveCount">
               <type>d:int</type>
            </property>
            <property name="wf:actualPercent">
               <type>d:int</type>
            </property>
         </properties>
      </aspect>
   </aspects>
</model>

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

I would be very greateful if you could help me!
Thank you very much!

Mirko

Re: send email to each assegnee on serial workflow

lucille_arkenst — Wed, 09 Mar 2011 14:14:13 GMT

I don't have defined any role for the users

Ah… but the program is still looking for a list of users. You still need to select users to which the workflow will be assigned. If you are not selecting any, the program is looking for the assignees, and that's where it's having problem.

Your web-client-config-custom.xml for submitSerialReviewTask looks good. It should definitely have:


<separator name="sep2" display-label-id="users_and_roles" component-generator="HeaderSeparatorGenerator" />
<show-association name="bpm:assignees" display-label-id="wf_reviewers" />
‍‍‍‍

Your workflowModel.xml also looks good. The submitSerialReviewTask should definitely have:


<mandatory-aspects>
   <aspect>bpm:assignees</aspect>
</mandatory-aspects>
‍‍‍‍‍

Is the initiator selecting users on the first screen or no?

Re: send email to each assegnee on serial workflow

mirkomane — Wed, 09 Mar 2011 16:09:21 GMT

I don't have defined any role for the users
Ah… but the program is still looking for a list of users. You still need to select users to which the workflow will be assigned. If you are not selecting any, the program is looking for the assignees, and that's where it's having problem.

Your web-client-config-custom.xml for submitSerialReviewTask looks good. It should definitely have:
<separator name="sep2" display-label-id="users_and_roles" component-generator="HeaderSeparatorGenerator" />
<show-association name="bpm:assignees" display-label-id="wf_reviewers" />
‍‍‍‍
Your workflowModel.xml also looks good. The submitSerialReviewTask should definitely have:
<mandatory-aspects>
   <aspect>bpm:assignees</aspect>
</mandatory-aspects>
‍‍‍‍‍
Is the initiator selecting users on the first screen or no?

Hi Lucille, thank you for your help.
Maybe I expressed myself badly…I'm sorry for my bad english. So, I select the correct user reviewer when I start the workflow wizard. In fact, at the first step, bpm_assignees contains the correct reviewer to send email and the email is send out correctly. The problem occur when the second reviewer has his turn. In this case the variable bpm_assignees is undefined. Many alfresco's user have opened a post about this problem but I can't found any solved solution. Today I try to use another way that I would like to submitted to you. Below my modified serialreview_processdefinition.xml:


<?xml version="1.0" encoding="UTF-8"?>

<!–  Filename: serialreview_processdefinition.xml
     Description: This altered file describes additional entries for the serial review workflow
     Usage: Upload file to : Company Home > Data Dictionary > Workflow Definitions
     Version: Alfresco Community 3.3
     Author: Karel Jordaan
–>

<process-definition xmlns="urn:jbpm.org:jpdl-3.1" name="wf:serialreview">

   <swimlane name="initiator"/>

   <start-state name="start">
      <task name="wf:submitSerialReviewTask" swimlane="initiator"/>
      <transition name="" to="startreview"/>
   </start-state>

   <decision name="startreview" >
      <event type="node-enter">
          <script>
            <variable name="wf_reviewCycle" access="write"/>
            <variable name="wf_reviewerCount" access="write"/>
            <variable name="wf_approveCount" access="write"/>
            <expression>
               wf_reviewerCount = bpm_assignees.size();
               wf_approveCount = 0;
               wf_reviewCycle = 1;
            </expression>
          </script>
          <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
            <runas>admin</runas>
              <script>
                <variable name="docNodeRef" access="read, write" />
                <variable name="bpm_package" access="read" />
                <expression>
                    var date = new Date();
                    var originalDocName = bpm_package.children[0].properties["cm:name"];
                    docNodeRef = bpm_package.children[0];
                    var existingDoc = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                    if(existingDoc == null)
                    {
                        var wf_doc = docNodeRef.parent.createFile(originalDocName +"_wfhistory.txt");
                        wf_doc.addAspect("cm:versionable");
                        wf_doc.content = date + " Start Serial &amp; Review Workflow on "+ originalDocName;
                        var workingCopy = wf_doc.checkout();
                        workingCopy.content = workingCopy.content + " by " + person.properties["firstName"]+" "+person.properties["lastName"]+"\n";
                        wf_doc = workingCopy.checkin(); 
                    }
                    if(existingDoc != null)
                    {
                        var logFile = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                        var workingCopy = logFile.checkout();
                        workingCopy.content = workingCopy.content + date +  " Restart Serial &amp; Review Workflow on "+ originalDocName + " by "+ person.properties["firstName"]+" "+person.properties["lastName"]+"\n";
                        logFile = workingCopy.checkin();
                    }
                </expression>
              </script>
          </action>
      </event>
      <transition name="serial" to="submitserialreview" />
   </decision>


   <!–               –>
   <!– Serial Review –>
   <!–               –>

   <decision name="submitserialreview">
      <transition name="endreview" to="endreview" />
      <transition name="review" to="serialreview">
        <condition>#{wf_approveCount &lt; wf_reviewerCount}</condition>
      </transition>
   </decision>
   
   <task-node name="serialreview">
      <task name="wf:approvedSerialTask">
         <assignment class="org.alfresco.repo.workflow.jbpm.AlfrescoAssignment">
            <actor>#{bpm_assignees.get(wf_approveCount)}</actor>
         </assignment>
         <event type="task-assign">
            <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
            <runas>admin</runas>
              <script>
              <variable name="wf_approveCount" access="read"/>
              <variable name="bpm_assignees" access="read"/>
              <variable name="bpm_package" access="read"/>
              <variable name="wf_assignees" access="read"/>
              <expression>
                  if(people.getPerson(taskInstance.actorId).properties["cm:email"] != "")
                  {
                      var originalDocName = bpm_package.children[0].properties["cm:name"];
                      var mail = actions.create("mail");
                      mail.parameters.to = people.getPerson(taskInstance.actorId).properties["cm:email"];
                      mail.parameters.subject = "Alfresco New Task";
                      mail.parameters.from = "alfresco@alfresco.org";
                      mail.parameters.text =  "Alfresco richiede la tua attenzione! \nL'utente "+person.properties["firstName"]+" "+person.properties["lastName"]+" richiede la tua partecipazione al workflow sul documento "+originalDocName;
                      mail.execute(bpm_package);  
                  }      
              </expression>
              </script>
            </action>
            <script>     
                  if (wf_reviewCycle > 1)taskInstance.description = taskInstance.description + " (" + wf_reviewCycle + ")";
                  if (bpm_workflowDueDate != void) taskInstance.dueDate = bpm_workflowDueDate;
                  if (bpm_workflowPriority != void) taskInstance.priority = bpm_workflowPriority;
            </script>
         </event>
      </task>
      <transition name="approve" to="submitserialreview">
         <script>
            <variable name="wf_approveCount" access="read, write"/>
            <expression>
                wf_approveCount = wf_approveCount + 1;        
            </expression>
         </script>
         <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
              <runas>admin</runas>
              <script>
                <variable name="bpm_package" access="read" />
                <variable name="docNodeRef" access="read, write" />
                <expression>
                    var date = new Date();
                    var originalDocName = bpm_package.children[0].properties["cm:name"];
                    var logFile = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                    var workingCopy = logFile.checkout();
                    workingCopy.content = workingCopy.content + date + " Approved by "+ person.properties["firstName"]+" "+person.properties["lastName"]+"\n";
                    logFile = workingCopy.checkin();
                </expression>
              </script>
         </action> 
      </transition>
      <transition name="reject" to="endreview" />
   </task-node>


   <!–                –>
   <!– End the Review –>
   <!–                –>

   
   <decision name="endreview">
      <transition name="rejected" to="rejected">
      <!–
          <action name="action" class="com.infogroup.action.MessageActionHandler">
              <message>Task rejected!</message>
          </action>
      –>
      </transition>
      <transition to="end" name="to end">
         <condition>#{wf_approveCount == wf_reviewerCount}</condition>
         <!–
         <action name="action" class="com.infogroup.action.WorkflowHandler" />
         –>
      </transition>
   </decision>
      
   <task-node name="rejected">
      <task name="wf:rejectedSerialTask" swimlane="initiator" >
      <event type="task-assign">
            <script>
               if (wf_reviewCycle > 1)
               taskInstance.description = taskInstance.description + " (" + wf_reviewCycle + ")";
            </script>
            <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
              <runas>admin</runas>
              <script>
              <variable name="bpm_package" access="read" />
                <variable name="docNodeRef" access="read, write" />
                <expression>
                  var date = new Date();
                  var originalDocName = bpm_package.children[0].properties["cm:name"];
                  var logFile = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                  var workingCopy = logFile.checkout();
                  workingCopy.content = workingCopy.content + date + " Rejected by "+ person.properties["firstName"]+" "+person.properties["lastName"]+"\n";
                  logFile = workingCopy.checkin();
                </expression>
              </script>
            </action>
      </event>
      </task>
      <transition name="abort" to="end">
          <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
              <runas>admin</runas>
              <script>
                <variable name="bpm_package" access="read" />
                <variable name="docNodeRef" access="read, write" />
                <expression>
                  var date = new Date();
                  var originalDocName = bpm_package.children[0].properties["cm:name"];
                  var logFile = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                  var workingCopy = logFile.checkout();
                  workingCopy.content = workingCopy.content + date + " Task Aborted"+"\n";
                  logFile = workingCopy.checkin();
                </expression>
              </script>
          </action>
      </transition>
      <transition name="resubmit" to="startreview" >
         <!– restart review process (next cycle) –>
         <script>
            <variable name="wf_reviewCycle" access="read,write" />
            <expression>
               wf_reviewCycle = wf_reviewCycle +1;
            </expression>
         </script>
      </transition>
   </task-node>

   <!–                 –>
   <!– End the Process –>
   <!–                 –>

   <end-state name="end"/>

   <event type="process-end">
      <action class="org.alfresco.repo.workflow.jbpm.AlfrescoJavaScript">
              <runas>admin</runas>
              <script>
                <variable name="bpm_package" access="read" />
                <variable name="docNodeRef" access="read, write" />
                <expression>
                  var date = new Date();
                  var originalDocName = bpm_package.children[0].properties["cm:name"];
                  var logFile = docNodeRef.parent.childByNamePath(originalDocName +"_wfhistory.txt");
                  var workingCopy = logFile.checkout();
                  workingCopy.content = workingCopy.content + date + " End Workflow Cycle"+"\n"+"\n";
                  logFile = workingCopy.checkin();
                </expression>
              </script>
          </action>
   </event>

</process-definition>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

In particular in wf:approvedSerialTask task I have used this statement:


mail.parameters.to = people.getPerson(taskInstance.actorId).properties["cm:email"];
‍‍‍

So each time, current user executes this task, will send out email to the next reviewer.
This solution seems work fine. What do you think about?
Thank you very much.

Mirko