cancel
Showing results for 
Search instead for 
Did you mean: 

BPMN Activity 'documentation' element

mlawler
Champ in-the-making
Champ in-the-making
If I have a <userTask> element in my BPMN20.xml process definition, I can add a <documentation> element inside it. Great.

But I cant see how I can do that with other elements such as manualTask.

Why cant a manualTask have some documentation? My app's usage of Activiti would like it 🙂

It looks like the documentation element is parsed into the UserTaskActivity's TaskDefinition object rather than in the ActivityImpl.

The ManualTaskActivity behaviour does not have a TaskDefinition.

Any reason for this?

Can I supply a patch to provide documentation for manualTasks?

What would be the preferred design?

(a) Add a documentation element directly to the ManualTaskActivity and parse it via parseDocumentation() from BpmnParse.parseManualTask()

(b) Add a TaskDefinition to ManualTaskActivity (this smells like a conceptual clash because a ManualTaskActivity is not assignable etc)

or

© Perhaps the documentation element should be refactored out of TaskDefinition to a more common position so that different Activity types can all leverage it.
4 REPLIES 4

jbarrez
Star Contributor
Star Contributor
You are correct, only for user tasks the documentation is parsed. But it should however be parsed for every supported BPMN construct that allows it.

So option C is the best way to go here. I added http://jira.codehaus.org/browse/ACT-224 to implement it.

mlawler
Champ in-the-making
Champ in-the-making
Is this something you'd accept a patch for, or is it something that a Core developer would implement.

Happy to have a crack at it and submit for review.

jbarrez
Star Contributor
Star Contributor
This is certainly something I'd welcome a patch for 🙂

The easiest path forward is to create a Jira, assign it to me and attach the patch to it.

iravanchi
Champ in-the-making
Champ in-the-making
I've changed the whole parser design in my own code, see here:
http://forums.activiti.org/en/viewtopic.php?f=4&t=305

And I'm waiting for Tom to permit me to contribute.
I guess I should make the patch in my new parser too, so either let me know (through this topic) the JIRA issue that has the patch, or wait to patch the new code. Joram's help on what we should do is welcome!

And, out of curiosity, what is your unit test policy in the project? Are you doing TDD?
I mean, should we write unit tests for such changes?