Suche

Command Meta Reference

This chapter gives an introduction to the command meta of PAK.

1. Glossary

In the following a short glossary is given to clarify the terms used in this chapter.

Term Description

User Task

Describes a command that needs some kind of input from the user, e.g. click a button or choose an item from a list.

2. Command Meta Information

2.1. What is it

The command meta information is JSON file which contains relevant meta information of a Command implementation.

It contains

  • basic information such as name, id, interpreter, version etc.

  • documentation of the command functionality

  • information about the in- and outputs of a command

  • information about its interpreter

2.2. How is it created

The command meta file should be created by its corresponding Command Interpreter. So each of our existing Command Interpreters (Java, Html,Open-API) has the abilities to create CommandMetas and also to execute / interpret them.

The command meta files needs to be packed inside a somelibrary-pakmeta.jar which is basically a zip file which contains als command-meta json files. Here you can download an example of our generic commands package. Extract it as a zip-file and you will have a folder-structure which contains multiple command-meta json files

2.3. How is it used

It is used by multiple core components.

  • Command- Pool/Collector – to initialize the commands and their needed Command Interpreters for the engine

  • Command Interpreter – to map in- and outputs and to execute the command

  • Apps (Editor / Executor) – for building workflows / showing Documentation

3. Fields of Command Meta

The following fields can be defined by the command meta.

Field name Description Example

artifactGroup

Defines the artifact group where the command can be found

de.example.adapter.somekind

artifactName

Defines the artifact name where the command can be found.

somekind-adapter

deprecated

Flag to tell if the command is deprecated and should not be used anymore.

true or false

deprecatedDocu

Tells why the command is deprecated. This can be shown to workflow developers.

Command is deprecated as the api does not support this functionality anymore!

group

Human-readable group name. One maven module usually provides one command group. But this is no law.

Git / Generic / Jenkins / …​

id

Unique command id. Usually a fully qualified name analogous to Java classes.

de.asap.pak.adapter.gitak.commands.CheckModification

interpreter

Java class of the interpreter implementation that can execute this command.

de.asap.pak.jlcint.pakbridge.JavaInterpreter

major
minor
increment

Maven-style command version. Major version should be changed for API breaks, minor version for API enhancements and increment for all other changes (e.g. bugfixes).

1.0.0

mappings

List with datastore variables that are read/written. Including their scope and data type.

[{key = hasModifications,…​},{key = targetFolder,…​}]

name

Language independent name of the command

Git Clone

properties

Additional, interpreter specific properties.

Map of keys and property objects

services

List of services required by the command.

[de.asap.pak.adapter.gitak.IGitService]

userTask

Boolean flag to mark commands as user tasks.

true or false

workflowDocu

Additional documentation for the workflow developer.

This command clones a remote repository to a local target

4. Command Meta – Command Mappings

The command mappings are part of the command meta and contain more information on every datastore variable defined by a command.
Some fields may not be present if their value was not set, e.g. in case no information is present to fill it with.

The following fields are defined for the command mapping.

Field name Description Example

allowedValues

A list of values that the variable is allowed to hold.
Values not part of the allowed values are not accepted and should throw an exception.
An empty list indicates that all values are allowed.

[], [ALL, NONE, A_PART_OF]
or ["Yes","No","Maybe"]

isAllowedValueSuggestion

Boolean-flag that indicates if the given values defined in allowedValues are only meant as a suggestion. This means that
the processor will be less restrictive when processing the command.

true, false

range

Object which defines an inclusive range for numerical mappings.

 
{
  "lowerLimit" : 0,
  "upperLimit" : 100
}

defaultConstant

Default value of the variable for the case no value will be set in the context.

NOTE: This value is not set with Java Commands as the default value is derived from the initialized value in the command itself.

default://uri_to_repo

documentation

A description for the datastore variable to explain what it is for.
Can be shown to a workflow developer.

„The URI is needed to know what instance to clone. Use only github URIs!“

group

The name of the group of the variable.
Only one of the variables within the same group needs to be filled with a value.

Group_For_Uri_Inputs

deprecated

Flag to tell if the mapping is deprecated and should not be used anymore.

true or false

deprecatedDocu

Tells why the mapping is deprecated. This can be shown to workflow developers.

Mapping is deprecated as the api does not support this functionality anymore!

key

Name of the datastore variable.

gitUri

mandatory

Flag that indicates if a value must exist in the datastore before executing the command.

true or false

pattern

A regex to check String values against.
Only values that fulfill the regex are allowed.

^.+World$

patternExample

Examples of Strings allowed by the pattern.
Used for user documentation so they know what is matched by the pattern.

HelloWorld, All Strings ending with World

scope

Determines whether the variable is to be read-only, written or both.

read, write or both

type

Data type of the variable.

string, boolean, integer, decimal, char, array or object

5. Command Meta – Required Services

Commands can require services to function.
These services are also defined in the command meta and have the following property fields.

Field name Description Example

id

Fully qualified name of the class of the service

de.asap.pak.adapter.codebeamer.api.ICodebeamerAdapter

key

The datastore key if the service can be found in the datastore

SavedAdapter

optional

Flag to determine if the service is optional or required. False stands for required and is the default.

true or false

increment

Increment version of the service – increased on bug fix releases

10

major

Major version of the service – increased on non-backward compatible changes

1

minor

Minor version of the service – increased on api extensions

3

name

Custom name of the service

CanDoEverythingAdapter

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.