powered by ASAP

1. What You Will Learn

In this guide you will learn how to upload and download Workflows using the PAK Editor.

2. Prerequisites

To complete this guide you will need

  • Roughly 15 minutes

  • The PAK Editor ( Download )

3. Defining the Repository

In order to upload/download Workflows with the Editor, you need to add a new Workflow repository.

PAK Editor Push Repo Dialog
Figure 1. Adding a new Workflow repository

The repository content defines what kind of content can be fetched from those repositories. This can either be Commands, Workflows or both.
To make your repository eligible for Workflow resolving, select either Workflows or Commands & Workflows as the repository content, telling the application that those contain Workflows.

4. Looking for Remote Workflows

As soon as your repository changes are saved, the Editor begins looking for all valid Workflows in the Workflow repositories. In order to view all Workflows in your enabled repositories, click on ‚Open Workflow‘ and select the second tab like shown below.

view workflows editor
Figure 2. Viewing all Workflows present in remote repositories

5. Upload Workflow to Remote Repository

To upload a Workflow you first need to create one. Here, we use the Workflow as it was described by the How to Build your First Workflow guide.

After saving the Workflow locally, you are able to upload it to a remote repository. To do this, navigate under File > Upload Workflow .

PAK Editor Open Push Dialog
A Workflow must be saved locally before being eligible for uploading.

5.1. The First Upload

Whenever a Workflow is uploaded for the first time to a remote repository you will be prompted by the dialog below. Fill it out and press the Upload Button to upload your Workflow.

PAK Editor Push First Dialog
Figure 3. The dialog when uploading for the first time
1 You can decide to which repository you want to upload the Workflow to. By default the first one found in the repository list is chosen.
2 You can rename the Workflow before you upload it. Renaming also leads to renaming of the local Workflow file!
3 Each uploaded Workflow must be part of a group. The groups are used to sort and filter the Workflows in the current available Workflow view.
4 To be able to track changes every Workflow will get a version assigned. Every new Workflow starts at 1.0.0 by default.
5 A Version Tag will hinder any future uploads to overwrite the version which was tagged. E.g. when 1.0.0 was has a Version Tag then it cannot be overwritten by an upload anymore.
6 After everything is filled out you can press Upload.

5.2. Updating the Workflow

Whenever you have successfully uploaded a Workflow or when you try to upload one which already exists on the remote repository, the below dialog will open instead.
The dialogs values are preset with the values from the Workflow and cannot be changed anymore. When you did changes locally you can now either overwrite the current remote version or upload a new version.

PAK Editor exists upload
Figure 4. Dialog when Workflow was found on remote repository
1 When you uploaded a Workflow successfully a moment before this green box will show you its success. It is orange when something has gone wrong during uploading.
2 You can still change the repository. Maybe this Workflow already exists on this one but you want to upload it to another? The repository will be automatically chosen to that one which was used to upload the Workflow before.
3 Name, Group and Version are not editable anymore.
4 To increase the version when uploading press the Create new Version button, then the Creating new Version dialog will be opening.
5 To just overwrite the current uploaded version of the Workflow, just press Overwrite and upload it again.
When the remote version you want to update is flagged with the Version Tag, then you cannot overwrite it anymore and you must increase the version instead.

Creating new Version

When a new version shall be created a new dialog opens which allows the editing of the version again. The increment of the version is automatically raised by one. Pressing the Upload new Version button will upload the current Workflow with the new version.

PAK Editor Create New Version
Figure 5. Dialog to increase the version before uploading

6. Download Workflow from Remote Repository

After you have uploaded your Workflows you can share them through the repository and download them to your local system. Either to look what they entail, or to apply changes.

To see where to find the available Workflows read through this part of the guide again.

The Workflows are shown in a tree like structure. Each node of the tree is a part of the group defined when uploading the command.
When selecting a Workflow you have some options how you want to download it.

PAK Editor download view
Figure 6. Dialog when downloading a Workflow
1 You can search for a Workflow. Either by its name or by its group.
2 The elements with the Workflow symbol Workflow Icon to its left side are the available Workflows. Double clicking the name will open a preview of the newest Workflow version in the editor.
3 Refresh the list of Workflows if you want to see newest Workflow versions on the repository. Always do this before opening a Workflow as someone might have uploaded a new version.
4 When selecting a Workflow a new small window opens, telling you properties and available versions of the Workflow.
5 Pressing the download button or double clicking an explicit version, downloads the chosen Workflow to your local machine. You will be asked whereto save the new Workflow.
6 When choosing a version without downloading it, then you can open a preview of that Workflow by pressing the Open button.

7. What to do next?

Now you are able to upload and download Workflows, sharing them and updating them in the future. You may be interested to run the uploaded Workflows from a remote repository. This guide will show you how to do this in the PAK 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.

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.