Contexto do cliente em detalhes client-context-in-detail

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.

Lojas de sessão session-stores

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.

Componentes da loja de contexto context-store-components

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.

Entrega de conteúdo direcionada targeted-content-delivery

As informações do perfil também são usadas para fornecer conteúdo direcionado.

Adicionar Contexto Do Cliente A Uma Página adding-client-context-to-a-page

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.

Extensão do contexto do cliente extending-client-context

Para estender o Contexto do Cliente, crie um armazenamento de sessão e, como opção, exiba os dados do armazenamento:

Criar um armazenamento de sessão creating-a-session-store

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:

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.

Tipos de armazenamentos de sessão types-of-session-stores

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:

A API também fornece extensões dessas classes especializadas para armazenar dados JSON ou dados JSONP:

Criação do objeto do armazenamento de sessão creating-the-session-store-object

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",{});
}

Criação de um componente de armazenamento de contexto creating-a-context-store-component

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:

Extensão dos componentes fornecidos do armazenamento de contexto extending-the-provided-context-store-components

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:

Configuração da aparência no Sidekick configuring-the-appearance-in-sidekick

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 .

Instâncias do componente de armazenamento de contexto context-store-component-instances

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.

Inicializando o Repositório de Sessões Associado initializing-the-associated-session-store

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/javascriptou não é executado.

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.

Renderização de dados do armazenamento de sessão para componentes de propriedades de armazenamento genérico rendering-session-store-data-for-genericstoreproperties-components

Exibir dados do armazenamento da sessão no Contexto do Cliente usando um formato consistente.

Exibição de dados de propriedade displaying-property-data

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"/>

Estrutura HTML html-structure

A pasta de biblioteca do cliente personalization.ui (https://experienceleague.adobe.com/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:

Renderização de dados do armazenamento da sessão para componentes do genericstore rendering-session-store-data-for-genericstore-components

Para renderizar dados de armazenamento usando um componente de armazenamento de genéricos, é necessário:

Identificação do armazenamento de sessão genericstore identifying-the-genericstore-session-store

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"/>

Implementando o método de renderização do Armazenamento de Sessões implementing-the-session-store-renderer-method

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:

Interagir com armazenamentos de sessão interacting-with-session-stores

Use o javascript para interagir com armazenamentos de sessão.

Acessar armazenamentos de sessão accessing-session-stores

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;
   }
}

Criação de um ouvinte para reagir a uma atualização do armazenamento de sessão creating-a-listener-to-react-to-a-session-store-update

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);
}

Verificando se um Repositório de Sessões está definido e inicializado checking-that-a-session-store-is-defined-and-initialized

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.

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;
    }
}

Excluir uma propriedade do cookie de persistência de sessão excluding-a-property-from-the-sessionpersistence-cookie

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");
});

Configurar o controle deslizante do dispositivo configuring-the-device-slider

Condições conditions

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).

Configuração configuration

Ao alternar da página de desktop para seu equivalente móvel:

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"
  ]
};

Exemplo: Criação de um componente personalizado do armazenamento de contexto example-creating-a-custom-context-store-component

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:

Adicionar o componente geográfico add-the-geoloc-component

Crie um aplicativo CQ e adicione o componente geoloc.

Criar a caixa de diálogo Editar geoloc create-the-geoloc-edit-dialog

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.

Criar o script de inicialização create-the-initialization-script

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.

Renderizar os dados do armazenamento de sessão geoloc render-the-geoloc-session-store-data

Adicione o código ao arquivo JSP do componente geoloc para renderizar os dados de armazenamento no Contexto do Cliente.

Adicionar o componente ao contexto do cliente add-the-component-to-client-context

Adicione o componente Armazenamento de localização ao Contexto do cliente para que ele seja inicializado quando a página for carregada.

Consulte as Informações de localização no contexto do cliente see-the-location-information-in-client-context

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.

Criação de um contexto de cliente personalizado creating-a-customized-client-context

Para criar um segundo contexto de cliente, você precisa duplicar a ramificação:

/etc/clientcontext/default

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