Configuração do ContextHub configuring-contexthub
O ContextHub é uma estrutura para armazenar, manipular e apresentar dados de contexto. Para obter mais detalhes sobre o ContextHub, consulte a documentação do desenvolvedor. O ContextHub substitui o Client Context na interface para toque.
Configure a barra de ferramentas ContextHub para controlar se ela aparece no modo de Visualização, para criar armazenamentos do ContextHub e adicionar módulos de interface usando a interface otimizada para toque.
Desativar o ContextHub disabling-contexthub
Por padrão, o ContextHub é ativado em uma instalação do AEM. O ContextHub pode ser desativado para impedir que carregue js/css e inicialize.
- Use CRXDE Lite para definir a propriedade
disabled
como true em/libs/settings/cloudsettings/legacy/contexthub
/etc/cloudsettings
para:/libs/settings/cloudsettings
/conf/global/settings/cloudsettings
/conf/<tenant>/settings/cloudsettings
Exibição e ocultação da interface do usuário do ContextHub showing-and-hiding-the-contexthub-ui
Configure o serviço OSGi do Adobe Granite ContextHub para mostrar ou ocultar a Interface do usuário do ContextHub em 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 usar 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, desmarque a propriedade Ocultar interface do usuário.
- Nó JCR: Para mostrar a interface do usuário, defina a propriedade booleana
com.adobe.granite.contexthub.show_ui
comotrue
. Para ocultar a interface, defina a propriedade comofalse
.
Ao mostrar a interface do usuário do ContextHub, ela só é exibida em páginas em instâncias de autor do AEM. A interface do usuário não aparece em páginas de instâncias de publicação.
Adição de modos e módulos da interface do usuário do ContextHub adding-contexthub-ui-modes-and-modules
Configure os modos e módulos da interface do usuário exibidos na barra de ferramentas do ContextHub no modo Visualização:
- Modos de interface do usuário: grupos de módulos relacionados
- Módulos: dispositivos que expõem dados de contexto de um armazenamento e permitem que os autores manipulem o contexto
Os modos da interface são exibidos como uma série de ícones no lado esquerdo da barra de ferramentas. Quando selecionados, os módulos de um modo de interface do usuário são exibidos à direita.
Os ícones são referências da biblioteca de ícones da interface do Coral.
Adição de um modo de interface adding-a-ui-mode
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.
-
No painel Experience Manager, clique em Ferramentas > Sites > Context Hub.
-
Clique no Contêiner de configuração padrão.
-
Clique em Configuração do Context Hub.
-
Clique no botão Criar e, em seguida, clique em Modo da interface do usuário do Context Hub.
-
Forneça valores para as seguintes propriedades:
- Título do modo da interface: o título que identifica o modo da interface
- Ícone de Modo: O seletor do ícone da interface do Coral para usar, por exemplo,
coral-Icon--user
- Ativado: selecione para mostrar o modo de interface na barra de ferramentas do ContextHub
-
Clique em Salvar.
Adição de um módulo de interface adding-a-ui-module
Adicione um módulo da interface do usuário do ContextHub a um modo de interface do usuário para que ele seja exibido na barra de ferramentas do ContextHub para a visualização do 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 do usuário base, bem como vários tipos de módulo de interface do usuário de amostra nos quais você pode basear um módulo de interface do usuário. A tabela a seguir fornece uma breve descrição de cada uma. Para obter informações sobre como desenvolver um módulo de interface personalizada, consulte Criando módulos de interface do usuário do ContextHub.
As propriedades do módulo de interface do usuário incluem uma configuração detalhada, na qual você pode 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 de interface do usuário.
-
No painel Experience Manager, clique em Ferramentas > Sites > ContextHub.
-
Clique no Contêiner de configuração ao qual você deseja adicionar um módulo de interface.
-
Clique ou digite a Configuração do ContextHub à qual você deseja adicionar o módulo de interface do usuário.
-
Clique no modo da interface do usuário ao qual você está adicionando o módulo da interface do usuário.
-
Clique no botão Criar e em Módulo de interface do usuário do ContextHub (genérico).
-
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 do usuário na barra de ferramentas do ContextHub
-
(Opcional) Para substituir a configuração de armazenamento padrão, insira um objeto JSON para configurar o Módulo de interface do usuário.
-
Clique em Salvar.
Criação de um armazenamento do ContextHub creating-a-contexthub-store
Crie um armazenamento do Context Hub para manter os dados do usuário e acessar os dados conforme necessário. Os armazenamentos do ContextHub são baseados em candidatos de armazenamento registrados. Ao criar o armazenamento, é necessário o valor do storeType com o qual o candidato do armazenamento foi registrado. (Consulte Criação De Candidatos À Loja Personalizada.)
Configuração detalhada da loja detailed-store-configuration
Quando você configura um armazenamento, a propriedade Detail Configuration permite fornecer valores para propriedades específicas do armazenamento. O valor é baseado no parâmetro config
da função init
do armazenamento. Portanto, a necessidade de fornecer esse valor e o formato do valor dependem do armazenamento.
O valor da propriedade Configuração Detalhada é um objeto config
em formato JSON.
Amostra de candidatos da loja sample-store-candidates
O AEM fornece as seguintes amostras de candidatos de armazenamento nas quais você pode basear uma loja.
-
No painel Experience Manager, clique em Ferramentas > Sites > ContextHub.
-
Clique no container de configuração padrão.
-
Clique em Configuração do Contexthub
-
Para adicionar um armazenamento, clique no ícone Create e em ContexHub Store Configuration.
-
Forneça valores para as propriedades de configuração básica e clique em Próximo:
- Título da Configuração: o título que identifica o armazenamento
- Tipo de repositório: O valor da propriedade storeType do candidato a repositório no qual basear o repositório
- Obrigatório: Selecionar
- Habilitado: selecione para habilitar o repositório
-
(Opcional) Para substituir a configuração de armazenamento padrão, insira um objeto JSON na caixa Configuração detalhada (JSON).
-
Clique em Salvar.
Exemplo: usando um serviço JSONP example-using-a-jsonp-service
Este exemplo ilustra como configurar um armazenamento e exibir os dados em um módulo de interface do usuário. Neste exemplo, o serviço MD5 do site jsontest.com é usado como uma fonte de dados para um armazenamento. O serviço retorna o código hash MD5 de uma determinada string, no formato JSON.
Um repositório contexthub.generic-jsonp está configurado 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 que são exibidos em um módulo de interface do usuário:
{
"md5": "919a56ab62b6d5e1219fe1d95248a2c5",
"original": "\"text to md5\""
}
Criação de um armazenamento contexthub.generic-jsonp creating-a-contexthub-generic-jsonp-store
O candidato do armazenamento de amostra contexthub.generic-jsonp permite recuperar dados de um serviço JSONP ou um serviço da Web que retorna dados JSON. Para este candidato da loja, use a configuração da loja para fornecer detalhes sobre o serviço JSONP a ser usado.
A função init da classe JavaScript ContextHub.Store.JSONPStore
define um objeto config
que inicializa esse candidato de armazenamento. O objeto config
contém um objeto service
que inclui detalhes sobre o serviço JSONP. Para configurar o armazenamento, você fornece o objeto service
no formato JSON como o valor da propriedade Configuração Detalhada.
Para salvar dados do serviço MD5 do site jsontest.com, use o procedimento em Criando um Armazenamento do ContextHub usando as seguintes propriedades:
-
Título da Configuração: md5
-
Tipo de armazenamento: contexthub.generic-jsonp
-
Obrigatório: Selecionar
-
Habilitado: Selecionar
-
Configuração detalhada (JSON):
code language-xml { "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 do usuário para os dados md5 adding-a-ui-module-for-the-md-data
Adicione um módulo de interface do 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:
Use o procedimento em Adicionando um Módulo de Interface do Usuário para adicionar o módulo de interface do usuário a um Modo de Interface do Usuário existente, como o Modo de Interface do Usuário Perona de exemplo. Para o Módulo de interface do usuário, 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):
code language-xml { "icon": "coral-Icon--data", "title": "MD5 Converstion", "storeMapping": { "md5": "md5" }, "template": "<p> {{md5.original}}</p>; <p>{{md5.md5}}</p>" }
Depuração do ContextHub debugging-contexthub
Um modo de depuração para o 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 pelo CRXDE.
Através da configuração via-the-configuration
Edite a configuração do ContextHub e verifique a opção Debug
- No painel, clique em Ferramentas > Sites > ContextHub
- Clique no Contêiner de configuração padrão
- Selecione a Configuração do ContextHub e clique em Editar elemento selecionado
- Clique em Depurar e em Salvar
Via CRXDE via-crxde
Use CRXDE Lite para definir a propriedade debug
como true em:
/conf/global/settings/cloudsettings
ou/conf/<tenant>/settings/cloudsettings
debug property
é /libs/settings/cloudsettings/legacy/contexthub
.Modo silencioso silent-mode
O modo silencioso suprime todas as informações de depuração. Diferentemente 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 instância de publicação, na qual você não deseja nenhuma informação de depuração. Como é uma configuração global, ela é ativada por meio do OSGi.
- Abra a Configuração do Console da Web do Adobe Experience Manager em
http://<host>:<port>/system/console/configMgr
- Pesquisar por Adobe Granite ContextHub
- Clique na configuração Adobe Granite ContextHub para editar suas propriedades
- Marque a opção Modo Silencioso e clique em Salvar
Recuperando configurações do ContextHub após a atualização recovering-contexthub-configurations-after-upgrading
Quando uma atualização para AEM é executada, o backup das configurações do ContextHub é feito e armazenado em um local seguro. Durante a atualização, as configurações padrão do ContextHub são instaladas, substituindo as configurações existentes. O backup é necessário para preservar quaisquer alterações ou adições feitas.
As configurações do ContextHub são armazenadas em uma pasta chamada contexthub
nos seguintes nós:
/conf/global/settings/cloudsettings
/conf/<tenant>/settings/cloudsettings
Após uma atualização, o backup é armazenado em uma pasta chamada contexthub
abaixo de um nó chamado:
/conf/global/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx
ou/conf/<tenant>/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx
A parte yyyymmdd
do nome do nó é a data em que a atualização foi executada.
Para recuperar as configurações do ContextHub, use o CRXDE Lite para copiar os nós que representam suas lojas, modos de interface do usuário e módulos de interface do usuário abaixo do nó default-pre-upgrade_yyyymmdd_xxxxxx
para abaixo:
/conf/global/settings/cloudsettings
ou/conf/<tenant>/settings/cloudsettings