Configuração do ContextHub

O ContextHub é uma estrutura para armazenar, manipular e apresentar dados de contexto. Para obter mais detalhes sobre o ContextHub, consulte o Visão geral do desenvolvedor do ContextHub.

É possível configurar a barra de ferramentas do ContextHub para controlar se ela aparece no modo de Visualização, criar armazenamentos do ContextHub e adicionar módulos de interface.

Exibir e ocultar a interface do usuário do ContextHub

Configure o serviço OSGi do Adobe Granite ContextHub para mostrar ou ocultar o Interface do usuário do ContextHub nas suas páginas. O PID deste serviço é com.adobe.granite.contexthub.impl.ContextHubImpl.

Para configurar o serviço, você pode usar o Console da Web ou use um nó JCR no repositório:

  • Console da Web: Para mostrar a interface do usuário, selecione a propriedade Mostrar interface do usuário . Para ocultar a interface do usuário, limpe a propriedade Ocultar interface do usuário .
  • Nó JCR: Para mostrar a interface do usuário, defina o booleano com.adobe.granite.contexthub.show_ui propriedade para true. Para ocultar a interface do usuário, defina a propriedade como false.

Ao mostrar a interface do usuário do ContextHub, ela só aparece nas páginas AEM instâncias do autor. A interface do usuário não é exibida nas páginas de instâncias de publicação.

Adicionar módulos e módulos da interface do usuário do ContextHub

Configure os modos e módulos de interface que aparecem na barra de ferramentas do ContextHub no modo de Visualização:

  • Modos da interface do usuário: Grupos de módulos relacionados
  • Módulos: Widgets que expõem dados de contexto de uma loja e permitem aos autores manipular o contexto

Os modos da interface do usuário são exibidos como uma série de ícones no lado esquerdo da barra de ferramentas. Quando selecionada, os módulos de um modo de interface do usuário são exibidos à direita.

Barra de ferramentas do ContextHub

Os ícones são referências do Biblioteca de ícones da interface do usuário Coral.

Adicionar um modo de interface do usuário

Adicione um modo de interface do usuário para agrupar módulos do ContextHub relacionados. Ao criar o modo de interface do usuário, forneça o título e o ícone que aparecem na barra de ferramentas do ContextHub.

  1. No trilho Experience Manager, clique ou toque em Ferramentas > Sites > Context Hub.

  2. Clique ou toque no Contêiner de configuração padrão.

  3. Clique ou toque em Configuração do Context Hub.

  4. Clique ou toque no botão Criar e, em seguida, clique ou toque em Modo de interface do usuário do Context Hub.

    Adicionar modo de interface do usuário

  5. Forneça valores para as seguintes propriedades:

    • Título do modo da interface do usuário: O título que identifica o modo da interface do usuário
    • Ícone de modo: O seletor do Ícone Coral UI para usar, por exemplo coral-Icon--user
    • Ativado: Selecione para mostrar o modo da interface do usuário na barra de ferramentas do ContextHub
  6. Clique ou toque em Salvar.

Adição de um módulo de interface do usuário

Adicione um módulo de interface do usuário do ContextHub a um modo de interface do usuário para que ele apareça na barra de ferramentas do ContextHub para visualizar o conteúdo da página. Ao adicionar um módulo de interface do usuário, você está criando uma instância de um tipo de módulo registrado no ContextHub. Para adicionar um módulo de interface do usuário, você deve saber o nome do tipo de módulo associado.

O AEM fornece um tipo de módulo de interface de usuário base, bem como vários tipos de módulos de interface de usuário de exemplo, com base nos quais você pode basear um módulo de interface de usuário. A tabela a seguir apresenta uma breve descrição de cada uma. Para obter informações sobre como desenvolver um módulo de interface personalizada, consulte Criação de módulos de interface do usuário do ContextHub.

As propriedades do módulo da interface do usuário incluem uma configuração detalhada, na qual é possível fornecer valores para propriedades específicas do módulo. Você fornece a configuração detalhada no formato JSON. A coluna Tipo de módulo na tabela fornece links para informações sobre o código JSON necessário para cada tipo de módulo da interface do usuário.

