Konfigurieren von ContextHub

ContextHub ist ein Framework zum Speichern, Ändern und Darstellen von Kontextdaten. Weitere Informationen zu ContextHub finden Sie unter Entwicklerdokumentation. In der Touch-optimierten Benutzeroberfläche wird Client Context durch ContextHub ersetzt.

Sie können die ContextHub-Symbolleiste konfigurieren, um unter Verwendung der Touch-optimierten Benutzeroberfläche zu steuern, ob sie im Vorschaumodus angezeigt wird, ContextHub-Stores zu erstellen und UI-Module hinzuzufügen.

Deaktivieren von ContextHub

In einer AEM-Installation ist ContextHub standardmäßig aktiviert. ContextHub kann deaktiviert werden, um zu verhindern, dass js/css geladen und initialisiert wird.

• Verwenden Sie dazu CRXDE Lite, um die Eigenschaft disabled unter /libs/settings/cloudsettings/legacy/contexthub auf true festzulegen.

Ein- und Ausblenden der ContextHub-Benutzeroberfläche

Konfigurieren Sie den Adobe Granite ContextHub-OSGi-Service, um die ContextHub-Benutzeroberfläche auf Ihren Seiten ein- oder auszublenden. Die PID dieses Service lautet com.adobe.granite.contexthub.impl.ContextHubImpl..

Der Service kann entweder mithilfe der Web-Konsole oder mit einem JCR-Knoten im Repository konfiguriert werden:

• Web-Konsole: Um die Benutzeroberfläche anzuzeigen, wählen Sie die Eigenschaft „Benutzeroberfläche anzeigen“ aus. Um die Benutzeroberfläche auszublenden, heben Sie die Auswahl dieser Eigenschaft aus.
• JCR-Knoten: Legen Sie die boolesche Eigenschaft com.adobe.granite.contexthub.show_ui auf true fest, um die Benutzeroberfläche anzuzeigen. Legen Sie die Eigenschaft auf false fest, um die Benutzeroberfläche auszublenden.

Wenn die ContextHub-Benutzeroberfläche angezeigt wird, erscheint sie nur auf den Seiten von AEM-Authoring-Instanzen. Auf Seiten von Publishing-Instanzen wird die Benutzeroberfläche nicht angezeigt.

Hinzufügen von ContextHub-UI-Modi und -Modulen

Konfigurieren Sie die UI-Modi und -Module, die in der ContextHub-Symbolleiste im Vorschaumodus angezeigt werden:

• UI-Modi: Gruppen verwandter Module
• Module: Widgets, die Kontextdaten aus einem Speicher bereitstellen und Autorinnen und Autoren die Bearbeitung des Kontexts ermöglichen

UI-Modi werden als eine Reihe von Symbolen auf der linken Seite der Symbolleiste angezeigt. Wenn diese Option aktiviert ist, werden die Module eines UI-Modus rechts angezeigt.

Bei Symbolen handelt es sich um Verweise aus der Coral-Bibliothek mit Benutzeroberflächensymbolen.

Hinzufügen eines UI-Modus

Fügen Sie einen UI-Modus hinzu, um verwandte ContextHub-Module zu gruppieren. Wenn Sie den UI-Modus erstellen, geben Sie den Titel und das Symbol an, die in der ContextHub-Symbolleiste angezeigt werden.

1. Klicken Sie in der Experience Manager-Leiste auf Tools > Sites > ContextHub.

2. Klicken Sie auf den standardmäßigen Konfigurations-Container.

3. Klicken Sie auf die ContextHub-Konfiguration.

4. Klicken Sie auf die Schaltfläche Erstellen und dann auf UI-Modus für ContextHub.

   

5. Geben Sie Werte für die folgenden Eigenschaften an:

   • UI-Modustitel: Der Titel, mit dem der UI-Modus identifiziert wird.
   • Modussymbol: Die Auswahl für Coral-UI-Symbol , um beispielsweise coral-Icon--user
   • Aktiviert: Wählen Sie diese Option aus, um den UI-Modus in der ContextHub-Symbolleiste anzuzeigen.

6. Klicken Sie auf „Speichern“.

Hinzufügen eines UI-Moduls

Fügen Sie einem UI-Modus ein ContextHub-UI-Modul hinzu, damit es in der ContextHub-Symbolleiste zur Vorschau von Seiteninhalten angezeigt wird. Wenn Sie ein UI-Modul hinzufügen, erstellen Sie eine Instanz eines Modultyps, der bei ContextHub registriert ist. Um ein UI-Modul hinzufügen zu können, müssen Sie den Namen des zugehörigen Modultyps kennen.

AEM bietet einen grundlegenden UI-Modultyp sowie mehrere Beispiel-UI-Modultypen, auf denen Sie ein UI-Modul aufbauen können. Die folgende Tabelle enthält eine kurze Beschreibung der einzelnen Typen. Informationen zum Entwickeln eines benutzerdefinierten UI-Moduls finden Sie unter Erstellen von ContextHub-UI-Modulen.

Die Eigenschaften des UI-Moduls enthalten eine Detailkonfiguration, in der Sie Werte für modulspezifische Eigenschaften angeben können. Die Detailkonfiguration stellen Sie im JSON-Format bereit. Die Spalte „Modultyp“ in der Tabelle enthält Links zu Informationen über den JSON-Code, der für jeden UI-Modultyp erforderlich ist.

1. Klicken Sie in der Experience Manager-Leiste auf Tools > Sites > ContextHub.

2. Klicken Sie auf den Konfigurations-Container, dem Sie ein UI-Modul hinzufügen möchten.

3. Klicken oder tippen Sie auf die ContextHub-Konfiguration, der Sie das UI-Modul hinzufügen möchten.

4. Klicken Sie auf den UI-Modus, dem Sie das UI-Modul hinzufügen.

5. Klicken Sie auf die Schaltfläche Erstellen und dann auf ContextHub UI Module (generisch).

   

6. Geben Sie Werte für die folgenden Eigenschaften an:

   • Titel des UI-Moduls: Ein Titel, der das UI-Modul bezeichnet
   • Modultyp: Der Modultyp
   • Aktiviert: Wählen Sie diese Option, um das UI-Modul in der ContextHub-Symbolleiste anzuzeigen.

7. (Optional) Geben Sie ein JSON-Objekt ein, um das UI-Modul zu konfigurieren und so die Standardkonfiguration für den Store außer Kraft zu setzen.

8. Klicken Sie auf „Speichern“.

Erstellen eines ContextHub-Store

Erstellen Sie einen ContextHub-Store, um Benutzerdaten beizubehalten und nach Bedarf auf die Daten zuzugreifen. ContextHub-Stores basieren auf registrierten Store-Kandidaten. Wenn Sie den Store erstellen, benötigen Sie den Wert von „storeType“, mit dem der Store-Kandidat registriert wurde. (Weitere Informationen finden Sie unter Erstellen benutzerdefinierter Store-Kandidaten.)

Store-Detailkonfiguration

Beim Konfigurieren eines Stores können Sie über die Eigenschaft „Detailkonfiguration“ Werte für Store-spezifische Eigenschaften angeben. Der Wert basiert auf dem Parameter config der Store-Funktion init. Es hängt daher vom Store ab, ob dieser Wert angegeben werden muss und welches Format der Wert haben muss.

Der Wert der Eigenschaft „Detailkonfiguration“ ist ein config-Objekt im JSON-Format.

Beispiele für Store-Kandidaten

In AEM werden die folgenden Beispiele für Store-Kandidaten bereitgestellt, die Sie als Basis für einen Store verwenden können.

1. Klicken Sie in der Experience Manager-Leiste auf Tools > Sites > ContextHub.

2. Klicken Sie auf den standardmäßigen Konfigurations-Container.

3. Klicken Sie auf ContextHub-Konfiguration

4. Um einen Store hinzuzufügen, klicken Sie auf das Symbol Erstellen und dann auf ContextHub-Speicherkonfiguration .

   

5. Geben Sie Werte für die grundlegenden Konfigurationseigenschaften ein und klicken Sie auf Weiter:

   • Konfigurationstitel: Der Titel, der den Store bezeichnet
   • Store-Typ: Der Wert der Eigenschaft „storeType“ des Store-Kandidaten, auf dem der Store basieren soll
   • Erforderlich: Wählen Sie diese Option aus.
   • Aktiviert: Wählen Sie diese Option aus, um den Store zu aktivieren

6. (Optional) Geben Sie ein JSON-Objekt in das Feld „Detailkonfiguration (JSON)“ ein, um die standardmäßige Store-Konfiguration zu überschreiben.

7. Klicken Sie auf „Speichern“.

Beispiel: Verwenden eines JSONP-Service

In diesem Beispiel wird veranschaulicht, wie Sie einen Store konfigurieren und die Daten in einem UI-Modul anzeigen. In diesem Beispiel wird der MD5-Service der Website „jsontest.com“ als Datenquelle für einen Store verwendet. Der Service gibt den MD5-Hashcode einer bestimmten Zeichenfolge im JSON-Format zurück.

Der Store „contexthub.generic-jsonp“ wird so konfiguriert, dass Daten für den Service-Aufruf https://md5.jsontest.com/?text=%22text%20to%20md5%22 gespeichert werden. Der Service gibt die folgenden Daten zurück, die in einem UI-Modul angezeigt werden:

{
   "md5": "919a56ab62b6d5e1219fe1d95248a2c5",
   "original": "\"text to md5\""
}

Erstellen des Stores „contexthub.generic-jsonp“

Mit dem Store-Beispielkandidaten „contexthub.generic-jsonp“ können Sie Daten aus einem JSONP-Service oder einem Webservice abrufen, der JSON-Daten zurückgibt. Verwenden Sie für diesen Store-Kandidaten die Store-Konfiguration, um Details zu dem JSONP-Service anzugeben, der genutzt werden soll.

Mit der Funktion init der JavaScript-Klasse ContextHub.Store.JSONPStore wird ein config-Objekt definiert, das diesen Store-Kandidaten initialisiert. Das config-Objekt enthält ein service-Objekt mit Details zum JSONP-Service. Zum Konfigurieren des Stores geben Sie das service-Objekt im JSON-Format als Wert für die Eigenschaft „Detailkonfiguration“ an.

Verwenden Sie zum Speichern von Daten aus dem MD5-Service der Website „jsontest.com“ das Verfahren unter Erstellen eines ContextHub-Store mit den folgenden Eigenschaften:

• Konfigurationstitel: md5

• Store-Typ: contexthub.generic-jsonp

• Erforderlich: Wählen Sie diese Option aus.

• Aktiviert: Wählen Sie diese Option aus.

• Detailkonfiguration (JSON):

  {
   "service": {
   "jsonp": false,
   "timeout": 1000,
   "ttl": 1800000,
   "secure": false,
   "host": "md5.jsontest.com",
   "port": 80,
   "params":{
   "text":"text to md5"
       }
     }
   }
  

Hinzufügen eines Benutzeroberflächenmoduls für die md5-Daten

Fügen Sie der ContextHub-Symbolleiste ein UI-Modul hinzu, um die Daten anzuzeigen, die im md5-Beispiel-Store gespeichert sind. In diesem Beispiel wird das Modul „contexthub.base“ verwendet, um das folgende UI-Modul zu erstellen:

Nutzen Sie das Verfahren unter Hinzufügen eines Benutzeroberflächenmoduls, um das Benutzeroberflächenmodul einem vorhandenen Benutzeroberflächenmodus hinzuzufügen, z. B. dem Beispiel-Benutzeroberflächenmodus „Perona“. Verwenden Sie für das UI-Modul die folgenden Eigenschaftswerte:

