1. What You Will Learn

After finishing this tutorial you will be able to write your own commands up to command groups, build them and integrate them into the PAK editor.

2. Prerequisites

To complete this guide you need:

  • Roughly 15 minutes (if you want to skip the guide click on the solution)

  • JDK 11+ installed with JAVA_HOME configured appropriately

  • An IDE

  • The PAK-Editor ( Download )

  • Gradle 7.4.2+

3. What is a Command?

A concrete implementation of a task. Commands are elements that are later displayed in the Construction Kit as part of the Palette in the editor.

4. Implementation

For the demonstration of the single steps in this tutorial the IDE IntelliJ is used.

First open your selected IDE and create a new Gradle project with the following configuration:

By adding a sample code you will automatically get the desired folder structure
Figure 1. Gradle-Project Configuration

Then replace the build.gradle file with the following code fragment:

plugins {
    id 'java-library'
    id 'maven-publish'
ext {
    version = '1.0.0'
    pakVersion = '1.5.14'
allprojects {
    project.description = 'Example Commands for PAK' = 'org.example'
    project.version = rootProject.ext.version

    repositories {
        maven {
            name = 'pak-explorer-maven'
            url ''

subprojects {
    apply plugin: 'java-library'
    apply plugin: 'maven-publish'

    compileJava.options.encoding = 'UTF-8'
    sourceCompatibility = 11
    targetCompatibility = 11

    javadoc {
        source = sourceSets.main.allJava
    // Dependencies provided by PAK
    annotationProcessor "de.asap.pak.jlcint:jlcint-processor:${pakVersion}"

    implementation "de.asap.pak.jlcint:jlcint-commandapi:${pakVersion}"
    implementation "de.asap.pak.core:pak-common:${pakVersion}"

    // Extern dependencies
    implementation 'org.slf4j:slf4j-api:1.7.25'
compileJava {
javadoc {
    source = sourceSets.main.allJava
    options.tags = [
            'workflowDocu:cm:Workflow Developer Documentation:'

task metaJar(type: Jar) {
    archiveClassifier = 'pakmeta'
    from sourceSets.main.output
    include 'meta/**'
    include 'entities/**'
    include 'icon/**'

publishing () {
    publications {
        local(MavenPublication) {
            artifactId =

You can verify the successful loading of build.gradle using the Gradle toolbar on the right side. This should look like this:

Figure 2. Gradle-Toolbar

Now we come to the coding of the HelloWorld command. For that you just have to replace the main class with the following class:
package org.example;

import de.asap.pak.jlcint.commandapi.CommandGroup;
import de.asap.pak.jlcint.commandapi.FieldScope;
import de.asap.pak.jlcint.commandapi.JavaCommand;
import de.asap.pak.jlcint.commandapi.Persistent;
import de.asap.pak.jlcint.commandapi.Run;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

 * Sample implementation for a example command that input name and returns a simple output.
 * The @JavaCommand annotation is necessary for the annotation processor to recognize this class as a command.
 * If this is not set, no meta file will be generated!
 * The @CommandGroup annotation is the described name that will be shown as group/cluster in the workflow editor.
 * The @workflowDocu annotation describes what the element of the command is for. For classes it describes their
 * whole purpose and for fields what are possible inputs and why you can do them.

 * @workflowDocu Greets an entered name
public class HelloWorld {

	 * The LoggerFactory is a utility class producing Loggers for various logging APIs
	private static final Logger LOG = LoggerFactory.getLogger(HelloWorld.class);

	 * The @Persistent annotation means that the value is read or saved from the data store. By default, any
	 * persistent variable is mandatory.
	 * This annotation provides many options, which are described in the JavaDoc.

	 * @workflowDocu Enter the name you want to greet
	private String input;

	 * @workflowDocu The greeting
	@Persistent(scope = FieldScope.WRITE_ONLY)
	private String output;

	 * Methods that are annotated with @Run are executed when the task is called.
	public void run() {
        this.output = "Hello " + input;;
Explanations about the individual annotations that can be used for command development can be found in the comments and in the PAK Command Developer Guide

That’s all, our first command is implemented!

In order to use our new developed command we need to create jar out of it and publish it. (In our example we publish it to maven local)

4.1. Publishing the Command Jar-File

Run following cmd command in the root folder of your project

with gradle run gradlew publishToMavenLocal

5. Build a Bpmn Workflow

In order to use our new command in our workflow we need to setup the Commands Repositories for the PAK Editor app.

5.1. Setting Up the Commands

To do so open the menu PreferencesRepositories

Figure 3. Preferences Commands (PAK-Editor)

Select the Folder Button


Select the .m2 folder of your users home and press the Add Button


Save the changes with the Save Changes Button

You can select any folder or directly the created jar-File. We are choosing this option just because we did so above.

After adding the jar file you should be able to refresh the commands at the bottom left and see the following:

Figure 4. HelloWorld-Command

5.2. Build the Workflow

Add the command and an End Node to the workflow


After saving the workflow as „Hello_World.bpmn“ we are basically ready to run this workflow. For this see the Next Steps.

6. Next Steps

This guide covered the building and using a command in the PAK-editor. Now we are ready to run this workflow in our Application

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.