LSPS documentation logo
LSPS Documentation
Generating the LSPS Application

With LSPS SDK installed, you can generate the LSPS Application

Before you generate or import an LSPS Application, make sure you have met the following requirements:

  • Living Systems® Process Suite Enterprise Edition with SDK is installed.

    If you have not installed SDK, reinstall Process Suite with the SDK option selected.

  • Maven and the Maven repository are available.

    You probably have set up the Maven repository as part of the installation.

  • PDS has the M2_REPO classpath variable defined.

    To create and set the M2_REPO variable, go to Window > Preferences; then Java > Build Path > Classpath Variables; click Add and define the M2_REPO variable.

    msrepovar.png
    M2_REPO variable set up
  • The Application User Interface must be built with Oracle JDK 1.8.

The Javadoc API documentation of the LSPS Application is available in the <PDS_HOME>/documentation/apidocs directory and in the newest minor version online.

Generating the LSPS Application from PDS

SDK of the PDS allows you to generate the LSPS Application, which are sources of the Application User Interface that expose its API, an SDK Embedded Server, and build and launch configurations. This setup allows you to modify the sources of the application, run the server, and build and deploy the application on-the-fly.

Important: The SDK Embedded Server with the generated run configuration called <YOURAPP> Embedded Server Launcher; is a different server form the PDS Embedded Server.

To generate the application and resources in PDS, do the following:

  1. Consider using the recommended structure and open your workspace which will hold the LSPS Application in a dedicated folder, for example, java folder to isolate it from your models.
  2. Go to File > New > Other
  3. In the New dialog box, select LSPS Application and click Next.
  4. In the updated dialog, enter the details of your application.
    appdetailsdialog.png
    Application details
    Alternatively, switch to Java perspective and go to New > LSPS Application.
    generatedappsources.png
    Generated application sources
  5. Set up version control over the application folder:
    • Create an initial commit: it will separate your customization from the initial default application. When upgrading to new LSPS, you will apply all commits apart from this initial commit on the new application (refer to Preparing LSPS Upgrade to a New Minor or Major Version).
    • Consider ignoring the .project directories of the java project of the application: These are generated by maven and differ depending on your environment. Note that is not the case for .project directories in modules: these are not generated by maven and must be tracked by your version control system.

The generated application is part of your PDS workspace: It is recommended to remove the workspace directories, create a new workspace in another location, and import the application into this new workspace. Also consider the recommended source structure.

You can customize the application and easily re-build and it on SDK Embedded Server to check the results.

launchingserver.png
Launching SDK Embedded Server with the LSPS Application

Generating the LSPS Application from the Command Line

  1. Create a directory for the application and models on your filesystem (refer to Recommended Structure).
  2. In a directory, create a directory for the application, for example, a java folder to isolate the application from your models.
  3. In the java folder, generate the lsps-app-archetype artifact: To get an example for the maven command, open PDS, go to File > New > Other and locate LSPS application in the popup. Note that the custom archetype is not available in the central maven repo: it is installed into either your local repo or the LSPS maven repo when installing PDS with SDK.
    generatingAppMavenCommand.png
  4. Put the main directory (parent of java) under version control:
    • Create an initial commit: In the future, when you will be migrating to a newer version of the application, you will apply all commits starting from the next commit on the new application version (refer to Preparing LSPS Upgrade to a New Minor or Major Version).
    • Consider ignoring the .project directories of the java project of the application: These are generated by maven and differ depending on your environment. Note that is not the case for .project directories in modules: these are not generated by maven and must be tracked.
  5. In the java/<LSPS_APP>/ directory, generate eclipse resources with mvn eclipse:eclipse.
  6. Import the application to PDS workspace.