topic Re: Workflow custom props update in Alfresco Forum

Workflow custom props update

vincent-kali — Thu, 02 Aug 2018 07:49:21 GMT

Hi all,I'm setting custom properties (defined on startTask model) when starting workflows.I want to update some of these properties after the workflow starts.When trying to update startTask properties:this.services.getWorkflowService().updateTask(startTask.getId(), customProps, null, null);It fails

Re: Workflow custom props update

afaust — Fri, 03 Aug 2018 07:12:46 GMT

You can never update a start task. Start tasks are "pseudo"-tasks - they technically do not exist. Using the Alfresco WorkflowService it is impossible to update workflow properties after a workflow has been started. Any update needs to happen as part of task / execution listeners within the workflow itself, i.e. you can set variables to update in a currently active task, and when that task is complete, a task listener copies the relevant properties into the process instance / execution, where all the workflow properties are stored.

Re: Workflow custom props update

vincent-kali — Fri, 03 Aug 2018 08:56:25 GMT

Thanks Axel for your response

I just want to query all workflow instances and return, for each of them a task status summary. I developped a REST API webscript to do that, but when querying tasks for each workflow instance, performances are catastrophic, that why my idea was to update workflow instance properties (adding a task summary to these properties) to avoid task query on each workflow instance.

Then two questions:

- Would you have any advise to do that ?

- Why task queries performances are so poor ? Known issue ? Misconfiguration on my side ?

Thanks,

Vincent

Re: Workflow custom props update

afaust — Fri, 03 Aug 2018 13:02:14 GMT

You can still have a summary property on the workflow instance - you just need to set it from within the workflow itself using Activti APIs, not using the Alfresco WorkflowService.

I don't know why specifically the task queries would be slow for you - I've never had issues with those myself. You may have a badly optimised database, excessive query conditions, complex user-group relations (in case you are dealing with pooled tasks), or just too many tasks per workflow itself.

Re: Workflow custom props update

vincent-kali — Fri, 03 Aug 2018 13:24:08 GMT

Axel, when you say

"You can still have a summary property on the workflow instance - you just need to set it from within the workflow itself using Activti APIs, not using the Alfresco WorkflowService."

Do you mean I can set and update a process variable with task summary information ?

In this case, how to access this variable from outside the workflow (WebScript) ?

Thanks for clarification..

VIncent

Re: Workflow custom props update

vincent-kali — Mon, 06 Aug 2018 07:17:57 GMT

In particular, could you share an example of 'setting it from within the workflow itself using Activti APIs'

Thanks in advance :

Re: Workflow custom props update

afaust — Mon, 06 Aug 2018 07:34:29 GMT

I shouldn't need to provide examples for this when the core engine and its APIs have been documented quite extensively, i.e. in the User Guide. So when you have a TaskListener / ExecutionListener, all you need to do is use the provided execution to set variables on it. The only thing to keep in mind is that

you need to transform the prefixed QName of a property / association to use '_' instead of ':'
Node references need to be stored as ActivitiScriptNode / ActivitiScriptNodeList
if you want to transfer the value of a variable set on the task (via a form) to an identically named variable on the process, you need to explicity obtain the global execution / process instance via the Activiti RuntimeService
Code snippet: processInstance = execution.getEngineServices().getRuntimeService().createProcessInstanceQuery().processInstanceId(execution.getProcessInstanceId()).singleResult()

Re: Workflow custom props update

vincent-kali — Mon, 06 Aug 2018 07:46:13 GMT

OK thanks Axel. Last thing (to achieve my initial target): could you please confirm that when setting process instance properties this way, these properties will become accessible from Alfresco WorkflowService ?

Re: Workflow custom props update

afaust — Mon, 06 Aug 2018 14:44:04 GMT

They become accesible from the WorkflowService provided they have been defined in the model of the start task, which Alfresco uses to determine which variables get mapped in the API. I usually use a lot of aspects with optional properties for this, set on my start task via mandatory-aspects.

Re: Workflow custom props update

vincent-kali — Mon, 06 Aug 2018 14:49:08 GMT

Great ! I'll test this and post here results. Thanks again.

Re: Workflow custom props update

vincent-kali — Wed, 26 Sep 2018 14:59:11 GMT

Still getting some issues when trying to set process custom properties and get it using worklflow service API.

Following axel recommendations, I did the following:

1) create aspect with optionnal properties and add it as mandatory aspect to process start task model

2) set these properties in ScriptTask / Scriptexecution listeners.

Result observed:

I defined two process listeners (org.alfresco.repo.workflow.activiti.listener.ScriptExecutionListener): one on 'start' event, one on 'end' event.

When setting the custom property by script on start event execution listener, property is set and accessible using workflow service. When setting the property on 'end' event (or from any other ScriptExecutionListener/ScriptTaskListener), the property is not set (or not visilble from workflow service).

Any idea ?

Thanks,

Vincent

Re: Workflow custom props update

vincent-kali — Thu, 27 Dec 2018 09:22:07 GMT

Just to complete this topic: as Axel explained above, any process property can be set from task/process activiti listener and read by workflow service as soon as the property is defined as a process (start task) property.

Listener code:

DelegateExecution execution = task.getExecution();
ProcessInstance processInstance = execution.getEngineServices().getRuntimeService().createProcessInstanceQuery().processInstanceId(execution.getProcessInstanceId()).singleResult();
execution.getEngineServices().getRuntimeService().setVariable(processInstance.getId(), "myPrefix_myProcessVariable", "myValue");

Wf model

...

<type name="myPrefix:submitTask">
<parent>bpm:startTask</parent>

<mandatory-aspects>
<aspect>myPrefix:myAspect</aspect>
</mandatory-aspects>
</type>

.....

<property name="myPrefix:myProcessVariable">
<type>d:text</type>
<mandatory>false</mandatory>
<index enabled="true">
<tokenised>false</tokenised>
<facetable>true</facetable>
</index>
</property>

</properties>
</aspect>

....