DokumentationAEM 6.5Användarhandbok

ContextHub konfigureras configuring-contexthub

Last update: Sat Jul 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare

ContextHub är ett ramverk för att lagra, ändra och presentera kontextdata. Mer information om ContextHub finns i utvecklardokumentationen. ContextHub ersätter klientkontext i pekgränssnittet.

Konfigurera verktygsfältet ContextHub för att kontrollera om det visas i förhandsgranskningsläget, skapa ContextHub-butiker och lägga till gränssnittsmoduler med det Touchoptimerade användargränssnittet.

Inaktiverar ContextHub disabling-contexthub

Som standard är ContextHub aktiverat i en AEM installation. ContextHub kan inaktiveras för att förhindra att den läser in js/css och initierar.

  • Använd CRXDE Lite för att ange egenskapen disabled till true under /libs/settings/cloudsettings/legacy/contexthub
NOTE
På grund av databasomstrukturering i AEM 6.4har platsen för ContextHub-konfigurationer ändrats från /etc/cloudsettings till:
  • /libs/settings/cloudsettings
  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings

Visa och dölja ContextHub-gränssnittet showing-and-hiding-the-contexthub-ui

Konfigurera Adobe Granite ContextHub OSGi-tjänsten för att visa eller dölja ContextHub-gränssnittet på dina sidor. Tjänstens PID är com.adobe.granite.contexthub.impl.ContextHubImpl.

Om du vill konfigurera tjänsten kan du antingen använda webbkonsolen eller en JCR-nod i databasen:

  • Webbkonsol: Om du vill visa användargränssnittet väljer du egenskapen Visa användargränssnitt. Om du vill dölja användargränssnittet avmarkerar du egenskapen Dölj användargränssnitt.
  • JCR-nod: Om du vill visa användargränssnittet anger du egenskapen com.adobe.granite.contexthub.show_ui för booleskt värde till true. Om du vill dölja användargränssnittet anger du egenskapen till false.

När du visar ContextHub-gränssnittet visas det bara på sidor AEM författarinstanser. Gränssnittet visas inte på sidor med publiceringsinstanser.

Lägga till gränssnittslägen och moduler för ContextHub adding-contexthub-ui-modes-and-modules

Konfigurera de gränssnittslägen och moduler som visas i ContextHub-verktygsfältet i förhandsgranskningsläget:

  • Gränssnittslägen: Grupper av relaterade moduler
  • Moduler: Widgetar som visar kontextdata från en butik och gör att författare kan ändra kontexten

Gränssnittslägen visas som en serie ikoner till vänster i verktygsfältet. När du väljer det här alternativet visas modulerna för ett användargränssnittsläge till höger.

chlimage_1-319

Ikoner är referenser från ikonbiblioteket Coral UI.

Lägga till ett gränssnittsläge adding-a-ui-mode

Lägg till ett gränssnittsläge för att gruppera relaterade ContextHub-moduler. När du skapar gränssnittsläget anger du den titel och ikon som visas i ContextHub-verktygsfältet.

  1. Klicka på Verktyg > Platser > Kontextnav på Experience Manager-listen.

  2. Klicka på standardkonfigurationsbehållaren.

  3. Klicka på Kontextnavkonfigurationen.

  4. Klicka på knappen Skapa och sedan på Gränssnittsläge för kontextnav.

    chlimage_1-320

  5. Ange värden för följande egenskaper:

    • Rubrik för användargränssnittsläge: Den titel som identifierar användargränssnittsläget
    • Lägesikon: Väljaren för Coral UI-ikonen som ska användas, till exempel coral-Icon--user
    • Aktiverad: Välj det här alternativet om du vill visa användargränssnittsläget i verktygsfältet ContextHub

  6. Klicka på Spara.

Lägga till en gränssnittsmodul adding-a-ui-module

Lägg till en ContextHub-gränssnittsmodul i ett UI-läge så att den visas i ContextHub-verktygsfältet för förhandsgranskning av sidinnehåll. När du lägger till en UI-modul skapar du en instans av en modultyp som är registrerad med ContextHub. Om du vill lägga till en gränssnittsmodul måste du känna till namnet på den associerade modultypen.

AEM innehåller en grundläggande gränssnittsmodultyp samt flera exempeltyper av gränssnittsmodul som du kan basera en gränssnittsmodul på. Följande tabell innehåller en kort beskrivning av vart och ett av dem. Mer information om hur du utvecklar en anpassad gränssnittsmodul finns i Skapa ContextHub-gränssnittsmoduler.

Egenskaperna för användargränssnittsmodulen innehåller en detaljkonfiguration där du kan ange värden för modulspecifika egenskaper. Du anger detaljkonfigurationen i JSON-format. Kolumnen Modultyp i tabellen innehåller länkar till information om den JSON-kod som krävs för varje gränssnittsmodultyp.

