1. What you will learn

In this short summary you will get an idea how you can transform the format of PAKs output data.

2. Basics

As mentioned in this summary, the IDataTransformer plays a major role in persisting data in PAK. It can be used to map between a specified output format and JSON, which PAK uses internally. By default, the output format is JSON as well.

3. Signature

Before giving a short example on how the interface should be used, this section describes the signature of the IDataTransformer<T> interface, as well as an overview on which methods have to be implemented.

T convertJSONToScheme(final String json) throws ConversionException;

Converts the given JSON to the desired representation

String convertSchemeToJSON(final T scheme) throws ConversionException;

Converts the specified scheme to JSON

boolean isScheme(final Object bean);

Checks if the given object is of the desired output type

Set<String> getExcludeFromConversion();

Returns a set of class names that are excluded from being serialized, defaults to an empty set

In this context, scheme refers to the output format, that is specified by the transformer.

All methods but getExcludeFromConversion have to be implemented.

4. Usage

This section briefly outlines a few examples demonstrating how the implementing Transformer should be used.

4.1. Data Transformation

Let’s suppose our persistence can only handle data stored in xml. In order to reduce the workload of the IPersistenceService, we implement a custom transformer to handle the conversions.

    "name" : "Max",
    "age" : 33,
    "hobbies" : [
            "name" : "Soccer",
            "id" : 0
            "name" : "Coding",
            "id" : 1
            "name" : "Automating Workflows",
            "id" : 2

Any data passing the persistence will be in the JSON format by default. The persistence service then calls IDataTransformer#convertJSONToScheme(…​) to prepare it for the store operation. In our case the result of this would something like follows.

<person name="Max" age="33">
        <hobby name="Soccer" id="0" />
        <hobby name="Coding" id="1" />
        <hobby name="Automating Workflows" id="2" />

We also need to handle the other way around. In order to prepare our data for PAK (after the find operation), IDataTransformer#convertSchemeToJSON(…​) is called and should result in the JSON above.

The IDataTransformer#isScheme(…​) method is solely responsible for detecting if the given data is already in the desired format, so in our case isScheme(json) = false and isScheme(xml) = true.

4.2. Data Exclusion

Sometimes it may be the case that data cannot be converted to json due to limitations. Should such a case be applicable to your environment, you can also choose to exclude specific class/package names to be converted at all.

All referenced classes have to be available at runtime

If this applies to some of your classes, make sure that your persistence can handle the (de-)serialization of java objects.

5. Default Implementations

  • The de.asap.pak.extra.impl.datatransformer.PakDefaultDataTransformer: Transforms data from and to the PAK data scheme.

  • The de.asap.pak.core.testutils.datatransformer.DataTransfomerImpl: Does not convert any objects at all. Can be used for migrating tests or to simplify
    tests, which write content into the persistence.

  • The de.asap.pak.core.testutils.datatransformer.DataTransformerMock: Helps running tests for IDataTransformer. Will fallback to the methods
    of TestDataTransformer when nothing is explicitly mocked.

  • The de.asap.pak.core.testutils.datatransformer.TestDataTransformer: Provides spy functionality when testing the IDataTransformer.

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.