Skip to content

Latest commit

 

History

History
75 lines (41 loc) · 4.14 KB

README.md

File metadata and controls

75 lines (41 loc) · 4.14 KB
Raw

ExCELL Scheduling Service

The Scheduling API is designed to optimize the route of a trip with multiple stops. It offers three endpoints which follow different purposes:

  • scheduling finds the best fit for a new appointment into a given schedule of existing appointments (JSON array).
  • schedulingcare plans the complete schedules for multiple cars. Therefore, it requires a detailed description (JSON) about different client constraints. The service acts as a wrapper for jsprit by Graphhopper.
  • schedulingpickup is very similar to the care scenario but is designed for pickup and delivery scenarios. The user has to define pickup objects in the JSON input instead of services.

Setup

This web service comes as a SpringBoot application so it's very easy to test it on your local machine. If you run the service from inside a Java IDE a Tomcat server will be launched and you can access the service through a browser via localhost:44434.

Application properties

Internally, the Scheduling Service calls the ExCELL Routing API and includes its results into the appointment planning. The user can set up his/her own Routing Service or use the online version on the ExCELL Developer Portal. The parameter url.routingservice in the application.properties defines which endpoint is used. The URL of the online API is the default setting but it requires a user login which can be configured in the application.properties as well. By default, the token is provided by the ExCELL API Gateway. If user authentification is not required change the parameter of url.routingservice.auth to false.

Build it

The project is using Maven as a build tool and for managing the software dependencies. So in order to build the software you should install Maven on your machine. To create an executable JAR file for your local machine open you favourite shell environment and run:

mvn clean package

This creates a JAR file called tourenplanung-0.0.1-SNAPSHOT.jar. You can change the name in the pom.xml file.

Run it

On your local machine run the JAR with:

java -jar tourenplanung-0.0.1-SNAPSHOT.jar

You might also want to change the server port or the URL to the routing service

java -jar tourenplanung-0.0.1-SNAPSHOT.jar --server.port=44444 --url.routingservice=http://localhost:43434

API Doc

This projects provides a Swagger interface to support the Open API initiative. The Java library Springfox is used to automatically create the swagger UI configuration from annotations in the Java Spring code.

An online version of the scheduling API is available on the ExCELL Developer Portal: Try it out!. You need to sign up first in order to access the services from the portal. Every user receives a token that he/she has to use for authorization for each service.

Developers

  • Stephan Piper (BHS)
  • Felix Kunde (BHS)
  • Oguzhan Uyar (BHS)
  • Maximilian Allies (BHS)

Contact

  • fkunde [at] beuth-hochschule.de

Acknowledgement

The Scheduling Service has been realized within the ExCELL project funded by the Federal Ministry for Economic Affairs and Energy (BMWi) and German Aerospace Center (DLR) - agreement 01MD15001B.

Special Thanks

  • Graphopper Team

Disclaimer

THIS SOFTWARE IS PROVIDED "AS IS" AND "WITH ALL FAULTS." BHS MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE QUALITY, SAFETY OR SUITABILITY OF THE SKRIPTS, EITHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

IN NO EVENT WILL BHS BE LIABLE FOR ANY INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES HOWEVER THEY MAY ARISE AND EVEN IF BHS HAS BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.