powered by ASAP

1. What you will learn

In this tutorial you will learn how to use PAKs Workflow Migration commands to migrate workflows to PAK v.1.7.x

2. Prerequisites

  • Roughly 5 minutes

  • The PAK Workflow Executor ( Download )

  • The migration workflow (Download)

3. What changed

3.1. User Input

Before version 1.7.x all user inputs needed to be in a json format, as to correctly work with the engine. That has changed in all places that a user can decide the data used during a workflow. This affects both apps and the constant definition during mapping.

Since version 1.7.x the PAK engine and apps follow the principle: The user gets what they type. Input data doesn’t need to be in json format anymore and what the user types in is also what will be used during Command execution.

For Example that changes how the user would enter a text which starts and ends with quotes:

Before: "\"TextWithQuotes\""

Now: "TextWithQuotes"

More on the rules of user inputs and data transforming can be read here.

This change only affects your workflows when you typed text as json string enclosed with quotes!

3.2. No more BOTH Mappings

When a Command defines an input and output on the same key name it was handled as a BOTH mapping in the BPMN file. Internally in the engine no BOTH mappings exists and they were splitted up into normal READ and WRITE mappings.

Since version 1.7.x BPMN files do not contain any BOTH mappings anymore but every in and output needs to be mapped explicitly. This aligns the BPMN file more to the engine execution.

This change is automatically migrated. Please check your workflows when loading them with the newest Editor version.

3.3. Keys follow Java Convention

The key of inputs and outputs had no constraints on what characters they could contain. From version 1.7.x onwards keys are only allowed to contain characters a to z, numbers, underscores _ and dollar signs $. When trying to type any other character it won’t be typed at all.

The keys are automatically migrated to not contain illegal chars anymore. Please check your workflows when loading them with the newest Editor version.

4. How To Migrate

In the current PAK version 1.7 there are two commands. The first one, „Check Workflow Migration 1_7“, checks if constant keys in a BPMN file are already migrated to version 1.7. The second command, „Migrate Workflow 1_7“, migrates the Workflow file to version 1.7.

We also provide a workflow which can be run, to ease the migration of the workflows.

4.1. Migrate to 1.7.x Workflow

Instead of manually running the commands to migrate your workflow, you can download the migration BPMN here and run it in the Workflow Executor.

The workflow will guide you through the necessary steps to migrate your workflows. The guide here will showcase the workflow, so you can follow along.

4.1.1. Choose Migration Directory

The first thing you are asked, after the workflow starts, is what directory contains the workflows. The workflow will look into this directory and check every workflow inside for a possible migration.

chooseDir

4.1.2. Decide on Migration Cases

Then you are guided through all possible migrations and you can decide if the one mapping from the specific workflow needs to be migrated. With that you can decide if the value is intended as is, or needs to be migrated.

decideMigration

4.1.3. Decide Copying

Before migration you can decide if you want to overwrite the current workflow files. Or if you want to create copies saving the original state.

decideCopy

4.1.4. Finishing

When you reach the end your workflows are migrated! Go check it out and see if everything is to your liking.

workflow

4.2. Check Workflow Migration Command

The „Check Workflow Migration 1_7“ command has one input field which is mandatory. The content of this field must specify the path to a BPMN workflow file or to a directory containing several Workflow files.

check workflow migration input
Figure 1. „Check Workflow Migration 1_7“ command view in Workflow Executor

After executing the command the result of the migration check will be displayed. If the positions key is filled with objects instead of being empty. Then some possible migration positions have been found, meaning that a migration could be needed.

check workflow migration result
Figure 2. Result view of „Check Workflow Migration 1_7“ command
The positions value in detail. Contains location and affected CONSTANT key.
[
	{
		"fileName":"C:\\temp\\OldWorkflow.bpmn",
		"commandKey":"typeToChoose",
		"dataStoreKey":"\"DIRECTORY\""
	}
]

4.3. Migrate Workflow Command

The „Migrate Workflow 1_7“ command has four input fields:

  • Path to workflow file or directory

  • Positions to migrate

    • Can be fetched from the Check Workflow Migration 1_7 beforehand

    • Tells the command what keys in the BPMN file to fix up

  • Checkmark if files should be migrated recursively

    • Only applies when a directory was chosen for the path

    • Default value: „false“

  • MigrationMode for copying or overwriting files during migration

    • Default value: „OVERWRITE“

If „OVERWRITE“ is chosen existing files are updated. Otherwise copies were created and migrated.
migrate workflow input
Figure 3. „Migrate Workflow 1_7“ command view in Workflow Executor

After executing the command the file or directory is migrated.

migrate workflow result
Figure 4. Result view of „Check Workflow Migration 1_7“ command after running the „Migrate Workflow 1_7“ command

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.