Start Command Coding Now

Prerequisites

To complete this guide you need

  • Roughly 15 to 30 minutes of your time
  • Installed IDE which supports Java11, Maven or Gradle (for example Intellij)

Download Example Project

  1. Download the example package as Gradle / Maven project
  2. Extract the ZIP as a new folder

Open in IDE

Open your favourite IDE and Import the extracted folder (depending on your download) as Gradle or Maven Project

Develop

Start developing new Commands, the Guides below will hep you out to do so

Build & Run

  1. Build your new Command
    • For maven run: “mvn clean install” in the folder which contains the pom.xml file
    • For gradle run : “gradlew clean build” in the folder which contains the build.gradle file
  2. Install & Open the Workflow Executor
  3. Add your build folder as a Repository to the Command Repostiories of the Worfklow Executor
  4. Run your new Command inside the Workflow Executor

Good to know / Further steps

  • You can also Unit-Test your command inside the IDE (a example is provided inside downloaded zip)
  • Instead of using a local Jar File (inside our Applications) you also can publish your new created commands (inclusive the *.pakmeta.jar) to a maven based online repository (JFrog Artifactoy / Sonatype Nexus). Our Applications can download and execute them at runtime.
  • The additonal pakmeta.jar contains meta details of your created commands as a json-file. The pakmeta.jar is essential when you decide to work with online maven based command repostiories in our apps, so make sure you publish them as well.
  • since Commands may need more complex logic like authentication / json mapping features there are several services provided by the engine which can be injected, for this see the Injectable Services Guide or Service Based Commands Guide