Tipo de módulo Descrição Armazenar
contexthub.base Um tipo genérico de módulo de interface do usuário Configurado nas propriedades do módulo da interface do usuário
contexthub.browserinfo Exibe informações sobre o navegador surferinfo
contexthub.datetime Exibe informações de data e hora datetime
contexthub.location Exibe a latitude e a longitude do cliente, bem como o local em um mapa. Permite alterar o local. geolocation
contexthub.screen-orientation Exibe a orientação da tela do dispositivo (paisagem ou retrato) emulators
contexthub.tagcloud Exibe estatísticas sobre tags de página tagcloud
granite.profile Exibe as informações de perfil do usuário atual, incluindo authorizableID, displayName e familyName. Você pode alterar o valor de displayName e familyName. profile
  1. No trilho Experience Manager, clique ou toque em Ferramentas > Sites > ContextHub.

  2. Clique ou toque no Contêiner de configuração ao qual deseja adicionar um módulo de interface do usuário.

  3. Clique ou digite a Configuração do ContextHub à qual deseja adicionar o módulo da interface do usuário.

  4. Clique ou toque no modo de interface do usuário ao qual você está adicionando o módulo de interface do usuário.

  5. Clique ou toque no botão Criar e, em seguida, clique ou toque em Módulo de interface do usuário do ContextHub (genérico).

    Módulo de interface do usuário do ContextHub

  6. Forneça valores para as seguintes propriedades:

    • Título do módulo da interface do usuário: Um título que identifica o módulo da interface do usuário
    • Tipo de módulo: O tipo de módulo
    • Ativado: Selecione para mostrar o módulo de interface na barra de ferramentas do ContextHub
  7. (Opcional) Para substituir a configuração padrão do armazenamento, insira um objeto JSON para configurar o Módulo de interface do usuário.

  8. Clique ou toque em Salvar.

Criação de um armazenamento do ContextHub

Crie um armazenamento do Context Hub para manter os dados do usuário e acessá-los conforme necessário. As lojas do ContextHub são baseadas em candidatos a lojas registradas. Ao criar a loja, você precisa do valor do storeType com o qual o candidato da loja foi registrado. (Consulte Criação de Candidatos de Loja Personalizada.)

Configuração detalhada da loja

Quando você configura uma loja, a propriedade Configuração de Detalhes permite que você forneça valores para propriedades específicas da loja. O valor é baseado na variável config parâmetro do init . Portanto, se você precisa fornecer esse valor e o formato do valor depende da loja.

O valor da propriedade Configuração de Detalhes é um config no formato JSON.

Amostra de candidatos da loja

AEM fornece os seguintes candidatos a armazenamento de amostra, nos quais você pode basear uma loja.

Tipo de armazenamento Descrição
aem.segmentation Armazenar para segmentos do ContextHub resolvidos e não resolvidos. Recupera automaticamente segmentos do ContextHub SegmentManager
contexthub.geolocation Armazena a latitude e a longitude do local do navegador.
granite.emuladores Define propriedades e recursos para vários dispositivos e detecta o dispositivo cliente atual
granite.profile Armazena dados de perfil para o usuário atual
contexthub.surferinfo Armazena informações sobre o cliente, como informações do dispositivo, tipo de navegador e orientação da janela
  1. No trilho Experience Manager, clique ou toque em Ferramentas > Sites > ContextHub.

  2. Clique ou toque no contêiner de configuração padrão.

  3. Clique ou toque em Configuração do Contexthub

  4. Para adicionar uma loja, clique ou toque no ícone Criar e, em seguida, clique ou toque em Configuração da loja do ContextHub.

    Configuração do armazenamento do ContextHub

  5. Forneça os valores para as propriedades de configuração básicas e clique ou toque em Próximo:

    • Título da configuração: O título que identifica a loja
    • Tipo de armazenamento: O valor da propriedade storeType do candidato da loja no qual basear a loja
    • Obrigatório: Selecionar
    • Ativado: Selecione para ativar a loja
  6. (Opcional) Para substituir a configuração padrão do armazenamento, insira um objeto JSON na caixa Configuração de detalhes (JSON).

  7. Clique ou toque em Salvar.

Exemplo: Usar um serviço JSONP

Este exemplo ilustra como configurar uma loja e exibir os dados em um módulo da interface do usuário. Neste exemplo, o serviço MD5 do site jsontest.com é usado como uma fonte de dados para uma loja. O serviço retorna o código de hash MD5 de uma determinada string, no formato JSON.

Uma loja contexthub.generic-jsonp é configurada para armazenar dados para a chamada de serviço https://md5.jsontest.com/?text=%22text%20to%20md5%22. O serviço retorna os seguintes dados exibidos em um módulo de interface do usuário:

{
   "md5": "919a56ab62b6d5e1219fe1d95248a2c5",
   "original": "\"text to md5\""
}

Criação de uma loja contexthub.generic-jsonp

O candidato de armazenamento de amostra contexthub.generic-jsonp permite recuperar dados de um serviço JSONP ou de um serviço da Web que retorna dados JSON. Para este candidato a loja, use a configuração da loja para fornecer detalhes sobre o serviço JSONP a ser usado.

