DokumentationAEM 6.4Användarhandbok om utveckling

Cloud Service Configurations cloud-service-configurations

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

Konfigurationer är utformade för att tillhandahålla logik och struktur för lagring av tjänstkonfigurationer.

Du kan utöka de befintliga instanserna för att skapa egna konfigurationer.

Concepts concepts

De principer som har använts vid utvecklingen av konfigurationerna har baserats på följande begrepp:

  • Tjänster/adaptrar används för att hämta konfigurationer.
  • Konfigurationer (t.ex. egenskaper/stycken) ärvs från de överordnade.
  • Refererad från analysnod(er) efter sökväg.
  • Enkelt att bygga ut.
  • Har flexibiliteten att klara mer komplexa konfigurationer, som Adobe Analytics.
  • Stöd för beroenden (t.ex. Adobe Analytics plugin-program behöver en Adobe Analytics konfiguration).

Struktur structure

Konfigurationens grundsökväg är:

/etc/cloudservices.

För varje typ av konfiguration tillhandahålls en mall och en komponent. Detta gör det möjligt att ha konfigurationsmallar som kan uppfylla de flesta behov efter att de har anpassats.

Om du vill tillhandahålla en konfiguration för nya tjänster måste du:

  • skapa en tjänst i

    /etc/cloudservices

  • enligt följande:

    • en konfigurationsmall
    • en konfigurationskomponent

Mallen och komponenten måste ärva sling:resourceSuperType från basmallen:

cq/cloudserviceconfigs/templates/configpage

eller baskomponent

cq/cloudserviceconfigs/components/configpage

Tjänsteleverantören bör även tillhandahålla tjänstsidan:

/etc/cloudservices/<service-name>

Mall template

Din mall utökar basmallen:

cq/cloudserviceconfigs/templates/configpage

och definiera resourceType som pekar på den anpassade komponenten.

/libs/cq/analytics/templates/sitecatalyst
sling:resourceSuperType = cq/cloudserviceconfigs/templates/configpage
allowedChildren = /libs/cq/analytics/templates/sitecatalyst
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
componentReference = cq/analytics/components/sitecatalyst
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/sitecatalystpage

/libs/cq/analytics/templates/generictracker
sling:resourceSuperType = cq/cloudservices/templates/configpage
allowedChildren = /libs/cq/analytics/templates/generictracker
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/generictrackerpage

Komponenter components

Komponenten bör utöka baskomponenten:

cq/cloudserviceconfigs/templates/configpage

/libs/cq/analytics/components/sitecatalystpage

/libs/cq/analytics/components/generictrackerpage

När du har konfigurerat mallen och komponenten kan du lägga till din konfiguration genom att lägga till undersidor under:

/etc/cloudservices/<service-name>

Innehållsmodell content-model

Innehållsmodellen lagras som cq:Page under:

/etc/cloudservices/<service-name>(/*)

/etc/cloudservices
/etc/cloudservices/service-name
/etc/cloudservices/service-name/config
/etc/cloudservices/service-name/config/inherited-config

Konfigurationerna lagras under undernoden jcr:content.

  • Fasta egenskaper som definieras i en dialogruta ska lagras på jcr:node direkt.
  • Dynamiska element (med parsys eller iparsys) använder du en undernod för att lagra komponentdata.
/etc/cloudservices/service/config/jcr:content as nt:unstructured
propertyname
*
par/component/ as cq:Component
propertyname
*

API api

Referensdokumentation om API finns i com.day.cq.wcm.webservicesupport.

AEM aem-integration

Tillgängliga tjänster visas i Cloud Services -fliken i Sidegenskaper dialogruta (för alla sidor som ärver från foundation/components/page eller wcm/mobile/components/page).

Fliken innehåller även:

  • en länk till den plats där du kan aktivera tjänsten
  • välj en konfiguration (undernod till tjänsten) från ett sökvägsfält

Lösenordskryptering password-encryption

När inloggningsuppgifter för tjänsten lagras bör alla lösenord krypteras.

Du kan uppnå detta genom att lägga till ett dolt formulärfält. Det här fältet ska ha anteckningen @Encrypted i egenskapsnamnet, t.ex. för password fältet som namnet skulle skrivas som:

password@Encrypted

Egenskapen krypteras sedan automatiskt (med CryptoSupport på EncryptionPostProcessor.

NOTE
Detta liknar standarden [SlingPostServlet](https://sling.apache.org/site/manipulating-content-the-slingpostservlet-servletspost.html) anteckningar.
NOTE
Som standard är EcryptionPostProcessor endast krypterar POST förfrågningar /etc/cloudservices.

Ytterligare egenskaper för tjänstsidans jcr:innehållsnoder additional-properties-for-service-page-jcr-content-nodes

Egenskap
Beskrivning
componentReference
Referenssökväg till en komponent som ska inkluderas automatiskt på sidan.
Detta används för ytterligare funktioner och JS-tillägg.
Detta inkluderar komponenten på sidan där
cq/cloudserviceconfigs/components/servicecomponents
ingår (normalt före body tagg).
När det gäller Analytics och Target använder vi detta för att inkludera ytterligare funktioner, som JavaScript-anrop för att spåra besökares beteende.
description
Kort beskrivning av tjänsten.
descriptionExtended
Utökad beskrivning av tjänsten.
rankning
Tjänstrankning för användning i listor.
selectableChildren
Filter för att visa konfigurationer i dialogrutan för sidegenskaper.
serviceUrl
URL till tjänstens webbplats.
serviceUrlLabel
Etikett för tjänst-URL.
thumbnailPath
Sökväg till miniatyrbild för tjänsten.
visible
Synlighet i dialogrutan för sidegenskaper. visas som standard (valfritt)

Användningsexempel use-cases

Dessa tjänster tillhandahålls som standard:

NOTE
Se även Skapa en anpassad Cloud Service.
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e