Admin UI Configuration

REST API Configuration

The REST Endpoint for the Frontend application can be configured using a JSON file. That JSON file has to be served at /environments/data-sources/environment-information.json and will be loaded on initial request.

The environment-information.json contains two configurations:

Property

Description

Property

Description

taskanaRestUrl

The root path of the REST Service. Please note that you have append /api . Otherwise the Frontend application will not find the REST Service.

taskanaLogoutUrl

The location a user is redirected to when a logout is triggered.

The default environment-information.json file can be found in our GitHub repository.

UI Customization

Some TASKANA UI elements, such as custom properties, can be configured using a JSON file. That json file has to be served at /environments/data-sources/taskana-customization.json and will be loaded on initial request.

The default taskana-customization.json will be found in our GitHub repository.

If you have any questions regarding the UI Customization, please don’t hesitate to contact us.

How to serve configuration files

There are multiple ways to serve these configuration files. Our example project showcases two:

  1. Using the /static folder in order to serve a static file.

  2. Using a REST Controller in order to serve a static file.

 

Our example project serves the environment-information.json using the /static folder. Here is a link to the repository: https://github.com/Taskana/taskana/tree/master/rest/taskana-rest-spring-example-common/src/main/resources/static/environments/data-sources

In our example the taskana-customization.json is served via a REST Controller. This allows further customization. E.g. Based on some environment properties you can serve a different taskana-customization.json. This can be done programmatically within the REST Controller.