DokumentationAEM 6.5Användarhandbok

Cloud Service Configurations cloud-service-configurations

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

Skapat för:

  • Utvecklare

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 (till exempel egenskaper/stycken) ärvs från de överordnade.
  • Refereras från analysnoder via sökväg.
  • Enkelt att bygga ut.
  • Har flexibiliteten att hantera mer komplexa konfigurationer, som Adobe Analytics.
  • Stöd för beroenden (till exempel Adobe Analytics plugin-program behöver en Adobe Analytics -konfiguration).

Struktur structure

Konfigurationernas 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 ha anpassats.

Så här konfigurerar du nya tjänster:

  • Skapa en tjänst i

    /etc/cloudservices

  • Under 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 en 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 direkt på jcr:node.
  • Dynamiska element (med parsys eller iparsys) använder 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:t finns i com.day.cq.wcm.webservicesupport.

AEM aem-integration

Tillgängliga tjänster visas på fliken Cloud Service i dialogrutan Sidegenskaper (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, d.v.s. namnet skulle skrivas som för fältet password:

password@Encrypted

Egenskapen krypteras sedan automatiskt (med tjänsten CryptoSupport) av EncryptionPostProcessor.

NOTE
Detta liknar standardanteckningarna för [SlingPostServlet](https://sling.apache.org/site/manipulating-content-the-slingpostservlet-servletspost.html).
NOTE
Som standard krypterar EcryptionPostProcessor bara POST begäranden som gjorts till /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-inkluderingar.
Detta inkluderar komponenten på sidan där
cq/cloudserviceconfigs/components/servicecomponents
inkluderas (vanligtvis före body -taggen).
Om det gäller Adobe Analytics och Adobe Target använder vi det här 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, synlig 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
19ffd973-7af2-44d0-84b5-d547b0dffee2