Suche

1. What You Will Learn

After finishing this tutorial you will be able to create your first simple workflow using the PAK Editor.

2. Prerequisites

To complete this guide you need:

  • Roughly 20 minutes

  • The PAK Bpmn Editor ( Download )

2.1. UI Overview

When starting the PAK Editor for the first time, you will see two buttons on the left-hand side of the window.

  • New BPMN(1): Use this button to create a new empty Workflow

  • Open BPMN(2): Use this button to open an existing Workflow from your local filesystem.

Editor FirstStart
Figure 1. Empty BPMN view

Let’s create a new Workflow by clicking on (1). After creating a new BPMN, the Editor loads all possible commands, control elements and a graphical representation of the workflow.

Editor Explanation
Figure 2. Parts of the editor

The Editor is divided in three sections:

  • Control Elements and Custom Commands Palette: All imported commands, as well as the workflow control elements are available in this section. The specific type and amount of the commands may vary depending on which repositories you have added and enabled under Preferences → Commands.

  • Graphical representation of the workflow: In this section you are able to create your workflow by dragging and dropping commands and control elements here.

  • Analysing Tabs: Here, you are able to analyse your Workflow, edit the Datastore and analyse the usage of the different variable keys in the Workflow.

3. Build the First Workflow

For our first Workflow, we simply want to read a text file on our local filesystem.

After creating a new workflow, only the „Start“ node (2) will exist. This is our entry point for the Workflow.

Editor StartElement
Figure 3. Start element

3.1. Adding the First Command

In order to extend the workflow, click on the start node and select the Command you want to append on the left-hand side. On the Commands palette (1) we can see different Command groups. By clicking on the Generic group, we can see different Commands and subgroups. We need a Command which is able to read a text file. Let’s have a look under File, which contains Commands for generic file operations. The Command „Read File“ (2) is exactly what we need. While hovering over this Command we see a preview (3) of where the Command will be added in the Workflow. The new Command will have a direct connection to the element we marked before. We can also have a look at the explanation of the Command containing its possible in- and output variables (4).

Editor CommandPreview
Figure 4. Command Preview

Finally click on the command name, which will add the Command to the BPMN.

If you don’t see the preview while hovering over the command name, or the command is not directly connected to the entry point, you might have to re-select the „Start“ node.

3.2. Configure the Command

After the Command is added to the Workflow, we can configure the Command by clicking on it. On the right-hand side of the window the Properties of the Command are shown. We now have the opportunity to give the Command a custom name (1), select a specific version (2) and define its input and output parameters.

When no specific version is chosen, the Editor will assume the newest version of the Command.
CommandProperties
Figure 5. Command Properties

Now, we can add the path to a file we want to open. In the command description in Command Preview we have already seen the possible variables of the command. The Command just has one input variable, which needs a path to a file. By clicking on the „Add Input Mapping“ button or the „+“ (3) next to the Input header, we can add this key for the path.

The „Add Output Mapping“ button or the „+“ next to the „Output“ header (8) open the same menu as under Input, but you can only map outputs of the command!

We can now decide which key we want to configure in the corresponding dropdown (4). In our case the pathToFile key should be the only option. After choosing the desired key, we have to choose the mapping type for this parameter.

  • Constant Mapping (5): Provides a hard-coded value for the key in question

  • Key/Datastore Mapping (6): Provides a key to look up in the datastore.

For our scenario we can use the constant mapping and provided the path as a constant String value (7).

For more details, refer to the Basic Mapping Guide.

3.3. Finishing the Workflow

After setting up the necessary Commands, we can see an error on the Dataflow Analysis Tab. The Dataflow Analysis calculates all connections between the commands and control elements. It secures that all keys are mapped correctly and that all paths through the workflow have a start and end.

Editor DFA
Figure 6. Error on the Dataflow Analysis

In order to fix this error, we just need to add an end event in our Workflow.

Select End Event (2) in the workflow control elements section and add the circle anywhere to the Workflow. After adding the event, we need to connect the end event with our Open-File-Command using an Edge (1). You can find the edge in the workflow control elements section as well.

After all elements are connected properly, a check mark (3) appears in the Dataflow Analysis Tab.

Editor FinishedWF
Figure 7. Correct finished workflow
The Dataflow Analysis should be run automatically by default. It is also possible to deactivate the automatic analysis task on WorkflowAnalyse Automatically and analyse the workflow on demand.

4. Saving the Workflow

After adding our end node to the workflow, we are ready to save it. The „*“ symbol on the top of the PAK Editor indicates that the workflow is not saved currently.

Click on FileSave and select a directory to save your Workflow as a .bpmn file.

In order to execute the Workflow, you need a runner application.

5. Summary

In this guide we learned how to build a simple workflow, which executes one command. We have learned how to design the BPMN and adjust the properties of commands.

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.

Jenkins

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.

Codebeamer

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.

Git

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.

Core

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.

Support

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.