LSPS documentation logo
LSPS Documentation
Tasks

Human

User

Task type used to create form-based to-dos. It enables to simultaneously present information to users and to collect their input.

title : String

The title of the generated to-do.

performers : Set<Performer>

Specification of those process performers who can see the generated to-do.

uiDefinition : UIDefinition

Content of the generated to-do.

escalationTimeout : Duration

Deprecated! Use GO-BPMN escalation mechanism (for example throwEscalation() function). Period of time from the start of the task until its escalation. If null, the task never escalates.

issueAction : {Todo : Object}

Closure executed after the to-do is generated. The generated to-do is passed as input parameter of the closure.

navigation : {Set<Todo> : Navigation}

Closure executed after the task is accomplished. The return value of the closure specify where the UI is navigated after submitting the to-do.

Throws:

-"NullParameterError" if mandatory parameter is null.

AddPersonToRole

Adds a person to a role.

person : Person

Person to be added to the role.

role : Role

Role the person is added to. If the role does not exist in the system yet, it is created.

Throws:

-"NullParameterError" if mandatory parameters are not specified.

RemovePersonFromRole

Removes the person from the role.

person : Person

Person that will be removed from the role.

role : Role

Role that the person should be removed from.

Throws:

-"NullParameterError" if mandatory parameters are not specified.

SendEmail

Sends an email. For configuration of the mail server see the implementation of the task.

subject : String

email subject

body : String

email body paragraphs

attachments : Set<File>

attachments

from : String

email address of sender. If not specified, the default (given by application server settings) is used.

recipientsTo : Set<String>

email addresses of recipients TO

recipientsCc : Set<String>

email addresses of recipients CC

recipientsBcc : Set<String>

email addresses of recipients BCC

mime : String

Mime subtype (without text/) e.g plain, html, rtf,...

charset : String

Name of character encoding used for subject and body of e-mail, for instance, “ISO-8859-1”, “UTF-8”, “windows-1250”, etc. If not speci- fied, the default is “UTF-8”. The supported encodings vary between different implementations of the Java 2 platform, see Java docu- mentation for details.