LSPS documentation logo
LSPS Documentation
Installation Documentation

Only single-user installation is supported, that is, PDS can be installed only on one computer for one user at a time.

Before installing PDS, make sure you have JDK installed. Optionally set the JAVA_HOME environment variable (If not set, you will need to enter the path to your JDK in PDS manually).

Important: If you plan on developing your custom Application User Interface, make sure to meet the requirements of LSPS SDK. Also when deploying LSPS to your own server, make sure to use a supported environment.

You can install PDS either using the zip file or using the install binary with wizard, which will guide you through the installation process. Note that the latter is now deprecated.

Requirements

PDS requires the following:

  • operating systems:
    • Windows
    • Linux
    • Mac OS X
  • Java:
    • Oracle JDK 1.8

      Important: We recommend to run JVM with at least -Xms1024m. However, the requirements of your environment may vary. Test your set up thoroughly.

    • OpenJDK 1.8

      Important: Currently running PDS over OpenJDK with OpenJ9 on Mac OS fails with the following exception: JVMJ9VM015W Initialization error for library j9gc29(2): Failed to instantiate compressed references metadata. 200M requested

      This is probably due to https://github.com/eclipse/openj9/issues/3371 and when run over OpenJDK 1.8 with Hotspot and Oracle JDK 1.8, the issues does not occur.

  • Web browsers (for Application User Interface and Management Console):
    • Mozilla Firefox latest
    • Mozilla Firefox ESR latest
    • Internet Explorer 11, Edge (latest version)
    • Safari 9+
    • Google Chrome latest

Note: If you plan on developing your custom Application User Interface, make sure your environment meets the product requirements.

Installing PDS Enterprise from the zip Package

Before you install PDS, make sure you have the following set up:

  • Properly set up OpenJDK 1.8 or Oracle JDK 1.8.x
  • Properly set up Maven 3.5.0 or later

To install PDS Enterprise, do the following:

  1. Unzip the lsps-designer zip package for your operating system.
  2. Copy the lsps license file to the extracted directory (referred to as LSPS_HOME).
  3. To be able to generate a custom process application:
    1. Extract the lsps-tools-repo zip package with the LSPS repository to your system maven repository, typically ~/.m2/repository/.
    2. Run the designer binary in the extracted lsps-designer folder.
    3. Go to Window > Preferences > Classpath Variables.
    4. Create the M2_REPO variable that points to the folder with the LSPS repository, for example, /home/me/.m2/repository

Installing PDS Enterprise Using Installer

Important: Installer packages are deprecated and will be removed in a future release. Consider using the zip package to install PDS.

Before installing PDS using Installer package Setup-LSPS-Enterprise, make sure you have JDK installed. Optionally set the JAVA_HOME environment variable (If not set, you will need to enter the path to your JDK manually).

To install Living Systems® Process Design Suite, do the following:

  1. Run the Setup-LSPS-Enterprise-$VERSION file.
  2. Select the Java PDS should use. If no Java is available, a Java will be installed automatically.
  3. Follow the installation steps.
  4. Make sure to set as the target install location an empty folder.

The installation wizards installs Living Systems® Process Design Suite on your computer with the Embedded server and optionally the LSPS repository with resources for the Application User Interface so you can develop your custom Process Application.

The settings provided during the installation are stored in the lsps-design-$VERSION.ini file in the LSPS folder.

Launching

To launch the Process Design Suite, do the following:

  1. Go to $LSPS_HOME.
  2. Run the lsps-design binary for your platform.

  3. In the Workspace Launcher dialog box, choose a workspace folder and click OK.

    If the chosen workspace folder does not exist, it will be created. A workspace is a folder, where the resources stored during the session are located. Its content is reflected in the workbench.

    workspace.png
    Workspace Launcher dialog
  4. If you are launching PDS in a new workspace, PDS displays the Welcome page with links to perspectives, documents, and other PDS resources.

Note: The Welcome command is not available, if all perspectives are closed. To activate the Welcome command, open a Process Design Suite perspective: go to Window -> Open Perspective -> Other and in the Open Perspective dialog box, click a Process Design Suite perspective (You can display it at any point from the main menu Help -> Welcome item.

Refer to one of the following for further instruction:

  • Quickstart to get a brief introduction to PDS and BPMN
  • Academy to learn how to use PDS and create BPMN processes
  • Creating Custom Application to learn how to generate and modify the Application User Interface: This guide is intended for developers of custom solutions.

Changing JVM and Maven Properties

To change JVM and Maven properties after you have already installed LSPS, edit the $LSPS_HOME/lsps-design.ini file (on 64-bit architectures $LSPS_HOME/lsps-design_64.ini).

Note: To use your system Java as defined by JAVA_HOME, you can delete the -vm property, since the system Java is used by default.

Renewing License

To renew an expired license, copy the new license file into $LSPS_HOME. On Mac, place the license in $LSPS_HOME/Process Design Suite/Contents/Eclipse/ directory.

Uninstalling

To uninstall Process Design Suite, run the uninstall file:

  • Windows: $LSPS_HOME\uninstall.bat
  • Linux/MacOS: $LSPS_HOME/uninstall or delete the $LSPS_HOME directory

Alternatively, delete the $LSPS_HOME directory and the related workspace directories.