ContentConnect

Mit dieser Version des ContentConnect-Moduls wird die bereitgestellte API erweitert.

Die Klasse ProductManager stellt nun zusätzlich die Methoden getTemplateMappingCategory und getTemplateMappingProduct bereit. Diese Methoden erlauben den Zugriff auf die Template-Mapping-Konfigurationen der Kategorien und Produkte, die innerhalb der Projekt-Komponente gepflegt werden. Die Klasse CategoryTemplateMapping wird durch die neu hinzugefügten Methoden obsolet und wird deshalb als veraltet gekennzeichnet. An ihrer Stelle wurde die Klasse TemplateMapping in die API aufgenommen.

Mit dieser Version des ContentConnect-Moduls wurde die vorhandene Cartridge in die folgenden drei Cartridges aufgeteilt:

Eine Migration zur Benutzung der neuen Cartridges ist nicht zwangsläufig notwendig, da keine neue Funktionalität hinzugefügt wurde. Sollen stattdessen trotzdem die neuen Cartridges benutzt werden, so muss zusätzlich zu der Architektur-abhängigen Cartridge (MobileFirst Reference Architecture Cartridge oder SiteGenesis Cartridge) die Core Cartridge im Cartridge-Pfad der Site angegeben werden.

Diese Version des ContentConnect-Moduls führt außerdem die Unterstützung für die Mobile First Reference Architecture (MFRA) in der Version 2.0 ein. Das StarterPackage ist somit nicht mehr abwärtskompatibel zu älteren Versionen der MFRA.

Mit dieser Version wurde das mitgelieferte StarterPackage grundlegend erneuert. Das Referenzprojekt sowie die Vorlagen der Cartridge bauen jetzt auf der neuen MobileFirst Reference Architecture auf.

Die Dokumentation des ContentConnect-Moduls wurde ebenfalls neu geschrieben. Sie besitzt jetzt einen starken Bezug zum neuen StarterPackage und setzt ihren Fokus auf die Umsetzung konkreter Anwendungsfälle.

Mit dieser Version des Moduls wird der ContentConnect Preview Proxy hinzugefügt. Dieser dient der Beseitigung von Problemen mit Cross-Origin-Requests in der Vorschau beim Laden externer Ressourcen.

Informationen zur Konfiguration und Verwendung des Proxys sind im Abschnitt ContentConnect Preview Proxy der Dokumentation zu finden.

Durch die Hinzunahme des ContentConnect Preview Proxys zur ContentConnect Web-Komponente wurde auch die dazugehörige web.xml um zwei Einträge für den Proxy erweitert. Die Aktualisierung der web.xml erfolgt automatisch bei der Aktualisierung des Moduls, wenn sie zuvor nicht manuell editiert wurde. Ist dies der Fall, bleibt sie bei der Aktualisierung des Moduls unberührt und muss im Nachgang jeweils für die Bereiche Vorschau und ContentCreator um folgende Einträge für den Proxy ergänzt werden:

<servlet>
   <servlet-name>ContentConnectPreviewProxy</servlet-name>
   <servlet-class>com.espirit.moddev.demandware.preview.proxy.ProxyServlet</servlet-class>
   <load-on-startup>0</load-on-startup>
