S-BPM (Modelling), Execution and Store Platform

This is a (modelling), execution and store platform for S-BPM processes, based on microservices powered by Spring Boot. The modelling platform is based on Angular 1, the frontend for the execution and store platform, however, is based on Angular 2+.
Basically, the platform consists of the following modules:

• ServiceDiscovery: Automatic detection of devices and services.
• ConfigurationService: Central repository for configuration files.
• ProcessModelStorage: This is the process repository.
• ProcessEngine: Responsible for the execution of processes, based on Akka.
• EventLogger: Logs events during execution, exports logs in CSV format, manipulates PNML files and transforms manipulated PNML files to OWL files.
• Gateway: Authentication and authorization service and handles the requests of the process execution frontend (GUI).
• Persistence: Hibernate mapping of the database tables.
• ExternalCommunicator: For the support of external projects.
• GUI-Dev: Development project for the Angular 2 execution platform frontend (With some dev tools, with node server backend).
• GUI: Production project for the Angular 2 execution platform frontend (minified, uglified, with Spring Boot backend).
• ModellingPlatform-Dev: Development project for the Angular 1 modelling platform frontend (with node server backend).
• ModellingPlatform: Production project for the Angular 1 modelling platform frontend (with Spring Boot backend).

  A new version of the S-BPM modelling platform is available here.

Further Development - EBUSA AIM17

The project hosted in this repository is a fork of the original project, where the intention was to build a S-BPM Modelling and Execution Platform. This fork however, aims to extend the platform by adding process-store functionality. This should allow for searching, buying, selling, reviewing and executing processes from the store(=market). Furthermore, organizations should be allowed to register and invite employees (as users) to the platform, and to give them different roles and rules.

Tutorial Videos

ModellingPlatform

ExecutionPlatform

Functionalities

Execution

Modelling

Master theses

In this section you will find Master's theses, which provide further information about the project.

• Development of a Microservice-based Architecture for Storing and Executing Subject-oriented Processes (german) by Stefan Stani Link

Setup

Prerequisites

• Java Platform (JDK) 8
• MySQL or Docker (Docker is recommended)

Development only:

• NodeJS for Angular development in GUI-Dev and ModellingPlatform-Dev
• Gulp for Angular development in ModellingPlatform-Dev

Database Settings

For non-docker users:

• Install the mysql database on your machine and start the service.
• Execute following statements to create the schema and the db user in your MySQL database: DB_setup.sql

  For docker users:

• cd into the /Setup/mysql_docker folder of the project
• Make sure that docker is already installed on your machine
• Execute the following command in the /Setup/mysql_docker directory: docker-compose up
  • The command will build a new mysql docker image and start a container which is preconfigured. No further configuration is needed as the database is set-up automatically.
  • Tipp: To truncate the output of docker in the terminal, use the following command: docker-compose up -d

Startup

Start the MySQL database

Non-docker:

1. Ensure that the service is started and up and running. Otherwise start the database service.

   Docker:

2. Check if the newly created docker container named ebusa-mysql is running by using the command docker ps.
3. If the docker container is not running, start it by using the command docker start ebusa-mysql.

   Start all services on Windows

4. Go to Setup/start_windows
5. Execute start.bat
   • Do not execute the start.bat script with administrator privileges, as it will not be able to execute all services.
   • To enable the example processes, execute the start.bat script and choose dev mode. Otherwise you can use the normal mode. Also check the section for further configuration details.

     Start all services on Linux/macOS

     1. Go to Setup/start_unix
     2. Execute the bash script start.sh.
   • NOTE: It is strongly recommended to use /bin/bash and NOT to use a zsh shell as this can cause issues.
     • To change your default shell, you can use the command chsh -s /bin/bash. To change it back to your custom shell, use the same command (i.e. chsh -s /bin/zsh)
   • The script will automatically detect if your machine is running Linux or macOS.
   • If the script cannot be executed due to permission rights, set the execution permission for the start.sh script with the following command: chmod +x start.sh.
   • To enable the example processes, execute the script with the following argument: ./start.sh -dev. Also check the section for further configuration details.

     Execution Platform

6. Start the MySQL Service or Docker Container
7. Go to ServiceDiscovery and run in cmd:
   gradlew bootRun
8. Go to ConfigurationService and run in cmd:
   gradlew bootRun
9. Go to ProcessModelStorage and run in cmd:
   gradlew bootRun
10. Go to ProcessEngine and run in cmd:
    gradlew bootRun
