LSPS documentation logo
LSPS Documentation
Installation Documentation

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

Before installing Designer, 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 Designer 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.

Requirements

The Designer 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 Designer 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 Designer

Before you install Designer, 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 Designer, do the following:

  1. Unzip the lsps-designer zip package for your operating system.
  2. 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
  3. Run Designer:

    1. Go to $LSPS_HOME.
    2. Run the lsps-design binary for your platform.
    3. In the Workspace Launcher dialog box, select a workspace folder and click OK.

    If the workspace folder does not exist yet, 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.

Refer to one of the following for further instructions:

  • Quickstart to get a brief introduction to Designer and BPMN
  • Academy to learn how to use Designer 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.

Managing Licenses

LSPS is free for up to 3 users, the admin and processExecutor users excluded. To manage your licenses, refer to the section on license management.

Uninstalling

To uninstall Designer, delete the $LSPS_HOME directory and the related workspace directories.