Wie es funktioniert

Vorwort

Diese Webseite ist nicht von der STARFACE GmbH oder einem Unternehmen der SF Technologies Gruppe erstellt. Ersteller und Betreiber dieser Webseite ist der STARFACE Partner 1 Qubit - J.Suing.

Die Idee zu dieser Datenbank ist aus eigener "Verzweiflung" entstanden, da es kaum möglich ist, einen Überblick über die verfügbaren STARFACE Module aller Partner und deren Versionsstände zu behalten. Hat man Module verschiedener Partner im Einsatz, stellt auch das Updaten einen gewissen Arbeitsaufwand dar, da man die entsprechenden Module zunächst herunterladen muss - dazu muss man sie auf der jeweiligen Webseite aber auch erst einmal finden.

Hierbei soll diese Datenbank helfen und folgende Erleichterungen bieten:

Übersicht verfügbarer Module
Übersicht der letzten Aktualisierung
Kurze Beschreibung der Modulfunktion direkt auf dieser Seite
Direkter Link zur Modul-Produktseite auf der Partnerwebseite
Bezugsmöglichkeit mittels Downloadlink, Link zum Anfrageformular oder passende Anfrage-Adresse des Partners

Damit das funktioniert, müssen sich möglichst viele Modul-Entwickler registrieren.

Und damit die Daten immer möglichst aktuell sind, liegt die Pflegeverantwortung beim Entwickler selbst. Dazu legt der Entwickler eine "Datei" mit den unten beschriebenen Modulinformationen auf seinem eigenen Webserver ab, die er jederzeit aktualisieren kann.

Unsere Webseite liest diese Daten mehrmals täglich in die Datenbank ein und stellt die Inhalte auf der Webseite dar.

Hinweis zur Datenbereitstellung

Falls Du keine Möglichkeit hast, die JSON Daten auf einem Webserver bereitzustellen, kannst Du uns eine fertige Datei zur Verfügung stellen, die wir auf unserem Webserver ablegen. Zur Aktualisierung der Daten musst Du dann aber immer eine neue Datei mailen.

Vorgehensweise

Erzeugen einer JSON Datei mit Daten der eigenen Module
Upload der JSON Datei auf den eigenen Webserver o.ä.
- Alternativ können die JSON Daten natürlich auch programmatisch erzeugt und mittels eines öffentlich erreichbaren API Endpunktes o.ä. zur Verfügung gestellt werden
Entwickler Registrierung mit Angabe der URL zu den JSON Daten
Prüfung und Freigabe der Registrierungsdaten durch 1 Qubit Mitarbeiter
Automatisches Einlesen der JSON Daten mittels Cron-Job, ein oder mehrmals täglich

Die Kontrolle (und Pflegeverantwortung) der eigenen Moduldaten liegt komplett beim Entwickler.

JSONBuilder Hilfsprogramm von Fabian Zünd / SI Solutions GmbH

Um die Erstellung der JSON Datei bei vielen Modulen zu erleichtern, hat Fabian Zünd ein kleines Tool entwickelt.
JSONBuilder Download, Programmbeschreibung im STARFACE Forum

JSON Feldbeschreibungen (Stand 26.11.2023)

productID und name sind Pflichtfelder
Nicht benötigte Felder können leer gelassen werden
productID muss pro Entwickler eindeutig sein
Über verschiedene Entwickler darf es Überschneidungen geben
Gleiche productIDs bei einem Entwickler führen zum Überschreiben der Daten - der letzte Eintrag gewinnt

