This function allows you to provide configuration options which can be displayed by the config app in a unified interface.

To provide configuration options, you must provide a configfeatures link relation.

Determining the configuration options:

The config app queries all registered apps. Afterwards, every registered app is queried with the request /<app name>/ on the base address (i.e.: https://<your base address>/<app name>/) and the request header "Accept: application/hal+json". This searches for the configfeatures link relation. In order for the link relation to be found, the JSON must be structured as follows:

JSON Response

{
  "_links" : {
        ...
    "configfeatures" : {
        "href" : "/<app name>/configfeatures"
    }, 
        ...
  },
  ...
}

If such a link relation exists, the URI specified in the user context under it is invoked with the request method GET and the request header “Accept: application/hal+json“ and the included JSON is interpreted. The JSON that apps must provide in order to offer one or more configuration options must be structured according to the following schema:

JSON Response

{
  "appName": "<app name>",
  "customHeadlines":[
    {
      "caption": "<caption of your configuration option>",
      "description": "<description of your configuration option>",
      "menuItems":[ {
          "caption": "<caption of your first menu item>",
          "description": "<description of your first menu item>",
          "href": "<link to your configuration>",
          "keywords":["<first key word>", "<second key word>", ...],
          "configurationState": <state of your configuration>
        }, 
                <second menu item>,
                ...
      ], 
          "categories":[{
                  "id": "<id of your category>"
            }
          ]
    },
        <second configuration option>,
        ...
  ]
}

The following table describes the categories that can be assigned to an app.

The code below lists examples for the different DTOs, describing the structure of a configfeature. The examples are written in C#.

ConfigFeatureDtos

public class ConfigFeatureDto
{
    public string AppName { get; set; }
    public IList<CustomHeadlineDto> CustomHeadlines { get; set; }
 
    public ConfigFeatureDto()
    {
        CustomHeadlines = new List<CustomHeadlineDto>();
    }
}

public class CustomHeadlineDto
{
    public string Caption { get; set; }
    public string Description { get; set; }
    public IList<MenuItemDto> MenuItems { get; set; }
    public IList<CategoryDto> Categories { get; set; }
 
    public CustomHeadlineDto()
    {
        MenuItems = new List<MenuItemDto>();
        Categories = new List<CategoryDto>();
    }
}

public class MenuItemDto
{
    public string Caption { get; set; }
    public string Description { get; set; }
    public string Href { get; set; }
    public IList<string> Keywords { get; set; }
    public ConfigurationStateDto ConfigurationState { get; set; }
 
    public MenuItemDto()
    {
        Keywords = new List<string>();
    }
}

public class CategoryDto
{
    public string Id { get; set; }
    public string Caption { get; set; }
}

public enum ConfigurationStateDto
{
    Complete = 0,
    Incomplete = 1
}