11. Go to Gateway and run in cmd:
    gradlew bootRun
12. Go to ExternalCommunicator and run in cmd:
    gradlew bootRun
13. Go to EventLogger and run in cmd:
    gradlew bootRun
14. Go to GUI and run in cmd:
    gradlew bootRun
15. Go to http://localhost:3000

    Modelling Platform

16. Go to ModellingPlatform and run in cmd:
    gradlew bootRun
17. Go to http://localhost:4000

    Alternative

    If you prefer to run the jar files, without using gradlew:

18. Go to builds
19. run in cmd: java -jar ModellingPlatform-0.0.1-SNAPSHOT.jar
20. Go to http://localhost:4000

GUI-Dev

Just for development purposes, not for production!

1. run in cmd: npm install
2. Go to GUI-Dev and run in cmd: npm start
3. in case of any errors when starting the first time, please stick to the installation guide of ng2-admin
4. Go to http://localhost:3000

ModellingPlatform-Dev

Just for development purposes, not for production!

1. Run npm install -g yo bower grunt-cli gulp && npm install && bower install to install required dependencies.
2. Go to ModellingPlatform-Dev and run in cmd: npm install && bower install
3. Run in cmd: gulp serve
4. Go to http://localhost:3000

   Configuration

Ports

Basically, the following ports are used:

To change the port configuration, change the server port in this file e.g. Gateway: application.properties

Note: If you change the port of the Gateway, make sure to change the restApi configuration in allProcesses.service.ts and to rebuild the GUI-Dev and GUI project according to the guide provide below.

User Configuration

In general, the authentication concept ist based on RBAC. Each user can be assigned to one or more roles. Each role can be assigned to one more rules.

The current *.csv files for the user configuration:

• users.csv
• roles.csv
• rules.csv

Standard configuration:

Development

Enable/Disable Example Processes

For the development process it is possible to activate the creation of example processes in order to avoid the manual creation of them during development and testing. The required steps are explained on page 72 in the master theses. The following steps are describing the steps mentioned in the thesis:

Enabling the Example Processes:

• Change the parameter ippr.insert-examples.enabled to true in the application.properties file found in the directory /ProcessModelStorage/src/main/resources
• Change the parameter spring.jpa.hibernate.ddl-auto to create in the application.properties file found in the directory /ProcessModelStorage/src/main/resources
• Disable the execution of the ConfigurationService microservice to avoid overwriting the configuration file. (See start all services for Windows or Linux/macOS how to do it)

  Disable the Example Processes:

• Change the parameter ippr.insert-examples.enabled to false in the application.properties file found in the directory /ProcessModelStorage/src/main/resources
• Change the parameter spring.jpa.hibernate.ddl-auto to update in the application.properties file found in the directory /ProcessModelStorage/src/main/resources
• Enable the execution of the ConfigurationService microservice. (See start all services for Windows or Linux/macOS how to do it)

  Spring Boot Modules

  Any further development concerning the ServiceDiscovery, the ConfigurationService, the Gateway, the ProcessModelStorage, the ExternalCommunicator or the ProcessEngine can be done directly in java. For further information please use the Spring Boot Documentation

Note: If you do any changes to a module, you have to rebuild it with gradlew build

GUI

Any further development concerning the GUI has to be done in the GUI-Dev module by using typescript and Angular 2. For further information please use the Angular Documentation and the ng2-admin Documentation.

Note: If you do any changes to the GUI-Dev project, you have to update the GUI project afterwards:

1. Go to GUI-Dev and run in cmd: npm run prebuild:prod && npm run build:prod
2. Go to GUI/src/main/resources/public/ and remove of all of its content.
3. Go to GUI-Dev/dist and move all of its content to GUI/src/main/resources/public/.
4. Go to GUI and run gradlew build or gradlew run

   ModellingPlatform

   Any further development concerning the ModellingPlatform has to be done in the ModellingPlatform-Dev module by using javascript and Angular 1.

Note: If you do any changes to the ModellingPlatform-Dev project, you have to update the ModellingPlatform project afterwards:

1. Go to ModellingPlatform-Dev and run in cmd: gulp build
2. Go to ModellingPlatform/src/main/resources/public/ and remove of all of its content.
3. Go to ModellingPlatform-Dev/dist and move all of its content to ModellingPlatform/src/main/resources/public/.
4. Go to ModellingPlatform and run gradlew build or gradlew run
   Note: You can change the appearance of the elements by modify the following file: ui-joint-shape.template.scss

License

MIT License