Grundlagen der Konfigurationsdatei

Als Basis für die smart.finder SDI Benutzeroberfläche dient map.apps. Alle Funktionen, die für die Darstellung von smart.finder SDI im Web-Browser erforderlich sind, sind innerhalb einer App als Bundles in map.apps integriert. Um die Konfiguration von smart.finder SDI anzupassen, sind deshalb Grundkenntnisse in map.apps erforderlich.

Die hier beschriebenen Konfigurationsgrundlagen können für smart.finder SDI in der Standalone Variante angewendet werden, aber auch, falls Sie den smart.finder Client in Kombination mit map.apps betreiben.

Web-Anwendungen auf der Basis von map.apps werden Apps genannt. In map.apps ist es möglich eine beliebige Anzahl von Apps zu erstellen. Diese basieren alle auf einer Menge von Programmmodulen, sogenannten Bundles. smart.finder SDI liefert einige Bundles mit. Diese werden bei der Installation von smart.finder SDI in map.apps installiert und können somit in allen Apps verwendet werden.

Jede App umfasst eine Konfigurationsdatei namens app.json. In ihr legen Sie fest, welche Bundles in die App eingebunden sind und wie diese Bundles konfiguriert sind.

Die Funktionen von smart.finder SDI lassen sich durch Konfiguration in den app.json oder am Backend an die eigenen Wünsche anpassen.

Aufbau

Die Konfigurationsdatei verwendet die JSON-Syntax. Auf der obersten Ebene enthält sie die Abschnitte load und bundles.

load

Die für eine App benötigten Bundles werden im load-Abschnitt unter allowedBundles aufgelistet. Jedem Bundle kann nach dem @-Zeichen noch die gewünschte Version angefügt werden.

"load": {
    "allowedBundles": [
        "<bundlename>@<versionsnummer>",
        "...weitere Bundles"
    ]
}
bundles

In diesem Abschnitt findet die Konfiguration der Bundles statt.

Jedes Bundle besteht in der Regel aus einer oder mehreren Komponenten. Die Eigenschaften konfigurieren Sie für jede Komponente einzeln. Bei nicht definierten Eigenschaften wird — sofern vorhanden — der Standardwert verwendet. Die Bundle-Konfiguration ist in die folgenden Ebenen gegliedert.

"bundles": {
    "<Bundlename>": {
        "<Komponentenname>": {
            "<konfigurierte Eigenschaft>": "<Wert>"
        }
    }
}

In dem folgenden, nicht vollständigen Auszug aus einer app.json werden die Bundles sf_template-main, sf_frontpage und sf_catalog geladen. Außerdem sind für die CardsCatalogConfig-Komponente des sf_catalog-Bundles die Kategorien konfiguriert.

{
  "load": {
    "allowedBundles": [
      "sf_template-main",
      "sf_frontpage",
      "sf_catalog"
    ]
  },
  "bundles": {
    "sf_catalog": {
      "CardsCatalogConfig": {
        "categories": [
          {
            "id": 1,
            "name": "Wasser",
            "value": "wasser"
          },
          {
            "id": 2,
            "name": "Natur",
            "value": "natur"
          }
        ]
      }
    }
  }
}

Bearbeitung

Um eine app.json-Datei zu bearbeiten, gibt es zwei Möglichkeiten.

  • Direkte Bearbeitung der Datei im Dateisystem, wenn Sie smart.finder SDI als eigenständiges Produkt verwenden

  • Bearbeitung über den map.apps Manager, bei einer bereits vorhandenen map.apps-Instanz

Sichern Sie die app.json, bevor Sie Änderungen daran vornehmen.

Im Dateisystem

Wenn Sie smart.finder als eigenständiges Produkt ohne eine vorhandene Installation von map.apps verwenden, ändern Sie die Dateien im Dateisystem. Die Ordner der einzelnen Apps, in denen sich die app.json-Dateien befinden, liegen im Verzeichnis [TOMCAT_HOME]/smartfinder-sdi/js/apps. Sie können diese mit einem gewöhnlichen Texteditor bearbeiten.

Im map.apps Manager

Wenn Sie die Bundles auf einer vorhandenen map.apps-Instanz installiert haben, können Sie die Dateien über den map.apps Manager bearbeiten.

  1. Öffnen Sie den map.apps Manager.
    Dieser ist standardmäßig unter der Adresse https://<yourserver>/mapapps/manager erreichbar.

  2. Klicken Sie im Reiter Apps auf die App, die Sie ändern möchten.

  3. Wählen Sie App-Editor. Es öffnet sich ein Fenster, in dem der Inhalt der app.json angezeigt wird.

  4. Bearbeiten Sie die Datei. Der Editor unterstützt Sie bei der Einhaltung der korrekten Syntax.

  5. Speichern Sie die Datei.

Weitere Informationen zum App-Editor bietet die map.apps Dokumentation.

Dokumentation

Die Dokumentation zu den Konfigurationsmöglichkeiten der einzelnen Bundles erhalten Sie über den folgenden Link:

https://<yourserver>/smartfinder-sdi/resources/jsregistry/root

Die Namen aller smart.finder SDI Bundles beginnen mit dem Kürzel sfsdi_. smart.finder-Bundles beginnen mit dem Kürzel sf_. Das macht es einfacher, sie von den map.apps Standard bundles zu unterscheiden.