A estrutura de comércio eletrônico pode ser usada com qualquer solução de comércio eletrônico. Certas especificações e exemplos aqui abordados se referem à híbris solução.
A estrutura de integração inclui uma camada de integração com uma API. Isso permite:
Documentação da API também está disponível.
Vários componentes de AEM prontos para uso são fornecidos para usar a camada de integração. Atualmente, são:
Para pesquisar, é fornecido um gancho de integração que permite usar a pesquisa de AEM, a pesquisa do sistema de eCommerce, uma pesquisa de terceiros ou uma combinação desse sistema.
A estrutura de eCommerce pode ser usada com qualquer solução de eCommerce, o mecanismo usado precisa ser identificado por AEM:
Os mecanismos de comércio eletrônico são serviços OSGi compatíveis com o CommerceService
interface
commerceProvider
propriedade de serviçoAEM compatível Resource.adaptTo()
para CommerceService
e Product
O adaptTo
a implementação procura uma cq:commerceProvider
na hierarquia do recurso:
A cq:Commerce
A mixin é usada para que a variável cq:commerceProvider
podem ser adicionados a recursos com muitos tipos.
O cq:commerceProvider
é também usada para fazer referência à definição de fábrica de comércio apropriada.
Por exemplo, um cq:commerceProvider
propriedade com o valor hybris
estará correlacionado à configuração do OSGi para Day CQ Commerce Fatory for Hybris (com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory) - onde o parâmetro commerceProvider
também tem o valor hybris
.
Aqui estão outras propriedades, como Versão do catálogo pode ser configurado (quando apropriado e disponível).
Consulte os seguintes exemplos abaixo:
cq:commerceProvider = geometrixx |
numa instalação-padrão AEM é necessária uma implementação específica; por exemplo, o exemplo geometrixx, que inclui extensões mínimas para a API genérica |
---|---|
cq:commerceProvider = hybris |
implementação de híbridos |
/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
Com o CRXDE Lite, você pode ver como isso é feito no componente de produto para a implementação de híbridos:
/apps/geometrixx-outdoors/components/hybris/product/product.jsp
A extensão hybris da estrutura de integração de comércio eletrônico foi atualizada para oferecer suporte ao Hybris 5, mantendo a compatibilidade com o Hybris 4.
As configurações padrão no código são ajustadas para Hybris 5.
Para desenvolver o Hybris 4 é necessário:
Ao chamar maven, adicione o seguinte argumento de linha de comando ao comando
-P hybris4
Ele baixa a distribuição pré-configurada do Hybris 4 e a incorpora ao pacote:
cq-commerce-hybris-server
No gerenciador de configuração do OSGi:
hybris usa uma sessão do usuário para armazenar informações como o carrinho de compras do cliente. A ID da sessão é retornada de híbridos em um JSESSIONID
cookie que precisa ser enviado em solicitações subsequentes para híbridos. Para evitar armazenar a id da sessão no repositório, ela é codificada em outro cookie que é armazenado no navegador do comprador. As seguintes etapas são executadas:
hybris-session-rest
) e defina na resposta ao comprador. A codificação em um novo cookie é necessária, pois o cookie original é válido apenas para um determinado caminho e, caso contrário, não seria enviado de volta do navegador em solicitações subsequentes. As informações de caminho também devem ser adicionadas ao valor do cookie.hybris-session-<*xxx*>
cookies e definido no cliente HTTP que é usado para solicitar dados de híbridos.Uma nova sessão anônima é criada quando a sessão original não é mais válida.
Esta sessão é "proprietária" da carrinho de compras
executa adicionar/remover/etc
realiza os vários cálculos no carrinho;
commerceSession.getProductPrice(Product product)
Possui o local de armazenamento para pedido dados
CommerceSession.getUserContext()
Também é proprietária da pagamento conexão de processamento
Também é proprietária da cumprimento conexão
Os dados do produto que são mantidos em híbridos precisam estar disponíveis em AEM. Foi implementado o seguinte mecanismo:
O importador (b) é usado para a configuração inicial da estrutura da árvore de páginas em AEM para catálogos.
As alterações no catálogo em híbridos são indicadas para AEM por meio de um feed, propagando-se então para AEM (b)
A extensão hybris fornece um importador de pesquisa (esquema "hybris"), que pode ser configurado para importar alterações para AEM em um intervalo especificado (por exemplo, a cada 24 horas, onde o intervalo é especificado em 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
}
A configuração do catálogo no AEM reconhece Preparado e Online versões de catálogo.
A sincronização de produtos entre versões de catálogo exigirá uma (des)ativação da página de AEM correspondente (a, c)
Ativar uma página no AEM c) requer uma verificação b) e só é possível se
As páginas de produtos ativadas precisam acessar os dados do produto Online versão d).
A instância de publicação de AEM requer acesso a híbridos para a recuperação de dados personalizados e do produto (d).
Um único produto pode apresentar variações múltiplas; por exemplo, pode variar de acordo com a cor e/ou o tamanho. Um produto deve definir as propriedades que determinam a variação; nós os designamos eixos de variantes.
No entanto, nem todas as propriedades são eixos de variante. As variações também podem afetar outras propriedades; por exemplo, o preço pode depender do tamanho. Essas propriedades não podem ser selecionadas pelo comprador e, portanto, não são consideradas eixos de variante.
Cada produto e/ou variante é representado por um recurso e, portanto, mapeia 1:1 para um nó de repositório. É um corolário que um produto e/ou variante específico pode ser identificado exclusivamente pelo seu caminho.
O recurso produto/variante nem sempre contém os dados reais do produto. Pode ser uma representação de dados realmente mantidos em outro sistema (como híbridos). Por exemplo, descrições de produtos, preços etc. não são armazenados em AEM, mas recuperados em tempo real do mecanismo de comércio eletrônico.
Qualquer recurso de produto pode ser representado por um Product API
. A maioria das chamadas na API de produto é específica para a variação (embora as variações possam herdar valores compartilhados de um ancestral), mas também há chamadas que listam o conjunto de variações ( getVariantAxes()
, getVariants()
, etc.).
Com efeito, os eixos de variantes são determinados pelo Product.getVariantAxes()
retorna:
Embora os produtos (em geral) possam ter vários eixos de variantes, o componente de produto pronto para uso trata apenas de dois:
size
mais um
Essa variante adicional é selecionada por meio da variável variationAxis
propriedade da referência do produto (normalmente color
para Geometrixx Outdoors).
Em geral:
os dados do produto estão localizados em /etc
e as referências de produto nos termos do /content
.
Deve haver um mapa 1:1 entre variações de produto e nós de dados de produto.
As referências de produto também devem ter um nó para cada variação apresentada, mas não há necessidade de apresentar todas as variações. Por exemplo, se um produto tiver variações de S, M, L, os dados do produto podem ser:
etc
commerce
products
shirt
shirt-s
shirt-m
shirt-l
Enquanto um catálogo "Grande e alto" pode ter apenas:
content
big-and-tall
shirt
shirt-l
Finalmente, não há requisito para usar dados do produto. Você pode colocar todos os dados do produto sob as referências no catálogo; mas não é possível ter vários catálogos sem duplicar todos os dados do produto.
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 geral de armazenamento
Os nós do produto não são:não estruturados.
Um nó de produto pode ser:
Uma referência, com os dados do produto armazenados em outro lugar:
productData
, que aponta para os dados do produto (normalmente em /etc/commerce/products
).Um produto em si:
productData
propriedade.Estrutura AEM-genérica do produto
+ 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
O carrinho de compras é de propriedade do CommerceSession:
CommerceSession
O executa adicionar/remover/etc.CommerceSession
O também executa os vários cálculos no carrinho. "Embora não esteja diretamente relacionado ao carrinho, a variável CommerceSession
também deve fornecer informações sobre preços de catálogo (já que possui preços)
Os preços podem ter vários modificadores:
Os modificadores são completamente abertos com a seguinte interface:
int CommerceSession.getQuantityBreakpoints(Product product)
String CommerceSession.getProductPrice(Product product)
Armazenamento
Armazenamento
Personalização
A personalização deve sempre ser conduzida pelo ClientContext.
Um ClientContext /version/
do carrinho é criado em todos os casos:
CommerceSession.addCartEntry()
método .O exemplo a seguir ilustra as informações do carrinho no carrinho do ClientContext:
Dados do carrinho e pedido
O CommerceSession
é proprietária dos três elementos:
Conteúdo do carrinho
Preços
Os detalhes do pedido
Conteúdo do carrinho
O esquema de conteúdo do carrinho é corrigido pela API:
public void addCartEntry(Product product, int quantity);
public void modifyCartEntry(int entryNumber, int quantity);
public void deleteCartEntry(int entryNumber);
Preços
O schema de preços também é corrigido pela API:
public String getCartPreTaxPrice();
public String getCartTax();
public String getCartTotalPrice();
public String getOrderShipping();
public String getOrderTotalTax();
public String getOrderTotalPrice();
Detalhes do pedido
No entanto, os detalhes do pedido são not corrigido pela API:
public void updateOrderDetails(Map<String, String> orderDetails);
public Map<String, String> getOrderDetails();
public void submitOrder();
Cálculos de Entrega
Os formulários de pedido geralmente precisam apresentar várias opções de envio (e preços).
Os preços podem ser baseados em itens e detalhes do pedido, como peso e/ou endereço de entrega.
O CommerceSession
O tem acesso a todas as dependências, portanto, pode ser tratado de maneira semelhante como o preço do produto:
CommerceSession
é proprietária de preços de envio.updateOrder(Map<String, Object> delta)
Você poderia implementar um seletor de envio; por exemplo:
yourProject/commerce/components/shippingpicker
:
Essencialmente, isto pode ser uma cópia de foundation/components/form/radio
, mas com retornos de chamada para a CommerceSession
a favor:
Verificando se o método está disponível
Adicionar informações sobre preços
Para permitir que os compradores atualizem a página de pedido em AEM (incluindo o superconjunto de métodos de envio e o texto que os descreve), mantendo o controle para expor a CommerceSession
informações.
Processamento de pagamento
CommerceSession
é igualmente proprietária da ligação de processamento de pagamentos.CommerceSession
implementação.Cumprimento do pedido
CommerceSession
é também proprietária da ligação de execução.CommerceSession
implementação.Seguindo o modelo padrão de API de serviço, o projeto de eCommerce fornece um conjunto de APIs relacionadas à pesquisa que podem ser implementadas por mecanismos de comércio individuais.
Atualmente, somente o mecanismo de híbridos implementa a API de pesquisa pronta para uso.
No entanto, a API de pesquisa é genérica e pode ser implementada por cada CommerceService individualmente.
O projeto de comércio eletrônico contém um componente de pesquisa padrão, localizado em:
/libs/commerce/components/search
Isso usa a API de pesquisa para consultar o mecanismo de comércio selecionado (consulte Seleção do mecanismo de comércio eletrônico):
Há várias classes genéricas/auxiliares fornecidas pelo projeto principal:
CommerceQuery
É usado para descrever uma consulta de pesquisa (contém informações sobre o texto da consulta, página atual, tamanho da página, classificação e aspectos selecionados). Todos os serviços de eCommerce que implementam a API de pesquisa receberão instâncias dessa classe para realizar sua pesquisa. A CommerceQuery
pode ser instanciado de um objeto de solicitação ( HttpServletRequest
).
FacetParamHelper
É uma classe de utilitário que fornece um método estático - toParams
- que é utilizado para gerar GET
strings de parâmetro de uma lista de facetas e um valor alternado. Isso é útil na interface do usuário, onde é necessário exibir um hiperlink para cada valor de cada faceta, de modo que, quando o usuário clica no hiperlink, o respectivo valor é alternado (ou seja, se foi selecionado, ele é removido da consulta, caso contrário, é adicionado). Isso cuida de toda a lógica de lidar com várias facetas/valores únicos, substituir valores etc.
O ponto de entrada da API de pesquisa é o CommerceService#search
método que retorna um CommerceResult
objeto. Consulte a Documentação da API para obter mais informações sobre este tópico.
A integração é fornecida entre o AEM e vários sistemas de eCommerce. Isso requer uma estratégia para sincronizar compradores entre os vários sistemas, de modo que o código específico do AEM tenha que saber apenas sobre AEM e vice-versa:
Autenticação
Presume-se que AEM é o only front-end da Web e, portanto, desempenho all autenticação.
Contas em Hybris
AEM cria uma conta correspondente (secundária) em híbridos para cada comprador. O nome de usuário desta conta é igual ao nome de usuário AEM. Uma senha aleatória criptograficamente é gerada automaticamente e armazenada (criptografada) no AEM.
Um front-end AEM pode ser posicionado na frente de uma implementação de hybris existente. Também é possível adicionar um mecanismo hybris a uma instalação AEM existente. Para fazer isso, os sistemas devem ser capazes de lidar com os usuários existentes em qualquer um dos sistemas:
AEM -> híbridos
Ao fazer logon em híbridos, se o usuário do AEM ainda não existir:
Consulte: com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()
hybris -> AEM
Ao fazer logon no AEM, se o sistema reconhecer o usuário:
O algoritmo acima é implementado em um Sling AuthenticationInfoPostProcessor
com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java
Para basear-se na funcionalidade existente, o manipulador de importação personalizado:
tem de implementar a ImportHandler
interface
pode estender o 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 seu manipulador personalizado seja reconhecido pelo importador, ele deve especificar a variável service.ranking
propriedade com valor superior a 0; por exemplo:
@Component
@Service
@Property(name = "service.ranking", value = 100)
public class MyImportHandler extends DefaultImportHandler {
...
}