Informationen zum Software Development Kit
Diese Edition des Software Development Kit ist für die Entwicklung von Modulen gedacht, um beispielsweise einen Prozessor oder eine individuelle Aktion bereitzustellen, welche in der Seitenleiste als Kachel verwendbar ist.
Was kann ich mit dem Software Development Kit machen?
Entwicklung von Modulen
Entwicklung von Datenabfragen Add-Ins
Entwicklung von kleinen Anwendungen, die auf dem Windows-Client ausgeführt werden (Desktop-Erweiterungen)
Entwicklung von Plugins für den Client. Diese können von der Seitenleiste angesteuert werden um die Brücke Service-to-Client zu ermöglichen
Entwicklung von Funktions-Plugins (z.b.: System- und Formatierungsfunktionen)
Entwicklung von Prozessoren
Entwicklung von Aktionen
Entwicklung von Smart Search Add-Ins
Entwicklung von Auslösern
Ich entwickle nicht in .NET - was bietet das Software Development Kit?
Für alle Entwickler, die nicht mit .NET arbeiten, bietet das Software Development Kit keine direkte Komponente an. Dafür unterstützt Sie dieses Dokument dennoch. Es wird nicht nur beschrieben, wie Sie die (Bibliothek) in .NET Anwendungen verwenden, sondern auch, wie Sie Module für das System als Service bereitstellen.
In diesem Dokument erfahren Sie, wie ein Modul als Service definiert werden kann und welche JSON-Objekte die einzelnen Routen empfangen und zurückgegeben müssen.
Komponenten eines Moduls
Ein Modul basiert immer auf einer Die Definition eines Modules, welche festlegt, welche Funktionen ein Modul beinhaltet. Des Weiteren geben Sie alle Bilddateien und Referenzbibliotheken (sofern .NET verwendet wird) in dem Modul mit. Diese werden dann vom System geladen und verwendet.
Aufbau des Modul-Containers
Alle benötigten Komponenten, die Sie im Modul mit ausliefern möchten bzw. müssen, werden in einem einfachen ZIP-Container angegeben. Für den ZIP-Container gibt es einen bestimmten Aufbau, der eingehalten werden muss. Nach liegend ist der Aufbau der ZIP-Containers aufgeführt und beschrieben, welche Inhalte in den einzelnen Dateien und Ordner hinterlegt werden müssen.
Datei/Ordner | Beschreibung |
|---|---|
functions | In diesem Ordner legen Sie alle benötigten Bibliotheken ab, welche von dem Designer oder anderen Diensten, die ein Modul nativ laden können. |
icons | Hier legen Sie die Bilddateien ab, welches Sie in der Definitionsdatei referenzieren. Sie können die Bilddateien in unterschiedlichen Formaten angeben. Wir empfehlen Ihnen grundsätzlich Ihre Icons im GIF- oder PNG-Format zu hinterlegen. Welche Format für die Angaben von Bildern für ein Modul zur Verfügung stehen, können Sie dem Aritkel: Angabe des Bildes für das Modul entnehmen |
languages | In diesem Ordner werden alle Sprachdateien hinterlegt, welche für die Übersetzung vom System verwendet werden sollen. |
references | Verweisen Sie auf Dritt-Anbieter, legen Sie in diesem Ordner die jeweiligen Dateien ab, welche für die Ausführung des Moduls bzw. der einzelnen Funktionen benötigt werden. |
info.json | Diese Datei ist der Kern eines Moduls. Sie beschreibt, welche Funktionen ein Modul ausliefert und wie diese zur Verfügung gestellt werden. |