PetriSim is a parametrization and scenario definition tool for Business Process Simulations. It can be used as an intermediary between a process discovery tool and a business process simulator. The user interface allows manual parameter editing and an integrated API provides smooth use experience between process discovery and simulation.
The user interface is represented by:
- StartView
- Model-based Parameters Page
- Scenario Page
- Resource Page
The application is connected to the discovery tool - Simod and the Business Process Simulator - Scylla
Below the software architecture is represented.
Simod integration into PetriSim is still under work and dockerfile needs to be created. Nevertheless a dataconverter has already been created. Please refer for the repository: https://github.com/PetriSim/Simod_converter The data converter takes as an input an .json file and .bpmn file. The dataconverter - which has been written in javaScript - will then translate these two files into a single .json file which will later be used as an input to the PetriSim tool.
The Simod repository (https://github.com/AutomatedProcessImprovement/Simod) contains two projects, Simod and Simod HTTP, which is created by the University of Tartu, Estonia. Simod HTTP is a lightweight web service wrapper around Simod that supports queued job execution.
Simod HTTP README.md section is available here, https://github.com/AutomatedProcessImprovement/Simod#simod-http.
Simod HTTP source code is located here, https://github.com/AutomatedProcessImprovement/Simod/tree/master/src/simod_http.
Docker images are available there, https://hub.docker.com/r/nokal/simod-http/tags or https://hub.docker.com/layers/nokal/simod-http/tu-berlin/images/sha256-2cc67052c748a78c610f619778b119af455d7c5027a983295254f6b7c8d574f6?context=explore
Scylla is an extensible BPMN process simulator which relies on the building blocks of discrete event simulation. For its repo please refer: https://github.com/PetriSim/Scylla-container/edit/main/README.md
Also, please refer the following link for the details of Scylla simulator, API which provides an endpoint to the functionality of this container and a data converter from PetriSim parameters to Scylla global and simulation configuration: https://github.com/PetriSim/Scylla-container
The frontend of our web application has been built using the Javascript library React. We have also utilized the Chakra-UI design framework to ensure a modern look for our website. To facilitate deployment and portability, the frontend has been containerized using Docker.
With Docker Compose, the frontend can be easily connected to different discovery tools and simulators, although currently Simod container has not yet been finished and hence not connected to the frontend. On the other hand, Scylla converter has been finalised but the integration with the front end app is still missing. Instead, we are using a mock server called "backend" which has been written in Javascript and Express to simulate the backend and the API calls between the frontend and the other tools.
To ensure a streamlined development process, we have set up a continuous integration (CI) pipeline with Github Actions. This automates the testing and containerizing of the frontend every time changes are pushed to the Github repository. This ensures that the code is always up-to-date and that any errors are caught early on.
The starting point for the frontend is the App.jsx file, which serves as the entry point to our application. Depending on whether a parameterization session has already been started or not, either the starting page (StartView.jsx) is loaded, or the tool dashboard is displayed. The tool dashboard always consists of two main components: a navigation panel on the left side (Navigation.jsx), and a content display component. The content of the page is loaded dynamically based on the route path, which is defined in the App.jsx file. Additionally, depending on the page being accessed, there is a sidebar on the right side of the screen (EditorSidebar.jsx), which contains input fields for editing the parameters of the page.
The frontend utilizes the browser's localStorage and sessionStorage to store data. The sessionStorage stores information about if a session has already started and which project is currently selected. On the other hand, the localStorage stores all data for each project, including updates of the tool parameters, which are automatically transferred to the localStorage.
In order to run out tool with all related components, we recommend to run it by using docker compose.
❗ Prerequisites:
- Docker installed
- Git installed
-
Make sure that docker is started and running (check at the dashboard)
-
Clone the repository
git clone https://github.com/FuratH/petri-sim-tool.git- Navigate into the project directory
cd petri-sim-tool - Start the docker containers by using docker compose
docker-compose -f docker-compose.yml up -dDocker compose will start the frontend, the discovery tool and the simulator together. Alternatively you can run each docker container separately.
❗ ❗ ❗ As there is currently no discovery tool integrated with our tool, the mocker server supplies a parameter file to the frontend. Please ensure that the backend is running before proceeding. The sample parameter file is located in the file directory of the backend, so there is no need to upload an eventlog or specify the discovery or simulation tool. Simply click on "start new project" and then "start parameterization" to begin.
❗ Prerequisites:
- Git installed
- Npm installed
- Node installed
- Clone git repository
git clone https://github.com/FuratH/petri-sim-tool.git - Go to the project directory
cd petri-sim-tool - run:
npm installIn order to install all packages successfully, it may be necessary to include the --legacy-peer-deps flag.
npm install --legacy-peer-deps- run:
npm start- Frontend takes long time to load: Please be patient, especially the first time, if the page takes a long time to load.
- Dashboard shows data that is not related to the uploaded eventlog: the tool currently ignores the eventlog that is uploaded and uses sample data from the backend
- Make sure all ports that are used in the docker compose file are not used by other programs.
- You can download the docker containers separately and start them:
- Download the frontend:
docker pull ghcr.io/furath/frontend:latest- Download the other tools / backend:
docker pull ghcr.io/furath/backend:latest- Start the frontend:
docker run -dp 3000:3000 ghcr.io/furath/frontend:latest- Start the backend:
docker run -dp 8000:8000 ghcr.io/furath/backend:latest- If you are not able to install the node dependencies with npm install from the root directory, navigate to the backend and frontend directory separately and install them (and start) from there.