Config API

In diesem Kapitel findest du grundlegende Informationen über die Config API.

Die Config-App sammelt Konfigurationsoptionen anderer d.velop-Apps und stellt diese gesammelt dar. Es werden sowohl benutzerspezifische, als auch administrative Konfigurationsoptionen angezeigt. Konfigurationsoptionen müssen von anderen Apps bereitgestellt werden, sodass diese von der Config-App abgefragt werden können.

Die Config-App ist die zentrale Schnittstelle zu folgenden Funktionalitäten zum Thema Konfiguration anderer Apps:

• Anzeigen von nicht konfigurierten Konfigurationsoptionen
• Anzeigen von allen Konfigurationsoptionen

Die Config-App erfragt andere Apps nach einer Schnittstelle, mit welcher die jeweiligen Konfigurationsoptionen abgefragt werden können. 

Wie diese Schnittstelle aufgebaut sein muss, wird unter Bereitstellen einer Konfigurationsoption beschrieben.

Des Weiteren kannst du einen eigenen Einsprungspunkt auf die Config-App anbieten. 

Dies wird unter (Veraltet) Anzeigen von Konfigurationsoptionen beschrieben.

Mit dieser Funktion kannst du Konfigurationsoptionen bereitstellen, die durch die Config-App gesammelt dargestellt werden. 

Damit du Konfigurationsoptionen bereitstellen kannst, musst du eine Linkrelation configfeatures bereitstellen.

Ermitteln der Konfigurationsoptionen:

Die Config-App fragt alle registrierten Apps ab. Anschließend wird jede registrierte App mit dem Aufruf /<app name>/ auf der Basisadresse (also: https://<your base address>/<app name>/) und dem Anforderungsheader "Accept: application/hal+json" abgefragt. Es wird nach der Linkrelation configfeatures gesucht. Damit die Linkrelation gefunden werden kann, muss das JSON wie folgt aufgebaut sein:

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

Wenn eine solche Linkrelation vorhanden ist, wird die darunter angegebene URI im Benutzerkontext mit der Anforderungsmethode GET und dem Anforderungsheader "Accept: application/hal+json" aufgerufen und das erhaltene JSON ausgewertet. Das JSON, welche Apps bereitstellen müssen, um eine oder mehrere Konfigurationsoptionen anzubieten, muss entsprechend dem nachfolgenden Schema aufgebaut sein:

{
  "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 first category>", 
		  "caption": "<caption of your first category>"
	    }, 
		<second category>, 
		...
	  ]
    },
	<second configuration option>,
	...
  ]
}

Die folgende Tabelle beschreibt die Kategorien, die einer App zugeordnet werden können. 

Im Folgenden sind Beispiele für die verschiedenen DTOs aufgelistet, die den Aufbau eines configfeatures beschreiben. Die Beispiele sind in C# geschrieben.

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

public class CustomHeadlineDto
{
    public string Caption { get; set; }
    public string Description { get; set; }
    public List<MenuItemDto> MenuItems { get; set; }
    public List<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 List<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
}

Diese Funktion ist veraltet und sollte nicht mehr genutzt werden.

Freigegeben: HTML-Seite

Mit dieser Funktion kannst du einen Einsprungspunkt auf die Config-App anbieten. 

Ermitteln der Linkrelation zum Anzeigen der Konfigurationsoptionen

Die URL für ein Repository ist als Linkrelation in der Antwort (Response) der HTTP GET-Anforderung verfügbar.

GET /config/
Accept: application/hal+json

{
	_links: {
		configfeatures: {
			href: "/config/features{?appname}",
			templated: true
		}
	}
}

Angeben von verhaltenssteuernden Parametern

Das Verhalten beim Anzeigen der Konfigurationsoptionen steuerst du mit folgenden Parametern:

Aufrufen der URL für die Konfigurationsoptionen

Wenn du eine URL erzeugt hast, dann kannst du die Ergebnisse wie folgt aufrufen:

GET /config/features?appname=identityprovider
Accept: text/html

Als Ergebnis werden dann alle Konfigurationsoptionen von der Identity Provider-App angezeigt.

Mit dieser Funktion kannst du - aus deiner Konfigurationsoberfläche heraus - deine Konfigurationsoptionen aktualisieren.

Angenommen deine Konfigurationsoption ist in einem fehlerhaften Status, da beispielsweise Verbindungsdaten nicht korrekt sind. In diesem Fall navigiert der Administrator mithilfe der Config-App zur Konfigurationsoberfläche. Nachdem du die Verbindungsdaten korrigiert hast, möchtest du, dass deine Konfigurationsoptionen neu geladen werden.

Neuladen der Konfigurationsoptionen - So geht's

1. Versende ein ResourceEvent über die API der Shell-App.
2. Gib unter Eventname "changed" an. Die übermittelte URI muss der aktuell angezeigten Konfigurationsoption entsprechen.

Informationen über das Senden von RessourceEvents findest du in der API-Dokumentation der Shell-App.

Deine Konfigurationsoptionen werden von der Config-App neu abgerufen.