Configurações do Cloud Service

As configurações são projetadas para fornecer a lógica e a estrutura para armazenar configurações de serviço.

É possível estender as instâncias existentes para criar suas próprias configurações.

Conceitos

Os princípios utilizados no desenvolvimento das configurações basearam-se nos seguintes conceitos:

  • Serviços/Adaptadores são usados para recuperar as configurações.
  • As configurações (por exemplo, propriedades/parágrafos) são herdadas dos pais.
  • Referenciado de nó(s) do Analytics por caminho.
  • Facilmente extensível.
  • Tem a flexibilidade de atender a configurações mais complexas, como o Adobe Analytics.
  • Suporte para dependências (por exemplo, plug-ins Adobe Analytics precisam de uma configuração Adobe Analytics ).

Estrutura

O caminho básico das configurações é:

/etc/cloudservices.

Para cada tipo de configuração, um modelo e um componente serão fornecidos.Isso possibilita a existência de modelos de configuração que possam atender à maioria das necessidades após serem personalizados.

Para fornecer uma configuração para novos serviços, é necessário:

  • criar uma página de serviço em

    /etc/cloudservices

  • nesta rubrica:

    • um modelo de configuração
    • um componente de configuração

O modelo e o componente devem herdar o modelo sling:resourceSuperType do modelo base:

cq/cloudserviceconfigs/templates/configpage

ou componente de base, respectivamente

cq/cloudserviceconfigs/components/configpage

O provedor de serviço também deve fornecer a página de serviço:

/etc/cloudservices/<service-name>

Modelo

Seu modelo estenderá o modelo base:

cq/cloudserviceconfigs/templates/configpage

e defina um resourceType que aponte para o componente personalizado.

/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

Componentes

Seu componente deve estender o componente básico:

cq/cloudserviceconfigs/templates/configpage

/libs/cq/analytics/components/sitecatalystpage

/libs/cq/analytics/components/generictrackerpage

Depois de configurar seu modelo e componente, você pode adicionar sua configuração adicionando subpáginas em:

/etc/cloudservices/<service-name>

Modelo de conteúdo

O modelo de conteúdo é armazenado como cq:Page em:

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

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

As configurações são armazenadas sob o subnó jcr:content.

  • As propriedades fixas, definidas em uma caixa de diálogo, devem ser armazenadas jcr:node diretamente no.
  • Os elementos dinâmicos (usando parsys ou iparsys) usam um subnó para armazenar os dados do componente.
/etc/cloudservices/service/config/jcr:content as nt:unstructured
propertyname
*
par/component/ as cq:Component
propertyname
*

API

Para obter a documentação de referência sobre a API, consulte com.day.cq.wcm.webservicessupport.

Integração AEM

Os serviços disponíveis são listados na guia Cloud Services da caixa de diálogo Propriedades da página (de qualquer página que herda de foundation/components/page ou wcm/mobile/components/page).

A guia também fornece:

  • um link para o local onde você pode ativar o serviço
  • escolha uma configuração (subnó do serviço) de um campo de caminho

Criptografia de senha

Ao armazenar credenciais de usuário para o serviço, todas as senhas devem ser criptografadas.

Para isso, adicione um campo de formulário oculto. Este campo deve ter a anotação @Encrypted no nome da propriedade; ou seja, para o password campo, o nome deve ser escrito como:

password@Encrypted

A propriedade será automaticamente criptografada (usando o CryptoSupport serviço) pelo EncryptionPostProcessor.

NOTE

Isso é semelhante às [SlingPostServlet](https://sling.apache.org/site/manipulating-content-the-slingpostservlet-servletspost.html) anotações padrão.

NOTE

Por padrão, EcryptionPostProcessor somente criptografa POST solicitações feitas para /etc/cloudservices.

Propriedades adicionais para o jcr da página de serviço:nós de conteúdo

Propriedade Descrição
componentReference Caminho de referência para um componente a ser incluído automaticamente na página.
Isso é usado para funcionalidade adicional e inclusões de JS.
Isso inclui o componente na página em que
cq/cloudserviceconfigs/components/servicecomponents
está incluído (normalmente antes da body tag).
No caso de o Analytics e o Público alvo usarmos isso para incluir funcionalidades adicionais, como chamadas de JavaScript para rastrear o comportamento do visitante.
descrição Breve descrição do serviço.
descriptionExtended Descrição estendida do serviço.
classificação Classificação de serviço para uso em listagens.
seletableChildren Filtro para exibir configurações na caixa de diálogo de propriedades da página.
serviceUrl URL do site de serviço.
serviceUrlLabel Rótulo do URL do serviço.
thumbnailPath Caminho para a miniatura do serviço.
visible Visibilidade na caixa de diálogo de propriedades da página; visível por padrão (opcional)

Use Cases

Esses serviços são fornecidos por padrão:

NOTE

Consulte também Criação de um Cloud Servicepersonalizado.

Nesta página