Modultyp
Beskrivning
Butik
contexthub.base
En allmän gränssnittsmodultyp
Konfigureras i gränssnittsmodulens egenskaper
contexthub.browserinfo
Visar information om webbläsaren
surferinfo
contexthub.datetime
Visar datum- och tidsinformation
datetime
contexthub.device
Visa klientenheten
emulatorer
contexthub.location
Visar klientens latitud och longitud och platsen på en karta. Gör att du kan ändra platsen.
geolokalisering
contexthub.screen-orientation
Visar enhetens skärmorientering (liggande eller stående)
emulatorer
contexthub.tagcloud
Visar statistik om sidtaggar
tagcloud
granite.profile
Visar profilinformationen för den aktuella användaren, inklusive authorizedID, displayName och familyName. Du kan ändra värdet för displayName och familyName.
profil

  1. Klicka på Verktyg > Platser > ContextHub på Experience Manager-listen.

  2. Klicka på den konfigurationsbehållare som du vill lägga till en gränssnittsmodul i.

  3. Klicka på eller skriv den ContextHub-konfiguration som du vill lägga till gränssnittsmodulen i.

  4. Klicka på det användargränssnittsläge som du lägger till användargränssnittsmodulen i.

  5. Klicka på knappen Skapa och sedan på ContextHub UI Module (generisk).

    chlimage_1-321

  6. Ange värden för följande egenskaper:

    • Modultitel för användargränssnitt: En titel som identifierar användargränssnittsmodulen
    • Modultyp: Modultypen
    • Aktiverad: Välj det här alternativet om du vill visa gränssnittsmodulen i ContextHub-verktygsfältet

  7. (Valfritt) Om du vill åsidosätta standardkonfigurationen för lagring anger du ett JSON-objekt för att konfigurera UI-modulen.

  8. Klicka på Spara.

Skapa ett ContextHub Store creating-a-contexthub-store

Skapa ett kontextnavlager för att behålla användardata och komma åt data efter behov. ContextHub-butikerna baseras på registrerade butikskandidater. När du skapar butiken behöver du värdet för den storeType som butikskandidaten registrerats med. (Se Skapa anpassade butikskandidater.)

Detaljerad lagringskonfiguration detailed-store-configuration

När du konfigurerar en butik kan du med egenskapen Detaljkonfiguration ange värden för butiksspecifika egenskaper. Värdet baseras på parametern config i butikens init-funktion. Därför beror det på butiken om du behöver ange det här värdet och värdeformatet.

Värdet för egenskapen Detaljkonfiguration är ett config-objekt i JSON-format.

Exempelarkivsökande sample-store-candidates

AEM innehåller följande exempel på butikskandidater som du kan basera en butik på.

Butikstyp
Beskrivning
aem.segmentation
Lagra för lösta och olösta ContextHub-segment. Hämtar automatiskt segment från ContextHub SegmentManager
aem.resolvedsegments
Lagrar de segment som är lösta just nu. Lyssnar på tjänsten ContextHub SegmentManager för att automatiskt uppdatera butiken
contexthub.geolocation
Lagrar latitud- och longitudvärdena för webbläsarplatsen.
contexthub.datetime
Lagrar aktuellt datum, aktuell tid och aktuell säsong för webbläsarplatsen
granite.emulators
Definierar egenskaper och funktioner för flera enheter och identifierar den aktuella klientenheten
contexthub.generic-jsonp
Hämtar och lagrar data från en JSONP-tjänst
granite.profile
Lagrar profildata för den aktuella användaren
contexthub.surferinfo
Lagrar information om klienten, till exempel enhetsinformation, webbläsartyp och fönsterorientering
contexthub.tagcloud
Lagrar sidtaggar och antal taggar

  1. Klicka på Verktyg > Platser > ContextHub på Experience Manager-listen.

  2. Klicka på standardkonfigurationsbehållaren.

  3. Klicka på Kontexthub-konfiguration

  4. Om du vill lägga till en butik klickar du på ikonen Skapa och sedan på KontexHub Store Configuration.

    chlimage_1-322

  5. Ange värden för de grundläggande konfigurationsegenskaperna och klicka sedan på Nästa:

    • Konfigurationstitel: Titeln som identifierar arkivet
    • Butikstyp: Värdet för egenskapen storeType för butikskandidaten som butiken ska baseras på
    • Obligatoriskt: Välj
    • Aktiverad: Markera för att aktivera arkivet

  6. (Valfritt) Om du vill åsidosätta standardarkivkonfigurationen anger du ett JSON-objekt i rutan Detaljkonfiguration (JSON).

  7. Klicka på Spara.

Exempel: Använda en JSONP-tjänst example-using-a-jsonp-service

I det här exemplet visas hur du konfigurerar en lagringsplats och visar data i en gränssnittsmodul. I det här exemplet används MD5-tjänsten på jsontest.com webbplats som datakälla för en butik. Tjänsten returnerar MD5-hash-koden för en sträng i JSON-format.

