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 differs from the other command annotations. Please keep in mind that @workflowDocu is only usable inside the JavaDoc blocks of command classes, i.e.
before @JavaCommand and command variables, i.e. before @Persistent.

It allows the user to understand the syntax of
these commands/parameters in order to use them correctly. The text written after @workflowDocu is stored in the command map as docu and is displayed 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.

1.1. Requirements

Since @workflowDocu is a documentation, there are no dependencies to define. It is only necessary to extend the build.gradle file of the project with a javadoc that allows the @workflowDocu annotation in all classes.

Listing 1. Integration of @workflowDocu via the build.gradle file
javadoc {
    source = sourceSets.main.allJava
    options.tags = [
        'workflowDocu:cm:Workflow Developer Documentation:'

2. Usage

The following three chapters describe the usage of @workflowDocu for in- and output variables as well as on command-level.

2.1. @workflowDocu for input parameters

For input parameters, the block should contain sufficient information about what the command/parameter does.

In addition, it may contain the following elements:

Listing 2. Usage of @workflowDocu for input-variables in combination with other annotations
	 * @workflowDocu The authentication type used to authenticate
        @AllowedValues(values = "REST_BASIC") (1)
        @Persistent(mandatory = false) (2)
	private String authType;
Figure 1. The resulting documentation, using @AllowedValues and @Persistent
  • Syntax information: Concrete specifications for the input which can be defined in annotations like @Persistent or @AllowedValues

    1 @AllowedValues: Marks a field to only allow specific values. This annotation only works when used together with the @Persistent annotation. The field must be of type String or Enum.
    2 @Persistent: When setting @Persistent to mandatory false, the documentation block should be prefixed with „(Optional) „. It should also contain information about the default value that will be used if the user does not provide any input.
Listing 3. Usage of @workflowDocu for input-variables giving an example
	 * @workflowDocu The name of the job that should be started. Build job with this
	 *               name should exist. If job does not exist, a
	 *               {@link RestClientAdapterException} exception will be thrown.
         *               Example: Tests/job/JenkinsAdapterTestBuildJob/ (1)
	private String jobName;
1 Example Input: An example input with the correct format (optional)
Figure 2. The resulting documentation, using an example
Furthermore, formatting such as line breaks can be taken directly from the development environment by using the HTML tag <pre>.
Listing 4. @workflowDocu using the <pre> tag
         * <pre>
	 * @workflowDocu Parameter map for the Jenkins job that will be executed.
	 *               Caution:
	 *               If the build job is not parametrized, the value must be
	 *               null.
	 *               If the build job is parameterized, the parameter map must
	 *               not be null.
	 *               For a parametrized build job the specified map can be empty. In
	 *               this case, the build job will be started with its default
	 *               values.
	 *               A parameter consists of a parameter name (key) and a value
	 *               (value). String, numbers and logic values are supported. Each
	 *               object will be converted to a String using its toString()
	 *               method.
	@Persistent(mandatory = false)
	private Map<String, Object> parameters;
Figure 3. The resulting documentation, using the <pre> tag

2.2. @workflowDocu for output parameters

For output parameters, the block should contain an information about the effect/output of the command

Listing 5. Usage of @workflowDocu for output-variables
	 * @workflowDocu The id of the build job. Can be retrieved with the
	 *               {@link StartBuildJob} command.
	@Persistent(scope = FieldScope.WRITE_ONLY)
	private Integer buildId;
Figure 4. The resulting documentation for output-parameters

2.3. @workflowDocu on Command-level

Listing 6. Usage of @workflowDocu on command-level
 * @workflowDocu This command gets an element by its id.  (1)
public class GetElement {

	 * @workflowDocu Id of the element to fetch (2)
	private String id;


1 @workflowDocu tag for the command
2 @workflowDocu tag for a command variable

Figure 5 shows the user documentation in the PAK BPMN Editor that results by using @workflowDocu.
You can open it by hovering over the command.
The user documentation can be accessed in the Workflow Executor as well by clicking/hovering over the small information symbol.

WorkflowDocu Editor
Figure 5. User documentation in the PAK BPMN Editor
WorkflowDocu Executor
Figure 6. User documentation in the Workflow Executor

Sonatype Nexus

PAK features connectors and commands for Sonatype Nexus. This means the software can directly interact with Nexus repositories for storing and managing artifacts. Through these connectors, PAK can automate tasks like uploading binaries or retrieving dependencies, ensuring efficient artifact management within Nexus.


PAK has connectors and commands for Jenkins. This allows the software to directly communicate with Jenkins servers, enabling the automation of CI/CD (Continuous Integration/Continuous Deployment) tasks. Through these connectors, PAK can trigger builds, fetch build statuses, or manage job configurations, streamlining the CI/CD processes within Jenkins.

Git Hub

PAK possesses connectors and commands for GitHub. This means the software can interface directly with GitHub repositories, facilitating actions like code pushes, pull requests, or issue tracking. Through these connectors, PAK can automate various GitHub operations, enhancing code collaboration and repository management.

Atlassian Confluence

PAK is equipped with connectors and commands for Atlassian Confluence. This enables the software to directly interact with Confluence spaces and pages. Through these connectors, PAK can automate actions such as creating, updating, or retrieving documentation, ensuring efficient content management and collaboration within Confluence.


PAK features connectors and commands for Codebeamer. This allows the software to seamlessly integrate with Codebeamer’s ALM (Application Lifecycle Management) platform. Through these connectors, PAK can automate tasks like issue tracking, test management, or requirements tracing, enhancing the coordination and management of software development processes.

JFrog Artifactory

PAK has connectors and commands for JFrog Artifactory. This means the software can directly interface with Artifactory repositories, enabling actions like artifact storage, retrieval, and management. Through these connectors, PAK can automate tasks such as deploying artifacts or managing repository configurations, streamlining the integration and management of binary artifacts within Artifactory.

Amazon Web Services (AWS)

PAK has connectors and commands for Amazon Web Services (AWS). This means the software possesses specialized interfaces to directly interact with AWS services and execute actions on the AWS platform. Through these connectors, PAK can automate AWS-specific commands, such as launching EC2 instances, managing S3 buckets, or configuring Lambda functions. This allows for efficient integration, management, and automation of AWS resources and services directly from PAK.

Atlassian Jira

PAK features integration tools and capabilities for Atlassian Jira. These tools allow for a direct connection to Jira and the execution of specific actions. Using these integration tools, PAK can automate Jira actions such as adding comments or changing ticket priorities, ensuring seamless handling and coordination of Jira processes.


PAK has connectors and commands for Git. This means it has interfaces to directly communicate with Git and execute actions. Through these connectors, the software can automate Git commands such as retrieving changes or creating branches, enabling efficient integration and management of Git tasks.

Generic Human Tasks

PAK offers you a standard set of commands which require creative input from the user. Enables you to start with automating your workflows, that still need abit of human input.

Generic Commands

PAK offers a standard set of commands giving you the first steps to automate your workflows.

Nexus Maven Command Pool

Nexus is an artifact repository manager for storing binaries, libraries, and artifacts, supporting formats like Maven. Maven, a software project management tool, is based on the Project Object Model (POM) and allows developers to consistently define projects and dependencies. Our Command Pool offers commands for interactions between Maven and Nexus, such as artifact uploads or dependency retrieval.

Artifactory Maven Command Pool

Artifactory allows developers to store, retrieve, and manage binary files and artifacts, providing a
central source for all binaries used in a development process. Apache Maven is a software project
management and comprehension tool that enables developers to consistently describe a project and
its dependencies. Our Command Pool offers a collection of commands used to facilitate interactions
between Maven and Artifactory, such as uploading artifacts or retrieving dependencies.

Open API Command Interpreter

The OpenApi Command Interpreter allows you the automatic parsing of commands from an OpenApi defintion. No additional code needs to be written anymore, just add the address to the definition and our framework does the rest!

Kotlin Command Interpreter

The Kotlin Command Interpreter allows you the parsing and execution of commands within a Kotlin environment to automate various tasks or processes.

Bpmn Interpreter

Workflows come in many shapes and forms. The BPMN (Business Process Model and Notation) Interpreter enables the parsing of worklows defined in the BPMN format into the PAK intern model.

Human Task Interpreter

The Human Task Interpreter allows you the parsing and running of commands within a HTML and Javascript environment. Use this to build commands which need the creative input of a workflow user!

Java Command Interpreter

The Java Command Interpreter allows you the parsing and execution of commands within a Java
environment to automate various tasks or processes.


The heart of the PAK-Framework. Contains the means to run workflows with the PAK engine, but also the possibility to enrich the frameworks interfaces with your own implementations and solutions.

RocksDB Persistence

Data that is generated by a workflow run needs to be saved for short or longer terms. Our solution to the Persistence Interface of the PAK-Framework is to use the high-performance, key-value based RocksDB developed by Facebook.

PAK online

PAK Online is a web based application and provides an Open API based REST API. It enables you to upload workflows and run them periodically or on REST demand.

Command Line App

Run tasks and workflows on the console or as part of a CI/CD Pipeline with our Command Line Interface.

Workflow Editor

With our specially developed editor, a wide variety of workflows can be easily modeled in the wide known BPMN process format.

Workflow Executor

The Workflow Executor is the application to run your workflows. It features a multilingual UI and easy managment of your favorite workflows.


We offer a community website where you can exchange ideas and support each other. For our Pro packages we also offer full support via email.