Jede Funktion (Prozessor, Aktion, etc.), welche ein Modul ausliefert, sollte Funktionen für die Konfiguration, Analyse und Ausführung anbieten. Diese Bereiche sind in Kategorien untergliedert und werden als Funktion in der Moduldefinitionsdatei adressiert.

{
	"config": [{
		"function": "LOAD",
		"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 Konfiguration, Analyse und Ausführung aufgebaut sind, wird in den nachstehenden Abschnitten erläutert.

Angabe von Konfigurationen für Funktionen

Diese Kategorie wird in jedem Abschnitt für die Funktionen immer als JSON-Objekt config angeben. In diesem JSON-Objekt wird dann mit dem Feld function angegeben, wie die jeweilige Funktion für die Konfiguration angesteuert werden soll.

Mit Funktion ist in diesem Kontext nicht die Funktion des Moduls wie Prozessor, Aktion, etc. gemeint. Hiermit ist gemeint, wie das System beispielsweise das Steuerelement für die Konfiguration laden soll oder welche Methodik verwendet werden soll um die Konfiguration zu speichern.

{
	"config": [{
		"function": "LOAD",
		"type": "...",
		...
	}]
}

Folgende Funktionen müssen in dem JSON-Objekt config angegeben werden:

Funktion	Beschreibung

Funktion	Beschreibung
LOAD	Diese Route wird aufgerufen, wenn der Designer das Steuerelement für die Konfiguration des Elementes benötigt.
SAVE	Diese Route wird aufgerufen, wenn der Designer die Konfiguration für das Element speichern möchte.
UPGRADE	Diese Route wird aufgerufen, wenn der Designer eine Aktualisierung der Konfiguration für das Element benötigt. Diese Methodik wird verwendet, damit eine Modulfunktion die Konfiguration aktualisieren kann wenn sich beispielsweise das Datenmodel zwischen zwei Versionen geändert haben soll.
UPDATE_REFERENCES	Diese Route wird aufgerufen, wenn der Designer eine bestimmte Konfiguration wie kfm. Objekte, Konfigurationsparameter, Datenfelder, etc. verändert um dem Modul mitzuteilen, dass dieses seine Konfiguration aktualisiert.
VALIDATE	Diese Route wird aufgerufen, wenn der Designer die Konfiguration validieren muss.

Unter Umständen kann es sein, dass einige Modulfunktionen (Prozessor, Aktionen, etc.) in dem JSON-Objekt config noch weitere Methodiken unterstützen.

In den nachstehenden Abschnitten sind die jeweiligen Modulfunktionen aufgelistet, die weitere Methodiken für die Konfiguration unterstützen/benötigen.

Benötigte Methodiken für Aktionen

Für die Konfiguration von Aktionen muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_USED_ITEMS	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, welche Elemente von der Funktion referenziert bzw. benötigt werden. Damit kann der Designer ermitteln, ob bestimmte Änderungen an dem Projekt Auswirkungen auf dessen Konfiguration haben könnte.

Benötigte Methodiken für Prozessoren

Für die Konfiguration des Prozessor muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_USED_ITEMS	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, welche Elemente von der Funktion referenziert bzw. benötigt werden. Damit kann der Designer ermitteln, ob bestimmte Änderungen an dem Projekt Auswirkungen auf dessen Konfiguration haben könnte.

Benötigte Methodiken für DataQuery Add-Ins

Für die Konfiguration von Add-Ins für die Datenabfragen muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_ITEMS	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, welche Datenabfragen das Add-In konfiguriert hat und zur Verfügung stellt um diese in anderen Konfigurationsabschnitten im Projekt oder von Modulen wiederzuverwenden.

Benötigte Methodiken für Repository Add-Ins

Für die Konfiguration von Add-Ins für ein Repository muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_ITEMS	Diese Route wird aufgerufen wenn der Designer ermitteln möchte, welche Repository Objekte das Add-In konfiguriert hat und zur Verfügung stellt um diese in anderen Konfigurationsabschnitten im Projekt oder von Modulen wiederzuverwenden.

Benötigte Methodiken für Smart Search Add-Ins

Für die Konfiguration von Add-Ins für Smart Search muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_COLUMNS	Diese Route wird aufgerufen wenn der Designer ermitteln möchte, welche Spalten für ein Suchergebnis von dem Add-In zurückgegeben wird.

Benötigte Methodiken für Desktop-Erweiterungen

Für die Konfiguration von Desktop-Erweiterungen muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_USED_ITEMS	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, welche Elemente von der Funktion referenziert bzw. benötigt werden. Damit kann der Designer ermitteln, ob bestimmte Änderungen an dem Projekt Auswirkungen auf dessen Konfiguration haben könnte.
GET_PROFILES	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, ob die Konfiguration der Desktoperweiterung auf Profile basiert und diese auch einzeln veröffentlicht werden sollen.

Benötigte Methodiken für Desktop-Plugins

Für die Konfiguration von Desktop-Plugins muss in dem Definitionsabschnitt folgende Methodiken zusätzlich hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_USED_ITEMS	Diese Route wird aufgerufen, wenn der Designer ermitteln möchte, welche Elemente von der Funktion referenziert bzw. benötigt werden. Damit kann der Designer ermitteln, ob bestimmte Änderungen an dem Projekt Auswirkungen auf dessen Konfiguration haben könnte.

Angabe von Analysewerkzeugen für Funktionen

Diese Kategorie wird in jedem Abschnitt für die Funktionen immer als JSON-Objekt analytics angeben. In diesem JSON-Objekt wird dann mit dem Feld function angegeben, wie die jeweilige Funktion für die Konfiguration angesteuert werden soll.

{
	"analytics": [{
		"function": "INSPECT",
		"type": "...",
		...
	}]
}

Folgende Funktionen müssen in dem JSON-Objekt config angegeben werden:

Funktion	Beschreibung

Funktion	Beschreibung
COLLECT_REFERENCES	Diese Route wird aufgerufen, wenn der Designer alle Abhängigkeiten, die dieses Element besitzt, benötigt. Das Element muss bei dieser Route alle Abhängigkeiten zu anderen Modulen und Konfigurationselementen zurück liefern.
INSPECT	Diese Route wird aufgerufen, wenn ein Projekt auf Fehler überprüft werden soll.
GENERATE_DOCUMENTATION	Diese Route wird aufgerufen, wenn eine Dokumentation für das Projekt erstellt werden muss.

Informationen wie die Ausführung einer Funktionen durchgeführt werden muss

Diese Kategorie wird in jedem Abschnitt für die Funktionen immer als JSON-Objekt execution angeben. In diesem JSON-Objekt wird dann mit dem Feld function angegeben, wie die jeweilige Funktion für die Konfiguration angesteuert werden soll.

Da jede Modulfunktion eigene Methodiken für die Ausführung besitzen, sind die Adressierungen für die einzelnen Methodiken in den nachfolgenden Abschnitten für die jeweilige Modulfunktion beschrieben.

Benötigte Methodiken für das Ausführen von Aktionen

Für die Ausführen von Aktionen muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
INITIALIZE	Diese Route wird aufgerufen, wenn der Client die Definition für die Seitenleiste lädt und die Aktion in dieser verwendet wird.
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.

Benötigte Methodiken für das Ausführen von Prozessoren

Für die Ausführen von Prozessoren muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiliger Konfiguration testen möchte.
CLEANUP	Diese Route wird immer aufgerufen, wenn eine Prozess erfolgreich durchgelaufen oder fehlgeschlagen ist.
DOWNLOAD	Diese Route wird immer aufgerufen, wenn ein Prozessor die Dateiverwaltung für sich selbst übernimmt.

Benötigte Methodiken für das Testen von Zugangsdaten

Zugangsdaten selbst haben eigentlich keine direkte Ausführung, da die Profile nur die Information der benötigten Daten für einen Login zu dem Zielsystem beinhalten. Dennoch bietet das System an, dass die Zugangsdaten getestet werden können.

Genau für diesen Fall muss folgende Methodik hinzugefügt werden.

Funktion	Beschreibung

Funktion	Beschreibung
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.

Benötigte Methodiken für das Ausführen von DataQuery Add-Ins

Für die Ausführen von Add-Ins für die Datenabfragen muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.

Benötigte Methodiken für das Ausführen von Smart Search Add-Ins

Für die Ausführen von Add-Ins für Smart Search muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.
DOWNLOAD	Diese Route wird aufgerufen, wenn das System einen Eintrag aus dem Suchergebnis herunterladen möchte.
DOWNLOAD_PREVIEW	Diese Route wird aufgerufen, wenn das System einen Vorschau für den Eintrag aus dem Suchergebnis herunterladen möchte.

Benötigte Methodiken für das Ausführen von Desktop-Erweiterungen

Für die Ausführen von Desktop-Erweiterungen müssen in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
INITIALIZE	Diese Route wird aufgerufen, wenn die Desktop-Erweiterung für das ausgewählte Projekt im Client aktiviert und vom Anwender ausgewählt wurde. Mit dieser Methode signalisiert der Client, dass die Desktop-Erweiterung initialisiert werden soll.
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.
SHUTDOWN	Diese Route wird aufgerufen, wenn der Client beendet wird oder der Anwender ein Projekt auswählt, welches die Desktop-Erweiterung nicht aktiviert hat.

Benötigte Methodiken für das Ausführen von Desktop-Plugins

Für die Ausführen von Desktop-Plugins muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
EXECUTE	Diese Route wird aufgerufen, wenn das System die Modulfunktion ausführen soll.

Benötigte Methodiken für das Ausführen von Auslösern

Ein Auslöser stellt eine eigene Anwendung dar und wird vom System selbst nicht zeitgesteuert oder ähnlich angesteuert. Wann und wie ein Auslöser etwas macht, ist von Auslöser selbst abhängig und wird auch von diesem selbst geregelt. Dennoch werden für die Ausführung bestimmte Methodiken benötigt. Dies liegt daran, dass das System die Konfiguration für den Auslöser verwaltet.

Funktion	Beschreibung

Funktion	Beschreibung
RELOAD	Diese Route wird aufgerufen, wenn im Designer die Konfiguration für die Auslöser geändert und bereitgestellt wurde. Damit soll dem Auslöser signalisiert werden, dass dieser eine neue Konfiguration hat und die benötigten Routinen durchlaufen muss um die neuen Einstellungen zu übernehmen.
TEST	Diese Route wird aufgerufen, wenn das System die Modulfunktion mit dessen jeweiligen Konfiguration testen möchte.

Benötigte Methodiken für das Ausführen von Repository Add-Ins

Für die Ausführen von Repository Add-Ins muss in dem Definitionsabschnitt folgende Methodiken hinzugefügt werden:

Funktion	Beschreibung

Funktion	Beschreibung
GET_ITEMS	Diese Route wird aufgerufen, wenn das System alle Einträge aus dem Repostory Add-In beziehen möchte.
GET_ITEM	Diese Route wird aufgerufen, wenn das System eine bestimmten Eintrage aus dem Repostory Add-In beziehen möchte.
DOWNLOAD	Diese Route wird aufgerufen, wenn das System einen Eintrag aus dem Repository Add-In herunterladen möchte.

ACTIWARE.IO

Angabe der Routen für die Konfiguration, Ausführung und Analyse