Skip to content

iml130/swap-it-dashboard

Repository files navigation

SWAP-IT Dashboard

Architecture


The SWAP-IT Dashboard is a visualization and management tool for an Order Controlled Production. This tool can visualize orders that are described by the Production Flow Description Language (PFDL).

Table of Contents

Features

Order Overview

A compact overview over all active orders, including the latest log messages. Order Overview

Order History

Once an order is finished, it is removed from the order overview, but kept in a seperate list to be still able to view all relevant information.

Order History

Order Creator

Create a new order with customly defined options using the integrated Order Creator. Order Creator

Detailed Order View

Show detailed information about a specific order (either active or finished) in the Order State View. All received logs are listed here. Furthermore, a graphical presentation of the corresponding PFDL program as well as the underlying PFDL code are visible here.

Order State Petri Net

Order State Logs

Detailed Code Visualization

In addition to the static Petri Net view in the order state, a full screen mode for further analysis is also provided. Here, all features from the PFDL VS Code Extension Code Visualization are supported. See the documentation for more information.

Code Visualization

Install

There are some requirements that need to be installed before using the Dashboard:

After installing the requirements, install the included NPM packages via npm install

The SWAP-IT Dashboard uses the code provided by the PFDL VS Code Extension to create and visualize Petri Nets. To enable this, you need to go to the repository's release page, select the latest release and download the bundle.js file provided there. This file needs to be copied to the static/js directory.

After following the steps above, the Dashboard is ready to go!

Usage

To start the Dashboard from VS Code, just select and start the SWAP-IT Dashboard debug script. To run the Dashboard using the command line, execute the following commands:

npm run browserify && python3 application.py

After startup, the server log contains the host address. Now, the Dashboard can be used inside a browser of your choice.

To create orders, log entries or new Petri Net images, a tool like JMeter or Postman is recommended, so dummy requests can be send to the application.

Testing

To test the Dashboard with some examplary requests, run the provided test collection that can be found in the test directory. To load it into Postman, simply click on the "Import" button and select the .json file. The tests can be executed afterwards by clicking the "Run" button in the "Collections" tab.

Release Notes

v0.1.0

  • First release

License

SWAP-IT Dashboard is licensed under the MIT License. See LICENSE for details on the licensing terms.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •