Konfigurieren von ContextHub

ContextHub ist ein Framework zum Speichern, Ändern und Darstellen von Kontextdaten. Ausführlichere Informationen zu ContextHub finden Sie in der ContextHub-Übersicht für Entwickler.

Sie können die ContextHub-Symbolleiste konfigurieren, um zu steuern, ob sie im Vorschaumodus angezeigt wird, um ContextHub-Stores zu erstellen und UI-Module hinzuzufügen.

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: Aktivieren Sie die Eigenschaft „Show UI“, um die Benutzeroberfläche anzuzeigen. Verwenden Sie die Eigenschaft „Hide UI“, um die Benutzeroberfläche auszublenden.
• 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-Autoreninstanzen. Auf Seiten von Veröffentlichungsinstanzen wird die Benutzeroberfläche nicht angezeigt.

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

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

• UI-Modi: Gruppen mit verwandten Modulen
• Module: Widgets, die Kontextdaten eines Stores verfügbar machen und Autoren die Änderung des Kontexts ermöglichen

UI-Modi werden als Symbole auf der linken Seite der Symbolleiste angezeigt. Wenn die Option ausgewählt ist, erscheinen die Module eines UI-Modus auf der rechten Seite.

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

Hinzufügen eines UI-Modus

Fügen Sie einer Gruppe mit verwandten ContextHub-Modulen einen UI-Modus hinzu. Beim Erstellen des UI-Modus geben Sie den Titel und das Symbol an, der bzw. das in der ContextHub-Symbolleiste angezeigt werden soll.

1. Klicken oder tippen Sie auf der Experience Manager-Leiste auf „Tools“ > „Sites“ > „ContextHub“.

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

3. Klicken oder tippen Sie auf die ContextHub-Konfiguration.

4. Klicken oder tippen Sie auf die Schaltfläche „Erstellen“ und dann auf „ContextHub-UI-Modus“.

   

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 das zu verwendende Coral-UI-Symbol, z. B. coral-Icon--user.
   • Aktiviert: Wählen Sie diese Option aus, um den UI-Modus in der ContextHub-Symbolleiste anzuzeigen.

6. Klicken oder tippen Sie auf „Speichern“.

Hinzufügen eines UI-Moduls

Fügen Sie ein ContextHub-UI-Modul einem UI-Modus hinzu, damit es in der ContextHub-Symbolleiste zum Einblenden einer Vorschau für Seiteninhalte angezeigt wird. Beim Hinzufügen eines UI-Moduls erstellen Sie eine Instanz eines Modultyps, der für ContextHub registriert ist. Sie müssen den Namen des zugeordneten Modultyps kennen, um ein UI-Modul hinzufügen zu können.

AEM stellt einen grundlegenden UI-Modultyp und mehrere Beispiele für UI-Modultypen bereit, die Sie als Basis für ein UI-Modul verwenden können. Die folgende Tabelle enthält eine kurze Beschreibung der einzelnen Modultypen. Weitere Informationen zum Entwickeln eines benutzerdefinierten UI-Moduls finden Sie unter Erstellen von ContextHub-UI-Modulen.

Die Eigenschaften von UI-Modulen enthalten eine Detailkonfiguration, in der Sie Werte für modulspezifische Eigenschaften angeben können. Sie stellen die Detailkonfiguration im JSON-Format bereit. Die Spalte „Modultyp“ in der Tabelle enthält Links zu Informationen zum JSON-Code, der für die einzelnen UI-Modultypen erforderlich ist.

1. Klicken oder tippen Sie auf der Experience Manager-Leiste auf „Tools“ > „Sites“ > „ContextHub“.

2. Klicken oder tippen 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 oder tippen Sie auf den UI-Modus, dem Sie das UI-Modul hinzufügen.

5. Klicken oder tippen Sie auf die Schaltfläche „Erstellen“ und dann auf „ContextHub-UI-Modul (generisch)“.

   

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

   • UI-Modultitel: Ein Titel, mit dem das UI-Modul identifiziert wird.
   • Modultyp: Gibt den Modultyp an.
   • Aktiviert: Wählen Sie diese Option aus, 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 oder tippen Sie auf „Speichern“.

Erstellen eines ContextHub-Store

Erstellen Sie einen ContextHub-Store, in dem Benutzerdaten dauerhaft gespeichert werden können und bei Bedarf zugänglich sind. ContextHub-Stores basieren auf registrierten Store-Kandidaten. Beim Erstellen des Stores benötigen Sie den Wert von storeType, unter dem der Store-Kandidat registriert wurde. (Siehe Erstellen von benutzerdefinierten 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 oder tippen Sie auf der Experience Manager-Leiste auf „Tools“ > „Sites“ > „ContextHub“.

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

3. Klicken oder tippen Sie auf „ContextHub-Konfiguration“.

4. Klicken oder tippen Sie zum Hinzufügen eines Stores auf das Symbol „Erstellen“ und dann auf „ContextHub-Store-Konfiguration“.

   

5. Geben Sie Werte für die grundlegenden Konfigurationseigenschaften an und klicken oder tippen Sie dann auf „Weiter“:

   • Konfigurationstitel: Der Titel, mit dem der Store identifiziert wird.
   • Filialtyp: Der Wert der Eigenschaft storeType des Store-Kandidaten, auf dem der Store basiert.
   • Erforderlich: Wählen Sie diese Option aus.
   • Aktiviert: Wählen Sie diese Option aus, um den Store zu aktivieren.

6. (Optional) Geben Sie im Feld „Detailkonfiguration (JSON)“ ein JSON-Objekt ein, um die Standardkonfiguration für den Store außer Kraft zu setzen.

7. Klicken oder tippen 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 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 UI-Moduls 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 UI-Moduls, um das UI-Modul einem vorhandenen UI-Modus hinzuzufügen, z. B. dem Beispiel-UI-Modus „Persona“. Verwenden Sie für das UI-Modul die folgenden Eigenschaftswerte:

• UI-Modultitel: MD5

• Modultyp: contexthub.base

• Detailkonfiguration (JSON):

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

Debuggen von ContextHub

Ein Debugmodus für ContextHub kann aktiviert werden, um die Fehlerbehebung zuzulassen. Der Debugmodus kann entweder über die ContextHub-Konfiguration oder per CRXDE aktiviert werden.

Per Konfiguration

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

1. Klicken oder tippen Sie in der Leiste auf Tools > Sites > ContextHub.
2. Klicken oder tippen Sie auf den standardmäßigen Konfigurations-Container.
3. Wählen Sie die ContextHub-Konfiguration aus und klicken oder tippen Sie auf Ausgewähltes Element bearbeiten.
4. Klicken oder tippen Sie auf Debuggen und dann auf Speichern.

Per CRXDE

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

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

Protokollieren von Debug-Meldungen für ContextHub

Konfigurieren Sie den Adobe Granite ContextHub-OSGi-Service (PID = com.adobe.granite.contexthub.impl.ContextHubImpl) für die Protokollierung detaillierter Debug-Meldungen, die bei der Entwicklung hilfreich sind.

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

• Web-Konsole: Wählen Sie zum Protokollieren von Debug-Meldungen die Debug-Eigenschaft aus.
• JCR-Knoten: Legen Sie zum Protokollieren von Debug-Meldungen die boolesche Eigenschaft com.adobe.granite.contexthub.debug auf true fest.

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.

Deaktivieren von ContextHub

ContextHub kann deaktiviert werden, um das Laden von JS/CSS-Code und die Initialisierung zu verhindern. Sie haben zwei Optionen, um ContextHub zu deaktivieren:

• Bearbeiten Sie die Konfiguration von ContextHub und aktivieren Sie die Option ContextHub deaktivieren.

  1. Klicken oder tippen Sie in der Leiste auf Tools > Sites > ContextHub.
  2. Klicken oder tippen Sie auf den standardmäßigen Konfigurations-Container.
  3. Wählen Sie die ContextHub-Konfiguration aus und klicken oder tippen Sie auf Ausgewähltes Element bearbeiten.
  4. Klicken oder tippen Sie auf ContextHub deaktivieren und dann auf Speichern.

oder

• Verwenden Sie CRXDE Lite, um die Eigenschaft disabled unter /conf/global/settings/cloudsettings/<configName>/contexthub auf true festzulegen.

Ressourcen für Business.Adobe.com