8.7. Adding New Process and Task Forms
Forms can be used to start a new process and complete a human task. To create a form for a specific process definition, create a template with the name {processId}.ftl. The template itself should use HTML to model the form. For example, com.sample.evaluation.ftl file uses HTML to model the form:
<html> <body> <h2>Start Performance Evaluation</h2> <hr> <form action="complete" method="POST" enctype="multipart/form-data"> Please fill in your username: <input type="text" name="employee" /></BR> <input type="submit" value="Complete"> </form> </body> </html>
Task forms for a specific type of human task (uniquely identified by its task name) can be linked to that human task by creating a template with the name {taskName}.ftl. The form has access to a task parameter that represents the current human task, so the task form can be dynamically adjusted based on the task input. The task parameter is a task model object as defined in the jbpm-human-task module. This allows the task form to be customized based on the description or input data related to that task. For example, the evaluation form shown earlier uses the task parameter to access the description of the task and show that in the task form:
<html> <body> <h2>Employee evaluation</h2> <hr> ${task.descriptions[0].text}<br/> <br/> Please fill in the following evaluation form: <form action="complete" method="POST" enctype="multipart/form-data"> Rate the overall performance: <select name="performance"> <option value="outstanding">Outstanding</option> <option value="exceeding">Exceeding expectations</option> <option value="acceptable">Acceptable</option> <option value="below">Below average</option> </select><br/> <br/> Check any that apply:<br/> <input type="checkbox" name="initiative" value="initiative">Displaying initiative<br/> <input type="checkbox" name="change" value="change">Thriving on change<br/> <input type="checkbox" name="communication" value="communication">Good communication skills<br/> <br/> <input type="submit" value="Complete"> </form> </body> </html>
Task forms also have access to the additional task parameters that might be mapped in the user task node from process variables using parameter mapping. See Section 10.1, “Human Tasks” for more details. These task parameters are also directly accessible inside the task form. For example, to make a task form to review customer requests, the user task node copies the userId (of the customer that performed the request), the comment (the description of the request) and the date (the actual date and time of the request) from the process into the task as task parameters, and these parameters will then be accessible directly in the task form:
<html> <body> <h2>Request Review</h2> <hr> UserId: ${userId} <br/> Description: ${description} <br/> Date: ${date?date} ${date?time} <form action="complete" method="POST" enctype="multipart/form-data"> Comment:<BR/> <textarea cols="50" rows="5" name="comment"></textarea></BR> <input type="submit" name="outcome" value="Accept"> <input type="submit" name="outcome" value="Reject"> </form> </body> </html>
Data that is provided by the user when filling in the task form will be added as result parameters when completing the task. The name of the data element will be used as the name of the result parameter. For example, when completing the first task above, the Map of outcome parameters will include result variables called performance, initiative, change, and communication. The result parameters can be accessed in the related process by mapping these result parameters to process variables using result mapping.
Forms should either be available on the classpath (for example inside a jar in the
jbossas/server/profile/lib
directory or added to the set of sample forms in the jbpm-gwt-form.jar in the jbpm console server war), or the forms can be stored in the JBoss BRMS process repository.