• Titel des UI-Moduls: MD5

• Modultyp: contexthub.base

• Detailkonfiguration (JSON):

  {
   "icon": "coral-Icon--data",
   "title": "MD5 Converstion",
   "storeMapping": { "md5": "md5" },
   "template": "<p> {{md5.original}}</p>;
                <p>{{md5.md5}}</p>"
  }
  

Debuggen von ContextHub

Ein Debugging-Modus für ContextHub kann aktiviert werden, um die Fehlerbehebung zu ermöglichen. Der Debugging-Modus kann entweder über die ContextHub-Konfiguration oder über CRXDE aktiviert werden.

Per Konfiguration

Bearbeiten Sie die Konfiguration von ContextHub und aktivieren Sie die Option Debuggen.

1. Klicken Sie in der Leiste auf Tools > Sites > ContextHub
2. Klicken Sie auf die Standardeinstellung Konfigurations-Container
3. Wählen Sie die ContextHub-Konfiguration und klicken Ausgewähltes Element bearbeiten
4. Klicks Debuggen und klicken Speichern

Per CRXDE

Verwenden Sie CRXDE Lite, um die Eigenschaft debug unter auf true festzulegen:

• /conf/global/settings/cloudsettings oder
• /conf/<tenant>/settings/cloudsettings

Unbeaufsichtigter Modus

Im unbeaufsichtigten Modus werden alle Debug-Informationen unterdrückt. Im Gegensatz zur normalen Debug-Option, die für jede ContextHub-Konfiguration einzeln festgelegt werden kann, ist der unbeaufsichtigte Modus eine globale Einstellung, die Vorrang vor allen Debug-Einstellungen auf der Ebene der ContextHub-Konfiguration hat.

Dies ist für Ihre Veröffentlichungsinstanz hilfreich, für die Sie keine Debug-Informationen benötigen. Da es sich um eine globale Einstellung handelt, wird sie per OSGi aktiviert.

1. Öffnen Sie die Konfiguration der Adobe Experience Manager-Web-Konsole unter http://<host>:<port>/system/console/configMgr.
2. Suchen Sie nach Adobe Granite ContextHub.
3. Klicken Sie auf die Konfiguration Adobe Granite ContextHub, um die Eigenschaften zu bearbeiten.
4. Aktivieren Sie die Option für den unbeaufsichtigten Modus und klicken Sie auf Speichern.

Wiederherstellen von ContextHub-Konfigurationen nach einem Upgrade

Wenn ein Upgrade für AEM durchgeführt wird, werden die ContextHub-Konfigurationen gesichert und an einem sicheren Speicherort gespeichert. Während des Upgrades werden die standardmäßigen ContextHub-Konfigurationen installiert. Sie ersetzen dabei die vorhandenen Konfigurationen. Die Sicherung ist erforderlich, um alle Änderungen oder Ergänzungen beizubehalten, die Sie vorgenommen haben.

ContextHub-Konfigurationen werden in einem Ordner mit dem Namen contexthub unter den folgenden Knoten gespeichert:

• /conf/global/settings/cloudsettings
• /conf/<tenant>/settings/cloudsettings

Nach einem Upgrade wird die Sicherung in einem Ordner mit dem Namen contexthub unter einem Knoten mit dem folgenden Namen gespeichert:

/conf/global/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx oder
/conf/<tenant>/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx

Der Teil yyyymmdd des Knotennamens ist das Datum, an dem das Upgrade durchgeführt wurde.

Verwenden Sie zum Wiederherstellen Ihrer ContextHub-Konfigurationen CRXDE Lite, um die Knoten mit Ihren Stores, Benutzeroberflächenmodi und Benutzeroberflächenmodulen von default-pre-upgrade_yyyymmdd_xxxxxx unter den folgenden Knoten zu kopieren:

• /conf/global/settings/cloudsettings oder
• /conf/<tenant>/settings/cloudsettings