Anpassen der Websites-Konsole (klassische Benutzeroberfläche)

Hinzufügen benutzerdefinierter Spalten zur Websites-Konsole (SiteAdmin)

Die Websites-Administrationskonsole kann zum Anzeigen benutzerdefinierter Spalten erweitert werden. Die Konsole basiert auf einem JSON-Objekt, das erweitert werden kann, indem ein OSGi-Dienst erstellt wird, der die Schnittstelle ListInfoProvider implementiert. Ein solcher Dienst modifiziert das JSON-Objekt, das an den Client gesendet wird, um die Konsole zu erstellen.

In diesem Schritt-für-Schritt-Tutorial wird erläutert, wie Sie eine neue Spalte in der Websites-Administrationskonsole anzeigen, indem Sie die Schnittstelle ListInfoProvider implementieren. Dieser Vorgang umfasst die folgenden Schritte:

1. Erstellen des OSGi-Diensts und Bereitstellen des Bundles, das ihn enthält, auf dem AEM-Server
2. (optional) Testen des neuen Diensts durch einen JSON-Aufruf, um das JSON-Objekt anzufordern, das zum Aufbau der Konsole verwendet wird
3. Anzeigen der neuen Spalte durch Erweitern der Knotenstruktur der Konsole im Repository

Erstellen von OSGi-Diensten

Die Schnittstelle ListInfoProvider definiert zwei Methoden:

• updateListGlobalInfo, um die globalen Eigenschaften der Liste zu aktualisieren,
• updateListItemInfo, um ein einzelnes Listenelement zu aktualisieren.

Die Argumente für beide Methoden lauten:

• request, das zugeordnete Sling-HTTP-Anforderungsobjekt,
• info, das zu aktualisierende JSON-Objekt, bei dem es sich um die globale Liste bzw. das aktuelle Listenelement handelt,
• resource, eine Sling-Ressource.

Mit der unten aufgeführten Beispielimplementierung wird Folgendes erreicht:

• Es wird eine Eigenschaft starred für jedes Element hinzugefügt, deren Wert auf true festgelegt ist, wenn der Seitenname mit e beginnt. Andernfalls ist der Wert auf false festgelegt.

• Es wird eine Eigenschaft starredCount hinzugefügt, die global für die Liste gilt und die Anzahl der Listenelemente mit der Eigenschaft „starred“ enthält.

Gehen Sie wie folgt vor, um den OSGi-Dienst zu erstellen:

1. Wechseln Sie zu CRXDE Lite und erstellen Sie ein Bundle.
2. Fügen Sie den unten aufgeführten Beispielcode ein.
3. Erstellen Sie das Bundle.

Der neue Dienste wird ordnungsgemäß ausgeführt.

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

}

Testen neuer Dienste

Wenn Sie die Website-Administrationskonsole öffnen und durch Ihre Website navigieren, gibt der Browser einen AJAX-Aufruf aus, um das JSON-Objekt zu erhalten, das zum Erstellen der Konsole verwendet wird. Wenn Sie beispielsweise zum Ordner /content/geometrixx navigieren, wird die folgende Anfrage an den AEM-Server gesendet, um die Konsole zu erstellen:

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

Gehen Sie wie folgt vor, um sicherzustellen, dass der neue Dienst nach der Bereitstellung des Bundles, das ihn enthält, ausgeführt wird:

1. Zeigen Sie Ihren Browser auf die folgende URL:
   https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

2. Die Antwort sollte die neuen Eigenschaften wie folgt anzeigen:

Anzeigen neuer Spalten

Der letzte Schritt besteht darin, die Knotenstruktur der Websites-Administrationskonsole anzupassen, um die neue Eigenschaft für alle Geometrixx anzuzeigen, indem /libs/wcm/core/content/siteadmin überlagert wird. Gehen Sie wie folgt vor:

1. Erstellen Sie in CRXDE Lite die Knotenstruktur /apps/wcm/core/content mit Knoten des Typs sling:Folder, um die Struktur /libs/wcm/core/content widerzuspiegeln.

2. Kopieren Sie den Knoten /libs/wcm/core/content/siteadmin und fügen Sie ihn unter /apps/wcm/core/content ein.

3. Kopieren Sie den Knoten /apps/wcm/core/content/siteadmin/grid/assets in /apps/wcm/core/content/siteadmin/grid/geometrixx und ändern Sie seine Eigenschaften:

   • Entfernen Sie pageText.

   • Setzen Sie pathRegex auf /content/geometrixx(/.*)?
     Dadurch wird die Rasterkonfiguration für alle Geometrixx-Websites aktiv.

   • Setzen Sie storeProxySuffix auf .pages.json

   • Bearbeiten Sie die mehrwertige Eigenschaft storeReaderFields und fügen Sie den Wert starred hinzu.

   • Um die MSM-Funktion zu aktivieren, fügen Sie die folgenden MSM-Parameter zur Eigenschaft mit mehreren Zeichenfolgen storeReaderFields hinzu:

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

4. Fügen Sie einen starred -Knoten (vom Typ nt:unstructured) unterhalb von /apps/wcm/core/content/siteadmin/grid/geometrixx/columns mit den folgenden Eigenschaften hinzu:

   • dataIndex: starred vom Typ String

   • header: Starred vom Typ String

   • xtype: gridcolumn vom Typ String

5. (optional) Legen Sie die Spalten ab, die nicht unter /apps/wcm/core/content/siteadmin/grid/geometrixx/columns angezeigt werden sollen.

6. /siteadmin ist ein Vanity-Pfad, der standardmäßig auf /libs/wcm/core/content/siteadminverweist.
   Um dies zu Ihrer Version von siteadmin auf /apps/wcm/core/content/siteadmin umzuleiten, definieren Sie die Eigenschaft sling:vanityOrder, damit sie einen höheren Wert hat als der, der für /libs/wcm/core/content/siteadmin definiert ist. Der Standardwert lautet 300, also sind alle höheren Werte geeignet.

7. Navigieren Sie zur Websites-Administrationskonsole und navigieren Sie zur Geometrixx-Site:
   https://localhost:4502/siteadmin#/content/geometrixx.

8. Die neue Spalte Starred ist nun verfügbar und zeigt benutzerdefinierte Informationen wie folgt an:

Beispielpaket

Das Ergebnis dieses Tutorials finden Sie im Paket Anpassen der Websites-Administrationskonsole in Package Share.