DocumentaçãoAEM 6.5Guia do usuário

Personalização do console Sites (interface clássica)

Última atualização: 15 de julho de 2024
  • Tópicos:
  • Desenvolvimento

Criado para:

  • Desenvolvedor

Adicionar uma coluna personalizada ao console Sites (siteadmin)

O console Administração de sites pode ser estendido para exibir colunas personalizadas. O console é criado com base em um objeto JSON que pode ser estendido com a criação de um serviço OSGI que implementa a interface ListInfoProvider. Esse serviço modifica o objeto JSON enviado ao cliente para criar o console.

Este tutorial passo a passo explica como exibir uma nova coluna no console Administração de Sites implementando a interface ListInfoProvider. Ele consiste nas seguintes etapas:

  1. Criando o serviço OSGI e implantando o pacote que o contém no servidor AEM.
  2. (opcional) Testando o novo serviço emitindo uma chamada JSON para solicitar o objeto JSON usado para criar o console.
  3. Exibindo a nova coluna ao estender a estrutura de nó do console no repositório.
NOTE
Este tutorial também pode ser usado para estender os seguintes consoles de administração:
  • o console do Digital Assets
  • o console da Comunidade

Criação do serviço OSGI

A interface ListInfoProvider define dois métodos:

  • updateListGlobalInfo, para atualizar propriedades globais da lista,
  • updateListItemInfo, para atualizar o item de lista única.

Os argumentos para ambos os métodos são:

  • request, o objeto de solicitação Sling HTTP associado,
  • info, o objeto JSON a ser atualizado, que é, respectivamente, a lista global ou o item de lista atual,
  • resource, um recurso Sling.

O exemplo de implementação está abaixo:

  • Adiciona uma propriedade asterisco para cada item, que é true se o nome da página começar com um e, e false caso contrário.

  • Adiciona uma propriedade asteriscoCount, que é global para a lista e contém o número de itens de lista com asterisco.

Para criar o serviço OSGI:

  1. No CRXDE Lite, crie um pacote.
  2. Adicione o código de amostra abaixo.
  3. Crie o pacote.

O novo serviço está em funcionamento.

package com.test;

import com.day.cq.commons.ListInfoProvider;
import com.day.cq.i18n.I18n;
import com.day.cq.wcm.api.Page;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;

@Component(metatype = false)
@Service(value = ListInfoProvider.class)
public class StarredListInfoProvider implements ListInfoProvider {

    private int count = 0;

    public void updateListGlobalInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        info.put("starredCount", count);
        count = 0; // reset for next execution
    }

    public void updateListItemInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        Page page = resource.adaptTo(Page.class);
        if (page != null) {
            // Consider starred if page name starts with 'e'
            boolean starred = page.getName().startsWith("e");
            if (starred) {
                count++;
            }
            I18n i18n = new I18n(request);
            info.put("starred", starred ? i18n.get("Yes") : i18n.get("No"));
        }
    }

}
CAUTION

  • Sua implementação deve decidir, com base na solicitação e/ou recurso fornecido, se deve adicionar as informações ao objeto JSON ou não.

  • Se a implementação ListInfoProvider definir uma propriedade que existe no objeto de resposta, seu valor será substituído pelo valor fornecido.

    Você pode usar a classificação de serviço para gerenciar a ordem de execução de várias implementações do ListInfoProvider.

Testando o novo serviço

Quando você abre o console Administração de sites e navega pelo seu site, o navegador emite uma chamada Ajax para obter o objeto JSON usado para criar o console. Por exemplo, quando você navega até a pasta /content/geometrixx, a seguinte solicitação é enviada ao servidor AEM para criar o console:

https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

Para garantir que o novo serviço esteja em execução após a implantação do pacote que o contém:

  1. Aponte seu navegador para o seguinte URL:
    https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

  2. A resposta deve exibir as novas propriedades da seguinte maneira:

screen_shot_2012-02-13at163046

Exibição da Nova Coluna

A última etapa consiste em adaptar a estrutura dos nós do console Administração de Sites para exibir a nova propriedade para todas as páginas do Geometrixx, sobrepondo /libs/wcm/core/content/siteadmin. Proceda da seguinte forma:

  1. No CRXDE Lite, crie a estrutura de nós /apps/wcm/core/content com nós do tipo sling:Folder para refletir a estrutura /libs/wcm/core/content.

  2. Copie o nó /libs/wcm/core/content/siteadmin e cole-o abaixo de /apps/wcm/core/content.

  3. Copie o nó /apps/wcm/core/content/siteadmin/grid/assets para /apps/wcm/core/content/siteadmin/grid/geometrixx e altere suas propriedades:

    • Remover pageText

    • Definir pathRegex para /content/geometrixx(/.*)?
      Isso torna a configuração de grade ativa para todos os sites do Geometrixx.

    • Definir storeProxySuffix como .pages.json

    • Edite a propriedade com vários valores storeReaderFields e adicione o valor starred.

    • Para ativar a funcionalidade do MSM, adicione os seguintes parâmetros do MSM à propriedade de várias cadeias de caracteres storeReaderFields:

      • msm:isSource
      • msm:isInBlueprint
      • msm:isLiveCopy

  4. Adicione um nó starred (do tipo nt:unstructured) abaixo de /apps/wcm/core/content/siteadmin/grid/geometrixx/columns com as seguintes propriedades:

    • dataIndex: starred do tipo String

    • cabeçalho: Starred do tipo String

    • xtype: gridcolumn do tipo String

  5. (opcional) Descarte as colunas que você não deseja exibir em /apps/wcm/core/content/siteadmin/grid/geometrixx/columns

  6. /siteadmin é um caminho personalizado que, como padrão, aponta para /libs/wcm/core/content/siteadmin.
    Para redirecionar para sua versão do siteadmin em /apps/wcm/core/content/siteadmin, defina a propriedade sling:vanityOrder para ter um valor maior que o definido em /libs/wcm/core/content/siteadmin. O valor padrão é 300, portanto, qualquer valor maior é adequado.

  7. Vá para o console Administração de sites e navegue até o site do Geometrixx:
    https://localhost:4502/siteadmin#/content/geometrixx.

  8. A nova coluna chamada Iniciada está disponível, exibindo informações personalizadas da seguinte maneira:

screen_shot_2012-02-14at104602

CAUTION
Se várias configurações de grade corresponderem ao caminho solicitado definido pela propriedade pathRegex, a primeira será usada, e não a mais específica, o que significa que a ordem das configurações é importante.

Pacote de exemplo

O resultado deste tutorial está disponível no pacote Personalizando o Console de Administração de Sites em Compartilhamento de Pacotes.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2