AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.
O Contexto do Cliente foi substituído pelo ContextHub na interface de toque. Consulte a documentação relacionada para obter detalhes.
O Contexto do Cliente representa uma coleção dinâmica de dados do usuário. Você pode usar os dados para determinar o conteúdo a ser exibido em uma página da Web em uma determinada situação (direcionamento de conteúdo). Os dados também estão disponíveis para análises de sites e para qualquer javascript na página.
O Contexto do Cliente consiste principalmente nos seguintes aspectos:
Para criar um armazenamento de sessão independente e adicioná-lo ao Contexto do Cliente ou criar um armazenamento de sessão vinculado a um componente do Armazenamento de Contexto. AEM instala vários componentes da Loja de contexto que você pode usar imediatamente. Você pode usar esses componentes como base para seus componentes.
Para obter informações sobre como abrir o Contexto do Cliente, configurar as informações exibidas e simular a experiência do usuário, consulte Contexto do cliente.
O Contexto do Cliente inclui vários armazenamentos de sessão que contêm dados do usuário. Os dados de armazenamento vêm das seguintes fontes:
A estrutura de Contexto do Cliente fornece uma API javascript que você pode usar para interagir com armazenamentos de sessão para ler e gravar dados do usuário e ouvir e reagir a eventos da loja. Você também pode criar armazenamentos de sessão para dados do usuário que você usa para direcionamento de conteúdo ou outros fins.
Os dados do armazenamento da sessão permanecem no cliente. O Contexto do Cliente não grava dados de volta no servidor. Para enviar dados ao servidor, use um formulário ou desenvolva um javascript personalizado.
Cada armazenamento de sessão é uma coleção de pares de valores de propriedade. O armazenamento de sessão representa uma coleção de dados (de qualquer tipo), cujo significado conceitual pode ser decidido pelo designer e/ou desenvolvedor. O exemplo de código javascript a seguir define um objeto que representa os dados de perfil que o armazenamento de sessão pode conter:
{
age: 20,
authorizableId: "aparker@geometrixx.info",
birthday: "27 Feb 1992",
email: "aparker@geometrixx.info",
formattedName: "Alison Parker",
gender: "female",
path: "/home/users/geometrixx/aparker@geometrixx.info/profile"
}
Um armazenamento de sessão pode ser mantido nas sessões do navegador ou pode durar apenas para a sessão do navegador em que foi criado.
A persistência de armazenamento usa o armazenamento do navegador ou os cookies (a variável SessionPersistence
cookie). O armazenamento do navegador é mais comum.
Quando o navegador é fechado e reaberto, um armazenamento de sessão pode ser carregado com os valores de um armazenamento persistente. A limpeza do cache do navegador é necessária para remover os valores antigos.
Um componente de armazenamento de contexto é um componente AEM que pode ser adicionado ao Contexto do Cliente. Normalmente, os componentes do armazenamento de contexto exibem dados de um armazenamento de sessão com o qual estão associados. No entanto, as informações exibidas pelos componentes do armazenamento de contexto não se limitam aos dados do armazenamento de sessão.
Os componentes do armazenamento de contexto podem incluir os seguintes itens:
Para obter uma descrição dos Componentes do Context Store instalados que você pode adicionar ao Context Store, consulte Componentes de contexto de cliente disponíveis.
Os dados da página não estão mais no contexto do cliente como um componente padrão. Se necessário, é possível adicionar isso editando o contexto do cliente, adicionando a variável Propriedades da Loja Genérica , em seguida, configure-o para definir a variável Loja as pagedata
.
As informações do perfil também são usadas para fornecer conteúdo direcionado.
Inclua o componente Contexto do Cliente na seção de corpo de suas páginas da Web para ativar o Contexto do Cliente. O caminho do nó do componente Contexto do Cliente é /libs/cq/personalization/components/clientcontext
. Para incluir o componente, adicione o seguinte código ao arquivo JSP do seu componente de página, localizado logo abaixo do body
elemento da sua página:
<cq:include path="clientcontext" resourceType="cq/personalization/components/clientcontext"/>
O componente clientcontext faz com que a página carregue as bibliotecas de clientes que implementam o ClientContext.
A interface do usuário de contexto do cliente está disponível somente na instância do autor.
Para estender o Contexto do Cliente, crie um armazenamento de sessão e, como opção, exiba os dados do armazenamento:
Se você tiver (ou criar) uma JSONP
que pode fornecer os dados, você pode simplesmente usar a variável JSONP
componente de armazenamento de contexto e mapeie-o para o serviço JSONP. Isso lidará com o armazenamento de sessão.
Crie um armazenamento de sessão para os dados que você precisa adicionar e recuperar do Contexto do Cliente. Geralmente, você usa o seguinte procedimento para criar um armazenamento de sessão:
Crie uma pasta da biblioteca do cliente que tenha uma categories
valor da propriedade de personalization.stores.kernel
. O Contexto do Cliente carrega automaticamente as bibliotecas do cliente desta categoria.
Configure a pasta da biblioteca do cliente para que ela tenha uma dependência no personalization.core.kernel
pasta da biblioteca do cliente. O personalization.core.kernel
a biblioteca do cliente fornece a API javascript do Contexto do Cliente.
Adicione o javascript que cria e inicializa o armazenamento de sessão.
A inclusão do javascript na biblioteca de clientes personalization.stores.kernel faz com que a loja seja criada quando a estrutura Contexto do Cliente for carregada.
Se estiver criando um armazenamento de sessão como parte de um componente de armazenamento de contexto, você pode, como alternativa, colocar o javascript no arquivo init.js.jsp do componente. Nesse caso, o armazenamento de sessão é criado somente se o componente for adicionado ao Contexto do Cliente.
Os armazenamentos de sessão são criados e disponibilizados durante uma sessão do navegador ou persistem no armazenamento do navegador ou nos cookies. A API javascript de Contexto do Cliente define várias classes que representam ambos os tipos de armazenamentos de dados:
CQ_Analytics.SessionStore
: Esses objetos residem somente no DOM da página. Os dados são criados e mantidos durante a vida útil da página.CQ_Analytics.PerstistedSessionStore
: Esses objetos residem no DOM da página e são mantidos no armazenamento do navegador ou em cookies. Os dados estão disponíveis em páginas e em sessões de usuário.A API também fornece extensões dessas classes especializadas para armazenar dados JSON ou dados JSONP:
Objetos somente sessão: CQ_Analytics.JSONStore
e CQ-Analytics.JSONPStore
.
Objetos persistentes: CQ_Analytics.PersistedJSONStore
e CQ-Analytics.PersistedJSONPStore
.
O javascript da pasta da biblioteca de clientes cria e inicializa o armazenamento de sessão. O armazenamento de sessão deve ser registrado usando o Gerenciador de armazenamento de contexto. O exemplo a seguir cria e registra um CQ_Analytics.SessionStore objeto.
//Create the session store
if (!CQ_Analytics.MyStore) {
CQ_Analytics.MyStore = new CQ_Analytics.SessionStore();
CQ_Analytics.MyStore.STOREKEY = "MYSTORE";
CQ_Analytics.MyStore.STORENAME = "mystore";
CQ_Analytics.MyStore.data={};
}
//register the session store
if (CQ_Analytics.ClientContextMgr){
CQ_Analytics.ClientContextMgr.register(CQ_Analytics.MyStore)
}
Para armazenar dados JSON, o exemplo a seguir cria e registra um CQ_Analytics.JSONStore objeto.
if (!CQ_Analytics.myJSONStore) {
CQ_Analytics.myJSONStore = CQ_Analytics.JSONStore.registerNewInstance("myjsonstore",{});
}
Crie um componente de armazenamento de contexto para renderizar dados de armazenamento de sessão no Contexto do Cliente. Depois de criado, você pode arrastar seu componente de armazenamento de contexto para o Contexto do Cliente para renderizar dados de um armazenamento de sessão. Os componentes do armazenamento de contexto consistem nos seguintes itens:
AEM fornece o armazenamento genérico e os componentes do armazenamento de contexto genericstoreproperties que você pode estender. A estrutura dos dados da loja determina o componente que você estende:
Pares de valor de propriedade: Estender o GenericStoreProperties
componente. Esse componente renderiza automaticamente lojas de pares de valores de propriedade. Vários pontos de interação são fornecidos:
prolog.jsp
e epilog.jsp
: interação de componente que permite adicionar lógica do lado do servidor antes ou depois da renderização do componente.Dados complexos: Estender o GenericStore
componente. O armazenamento de sessão precisará de um método de "renderizador" que será chamado sempre que o componente precisar ser renderizado. A função renderizadora é chamada com dois parâmetros:
@param {String} store
A loja a renderizar
@param {String} divId
Id do div no qual o armazenamento deve ser renderizado.
Todos os componentes de Contexto do Cliente são extensões dos componentes Loja Genérica ou Propriedades de Loja Genérica. Vários exemplos são instalados na variável /libs/cq/personalization/components/contextstores
pasta.
Ao editar o Contexto do Cliente, os componentes do armazenamento de contexto são exibidos no Sidekick. Assim como em todos os componentes, a variável componentGroup
e jcr:title
as propriedades do componente de contexto do cliente determinam o grupo e o nome do componente.
Todos os componentes que têm uma componentGroup
valor da propriedade de Client Context
aparecem no Sidekick por padrão. Se você usar um valor diferente para a variável componentGroup
, você deve adicionar o componente manualmente ao Sidekick usando o modo Design .
Ao adicionar um componente de armazenamento de contexto ao Contexto do Cliente, um nó que representa a instância do componente é criado abaixo /etc/clientcontext/default/content/jcr:content/stores
. Esse nó contém os valores da propriedade que são configurados usando a caixa de diálogo Editar do componente.
Quando o Contexto do Cliente é inicializado, esses nós são processados.
Adicione um arquivo init.js.jsp ao seu componente para gerar um código javascript que inicializa o armazenamento de sessão que seu componente de armazenamento de contexto usa. Por exemplo, use o script de inicialização para recuperar as propriedades de configuração do componente e usá-las para preencher o armazenamento de sessão.
O javascript gerado é adicionado à página quando o Contexto do Cliente é inicializado no carregamento da página nas instâncias de autor e de publicação. Esse JSP é executado antes que a instância do componente de armazenamento de contexto seja carregada e renderizada.
O código deve definir o tipo mime do arquivo como text/javascript
ou não é executado.
O script init.js.jsp é executado na instância de criação e publicação, mas somente se o componente de armazenamento de contexto for adicionado ao Contexto do Cliente.
O procedimento a seguir cria o arquivo de script init.js.jsp e adiciona o código que define o tipo mime correto. O código que executa a inicialização de armazenamento seria seguido.
Clique com o botão direito do mouse no nó do componente de armazenamento de contexto e clique em Criar > Criar arquivo.
No campo Nome, digite init.js.jsp
e clique em OK.
Na parte superior da página, adicione o seguinte código e clique em Salvar tudo.
<%@page contentType="text/javascript" %>
Exibir dados do armazenamento da sessão no Contexto do Cliente usando um formato consistente.
O taglib de personalização fornece a variável personalization:storePropertyTag
que exibe o valor de uma propriedade de um armazenamento de sessão. Para usar a tag , inclua a seguinte linha de código no arquivo JSP:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
A tag tem o seguinte formato:
<personalization:storePropertyTag propertyName="property_name" store="session_store_name"/>
O propertyName
attribute é o nome da propriedade store a ser exibida. O store
attribute é o nome do armazenamento registrado. A tag de exemplo a seguir exibe o valor da variável authorizableId
da profile
armazenar:
<personalization:storePropertyTag propertyName="authorizableId" store="profile"/>
A pasta de biblioteca do cliente personalization.ui (/etc/clientlibs/foundation/personalization/ui/themes/default?lang=pt-BR) fornece os estilos CSS que o Client Context usa para formatar o código HTML. O código a seguir ilustra a estrutura sugerida a ser usada para exibir dados da loja:
<div class="cq-cc-store">
<div class="cq-cc-thumbnail">
<div class="cq-cc-store-property">
<!-- personalization:storePropertyTag for the store thumbnail image goes here -->
</div>
</div>
<div class="cq-cc-content">
<div class="cq-cc-store-property cq-cc-store-property-level0">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level1">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level2">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level3">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
</div>
<div class="cq-cc-clear"></div>
</div>
O /libs/cq/personalization/components/contextstores/profiledata
o componente de armazenamento de contexto usa essa estrutura para exibir dados do armazenamento de sessão do perfil. O cq-cc-thumbnail
adiciona a imagem em miniatura. O cq-cc-store-property-level*x*
As classes formatam os dados alfanuméricos:
Para renderizar dados de armazenamento usando um componente de armazenamento de genéricos, é necessário:
O taglib de personalização fornece a variável personalization:storePropertyTag
que exibe o valor de uma propriedade de um armazenamento de sessão. Para usar a tag , inclua a seguinte linha de código no arquivo JSP:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
A tag tem o seguinte formato:
<personalization:storeRendererTag store="store_name"/>
O armazenamento de sessão precisará de um método de "renderizador" que será chamado sempre que o componente precisar ser renderizado. A função renderizadora é chamada com dois parâmetros:
@param {String} store
A loja a renderizar
@param {String} divId
Id do div no qual o armazenamento deve ser renderizado.
Use o javascript para interagir com armazenamentos de sessão.
Obtenha um objeto de armazenamento de sessão para ler ou gravar dados no armazenamento. CQ_Analytics.ClientContextMgr
fornece acesso a lojas com base no nome da loja. Uma vez obtidos, use os métodos da CQ-Analytics.SessionStore
ou CQ-Analytics.PersistedSessionStore
para interagir com os dados de armazenamento.
O exemplo a seguir obtém a variável profile
armazene e recupera o formattedName
da loja.
function getName(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
if(profilestore){
return profilestore.getProperty("formattedName", false);
} else {
return null;
}
}
A sessão armazena eventos de acionamento, portanto, é possível adicionar ouvintes e acionar eventos com base nesses eventos.
Os armazenamentos de sessão são criados no Observable
padrão. Elas se estendem CQ_Analytics.Observable
que fornece a addListener
método .
O exemplo a seguir adiciona um ouvinte ao update
do profile
armazenamento de sessão.
var profileStore = ClientContextMgr.getRegisteredStore("profile");
if( profileStore ) {
//callback execution context
var executionContext = this;
//add "update" event listener to store
profileStore.addListener("update",function(store, property) {
//do something on store update
},executionContext);
}
Os armazenamentos de sessão não estão disponíveis até serem carregados e inicializados com dados. Os seguintes fatores podem afetar o tempo de disponibilidade do armazenamento da sessão:
Use o CQ_Analytics.ClientContextUtils
do objeto onStoreRegistered
e onStoreInitialized
métodos para acessar armazenamentos de sessão somente quando estiverem disponíveis. Esses métodos permitem registrar ouvintes de eventos que reagem aos eventos de registro e inicialização da sessão.
Se você depender de outra loja, precisará atender o caso de a loja nunca ser registrada.
O exemplo a seguir usa a variável onStoreRegistered
do profile
armazenamento de sessão. Quando a loja é registrada, um ouvinte é adicionado ao update
do armazenamento de sessão. Quando a loja é atualizada, o conteúdo da variável <div class="welcome">
O elemento na página é atualizado com o nome do profile
armazenar.
//listen for the store registration
CQ_Analytics.ClientContextUtils.onStoreRegistered("profile", listen);
//listen for the store's update event
function listen(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
profilestore.addListener("update",insertName);
}
//insert the welcome message
function insertName(){
$("div.welcome").text("Welcome "+getName());
}
//obtain the name from the profile store
function getName(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
if(profilestore){
return profilestore.getProperty("formattedName", false);
} else {
return null;
}
}
Para evitar uma propriedade de um PersistedSessionStore
da persistência (ou seja, exclua do sessionpersistence
cookie), adicione a propriedade à lista de propriedades não persistentes do armazenamento de sessão persistente.
Consulte CQ_Analytics.PersistedSessionStore.setNonPersisted(propertyName)
CQ_Analytics.ClientContextUtils.onStoreRegistered("surferinfo", function(store) {
//this will exclude the browser, OS and resolution properties of the surferinfo session store from the
store.setNonPersisted("browser");
store.setNonPersisted("OS");
store.setNonPersisted("resolution");
});
A página atual deve ter uma página móvel correspondente; isso é determinado somente se a página tiver uma LiveCopy configurada com uma configuração de implantação móvel ( rolloutconfig.path.toLowerCase
contém mobile
).
Ao alternar da página de desktop para seu equivalente móvel:
O DOM da página móvel é carregado.
O principal div
(obrigatório) que contém o conteúdo, é extraído e injetado na página de desktop atual.
As classes CSS e body que precisam ser carregadas precisam ser configuradas manualmente.
Por exemplo:
window.CQMobileSlider["geometrixx-outdoors"] = {
//CSS used by desktop that need to be removed when mobile
DESKTOP_CSS: [
"/etc/designs/${app}/clientlibs_desktop_v1.css"
],
//CSS used by mobile that need to be removed when desktop
MOBILE_CSS: [
"/etc/designs/${app}/clientlibs_mobile_v1.css"
],
//id of the content that needs to be removed when mobile
DESKTOP_MAIN_ID: "main",
//id of the content that needs to be removed when desktop
MOBILE_MAIN_ID: "main",
//body classes used by desktop that need to be removed when mobile
DESKTOP_BODY_CLASS: [
"page"
],
//body classes used by mobile that need to be removed when desktop
MOBILE_BODY_CLASS: [
"page-mobile"
]
};
Neste exemplo, você cria um componente de armazenamento de contexto que recupera dados de um serviço externo e o armazena no armazenamento de sessão:
CQ_Analytics.JSONPStore
objeto javascript.Crie um aplicativo CQ e adicione o componente geoloc.
Abra o CRXDE Lite no navegador da Web (http://localhost:4502/crx/de).
Clique com o botão direito do mouse no /apps
e clique em Criar > Criar pasta. Especifique um nome de myapp
e clique em OK.
Da mesma forma, abaixo myapp
, crie uma pasta chamada contextstores
. "
Clique com o botão direito do mouse no /apps/myapp/contextstores
e clique em Criar > Criar componente. Especifique os seguintes valores de propriedade e clique em Avançar:
cq/personalization/components/contextstores/genericstoreproperties
Na caixa de diálogo Criar componente, clique em Avançar em cada página até que o botão OK esteja ativado e clique em OK.
Clique em Salvar tudo.
O componente de armazenamento de contexto requer uma caixa de diálogo de edição. A caixa de diálogo de edição geográfica conterá uma mensagem estática indicando que não há propriedades a serem configuradas.
Clique com o botão direito do mouse no /libs/cq/personalization/components/contextstores/genericstoreproperties/dialog
e clique em Copiar.
Clique com o botão direito do mouse no /apps/myapp/contextstores/geoloc
e clique em colar.
Exclua todos os nós filhos abaixo do nó /apps/myapp/contextstores/geoloc/dialog/items/items/tab1/items:
Clique com o botão direito do mouse no /apps/myapp/contextstores/geoloc/dialog/items/items/tab1/items
e clique em Criar > Criar nó. Especifique os seguintes valores de propriedade e clique em OK:
Adicione as seguintes propriedades ao nó :
Nome | Tipo | Valor |
---|---|---|
cls | String | x-form-fieldset-description |
text | String | O componente geoloc não requer configuração. |
xtype | String | estático |
Clique em Salvar tudo.
Adicione um arquivo init.js.jsp ao componente geoloc e use-o para criar o armazenamento de sessão, recuperar os dados de localização e adicioná-los ao armazenamento.
O arquivo init.js.jsp é executado quando o Contexto do Cliente é carregado pela página. Por esse tempo, a API javascript do Contexto do Cliente será carregada e estará disponível no seu script.
Clique com o botão direito do mouse no /apps/myapp/contextstores/geoloc
e clique em Criar -> Criar arquivo. Especifique um Nome de init.js.jsp e clique em OK.
Adicione o seguinte código à parte superior da página e clique em Salvar tudo.
<%@page contentType="text/javascript;charset=utf-8" %><%
%><%@include file="/libs/foundation/global.jsp"%><%
log.info("***** initializing geolocstore ****");
String store = "locstore";
String jsonpurl = "https://api.wipmania.com/jsonp?callback=${callback}";
%>
var locstore = CQ_Analytics.StoreRegistry.getStore("<%= store %>");
if(!locstore){
locstore = CQ_Analytics.JSONPStore.registerNewInstance("<%= store %>", "<%= jsonpurl %>",{});
}
<% log.info(" ***** done initializing geoloc ************"); %>
Adicione o código ao arquivo JSP do componente geoloc para renderizar os dados de armazenamento no Contexto do Cliente.
No CRXDE Lite, abra o /apps/myapp/contextstores/geoloc/geoloc.jsp
arquivo.
Adicione o seguinte código de HTML abaixo do código stub:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
<div class="cq-cc-store">
<div class="cq-cc-content">
<div class="cq-cc-store-property cq-cc-store-property-level0">
Continent: <personalization:storePropertyTag propertyName="address/continent" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level1">
Country: <personalization:storePropertyTag propertyName="address/country" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level2">
City: <personalization:storePropertyTag propertyName="address/city" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level3">
Latitude: <personalization:storePropertyTag propertyName="latitude" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level4">
Longitude: <personalization:storePropertyTag propertyName="longitude" store="locstore"/>
</div>
</div>
<div class="cq-cc-clear"></div>
</div>
Clique em Salvar tudo.
Adicione o componente Armazenamento de localização ao Contexto do cliente para que ele seja inicializado quando a página for carregada.
Abra a página inicial do Geometrixx Outdoors na instância do autor (http://localhost:4502/content/geometrixx-outdoors/en.html).
Clique em Ctrl-Alt-c (windows) ou control-option-c (Mac) para abrir o Contexto do Cliente.
Clique no ícone de edição na parte superior do Contexto do Cliente para abrir o Designer de Contexto do Cliente.
Arraste o componente Armazenamento de local para o Contexto do cliente.
Abra a página inicial do Geometrixx Outdoors no modo de edição e, em seguida, abra o Contexto do Cliente para ver os dados do componente Armazenamento de Local.
Para criar um segundo contexto de cliente, você precisa duplicar a ramificação:
/etc/clientcontext/default
A subpasta:
/content
conterá o conteúdo do contexto de cliente personalizado.
A pasta:
/contextstores
permite definir configurações diferentes para os armazenamentos de contexto.
Para usar o contexto personalizado do cliente, edite a propriedade
path
no estilo de design do componente de contexto do cliente, conforme incluído no modelo da página. Por exemplo, como o local padrão de:
/libs/cq/personalization/components/clientcontext/design_dialog/items/path