Angaben von Routen für das Bereitstellen von Dateien

Module können die Anforderung haben, dass Dateien für das Modul bereitgestellt werden müssen und/oder die bestehende Lizenz-Datei für das Modul benötigt wird. Damit das System diese Dateien dem Modul zur Verfügung stellen kann, benötigt es unterschiedliche Methodiken, damit der Designer diese Daten beim Veröffentlichen eines Projektes die benötigten Daten dem Modul zur Verfügung stellen kann.

Damit für ein Modul Dateien bereitgestellt werden können, muss in der Moduldefinitionsdatei der Bereich upload angegeben werden.

{
	"upload": [{
		"function": "LICENSE_UPLOAD",
		"type": "http",
		"http": {
			"method": "POST",
			"url": "https://myservice:10487/api/inspect",
			"request_headers": [{
				"name": "Authorization",
				"value": "Basic [PAR.My Parameter]"
			}]
		}
	}]
}

Das oben aufgeführte JSON-Objekt ist exemplarisch und spiegelt nicht zwingend eine gültige Konfiguration wider.

Wie die einzelnen Kategorien für das Bereitstellen von Dateien aufgebaut sind, wird in den nachstehenden Abschnitten erläutert.

Benötigte Methodiken für das Bereitstellen von Lizenzen

Für ein Modul kann es nötig sein, dass dieses die bestehende Lizenzdatei benötigt um zu validieren, dass das Modul auch lizensiert wurde und ausgeführt werden darf. Damit der Designer beim Veröffentlichen des Projektes die aktuelle Lizenzdatei dem Modul zur Verfügung steht, muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
LICENSE_UPLOAD	Diese Route wird aufgerufen wenn der Designer die Lizenz dem Modul zur Verfügung stellen möchte. Sollte diese Route nicht angegeben worden sein, wird die Lizenz-Datei dem Modul nicht übermittelt und das System geht davon aus, dass das Modul keine Lizenzprüfung besitzt.

Benötigte Methodiken für das Bereitstellen von Lizenzen

In der Konfiguration eines Moduls oder dessen weitere, angebotenen Funktionen können Spracheinträge erzeugt werden. Diese werden vom Designer verwaltet und kann in mit der Verwaltung von Spracheinträgen im Designer übersetzt werden. Damit das Modul diese übersetzten Spracheinträge erhält, muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
LANGUAGE_UPLOAD	Wenn ein Modul Spracheinträge verwaltet, müssen diese dem Modul evtl. zur Verfügung gestellt werden. Mit dieser Kategorie kann dem Designer mitgeteilt werden, dass die generierten Spracheinträge dem Modul zur Verfügung gestellt werden.

Benötigte Methodiken für das Bereitstellen von Dateien

Ein Modul kann in der Konfiguration dem Projekt eigene Dateien hinzufügen. Diese können beispielsweise Hintergrundseiten sein. Dadurch dass das Modul nicht zwingend auf dem gleichen System installiert ist wie der Designer, muss gewährleistet werden, dass das Modul die benötigten Dateien erhält. Um diese Dateien dem Modul bereitzustellen, muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
FILE_UPLOAD	Wenn ein Modul einem Projekt eigene Dateien hinzufügt, können diese in dem Projekt hinterlegt werden. Wenn diese dem Projekt hinterlegt werden, kann mit dieser Kategorie dem Designer mitgeteilt werden, dass die Dateien an diese Route gesendet werden sollen.