La consola Administración de sitios web se puede ampliar para mostrar columnas personalizadas. La consola se basa en un objeto JSON que se puede ampliar creando un servicio OSGI que implemente el ListInfoProvider
interfaz. Este servicio modifica el objeto JSON que se envía al cliente para crear la consola.
Este tutorial paso a paso explica cómo mostrar una nueva columna en la consola Administración de sitios web implementando el ListInfoProvider
interfaz. Consiste en los siguientes pasos:
Este tutorial también se puede utilizar para ampliar las siguientes consolas de administración:
El ListInfoProvider
La interfaz de define dos métodos:
updateListGlobalInfo
, para actualizar las propiedades globales de la lista,updateListItemInfo
, para actualizar el elemento de lista única.Los argumentos para ambos métodos son:
request
, el objeto de solicitud HTTP de Sling asociado,info
, el objeto JSON que se va a actualizar, que es respectivamente la lista global o el elemento de lista actual,resource
, un recurso de Sling.La implementación de ejemplo siguiente:
Agrega un estrellado propiedad para cada elemento, que es true
si el nombre de la página comienza con un e, y false
de lo contrario.
Agrega un starredCount , que es global para la lista y contiene el número de elementos de la lista con estrellas.
Para crear el servicio OSGI:
El nuevo servicio está en funcionamiento.
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"));
}
}
}
Su implementación debe decidir, en función de la solicitud o el recurso proporcionados, si debe agregar la información al objeto JSON o no.
Si su ListInfoProvider
implementation define una propiedad que ya existe en el objeto response; el valor que proporcione sobrescribirá esta propiedad.
Puede utilizar clasificación de servicios para administrar el orden de ejecución de varios ListInfoProvider
implementaciones.
Cuando abre la consola de administración de sitios web y explora su sitio, el explorador emite una llamada ajax para obtener el objeto JSON utilizado para crear la consola. Por ejemplo, al navegar a /content/geometrixx
AEM carpeta, se enviará la siguiente solicitud al servidor de para crear la consola:
https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin
Para asegurarse de que el nuevo servicio se está ejecutando después de haber implementado el paquete que lo contiene:
Dirija el explorador a la siguiente dirección URL:
https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin
La respuesta debe mostrar las nuevas propiedades como se indica a continuación:
El último paso consiste en adaptar la estructura de nodos de la consola de administración de sitios web para mostrar la nueva propiedad para todas las páginas de Geometrixx superponiendo /libs/wcm/core/content/siteadmin
. Proceda como se indica a continuación:
En CRXDE Lite, cree la estructura de nodos /apps/wcm/core/content
con nodos de tipo sling:Folder
para reflejar la estructura /libs/wcm/core/content
.
Copie el nodo /libs/wcm/core/content/siteadmin
y péguelo debajo /apps/wcm/core/content
.
Copie el nodo /apps/wcm/core/content/siteadmin/grid/assets
hasta /apps/wcm/core/content/siteadmin/grid/geometrixx
y cambia sus propiedades:
Eliminar pageText
Establecer pathRegex hasta /content/geometrixx(/.*)?
Esto hará que la configuración de cuadrícula esté activa para todos los sitios web de geometrixx.
Establecer storeProxySuffix hasta .pages.json
Edite el storeReaderFields propiedad multivalor y agregue starred
valor.
Para activar la funcionalidad de MSM, agregue los siguientes parámetros MSM a la propiedad de varias cadenas storeReaderFields:
Añadir un starred
nodo (de tipo nt:unstructured) a continuación /apps/wcm/core/content/siteadmin/grid/geometrixx/columns
con las siguientes propiedades:
dataIndex: starred
de tipo cadena
encabezado: Starred
de tipo cadena
xtype: gridcolumn
de tipo cadena
(opcional) Suelte las columnas que no desee mostrar en /apps/wcm/core/content/siteadmin/grid/geometrixx/columns
/siteadmin
es una ruta de vanidad que, de forma predeterminada, apunta a /libs/wcm/core/content/siteadmin
.
Para redireccionar esto a su versión de siteadmin en /apps/wcm/core/content/siteadmin
definir la propiedad sling:vanityOrder
para tener un valor superior al definido en /libs/wcm/core/content/siteadmin
. El valor predeterminado es 300, por lo que cualquier valor superior es adecuado.
Vaya a la consola de administración de sitios web y navegue hasta el sitio de Geometrixx:
https://localhost:4502/siteadmin#/content/geometrixx.
La nueva columna llamada Estelar está disponible y muestra la información personalizada de la siguiente manera:
Si varias configuraciones de cuadrícula coinciden con la ruta solicitada definida por el pathRegex , se utilizará la primera y no la más específica, lo que significa que el orden de las configuraciones es importante.
El resultado de este tutorial está disponible en la Personalización de la consola de administración de sitios web paquete en Package Share.