Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sap-samples/fsm-scheduling-samples

SAP Field Service Management - artificial intelligence scheduling - reference implementation and tools.
https://github.com/sap-samples/fsm-scheduling-samples

booking-api field-service-management plugins reference-implementation sample sample-code sap-fsm scheduling

Last synced: about 1 month ago
JSON representation

SAP Field Service Management - artificial intelligence scheduling - reference implementation and tools.

Awesome Lists containing this project

README 

        
# SAP Field Service Management - Intelligent Scheduling Samples



[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/fsm-scheduling-samples)](https://api.reuse.software/info/github.com/SAP-samples/fsm-scheduling-samples)



# About this repository



In this repository you will find example code, code snippet and a example scheduling workbench-app application to work with SAP FSM APIs for advanced scheduling use cases and reference implementation for integration scenarios.



## Demo application 



Find a workbench demo here: [demo-application](https://fsm-scheduling-samples.cfapps.eu10.hana.ondemand.com)



# Requirements



to use the examples in this repository you will need a SAP FSM account with admin-role data access with account (id & name) / company (id & name)  / user (id & name) as well as the name of the data-cluster (eu|de|us|au|cn)



to build and run the source code:

- docker 19.x

- nodejs v10.x

- npm v6.9.x



>**NOTE:** We recommend using unix based systems to follow this guide. Note that for OSX and Windows tools might be installed differently.



# Getting started, Download and Installation



Checkout the [how-to.md](./docs/how-to.md) quick guide in the `/docs`-folder.

HTTP requests may be found in ``/workbench/backend/http_requests`` directory. You will need to [set an environment](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html) with with several variables in order to execute the requests. 



## Running pre build docker container locally

```bash

docker run --rm -e PORT=3000 -p 3000:3000 --name fsm-scheduling-samples gausim/fsm-scheduling-samples:latest

```

open http://localhost:3000 in your browser



## Build from source & run workbench-app locally

use the cli the following command in the `/workbench-app`-folder

```bash

cd workbench && ./cli.sh 

```

use commands:

```

r -> run container

b -> build container

d -> deploy

```



# Configuration

- For workbench configuration options see this [readme](./workbench/README.md)-file



# Limitations

- Refer to [constraints and limitations](https://help.sap.com/viewer/fsm_ai/Cloud/en-US/constraints-limitations.html) documentation



# Known Issues

- Maintainers of the project have to observe changes in the DTO Model and make sure the [fsm-sdk dependency is updated](https://github.com/SAP/fsm-sdk/blob/master/src/test/update-dto-versions.ts) accordingly, otherwise the query API will fail. The update in fsm-sdk has to be manually executed.



# Supplements

On top of the workbench application, you can also configure Business Rules to trigger reoptimization and avoid scenarios like overlapping jobs for a Technician. Refer to [business-rules](/business-rules) folder.



# How to obtain support



## Product support

- In case you need further help, check out the [SAP Field Service Management Help Portal](https://help.sap.com/viewer/product/SAP_FIELD_SERVICE_MANAGEMENT/Cloud/en-US) or report and incident in [SAP Support Portal](https://support.sap.com) with the component "CEC-SRV-FSM".



## Technical request 

- [https://developers.sap.com/](https://developers.sap.com) and [email protected]



- Technical questions about code in this repository, please open an issue [here](https://github.com/SAP-samples/fsm-scheduling-samples/issues/new)



## Related documentation 



- [SAP Field Service Management - Product Website](https://www.sap.com/germany/products/field-service-management.html)

- [AI-based Scheduling](https://help.sap.com/viewer/fsm_ai/Cloud/en-US/ai-based-scheduling-overview.html) 

  - [Best Matching Technician](https://help.sap.com/viewer/fsm_ai/Cloud/en-US/best-matching-technician-two-versions.html)

  - [Sample Business Rules for Optimization](https://help.sap.com/viewer/fsm_ai/Cloud/en-US/optimization-business-rules.html)

- [Optimization API](https://eu.coresystems.net/optimization/api/v1/swagger-ui/#/)

- [Service Management API](https://help.sap.com/viewer/fsm_service_api/Cloud/en-US/service-api-overview.html) [Spec](https://app.swaggerhub.com/apis/coresystemsFSM/ServiceManagementAPI) 



# Contributing



Want to contribute? Check out our [contribution](./CONTRIBUTING.md) guide and follow our [code of conduct](./CODE_OF_CONDUCT).



# License

Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.