Ett contexthub.generic-jsonp-arkiv har konfigurerats så att det lagrar data för tjänstanropet https://md5.jsontest.com/?text=%22text%20to%20md5%22. Tjänsten returnerar följande data som visas i en gränssnittsmodul:

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

Skapa ett kontexthub.generic-jsonp-arkiv creating-a-contexthub-generic-jsonp-store

Med exempelarkivkandidaten contexthub.generic-jsonp kan du hämta data från en JSONP-tjänst eller en webbtjänst som returnerar JSON-data. För den här butikskandidaten använder du butikskonfigurationen för att ange information om den JSONP-tjänst som ska användas.

Funktionen init i JavaScript-klassen ContextHub.Store.JSONPStore definierar ett config-objekt som initierar den här lagringskandidaten. Objektet config innehåller ett service-objekt som innehåller information om JSONP-tjänsten. Om du vill konfigurera arkivet anger du objektet service i JSON-format som värde för egenskapen Detaljkonfiguration.

Om du vill spara data från MD5-tjänsten på jsontest.com ska du göra så här i Skapa ett ContextHub Store med följande egenskaper:

  • Konfigurationstitel: md5

  • Butikstyp: contexthub.generic-jsonp

  • Obligatoriskt: Välj

  • Aktiverad: Välj

  • Detaljkonfiguration (JSON):

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

Lägga till en gränssnittsmodul för md5-data adding-a-ui-module-for-the-md-data

Lägg till en gränssnittsmodul i ContextHub-verktygsfältet för att visa data som lagras i exempelarkivet md5. I det här exemplet används modulen contexthub.base för att skapa följande gränssnittsmodul:

chlimage_1-323

Använd proceduren i Lägga till en UI-modul för att lägga till UI-modulen i ett befintligt UI-läge, t.ex. UI-läget Perona. Använd följande egenskapsvärden för UI-modulen:

  • Modultitel för användargränssnitt: MD5

  • Modultyp: contexthub.base

  • Detaljkonfiguration (JSON):

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

Debugging ContextHub debugging-contexthub

Ett felsökningsläge för ContextHub kan aktiveras för att tillåta felsökning. Felsökningsläget kan aktiveras antingen via ContextHub-konfigurationen eller via CRXDE.

Via konfigurationen via-the-configuration

Redigera ContextHub-konfigurationen och kontrollera alternativet Felsök

  1. Klicka på Verktyg > Webbplatser > ContextHub i fältet.
  2. Klicka på standardbehållaren för konfiguration
  3. Markera ContextHub-konfigurationen och klicka på Redigera markerat element
  4. Klicka på Felsök och klicka på Spara

Via CRXDE via-crxde

Använd CRXDE Lite för att ange egenskapen debug till true under:

  • /conf/global/settings/cloudsettings eller
  • /conf/<tenant>/settings/cloudsettings
NOTE
För ContextHub-konfigurationer som fortfarande finns under de tidigare sökvägarna är platsen som debug property ska anges /libs/settings/cloudsettings/legacy/contexthub.

Tyst läge silent-mode

I tyst läge inaktiveras all felsökningsinformation. Till skillnad från det normala felsökningsalternativet, som kan anges separat för varje ContextHub-konfiguration, är tyst läge en global inställning som har företräde framför eventuella felsökningsinställningar på ContextHub-konfigurationsnivån.

Detta är användbart för publiceringsinstansen där du inte vill ha någon felsökningsinformation alls. Eftersom det är en global inställning aktiveras den via OSGi.

  1. Öppna Adobe Experience Manager Web Console-konfigurationen på http://<host>:<port>/system/console/configMgr
  2. Sök efter Adobe Granite ContextHub
  3. Klicka på konfigurationen Adobe Granite ContextHub för att redigera dess egenskaper
  4. Markera alternativet Tyst läge och klicka på Spara

Återställer ContextHub-konfigurationer efter uppgradering recovering-contexthub-configurations-after-upgrading

När en uppgradering till AEM utförs säkerhetskopieras ContextHub-konfigurationerna och lagras på en säker plats. Under uppgraderingen installeras ContextHub-standardkonfigurationerna, vilket ersätter de befintliga konfigurationerna. Säkerhetskopieringen krävs för att bevara ändringar eller tillägg som du har gjort.

ContextHub-konfigurationer lagras i en mapp med namnet contexthub under följande noder:

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

Efter en uppgradering lagras säkerhetskopian i en mapp med namnet contexthub under en nod med namnet:

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

Delen yyyymmdd i nodnamnet är det datum då uppgraderingen utfördes.

Om du vill återställa dina ContextHub-konfigurationer använder du CRXDE Lite för att kopiera noderna som representerar dina butiker, gränssnittslägen och gränssnittsmoduler från under noden default-pre-upgrade_yyyymmdd_xxxxxx till nedan:

  • /conf/global/settings/cloudsettings eller
  • /conf/<tenant>/settings/cloudsettings
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2