powered by ASAP

Suche

1. Summary

This command lets you create a multi form page which the user has to fill out to continue.

2. Examples

CreateFormSCR
Figure 1. The Command

Due to simplicity, the descriptiveText input parameter will be left empty for the examples. By default, it is set to „Please fill out the form below to continue“.

All example images use the Human Task representation of the Workflow Executor.

The labelList input parameter is required and represents each input which will be a text field by default.

2.1. Minimal Command Execution

Example 1. Command execution only using labels
CreateForm1
CreateForm1 2

In the first example we ran the command with the labelList "First Name, Last Name, Email". By default, all inputs will be text field and every input is mandatory. When the user for example fills the form with John, Doe and john@doe.com, the formObject will be written as {"First Name":"John","Last Name":"Doe","Email":"john@doe.com"}.

2.2. Adding Optional Fields

Sometimes not all fields have to be required, to exclude certain fields we can make use of the mandatoryFields parameter, which accepts a list of boolean values.

Example 2. Command execution using an optional input field
CreateForm2
CreateForm2 2

In this example, we made the Email-field optional, this can be done by providing mandatoryFields with "true, true, false", indicating that the first two inputs shall be mandatory, the last one however will be optional. The result can now either be the same as above, or {"First Name":"John","Last Name":"Doe","Email":null}.

2.3. Adding Different Input Types

Only having text inputs will not fit our long-term needs, if we want to include some kind of date, for example the date of expiry, we can use the dataTypes parameter. All available types are text, number, boolean, date, textarea and select (see the table below for more information).

Example 3. Command execution using one non-text input field
CreateForm3 1
CreateForm3 2

In the third example, we substituted Email with Date of Expiry in the label list. To make the input a date chooser we can set dataTypes to "Text, Text, Date". The result will now be written as {"First Name":"John","Last Name":"Doe","Date of Expiry":"2000-06-06T00:00:00.000Z"}.

Available data types are:

DataType Description

text

A normal, one line, text input field.

number

An input field, that only allows numbers (positive and negative) as values. Supplies a button to increase/decrease a number by one.

boolean

A checkbox input.

date

A field to enter a date by typing or selecting a day out of a calendar view.

textarea

A text input with multiple lines and adjustable height.

select[option1,option2,…​]

A drop down menu, where one of the specified options can be selected.

2.4. Setting initial Values

In the parameter initialValues a list of default values can be added to prefill the form. For the example above this parameter could be filled with "John,Doe,2000-06-06T00:00:00.000Z" to produce following prefilled table.
In the previous examples, the user typed "John", "Doe" and the chose date. Now the values are already set, but the user can change them again, if needed.

Example 4. Command execution using initial values
CreateForm4 1
CreateForm4 2

2.5. Customizing the JSON Output

The last parameter we can make use of is the fieldIds variable, which lets us choose the name of the inputs in the resulting JSON object. For instance, we might want to stay conformed to the Java variable naming syntax, so we can transform our JSON to a Java object. When we for example set fieldIds to firstName, lastName, dateOfExpiry, the resulting JSON object will be {"firstName":"John","lastName":"Doe","dateOfExpiry":"2000-06-06T00:00:00.000Z"}.

2.6. A complete Example

We will create a form to ask for a Tea-Time Meeting. We want to know who is coming and how many friends they will bring with them, if they will bring a desert and when they plan on attending. A short introduction and their drink of choice are also required.
We enter the label descriptions into labelList, so the user knows what the input is about. The dataTypes are set to the corresponding inputs and the options we want the „select“ to have are already supplied.
After setting the descriptiveText to our message, we provide the fieldIds to declare the JSON-Keys, under which the values will be saved. We enter initialValues, providing a default-value for certain inputs. Finally, we set the boolean in mandatoryFields to true, where an answer is required.

Example 5. Command execution using all fields and data types
CreateForm5 1
CreateForm5 2

The saved result would then be saved as:

{
	"name":"John Doe",
	"guests" : 2,
	"desert" : true,
	"date":"2024-12-06T00:00:00.000Z",
	"introduction":"Hi, I'm John! I love talking about food and i love baking (especially Apple-Crumble-Pie ;)",
	"drink":"coffee"
}

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.