Versions Compared

Version Old Version 1 New Version Current
Changes made by

PIPEFORCE

PIPEFORCE

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • You have a valid PIPEFORCE Developer account

  • You have executed all basic tutorials

  • You know how to work with the terminal of your operating system

Info

The local workspace and the CLI tool are considered for advanced users. If you’re new to PIPEFORCE we suggest to skip this tutorial and come back when have learned about the main concepts of PIPEFORCE.

1 - Setup your local environment

At first, before you can setup your local low-code workbench, you have to make sure that you have these local toolings installed on your computer:

...

Info

Tip: If you have already installed these tools by a previously executed tutorial you can skip the full section 1.

Java 8

Open your terminal and verify that you have a Java runtime version >= 1.8 installed:

...

In case you see an output like “command not found” then you probably have no Java environment installed yet. So go to the next step and download and install the environment.

Install Java

If you have not Java runtime yet, follow these steps to download and install:

  1. Go to https://www.java.com/de/download/ and download the latest Java runtime.

  2. Install the downloaded package.

  3. Open a new console window and try out that this command now shows the installed Java version:

  4. Code Block
    $> java -version

    In case the Java version is shown. You’re done.
    Otherwise make sure the java command was added to your path variable.

Visual Studio Code

The VS Code editor will be used to edit configurations for your workflow apps. You can download and install it for free from here:

...

Info

UTF-8 Encoding
Regardless which editor you’re using, it is very important to make sure the editor handles all files with UTF-8 encoding which is the default for Visual Studio Code. You can check this here: Preferences → Settings → file.encoding.

Install YAML editor plugin

Since we will create and edit a lot of configuration files in the YAML format, we recommend you to install the YAML editor plugin in VS Code. With this you will get YAML editor with text completion as shown here:

...

As an alternative you can go to Preferences → Extensions in VS Code and then search for YAML and then click on install on the plugin found:

...

2 - Setup the Command Line Interface (CLI)

In order to create and publish resources like apps, workflows, forms, lists or pipelines in your low-code workspace, we provide a command line tool which simplifies these steps a lot.

Check Java

In order to install this tool, first make sure you have a working Java version installed locally by opening up a terminal window and typing in this command:

...

In case the current Java version is shown, everything is fine. Otherwise you need to install Java first. To do so, please refer to the setup section at the beginning of this guide.

Download and install pipeforce-cli

After you have made sure that Java is installed and runs correctly, you can download the latest version of the cli tool by clicking this link:

...

Finally the PIPEFORCE CLI tool was successfully installed to your home folder $USER_HOME/pipeforce and you can start creating your workflow apps. To do so, see the next steps in this guide.

3 - Open the PIPEFORCE workspace

After successful installation, you can find the PIPEFORCE workspace folder under $USER_HOME/pipeforce whereas $USER_HOME depends on your underlying operating system and username.

...