MicroApp Konfigurationsparameter
| Inhaltsverzeichnis |
Properties-Datei
Spezifisch für einzelne MicroApps
Zur Konfiguration einer MicroApp kann eine Properties-Datei verwendet werden ([microapp_name].properties). Bei einem automatischen FirstSpirit-Update bleiben die in der Properties-Datei hinterlegten Einstellungen unverändert und werden nicht überschrieben bzw. zurückgesetzt. Dazu muss im Classpath zunächst ein „config“-Verzeichnis erstellt und anschließend eine Datei
/config/[microapp_name].properties
angelegt werden. Bei Verwendung eines Tomcat z. B. im Verzeichnis
${TOMCAT_HOME}/lib Innerhalb dieser Datei können die gewünschten Parameter konfiguriert werden.
Universal für alle MicroApps
Die universale Properties-Datei (cxt-microapps-common.properties) bietet eine zentrale Schnittstelle zur Definition von Parametern, die für alle MicroApps gelten. Dies fördert eine konsistente Konfiguration und erleichtert die Verwaltung gemeinsamer Einstellungen.
Es ist zu beachten, dass falls eine eigene Properties-Datei für eine MicroApp definiert ist, diese eigene Konfiguration den Vorrang hat. Das bedeutet, dass Werte aus der eigenen Properties-Datei die in der universellen Properties-Datei definierten Werte überschreiben.
Parameter für alle MicroApps
Folgende Konfigurationsparemter sind für alle MicroApps zu definieren:
eureka.client.serviceUrl.defaultZone: URL, bei der sich MicroApps an der CXT-Platform mittels Eureka registrieren.
Beispiel:
eureka.client.serviceUrl.defaultZone=http://cxt_eureka:<change-me-eureka-password>@localhost:8080/cxt-platform/eureka/
cxt.platform.oauth.clientSecret: Ein Passwort („client secret“), mit der sich MicroApps an der CXT-Platform authentifizieren.
Beispiel:
cxt.platform.oauth.clientSecret=<change-me-cxt-oauth-client-secret>
cxt.firstspirit-connector.url: URL, über welche MicroApps Informationen zum FirstSpirit-Server von der CXT-Platform erhalten.
Beispiel:
cxt.firstspirit-connector.url=http://localhost:8080/cxt-platform/firstspirit-connector/
cxt.microapps.external-url: Von außen erreichbare URL, die benutzt wird, um die komplette URL von MicroApps zu erstellen.
Beispiel:
cxt.microapps.external-url=<change-me-external-server-url>
cxt.microapp.status-page.enabled: Aktiviert/Deaktiviert die Statusseiten von MicroApps (optional)
Standardwert: false
Beispiel:
cxt.microapp.status-page.enabled=true
Alle diese Parameter können auch in den Konfigurationsdateien der MicroApps definiert werden, aber in der Regel sollten diese nur in der cxt-microapps-common.properties Datei eingetragen sein.
Parameter pro MicroApp
Alle MicroApps können folgende Konfigurationsparemter selbst bestimmen:
eureka.instance.metadata-map.contextTypes: Eine mit Komma separierte Liste an Kontexttypen.
Beispiel:
eureka.instance.metadata-map.contextTypes=template,fragment
eureka.instance.metadata-map.supportedClients: Eine mit Komma separierte Liste an CXT-Clients.
Beispiel:
eureka.instance.metadata-map.contextTypes=fragment-creator,content-creator
eureka.instance.metadata-map.embeddable: Gibt an, ob diese MicroApp in CXT-Clients eingebettet werden kann.
- true (Wird als Standardwert benutzt, wenn der Wert nicht gesetzt ist)
- false
Beispiel:
eureka.instance.metadata-map.embeddable=false
cxt.platform.connection-cleanup-rate: Legt fest, wann die MicroApps ihre FS-Connection schließen (in Minuten).
Standardwert: PT30M (30 Minuten)
Beispiel:
cxt.platform.connection-cleanup-rate=PT30M
eureka.instance.metadata-map.asNonModalDialog: Gibt an, ob eine MicroApp als nicht-blockierender und verschiebbarer Dialog angezeigt werden soll.
- false (Wird als Standardwert benutzt, wenn der Wert nicht gesetzt ist)
- true
Beispiel:
eureka.instance.metadata-map.asNonModalDialog=true
eureka.instance.metadata-map.initNonModalDialogWidth: Gibt die initiale Breite der MicroApp in Pixeln an. Greift nur, wenn eureka.instance.metadata-map.asNonModalDialog den Wert true hat.
Beispiel:
eureka.instance.metadata-map.initNonModalDialogWidth=650
Minimale Beispiel-Konfiguration
cxt-microapps-common.properties
eureka.client.serviceUrl.defaultZone=http://cxt_eureka:<change-me-eureka-password>@localhost:8080/cxt-platform/eureka/
cxt.platform.oauth.clientSecret=<change-me-cxt-oauth-client-secret>
cxt.firstspirit-connector.url=http://localhost:8080/cxt-platform/firstspirit-connector/
cxt.microapps.external-url=<change-me-external-server-url>