Bug 1209494 - Document Human Task parameter
Summary: Document Human Task parameter
Keywords:
Status: CLOSED EOL
Alias: None
Product: JBoss BPMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.0.3
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: CR2
: One-off release
Assignee: Vidya
QA Contact: Lukáš Petrovický
Dawn Eisner
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-04-07 13:37 UTC by Anton Giertli
Modified: 2020-03-27 20:00 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-03-27 20:00:18 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker JBPM-4600 0 Major Open Document Task parameter 2016-11-02 01:56:18 UTC

Description Anton Giertli 2015-04-07 13:37:28 UTC
Document Task Parameters.
1) Human Tasks
Some of them can be set directly through the Web Designer or Eclipse plugin, but some are hidden, and are only known after reading internal implementation of Human Task Handler.
some of them can be found here
https://github.com/droolsjbpm/jbpm/blob/master/jbpm-human-task/jbpm-human-task-workitems/src/main/java/org/jbpm/services/task/wih/util/PeopleAssignmentHelper.java
https://github.com/droolsjbpm/jbpm/blob/master/jbpm-human-task/jbpm-human-task-workitems/src/main/java/org/jbpm/services/task/wih/AbstractHTWorkItemHandler.java
For example - if I want to change the default business administrator value, I need to check PeopleAssignmentHelper.java in order to know what parameter I need to change.
Or - If I want to know who completed the Human Task, I can just map the "ActorId" parameter to some process variable - but again, 'ActorId' parameter value is known only after reading the source codes.
These parameters should be documented for example here:
https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/User_Guide/index.html#sect-User_Task

2) Custom Work item - i.e. Rest / WS - it would be nice to have the list of parameters documented, with the default and allowed values and with some brief description. These work items are supported and they should be easy to use, even without reading the source codes of RestWorkItemHandler..
// update - REST is documented here
http://docs.jboss.org/jbpm/v6.0/repository/Rest/
WS is missing completely.

https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/User_Guide/index.html#sect-Service_repository

Comment 2 Anton Giertli 2015-04-14 09:41:36 UTC
False alarm on those Service tasks, it is documented here
https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/User_Guide/index.html#appe-Service_Tasks

One missing thing about Email task is that user/developer needs to register EmailWorkItemHandler with proper SMTP settings. i.e.

"Email": new
org.jbpm.process.workitem.email.EmailWorkItemHandler("MySMTPHost","MySMTPPort","MyUsername","MyPassword")

Comment 3 Vidya 2015-04-23 06:21:55 UTC
Updated topic "Using User Tasks in Processes" in the development guide.

Since these parameters (mentioned in comment1 - Human Tasks) can't be set via the UI, and need to be set only in the code, hence including these in the development guide and not the user guide. 


The changes can be verified here:

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.1/html-single/Development_Guide/index.html#Using_User_Tasks_in_Processes

Comment 4 Tomas Livora 2015-07-16 14:56:13 UTC
Anton, I have noticed that you filed this BZ against 6.0 documentation, however, the fix is provided just for 6.1. Are you fine with this or do you demand having it in the 6.0 as well? I am not sure what are the rules about editing old documentation.

Comment 5 Anton Giertli 2015-07-20 07:22:42 UTC
Tomas,

I am fine with this content being present only in 6.1 guide.

Anton.

Comment 6 Tomas Livora 2015-07-20 09:10:37 UTC
Only parameters from PeopleAssignmentHelper have been added to the documentation. However, Anton also mentioned there were some in AbstractHTWorkItemHandler. I can see there parameters like NodeName, ParentId, CreatedBy, DueDate and SwimlaneActorId which are not described anywhere. I think that at least CreatedBy and DueDate should be mentioned in the documentation.

EmailWorkItemHandler settings from comment 2 have not been added to the documentation either.

Comment 7 Vidya 2015-07-22 08:42:12 UTC
Hi Tomas,

Can you provide description for NodeName, ParentId, CreatedBy, DueDate and SwimlaneActorId parameters?

Regards,

Vidya

Comment 8 Tomas Livora 2015-09-03 07:39:48 UTC
In fact, I am not 100% sure what exactly each of these parameters means. I think Mauricio can help us to figure it out.

Comment 9 Mauricio Salatino 2015-09-03 14:48:30 UTC
Hi Tomas, Anton, Vidya, 
ParentId is the Task Parent Id, in case that you want to create hierarchical tasks, but it is not used anywhere right now. 
CreatedBy is the user that created the task
DueDate is an expression that allows you to set up when the task should expire. This is only used as a reference for now. 
the SwimlaneActorId is used for Swimlanes, so if you are using Swimlanas in your process definition this field inside the task will be populated. NodeName is the name of the node inside the process. 

HTH


Note You need to log in before you can comment on or make changes to this bug.