productID [string, 50]: ProductID / Artikelnummer
name [string, 255]: Deutscher Name des Moduls
nameEN [string, 255]: English name of the module
description [string]: Deutsche Kurz-Beschreibung des Moduls (HTML möglich, bitte sparsam benutzen)
descriptionEN [string]: English short description of the module (HTML possible, please use wisely)
keywords [string]: Keywords unter denen der Eintrag in der Liste neben dem Namen noch gefunden werden soll, komma-separiert
keywordsEN [string]: Keywords used to find the module with the searchbar beyond the name, comma-separated
pictureURI [array]: Array von HTTP/S Links zu Produktbildern
pictureURIEN [array]: Array of HTTP/S links to product pictures
language [array]: Array of ISO 639-1 two letter language codes (de,en,fr,...) / Array von zwei-stelligen ISO 639-1 Sprachcodes (de,en,fr,...)
version [string, 50]: Module Versionnumber / Modulversionsnummer
dateUpdated [string]: Date of the last module update (yyyy-mm-dd) / Datum des letzten Modul-Updates (yyyy-mm-dd)
dateFirstReleased [string]: Date of the first release of the module (yyyy-mm-dd) / Datum des erste Release des Moduls (yyyy-mm-dd)
minimumStarfaceVersion [string, 50]: Minimum supported STARFACE version / Minimal unterstützte STARFACE Version
approvedStarfaceVersion [string, 50]: Newest supported STARFACE version / Neueste, unterstützte STARFACE Version
isFree [bool]: Is free of charge or has free option (true/false) / Ist kostenlos oder enthält kostenlose Funktionen (true/false)
hasDemo [bool]: Has demo option (true/false) / Hat Demo Option (true/false)
hasNFR [bool]: Has Not For Resale option for STARFACE partners (true/false) / Hat Not For Resale Option für STARFACE Partner (true/false)
obtainedBy [string, 50]: The way the module can be obtained (download/contactform/mail) / Bezugsmöglichkeit des Moduls (download/contactform/mail)
obtainingURI [string, 255]: URI to the .sfm file (obtainedBy: download) or the contactform (obtainedBy: contactform) or mail address (obtainedBy: mail) / URL zur .sfm Datei (obtainedBy: download) oder einem Kontaktformular (obtainedBy: contactform) oder einer E-Mailadresse (obtainedBy: mail)
productPageURI [string, 255]: URI to the product page on the vendors website / ULR zur Produktseite auf der Hersteller-Webseite

JSON Beispieldaten (Stand 26.11.2023)

[
  {
    "productID": "vd.mod1",
    "name": "Modul 1",
    "nameEN": "Module 1",
    "description": "Hier steht eine Beschreibung",
    "descriptionEN": "This is the description",
    "keywords": "keyword1, keyword2, keyword3",
    "keywordsEN": "keywordEN1, keywordEN2, keywordEN3",
    "pictureURI": ["https://www.domain.tld/modules/pics/mod1-pic1.png"],
    "pictureURIEN": ["https://www.domain.tld/modules/pics_en/mod1-pic1.png"],
    "language": ["de","en"],
    "version": "1.0",
    "dateUpdated": "2023-08-01",
    "dateFirstReleased": "2023-01-01",
    "minimumStarfaceVersion": "6.7.3.11",
    "approvedStarfaceVersion": "8.1.0.5",
    "isFree": "false",
    "hasDemo": "true",
    "hasNFR": "true",
    "obtainedBy": "download",
    "obtainingURI": "https://www.domain.tld/modules/dl/mod1.sfm",
    "productPageURI": "https://www.domain.tld/modules/pages/mod1"
  },
  {
    "productID": "123456",
    "name": "Modul 2",
    "nameEN": "Module 2",
    "description": "Hier steht eine Beschreibung",
    "descriptionEN": "This is the description",
    "keywords": "keyword1, keyword2, keyword3",
    "keywordsEN": "keywordEN1, keywordEN2, keywordEN3",
    "pictureURI": ["https://www.domain.tld/modules/pics/mod2-pic1.png","https://www.domain.tld/modules/pics/mod2-pic2.png"],
    "pictureURIEN": ["https://www.domain.tld/modules/pics_en/mod2-pic1.png","https://www.domain.tld/modules/pics_en/mod2-pic2.png"],
    "language": ["de"],
    "version": "1.0",
    "dateUpdated": "2023-07-01",
    "dateFirstReleased": "2022-12-22",
    "minimumStarfaceVersion": "7.3.1.3",
    "approvedStarfaceVersion": "8.0.0.12",
    "isFree": "true",
    "hasDemo": "false",
    "hasNFR": "false",
    "obtainedBy": "mail",
    "obtainingURI": "modulerequest@domain.tld",
    "productPageURI": "https://www.domain.tld/modules/pages/mod2"
  },
  {
    "productID": "123-mod3",
    "name": "Modul 3",
    "nameEN": "Module 3",
    "description": "Hier steht eine Beschreibung",
    "descriptionEN": "This is the description",
    "keywords": "keyword1, keyword2, keyword3",
    "keywordsEN": "keywordEN1, keywordEN2, keywordEN3",
    "pictureURI": [],
    "pictureURIEN": [],
    "version": "1.0",
    "dateUpdated": "2023-07-01",
    "dateFirstReleased": "2022-12-22",
    "minimumStarfaceVersion": "7.3.1.3",
    "approvedStarfaceVersion": "8.0.0.12",
    "isFree": "false",
    "hasDemo": "false",
    "hasNFR": "false",
    "obtainedBy": "contactform",
    "obtainingURI": "https://www.domain.tld/contactform",
    "productPageURI": "https://www.domain.tld/modules/pages/mod2"
  }
]