</servlet>
<servlet-mapping>
   <servlet-name>ContentConnectPreviewProxy</servlet-name>
   <url-pattern>/proxy/*</url-pattern>
</servlet-mapping>

Weitere Informationen zu den Web-Komponenten sind im Kapitel Hinzufügen der Web-Komponenten der Dokumentation zu finden.

Mit dieser Version des ContentConnect-Moduls wird das Feature Content Bereinigung eingeführt und die bereitgestellte API erweitert. Die Content Bereinigung erlaubt die automatisierte Bereinigung von obsoleten, FirstSpirit-verwalteten Content Assets und Slot Configurations aus der Commerce Cloud. Um dieses Feature zu nutzen, müssen folgende Änderungen vorgenommen werden.

Die API wurde um verschiedene Methoden erweitert. Zum Einen wurde das SlotConfigurationManager Interface um die Methoden deleteSlotConfigurations und searchSlotConfigurations erweitert. Um die Methode searchSlotConfigurations möglichst generisch bedienen zu können, wurde die neue Klasse SearchRequest zur API hinzugefügt. Diese erlaubt das Formulieren einer generischen Suchanfrage mittels der Angabe einer Query, welche ebenfalls neu und Teil der API ist.

Zum Anderen wurde die Methoden deleteContentAssets zum LibraryManager Interface hinzugefügt. Weitere Informationen zur ContentConnect-API können der mitgelieferten Javadoc-Dokumentation entnommen werden.

Mit dieser Version des Moduls wird der ContentConnect Preview Filter hinzugefügt. Dieser ermöglicht einen lesbareren Template-Code, ersetzt die JSP-Logik und minimiert die Fehleranfälligkeit bei umfangreichen Seiten.

Für die Verwendung des neuen ContentConnect Preview Filters sind einige Anpassungen an den Seitenvorlagen, Formatvorlagen und Projekteinstellungen notwendig. Zusätzlich muss die Web-Komponente des ContentConnect Preview Filters konfiguriert werden.

Eine detaillierte Beschreibung dieser notwendigen Anpassungen ist im Kapitel 8 der Dokumentation zu finden.

Der Report über Kategorien zeigt ab dieser Version auch versteckte Kategorien. Diese Funktion kann über eine neue Filter-Funktion des Reports aktiviert oder deaktiviert werden.

Diese Erweiterung hat zur Folge, dass der Parameter Password in der Konfiguration der Projektkomponente jetzt ein Pflichtfeld ist und nicht leer bleiben darf.

Außerdem muss die verwendete Client-Id berechtigt sein, GET-Anfragen über die DataAPI für folgende Ressourcen durchzuführen:

Weitere Informationen finden sich in den Kapiteln 3.1.4 und 5.3 der Dokumentation.

In der Formatvorlage Preview Generation wurde die folgende Aktualisierung vorgenommen:

Alt. 

$CMS_SET(set_replaceTracker, "(<!-- Demandware Analytics)((.|[\\t\\n\\r])*)(</script>)")$

Neu. 

$CMS_SET(set_replaceTracker, "(<!-- Demandware Analytics)(?s:.)*(</script>)")$

Durch diese Änderung wird einer möglichen Stackoverflow-Exception vorgebeugt. Es wird empfohlen diese Aktualisierung in existierenden Projekten manuell durchzuführen.

Die Cartridge wurde mit dieser Version an einigen stellen angepasst. Eine Aktualisierung der Cartridge oder der Import-Jobs ist in existierenden Projekten nicht zwingend erforderlich.

Folgende Anpassungen wurden vorgenommen:

Weitere Informationen finden sich in den Kapiteln 2.4 und 3.2 der Dokumentation.

Vor Kurzem wurde Demandware zu Salesforce Commerce Cloud umbenannt. Dementsprechend hat auch das Modul DemandwareConnect einen neuen Namen erhalten: ContentConnect for Salesforce Commerce Cloud

Das ContentConnect-Modul untersützt die Nutzung der Content Integration API. Die Integration mit FirstSpirit ist in Kapitel 8 der Dokumentation beschrieben.

In bestehenden Projekten sollte neben den in der Dokumentation beschrieben Schritten außerdem die mitgelieferte Formatvorlage preview_generation angepasst werden. Folgender Code-Schnipsel sollte an den Beginn des umschließenden JSP-Scriptlets verschoben werden, damit die anschließenden Ersetzungen auch auf eingebundene Widgets agieren:

$-- Inject CMS preview content: Replace placeholder with actual CMS content --$
$CMS_FOR(for_item, [0..stringToReplace.size-1])$
    html = html.replaceFirst(
        "$CMS_VALUE(stringToReplace[for_item])$",
        "$CMS_VALUE(stringToInsert[for_item].toString().quoteJS())$");
$CMS_END_FOR$

Des Weiteren wurde zum Einbinden von Widgets ein neues Skript in die Auslieferung aufgenommen. Dieses kann manuell angelegt werden. Als Referenzname ist dabei include_html zu verwenden sowie folgender Inhalt:

//!Beanshell

import java.net.URL;
import java.net.URLConnection;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;

String includeURL = gc.getVariableValue("includeURL").toString();
String name = gc.getVariableValue("name").toString();
String password = gc.getVariableValue("password").toString();
String isProtected = gc.getVariableValue("isProtected").toString();
String html = "";

includeURL = includeURL.replaceAll(" ","%20");
URL url = new URL(includeURL);
URLConnection urlConnection = url.openConnection();

if (isProtected.equals("true")){
    import org.apache.commons.codec.binary.Base64;

    String authString = name + ":" + password;
    byte[] authEncBytes = Base64.encodeBase64(authString.getBytes());
    String authStringEnc = new String(authEncBytes);

    urlConnection.setRequestProperty("Authorization", "Basic " + authStringEnc);
}

InputStream is = urlConnection.getInputStream();
InputStreamReader isr = new InputStreamReader(is);

int numCharsRead;
char[] charArray = new char[1024];
StringBuffer sb = new StringBuffer();
while ((numCharsRead = isr.read(charArray)) > 0) {
    sb.append(charArray, 0, numCharsRead);
}
html = sb.toString();
html = html.replaceAll("\\$", "$");

return(html);

Für Detailseiten für Kategorien kann nun mehr als eine Seitenvorlage in FirstSpirit konfiguriert werden. Deshalb muss in bestehenden Projekten die Cartridge aktualisiert werden.

Die Version 1.5.0 des DemandwareConnect-Moduls enthält diverse Überarbeitungen und Neuerungen. Sollte bereits eine frühere Version des Moduls im Einsatz sein, ist aus diesem Grund die Durchführung einiger Migrationsschritte notwendig. Diese sind nachfolgend erläutert und sind in der angegebenen Reihenfolge auszuführen:

Nach der Neuinstallation des Moduls müssen einige Template-Anpassungen vorgenommen werden.

Sollten die Skripte CreateProductManager (Referenzname "createproductmanager") und CreateXmlCollector (Referenzname "createxmlcollector") noch nicht innerhalb des Projekts existieren, müssen sie mit den genannten Referenznamen und den folgenden Inhalten angelegt werden:

CreateProductManager. 

#!executable-class
ManagerFactory

CreateXmlCollector. 

#!executable-class
XmlCollectorFactory

Innerhalb der Vorlage für die Projekteinstellungen müssen die Aufrufe zur Initialisierung der XML-Kollektoren angepasst werden. Des Weiteren wird zur Abfrage von Produktinformationen in Templates jetzt das Interface ProductManager verwendet, weshalb die Instanziierung der Klasse Connector ersetzt werden muss.

Xml-Kollektor für die Content Library:

alt. 

$CMS_SET(ps_xmlCollector,class("com.espirit.moddev.demandware.xml.DemandwareXmlCollector").newInstance())$

neu. 

$CMS_RENDER(script:"createxmlcollector",variableName:"ps_xmlCollector")$

Xml-Kollektor für die Content Slot Konfiguration:

alt. 

$CMS_SET(ps_xmlCollectorContentSlot,class("com.espirit.moddev.demandware.xml.DemandwareXmlCollector").newInstance(false))$

neu. 

$CMS_RENDER(script:"createxmlcollector", variableName:"ps_xmlCollectorContentSlot", createLibraryNode:false)$

Objekt zur Abfrage von Produktinformationen:

alt. 

$CMS_SET(ps_DWRconnector,class("com.espirit.moddev.demandware.products.Connector").create(#global))$

neu. 

$CMS_RENDER(script:"createproductmanager", variableName:"ps_productManager")$

Einige Komponenten des Moduls wurden umbenannt, weshalb in allen Vorlagen jede Nennung des Ausdrucks FSDWC_ durch DemandwareConnect_ zu ersetzen ist. Dies betrifft zum Beispiel den Product-Drop-Handler.

Das Interface ProductManager ist inkompatibel mit der öffentlichen Schnittstelle der zuvor verwendeten Connector-Klasse. Die Abfrage der Produktinformationen muss deshalb angepasst werden:

queryProduct(alt). 

ps_DWRconnector.queryProduct(for_product.id)

loadProduct (neu). 

ps_productManager.loadProduct(for_product.id)

Neben der Ersetzung der Klasse Connector durch das Interface ProductManager, wurden auch die Interfaces Product und Category angepasst. Entsprechende Template-Änderung können deshalb erforderlich sein.