map.apps Integration

Analytics Bundles in map.apps hochladen

Für die Nutzung der service.monitor Analytics Bundles müssen diese in map.apps installiert werden. Folgende Schritte sind für die Installation notwendig:

  1. Loggen Sie sich als Admin im map.apps Manager ein

  2. Wechseln Sie zum Bundles Tab

  3. Klicken Sie das + über der Liste der bereits installierten Bundles

  4. Laden Sie anschließend die service.monitor Analytics Bundles durch Auswahl der Datei [CD-CONTENTS]/software/service.monitor Analytics web/ct-analytics-js-[VERSION].jar hoch

Nach dem Hochladen werden die service.monitor Analytics Bundles in der Liste der installierten Bundles aufgeführt.

Um die Änderungen zu sehen, muss der map.apps Manager im Browser aktualisiert werden.

Konfiguration von map.apps

Für die Nutzung des service.monitor Analytics zum Erfassen und Darstellen von Nutzungsdaten ist es erforderlich, map.apps für die Integration der service.monitor Analytics Webapp und der Logging-Infrastruktur zu konfigurieren. Dafür müssen einige Eigenschaften in der map.apps application.properties Datei geändert werden. Diese befindet sich unter (map.apps) [data.directory.location]/application.properties

Beachten Sie, dass der Pfad des map.apps data.directory unterschiedlich von dem des service.monitor Analytics ist und üblicherweise unter $\{user.home\}/.mapapps zu finden ist.

Nach Änderung der Eigenschaften, muss der Servlet Container neu gestartet oder der Context aktualisiert werden.

application.properties (map.apps)
#### service.monitor Integration
analytics.service.url=/monitor-analytics/resources/usage/log
analytics.message.src=map.apps
analytics.elasticsearch.url=/monitor-analytics/resources/elastic/forward
analytics.management.role=maAdmin
appservice.default.bundles=system,templatelayout,usagelog_restservice

##### Properties for map.apps 4
manager.3x.config.enabled=true
manager.3x.config.viewbundles=usagelog_monitorIntegration,usagelog_management,usagelog_questionsDashboardConfig
manager.3x.config.activetool=usagelog_management

servicemonitor.base.url=/monitor

Beschreibung der Konfigurationseigenschaften

analytics.service.url

http-Endpunkt zum Erfassen von Nutzungsdaten durch die service.monitor Analytics Webapp

Property-Status: neu

Default: <host>/monitor-analytics/resources/usage/log

analytics.message.src

Name der Nachrichtenquelle (für spätere Analysen)

Property-Status: neu

Default: map.apps

analytics.elasticsearch.url

http-Endpunkt für das Abfragen von Log-Events. Um Zugriff auf die durch Elasticsearch erfassten Daten zu erhalten, muss die entsprechende URL konfiguriert werden. Direkte Anfragen an Elasticsearch sind durchaus möglich, jedoch wird dieser Weg nicht empfohlen. Für die Absicherung der erfassten Daten sollte daher die service.monitor Analytics Webapp als Sicherheitslayer genutzt werden.

Property-Status: neu

Default: <host>/monitor-analytics/resources/elastic/forward

analytics.management.role

Dashboards werden durch das map.apps Rollensystem abgesichert, sodass definiert werden muss welche Rolle Zugang erhält. Die folgende Eigenschaft muss dazu konfiguriert werden.

Property-Status: neu

Default: maAdmin

appservice.default.bundles

Das Erfassen der Nutzungsdaten kann für alle map.apps Apps standardmäßig aktiviert werden. Dafür muss eine Liste der entsprechenden Bundles in den application.properties von map.apps angelegt werden, die für jede App automatisch geladen werden, auch wenn diese nicht im allowedBundles-Bereich in der app.json Datei spezifiert sind. Das Hinzufügen des Codes zu den application.properties vereinfacht die einmalige Aktivierung des service.monitor Analytics für mehrere Apps. Dafür wird die appservice.default.bundles Eigenschaft um das benötigte Logging Bundle ergänzt.

Wenn Sie die Eigenschaft appservice.default.bundles um das usagelog_restservice Bundle ergänzt haben, senden nun alle neu angelegten Apps die erfassten Daten an die definierte URL.

Property-Status: warning liegt möglicherweise schon in der Datei vor

Default: system,templatelayout,usagelog_restservice

manager.3x.config.enabled

Wenn Sie map.apps 4 verwenden, werden die Dashboards über die 3.x Manager-Konfiguration angezeigt und definiert.

Property-Status: warning liegt möglicherweise schon in der Datei vor

Default: true

manager.3x.config.viewbundles

Wenn Sie map.apps 4 verwenden, werden die Dashboards über die 3.x Manager-Konfiguration angezeigt und definiert.

Property-Status: warning liegt möglicherweise schon in der Datei vor

Default:

"usagelog_management",
"usagelog_questionsDashboardConfig",
"usagelog_monitorIntegration"
manager.3x.config.activetool

Wenn Sie map.apps 4 verwenden, werden die Dashboards über die 3.x Manager-Konfiguration angezeigt und definiert.

Property-Status: warning liegt möglicherweise schon in der Datei vor

Default: usagelog_management

servicemonitor.base.url

http-Endpunkt zum Aufruf der /monitor-Webapp innerhalb des map.apps Managements

Property-Status: neu

Default: <host>/monitor

Sollte map.apps und service.monitor Analytics nicht auf einem gemeinsamen Host betrieben werden, so stellen Sie bitte sicher, dass der entsprechende Host den allowedProxyUrls in der map.apps application.properties Datei hinzugefügt wird.

Nachdem eine App über die Live-Konfiguration in map.apps bearbeitet und gespeichert wurde, werden die oben aufgeführten Bundles zur app.json Datei hinzugefügt. Werden anschließend die Bundles in den application.properties wieder entfernt, so bleiben diese dennoch in den entsprechenden Apps erhalten.

Beachten Sie auch, dass diese Eigenschaft nur auf Apps angewendet wird, die durch den map.apps App Dienst zur Verfügung gestellt werden und nicht auf solche die im Dateisystem gespeichert sind.

Logging für einzelne Applikationen aktivieren

Stellen Sie sicher, dass in der App, in der Daten erfasst werden sollen, die erforderlichen Bundles hinzugefügt sind; dies geschieht in der Datei app.json. Es ist mindestens ein Bundle mit writer Komponente erforderlich (z.B. das usagelog_restservice bundles).

app.json
{
  "load": {
    "allowedBundles": [
      ...
      "usagelog_restservice"
    ]
  }
  ...
}