O init da ContextHub.Store.JSONPStore A classe Javascript define um config que inicializa este candidato de armazenamento. O config contém um service objeto que inclui detalhes sobre o serviço JSONP. Para configurar a loja, você fornece a variável service no formato JSON como o valor da propriedade Configuração de detalhes.

Para salvar dados do serviço MD5 do site jsontest.com, use o procedimento em Criação de um armazenamento do ContextHub usando as seguintes propriedades:

  • Título da configuração: md5

  • Tipo de armazenamento: contexthub.generic-jsonp

  • Obrigatório: Selecionar

  • Ativado: Selecionar

  • Configuração detalhada (JSON):

    {
     "service": {
     "jsonp": false,
     "timeout": 1000,
     "ttl": 1800000,
     "secure": false,
     "host": "md5.jsontest.com",
     "port": 80,
     "params":{
     "text":"text to md5"
         }
       }
     }
    

Adição de um módulo de interface para os dados md5

Adicione um módulo de interface de usuário à barra de ferramentas do ContextHub para exibir os dados armazenados no armazenamento md5 de exemplo. Neste exemplo, o módulo contexthub.base é usado para produzir o seguinte módulo de interface do usuário:

Armazenamento MD5 do ContextHub

Use o procedimento em Adição de um módulo de interface do usuário para adicionar o módulo de interface de usuário a um modo de interface de usuário existente, como o exemplo do modo de interface de usuário Persona. Para o Módulo de interface do usuário do , use os seguintes valores de propriedade:

  • Título do módulo da interface do usuário: MD5

  • Tipo de módulo: contexthub.base

  • Configuração detalhada (JSON):

    {
     "icon": "coral-Icon--data",
     "title": "MD5 Conversion",
     "storeMapping": { "md5": "md5" },
     "template": "<p> {{md5.original}}</p>;
                  <p>{{md5.md5}}</p>"
    }
    

Depuração do ContextHub

Um modo de depuração do ContextHub pode ser ativado para permitir a solução de problemas. O modo de depuração pode ser ativado por meio da configuração do ContextHub ou por meio do CRXDE.

Com a configuração

Edite a configuração do ContextHub e marque a opção Depurar

  1. No painel, clique ou toque em Ferramentas > Sites > ContextHub
  2. Clique ou toque no padrão Contêiner de configuração
  3. Selecione o Configuração do ContextHub e clique ou toque em Editar elemento selecionado
  4. Clique ou toque em Depurar e clique ou toque em Salvar

Via CRXDE

Use o CRXDE Lite para definir a propriedade debug para true em:

  • /conf/global/settings/cloudsettings ou
  • /conf/<site>/settings/cloudsettings

Registro de mensagens de depuração do ContextHub

Configurar o serviço OSGi do Adobe Granite ContextHub (PID = com.adobe.granite.contexthub.impl.ContextHubImpl) para registrar mensagens de Depuração detalhadas que são úteis no desenvolvimento.

Para configurar o serviço, você pode usar o Console da Web ou use um nó JCR no repositório:

  • Console da Web: Para registrar mensagens de depuração, selecione a propriedade Debug .
  • Nó JCR: Para registrar mensagens de depuração, defina o booleano com.adobe.granite.contexthub.debug propriedade para true.

Modo silencioso

O modo silencioso suprime todas as informações de depuração. Ao contrário da opção de depuração normal, que pode ser definida independentemente para cada configuração do ContextHub, o modo silencioso é uma configuração global que tem precedência sobre qualquer configuração de depuração no nível de configuração do ContextHub.

Isso é útil para a sua instância de publicação, onde você não quer nenhuma informação de depuração. Como é uma configuração global, ela é ativada por meio de OSGi.

  1. Abra o Configuração do Console da Web do Adobe Experience Manager at http://<host>:<port>/system/console/configMgr
  2. Procurar por Adobe Granite ContextHub
  3. Clique na configuração Adobe Granite ContextHub para editar suas propriedades
  4. Marque a opção Modo silencioso e clique em Salvar

Desativação do ContextHub

O ContextHub pode ser desativado para impedir o carregamento de js/css e a inicialização. Há duas opções para desativar o ContextHub:

  • Edite a configuração do ContextHub e marque a opção Desativar o ContextHub

    1. No painel, clique ou toque em Ferramentas > Sites > ContextHub
    2. Clique ou toque no padrão Contêiner de configuração
    3. Selecione o Configuração do ContextHub e clique ou toque em Editar elemento selecionado
    4. Clique ou toque em Desativar o ContextHub e clique ou toque em Salvar

ou

  • Use o CRXDE Lite para definir a propriedade disabled para true under /conf/global/settings/cloudsettings/<configName>/contexthub

Nesta página