Java command annotations are used for the developing Java commands in PAK.
This chapter describes the functionality of the @workflowDocu annotation.
It also gives an example of how you can use this annotation in your implementation.
1. Basics
@workflowDocu refers to documentation tags and thus, it is not like the other Java annotations.
It is only usable inside the JavaDoc block of a command class, i.e. before @JavaCommand and command variables, i.e. before @Persistent.
The text written after the @workflowDocu tag is shown to users of the command as additional information.
You should add a short but precise description to the command class and the individual command variables.
This will help the user to understand the usage and functionality more easily.
2. Usage
The following Listing 1 shows the usage of the @workflowDocu tag.
@workflowDocu/**
* @workflowDocu This command gets an element by its id. (1)
*/
@JavaCommand
@CommandGroup("Element")
public class GetElement {
/**
* @workflowDocu Id of the element to fetch (2)
*/
@Persistent
private String id;
[...]
}| 1 | @workflowDocu tag for the command |
| 2 | @workflowDocu tag for a command variable |
Figure 1 shows the user documentation in the PAK BPMN Editor that results by using @workflowDocu.
You can open it by overing over the command.
The user documentation can be accessed in the Workflow Executor as well by clicking/hovering over the small information symbol, see Figure 2.
