El marco de comercio electrónico se puede utilizar con cualquier solución de comercio electrónico. Algunos detalles y ejemplos que se tratan aquí hacen referencia al hibris solución.
El marco de integración incluye una capa de integración con una API. Esto le permite:
Documentación de API también está disponible.
Se proporcionan varios componentes de AEM listos para usar para utilizar la capa de integración. Actualmente son:
Para la búsqueda, se proporciona un vínculo de integración que le permite utilizar la búsqueda de AEM, la búsqueda del sistema de comercio electrónico, una búsqueda de terceros o una combinación de estos.
El marco de comercio electrónico se puede utilizar con cualquier solución de comercio electrónico; el motor utilizado debe ser identificable por AEM:
Los motores de comercio electrónico son servicios de OSGi que admiten el CommerceService
interfaz
commerceProvider
propiedad serviceAEM admite Resource.adaptTo()
para CommerceService
y Product
La variable adaptTo
la implementación busca un cq:commerceProvider
en la jerarquía del recurso:
A cq:Commerce
mixin se usa de modo que la variable cq:commerceProvider
se puede agregar a recursos con establecimiento inflexible de tipos.
La variable cq:commerceProvider
también se utiliza para hacer referencia a la definición de fábrica de comercio apropiada.
Por ejemplo, una cq:commerceProvider
propiedad con el valor hybris
se correlacionará con la configuración OSGi para Day CQ Commerce Factory for Hybris (com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory): donde el parámetro commerceProvider
también tiene el valor hybris
.
Aquí hay propiedades adicionales, como Versión del catálogo se puede configurar (cuando corresponda y esté disponible).
Consulte los siguientes ejemplos:
cq:commerceProvider = geometrixx |
en una instalación AEM estándar se requiere una implementación específica; por ejemplo, el ejemplo de geometrixx, que incluye extensiones mínimas para la API genérica |
---|---|
cq:commerceProvider = hybris |
implementación de hybris |
/content/store
+ cq:commerceProvider = hybris
+ mens
+ polo-shirt-1
+ polo-shirt-2
+ employee
+ cq:commerceProvider = jcr
+ adobe-logo-shirt
+ cq:commerceType = product
+ price = 12.50
+ adobe-logo-shirt_S
+ cq:commerceType = variant
+ size = S
+ adobe-logo-shirt_XL
+ cq:commerceType = variant
+ size = XL
+ price = 14.50
Con CRXDE Lite puede ver cómo se gestiona esto en el componente de producto para la implementación de híbris:
/apps/geometrixx-outdoors/components/hybris/product/product.jsp
La extensión híbris del eCommerce Integration Framework se ha actualizado para admitir Hybris 5, manteniendo al mismo tiempo la compatibilidad con Hybris 4.
La configuración predeterminada del código se ajusta para Hybris 5.
Para desarrollar Hybris 4 se requiere lo siguiente:
Al invocar a maven, agregue el siguiente argumento de línea de comandos al comando
-P hybris4
Descarga la distribución preconfigurada de Hybris 4 e la incrusta en el paquete:
cq-commerce-hybris-server
En el administrador de configuración de OSGi:
hybris utiliza una sesión de usuario para almacenar información como el carro de compras del cliente. El id de sesión se devuelve de hybris en una JSESSIONID
que debe enviarse en solicitudes posteriores a hybris. Para evitar almacenar el ID de sesión en el repositorio, se codifica en otra cookie almacenada en el explorador del comprador. Se realizan los siguientes pasos:
hybris-session-rest
) y configure en la respuesta al comprador. La codificación en una nueva cookie es necesaria, ya que la cookie original solo es válida para una ruta determinada y, de lo contrario, no se enviaría de nuevo desde el explorador en solicitudes posteriores. La información de la ruta también debe agregarse al valor de la cookie.hybris-session-<*xxx*>
cookies y se establece en el cliente HTTP que se utiliza para solicitar datos de hybris.Se crea una nueva sesión anónima cuando la sesión original ya no es válida.
Esta sesión "posee" el carro de compras
realiza añadir/quitar/etc
realiza los distintos cálculos en el carro de compras;
commerceSession.getProductPrice(Product product)
Es propietario del ubicación de almacenamiento para el pedido data
CommerceSession.getUserContext()
También posee el pago conexión de procesamiento
También posee el cumplimiento connection
Los datos del producto que se mantienen en híbris deben estar disponibles en AEM. Se ha implementado el siguiente mecanismo:
El importador (b) se utiliza para la configuración inicial de la estructura de árbol de páginas en AEM para catálogos.
Los cambios en el catálogo de híbridos se indican para AEM a través de una fuente, que luego se propagan al AEM b).
La extensión hybris proporciona un importador de encuestas ("esquema de híbridos"), que puede configurarse para importar cambios en AEM en un intervalo especificado (por ejemplo, cada 24 horas en las que el intervalo se especifica en segundos):
http://localhost:4502/content/geometrixx-outdoors/en_US/jcr:content.json
{
* "jcr:mixinTypes": ["cq:PollConfig"],
* "enabled": true,
* "source": "hybris:outdoors",
* "jcr:primaryType": "cq:PageContent",
* "interval": 86400
}
La configuración del catálogo en AEM reconoce Ensayo y En línea versiones del catálogo.
La sincronización de productos entre las versiones del catálogo requerirá una (des)activación de la página de AEM correspondiente (a, c)
La activación de una página en el AEM c) requiere una comprobación b) y solo es posible si
Las páginas de productos activadas deben acceder a los datos del producto En línea versión (d).
La instancia de publicación de AEM requiere acceso a hybris para la recuperación de datos personalizados y de productos (d).
Un solo producto puede tener varias variaciones; por ejemplo, puede variar según el color o el tamaño. Un producto debe definir qué propiedades impulsan la variación; los llamamos ejes de variante.
Sin embargo, no todas las propiedades son ejes de variante. Las variaciones también pueden afectar a otras propiedades; por ejemplo, el precio puede depender del tamaño. El comprador no puede seleccionar estas propiedades y, por lo tanto, no se consideran ejes de variante.
Cada producto o variante está representado por un recurso y, por lo tanto, asigna 1:1 a un nodo de repositorio. Es un corolario que un producto específico o una variante se puedan identificar de forma única por su ruta.
El recurso de producto/variante no siempre contiene los datos reales del producto. Puede tratarse de una representación de los datos que realmente se poseen en otro sistema (como híbridos). Por ejemplo, las descripciones de productos, los precios, etc. no se almacenan en AEM, sino que se recuperan en tiempo real desde el motor de comercio electrónico.
Cualquier recurso de producto puede representarse mediante un Product API
. La mayoría de las llamadas que se hacen en la API del producto son específicas para variaciones (aunque las variaciones pueden heredar valores compartidos de un antecesor), pero también hay llamadas que enumeran el conjunto de variaciones ( getVariantAxes()
, getVariants()
, etc.).
De hecho, los ejes de una variante están determinados por lo que sea Product.getVariantAxes()
devuelve:
Aunque los productos (en general) pueden tener muchos ejes de variante, el componente de producto listo para usar solo gestiona dos:
size
más uno más
Esta variante adicional se selecciona mediante la variable variationAxis
propiedad de la referencia del producto (normalmente color
para Geometrixx Outdoors).
En general:
los datos del producto se encuentran en /etc
y referencias de productos en /content
.
Debe haber un mapa 1:1 entre las variaciones del producto y los nodos de datos del producto.
Las referencias del producto también deben tener un nodo para cada variación presentada, pero no es necesario presentar todas las variaciones. Por ejemplo, si un producto tiene variaciones S, M o L, los datos del producto podrían ser:
etc
commerce
products
shirt
shirt-s
shirt-m
shirt-l
Mientras que un catálogo "Big and Tall" solo puede tener:
content
big-and-tall
shirt
shirt-l
Por último, no es necesario utilizar los datos del producto. Puede colocar todos los datos del producto debajo de las referencias en el catálogo; pero, en realidad, no puede tener varios catálogos sin duplicar todos los datos del producto.
API
public interface Product extends Adaptable {
public String getPath(); // path to specific variation
public String getPagePath(); // path to presentation page for all variations
public String getSKU(); // unique ID of specific variation
public String getTitle(); // shortcut to getProperty(TITLE)
public String getDescription(); // shortcut to getProperty(DESCRIPTION)
public String getImageUrl(); // shortcut to getProperty(IMAGE_URL)
public String getThumbnailUrl(); // shortcut to getProperty(THUMBNAIL_URL)
public <T> T getProperty(String name, Class<T> type);
public Iterator<String> getVariantAxes();
public boolean axisIsVariant(String axis);
public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}
/**
* Interface for filtering variants and AxisFilter provided as common implementation
*
* The <code>VariantFilter</code> is used to filter variants,
* e.g. when using {@link Product#getVariants(VariantFilter filter)}.
*/
public interface VariantFilter {
public boolean includes(Product product);
}
/**
* A {@link VariantFilter} for filtering variants by the given
* axis and value. The following example returns a list of
* variant products that have a value of <i>blue</i> on the
* <i>color</i> axis.
*
* <p>
* <code>product.getVariants(new AxisFilter("color", "blue"));</code>
*/
public class AxisFilter implements VariantFilter {
private String axis;
private String value;
public AxisFilter(String axis, String value) {
this.axis = axis;
this.value = value;
}
/**
* {@inheritDoc}
*/
public boolean includes(Product product) {
ValueMap values = product.adaptTo(ValueMap.class);
if(values != null) {
String v = values.get(axis, String.class);
return v != null && v == value;
}
return false;
}
}
Mecanismo General de Almacenamiento
Los nodos de producto son nt:unstructured.
Un nodo de producto puede ser:
Una referencia, con los datos del producto almacenados en otra parte:
productData
, que señala a los datos del producto (normalmente, en /etc/commerce/products
).Un producto en sí:
productData
propiedad.Estructura de producto AEM genérica
+ banyan_shirt
- cq:commerceType = product
- cq:productAttributes = [jcr:title, jcr:description, size, price, color]
- cq:productVariantAxes = [color, size]
- jcr:title = Banyan Shirt
- jcr:description = Flowery, all-cotton shirt.
- price = 14.00
+ banyan_shirt_s
- cq:commerceType = variant
- size = S
+ banyan_shirt_s_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_s_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_m
- cq:commerceType = variant
- size = M
+ banyan_shirt_m_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_m_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_l
- cq:commerceType = variant
- size = L
+ banyan_shirt_l_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_l_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_xl
- cq:commerceType = variant
- size = XL
- price = 18.00
Componentes
El carro de compras es propiedad del CommerceSession:
CommerceSession
realiza añadir, quitar, etc.CommerceSession
también realiza los distintos cálculos del carro de compras. "Aunque no está directamente relacionado con el carro de compras, la variable CommerceSession
también debe proporcionar información de precios de catálogo (ya que posee precios)
Los precios pueden tener varios modificadores:
Los modificadores están totalmente abiertos con la siguiente interfaz:
int CommerceSession.getQuantityBreakpoints(Product product)
String CommerceSession.getProductPrice(Product product)
Almacenamiento
Almacenamiento
Personalización
La personalización siempre debe impulsarse a través de la variable ClientContext.
Un ClientContext /version/
del carro de compras se crea en todos los casos:
CommerceSession.addCartEntry()
método.A continuación se muestra un ejemplo de información del carro de compras en el carro de ClientContexts:
Datos de carro de compras y pedidos
La variable CommerceSession
posee los tres elementos siguientes:
Contenido del carro de compras
Precio
Los detalles del pedido
Contenido del carro de compras
La API corrige el esquema de contenido del carro de compras:
public void addCartEntry(Product product, int quantity);
public void modifyCartEntry(int entryNumber, int quantity);
public void deleteCartEntry(int entryNumber);
Precio
La API también corrige el esquema de precios:
public String getCartPreTaxPrice();
public String getCartTax();
public String getCartTotalPrice();
public String getOrderShipping();
public String getOrderTotalTax();
public String getOrderTotalPrice();
Detalles del pedido
Sin embargo, los detalles del pedido son not solucionado por la API:
public void updateOrderDetails(Map<String, String> orderDetails);
public Map<String, String> getOrderDetails();
public void submitOrder();
Cálculos de envío
Los formularios de pedido a menudo necesitan presentar varias opciones de envío (y precios).
Los precios pueden basarse en artículos y detalles del pedido, como peso o dirección de entrega.
La variable CommerceSession
tiene acceso a todas las dependencias, por lo que se puede tratar de forma similar a los precios de los productos:
CommerceSession
es propietario de precios de envío.updateOrder(Map<String, Object> delta)
Puede implementar un selector de envío; por ejemplo:
yourProject/commerce/components/shippingpicker
:
Esencialmente esto podría ser una copia de foundation/components/form/radio
, pero con llamadas de retorno a la variable CommerceSession
para:
Comprobación de si el método está disponible
Adición de información de precios
Para permitir a los compradores actualizar la página de pedidos en AEM (incluyendo el superconjunto de métodos de envío y el texto que los describe), mientras tienen el control para exponer el CommerceSession
información.
Procesamiento de pagos
CommerceSession
también posee la conexión de procesamiento de pagos.CommerceSession
implementación.Cumplimiento de pedidos
CommerceSession
también posee la conexión de cumplimiento.CommerceSession
implementación.Siguiendo el modelo de API de servicio estándar, el proyecto de comercio electrónico proporciona un conjunto de API relacionadas con la búsqueda que pueden ser implementadas por motores de comercio individuales.
Actualmente, solo el motor híbris implementa la API de búsqueda predeterminada.
Sin embargo, la API de búsqueda es genérica y cada CommerceService puede implementarla individualmente.
El proyecto eCommerce contiene un componente de búsqueda predeterminado, ubicado en:
/libs/commerce/components/search
Esto hace uso de la API de búsqueda para consultar el motor de comercio seleccionado (consulte Selección del motor de comercio electrónico):
El proyecto principal proporciona varias clases genéricas/de ayuda:
CommerceQuery
Se utiliza para describir una consulta de búsqueda (contiene información sobre el texto de la consulta, la página actual, el tamaño de la página, el orden y las facetas seleccionadas). Todos los servicios de comercio electrónico que implementan la API de búsqueda recibirán instancias de esta clase para realizar su búsqueda. A CommerceQuery
se puede crear una instancia desde un objeto de solicitud ( HttpServletRequest
).
FacetParamHelper
Es una clase de utilidad que proporciona un método estático: toParams
- que se utiliza para generar GET
cadenas de parámetros de una lista de facetas y un valor alternado. Esto resulta útil en la interfaz de usuario, donde debe mostrar un hipervínculo para cada valor de cada faceta, de modo que cuando el usuario haga clic en el hipervínculo, se alterne el valor respectivo (es decir, si se seleccionó, se eliminará de la consulta y se añadirá de lo contrario). Esto se ocupa de toda la lógica de gestionar facetas de varios valores o de un solo valor, valores anuladores, etc.
El punto de entrada para la API de búsqueda es la CommerceService#search
método que devuelve un CommerceResult
objeto. Consulte la Documentación de API para obtener más información sobre este tema.
Se proporciona integración entre AEM y varios sistemas de comercio electrónico. Esto requiere una estrategia para sincronizar compradores entre los distintos sistemas, de modo que el código específico de AEM solo tenga que saber sobre AEM y viceversa:
Autenticación
AEM se presume que es la variable only front-end web y, por lo tanto, funciona all autenticación.
Cuentas en Hybris
AEM crea una cuenta correspondiente (subordinada) en hybris para cada comprador. El nombre de usuario de esta cuenta es el mismo que el nombre de usuario AEM. Una contraseña criptográficamente aleatoria se genera automáticamente y se almacena (encriptado) en AEM.
Se puede colocar un front-end AEM delante de una implementación híbrida existente. También se puede añadir un motor híbrido a una instalación de AEM existente. Para ello, los sistemas deben poder gestionar correctamente a los usuarios existentes en cualquiera de los sistemas:
AEM -> híbrido
Al iniciar sesión en hybris, si el usuario AEM no existe:
Consulte: com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()
hybris -> AEM
Al iniciar sesión en AEM, si el sistema reconoce al usuario:
El algoritmo anterior se implementa en un Sling AuthenticationInfoPostProcessor
com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java
Para aprovechar la funcionalidad existente, utilice el controlador de importación personalizado:
debe implementar la variable ImportHandler
interfaz
puede ampliar el DefaultImportHandler
/**
* Services implementing the <code>ImportHandler</code> interface are
* called by the {@link HybrisImporter} to create actual commerce entities
* such as products.
*/
public interface ImportHandler {
/**
* Not used.
*/
public void createTaxonomie(ImporterContext ctx);
/**
* Creates a catalog with the given name.
* @param ctx The importer context
* @param name The catalog's name
* @return Path of created catalog
*/
public String createCatalog(ImporterContext ctx, String name) throws Exception;
/**
* Creates a product from the given values.
* @param ctx The importer context
* @param values The product's properties
* @param parentCategoryPath The containing category's path
* @return Path of created product
*/
public String createProduct(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
/**
* Creates a variant product from the given values.
* @param ctx The importer context
* @param values The product's properties
* @param baseProductPath The base product's path
* @return Path of created product
*/
public String createVariantProduct(ImporterContext ctx, ValueMap values, String baseProductPath) throws Exception;
/**
* Creates an asset for a product. This is usually a product
* image.
* @param ctx The importer context
* @param values The product's properties
* @param baseProductPath The product's path
* @return Path of created asset
*/
public String createAsset(ImporterContext ctx, ValueMap values, String productPath) throws Exception;
/**
* Creates a category from the given values.
* @param ctx The importer context
* @param values The category's properties
* @param parentPath Path of parent category or base path of import in case of root category
* @return Path of created category
*/
public String createCategory(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
}
Para que el importador reconozca el controlador personalizado, debe especificar la variable service.ranking
propiedad con un valor superior a 0; por ejemplo:
@Component
@Service
@Property(name = "service.ranking", value = 100)
public class MyImportHandler extends DefaultImportHandler {
...
}