Utveckla (allmän)

Senast uppdaterad: 4 maj 2023

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.
NOTE
API-dokumentation finns också.

Integreringsramverket innehåller ett integreringslager med ett API. Detta gör att du kan bygga AEM komponenter för e-handelsfunktioner (oberoende av din specifika e-handelsmotor). Man kan också använda den interna CRX-databasen eller koppla in ett e-handelssystem och hämta in produktdata i AEM.

Det finns ett antal färdiga AEM för att använda integreringslagret. För närvarande är följande:

  • En produktvisningskomponent
  • En kundvagn
  • Kampanjer och kuponger
  • Katalog- och avsnittsritningar
  • Checka ut
  • Sökning

För sökningar finns en integreringsfunktion som gör att du kan använda AEM, en tredjepartssökning eller en kombination av dessa.

Val av e-handelsmotor

eCommerce-ramverket kan användas tillsammans med alla e-handelslösningar, och den motor som används måste identifieras av AEM - även när den AEM generiska motorn används:

  • eCommerce Engines är OSGi-tjänster som stöder CommerceService gränssnitt

    • Motorer kan särskiljas av en commerceProvider service, egenskap

  • AEM Resource.adaptTo() for CommerceService och Product

    • The adaptTo implementering söker efter en cq:commerceProvider i resursens hierarki:

      • Om det hittas används värdet för att filtrera e-handelstjänstens sökning.
      • Om den inte hittas används den mest rankade e-handelstjänsten.

    • A cq:Commerce mixin används så att cq:commerceProvider kan läggas till i starkt typbestämda resurser.

  • The cq:commerceProvider -egenskapen används också för att referera till lämplig definition för handelsfabrik.

    • Till exempel en cq:commerceProvider egenskapen med värdet geometrixx korrelerar till OSGi-konfigurationen för Dagens CQ Commerce Factory för Geometrixx-utomhusbruk (com.adobe.cq.commerce.hybris.impl.GeoCommerceServiceFactory) - där parametern commerceProvider har även värdet geometrixx.
    • Här kan ytterligare egenskaper konfigureras (när det är lämpligt och tillgängligt).

I en AEM krävs en specifik implementering, till exempel:

cq:commerceProvider = geometrixxGeometrixx-exempel; detta inkluderar minimala tillägg till det generiska API:t

Exempel 

/etc/commerce/products/geometrixx-outdoors
+ cq:commerceProvider = geometrixx
  + 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
NOTE
Med CRXDE Lite kan du se hur detta hanteras i produktkomponenten för den AEM allmänna implementeringen:
/apps/geometrixx-outdoors/components/product

Sessionshantering

En session där information om kundens kundvagn lagras.

The CommerceSession:

  • Äger kundvagn

    • utför Lägg till/ta bort/etc

    • utför de olika beräkningarna av varukorgen,

      commerceSession.getProductPriceInfo(Product product, Predicate filter)

  • Äger beständighet för order data:

    CommerceSession.getUserContext()

  • Kan hämta/uppdatera leveransinformation med updateOrder(Map<String, Object> delta)

  • Äger även betalning bearbetningsanslutning

  • Äger även uppfyllelse anslutning

Arkitektur

Arkitektur för produkt och varianter

En och samma produkt kan ha flera variationer. den kan till exempel variera beroende på färg och/eller storlek. En produkt måste definiera vilka egenskaper som driver variationen. vi kallar dem variantaxlar.

Alla egenskaper är dock inte olika axlar. Variationer kan också påverka andra egenskaper. Priset kan till exempel vara beroende av storleken. Dessa egenskaper kan inte väljas av kunden och betraktas därför inte som olika axlar.

Varje produkt och/eller variant representeras av en resurs och mappar därför 1:1 till en databasnod. Det är en extra konsekvens att en specifik produkt och/eller variant kan identifieras unikt genom sin sökväg.

Alla produktresurser kan representeras av en Product API. De flesta anrop i produkt-API:t är variationsspecifika (även om variationer kan ärva delade värden från ett överordnat objekt), men det finns också anrop som listar variantuppsättningen ( getVariantAxes(), getVariants(), osv.).

NOTE
I själva verket bestäms en variantaxel av vad som helst Product.getVariantAxes() returnerar:
  • för den generiska implementeringen AEM läsa den från en egenskap i produktdata ( cq:productVariantAxes)
Produkter (i allmänhet) kan ha många olika axlar, men produktkomponenten som finns i paketet hanterar bara två:

  1. size

  2. plus ytterligare

    Den här extra varianten markeras via variationAxis egenskap för produktreferensen (vanligtvis color för Geometrixx Outdoors).

Produktreferenser och PIM-data

I allmänhet:

  • PIM-data finns under /etc

  • Produktreferenser under /content.

Det måste finnas en 1:1-karta mellan produktvariationer och produktdatanoder.

Produktreferenser måste också ha en nod för varje variant som presenteras - men det finns inget krav på att presentera alla variationer. Om en produkt till exempel har variationer i S, M och L kan produktinformationen vara:

etc
  commerce
    products
      shirt
        shirt-s
        shirt-m
        shirt-l

En stor och hög katalog kanske bara innehåller:

content
  big-and-tall
    shirt
      shirt-l

Slutligen finns det inget krav på att använda produktdata. Du kan placera alla produktdata under referenserna i katalogen; men du kan inte ha flera kataloger utan att duplicera alla produktdata.

API

com.adobe.cq.commerce.api.Product interface 

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

com.adobe.cq.commerce.api.VariantFilter 

/**
 * 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;
    }
}

  • Allmän lagringsmekanism

    • Produktnoder är inte:ostrukturerade.

    • En produktnod kan vara antingen:

      • En referens med produktdata lagrade någon annanstans:

        • Produktreferenser innehåller en productData -egenskap, som pekar på produktdata (vanligtvis under /etc/commerce/products).
        • Produktinformationen är hierarkisk. produktattribut ärvs från en produktdatanodens överordnade.
        • Produktreferenser kan också innehålla lokala egenskaper som åsidosätter de som anges i deras produktdata.

      • En produkt i sig:

        • Utan productData -egenskap.
        • En produktnod som innehåller alla egenskaper lokalt (och inte innehåller någon productData-egenskap) ärver produktattribut direkt från sina egna överordnade.

  • AEM produktstruktur

    • Varje variant måste ha en egen lövnod.
    • Produktgränssnittet representerar både produkter och varianter, men den relaterade databasnoden är specifik för vilken den är.
    • Produktnoden beskriver produktattribut och variantaxlar.

Exempel 

+ 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

Arkitektur för kundvagnen

Komponenter

  • Kundvagnen ägs av CommerceSession:

    • The CommerceSession utför lägger till, tar bort osv.
    • The CommerceSession utför även de olika beräkningarna på kundvagnen.
    • The CommerceSession gäller även kuponger och kampanjer som har sparats i kundvagnen.

  • Även om de inte är direkt kundvagnsrelaterade är CommerceSession måste även tillhandahålla information om katalogpriser (eftersom den äger priser)

    • Priset kan innehålla flera modifieringar:

      • Kvantitetsrabatter.
      • Olika valutor.
      • momspliktig och momsfri.

    • Modifierarna är helt öppna med följande gränssnitt:

      • int CommerceSession.getQuantityBreakpoints(Product product)
      • String CommerceSession.getProductPrice(Product product)

Lagring

  • Lagring

Personanpassning

  • Personalisering bör alltid styras av ClientContext.

  • A ClientContext /version/ av kundvagnen skapas i samtliga fall:

    • Produkterna ska läggas till med CommerceSession.addCartEntry() -metod.

  • Följande illustrerar ett exempel på kundvagnsinformation i kundvagnen i ClientContext:

chlimage_1-33

Arkitektur för utcheckning

Kundvagn- och orderdata

The CommerceSession äger de tre elementen:

  1. Kundvagnsinnehåll

    Schemat för kundvagnens innehåll har korrigerats av API:

        public void addCartEntry(Product product, int quantity);
    public void modifyCartEntry(int entryNumber, int quantity);
    public void deleteCartEntry(int entryNumber);

  2. Priser

    Prisschemat är också fast av API:

        public String getCartPreTaxPrice();
    public String getCartTax();
    public String getCartTotalPrice();
    public String getOrderShipping();
    public String getOrderTotalTax();
    public String getOrderTotalPrice();

  3. Beställningsinformation

    Beställningsinformationen är dock not åtgärdat av API:

        public void updateOrderDetails(Map<String, String> orderDetails);
    public Map<String, String> getOrderDetails();
    public void submitOrder();

Leveransberäkningar

  • Beställningsblanketter måste ofta innehålla flera olika leveransalternativ (och priser).

  • Priserna kan baseras på artiklar och detaljer i beställningen, t.ex. vikt och/eller leveransadress.

  • The CommerceSession har tillgång till alla beroenden, så det kan behandlas på liknande sätt som produktpriser:

    • The CommerceSession äger fraktpriser.
    • Använd updateOrder(Map<String, Object> delta) för att hämta/uppdatera leveransinformation.

Sökdefinition

I enlighet med standardtjänstens API-modell innehåller e-handelsprojektet en uppsättning sökrelaterade API:er som kan implementeras av enskilda e-handelsmotorer.

NOTE
För närvarande är det bara hybris-motorn som implementerar söknings-API:t.
Söknings-API:t är dock allmänt och kan implementeras av varje enskild CommerceService.
Även om den generiska implementeringen inte implementerar det här API:t kan du utöka det och lägga till sökfunktionen.

eCommerce-projektet innehåller en standardsökkomponent som finns i:

/libs/commerce/components/search

chlimage_1-34

Detta använder sökgränssnittet för att fråga den valda e-handelsmotorn (se Val av e-handelsmotor):

Söknings-API

Det finns flera allmänna/hjälpklasser i huvudprojektet:

  1. CommerceQuery

    Används för att beskriva en sökfråga (innehåller information om frågetext, aktuell sida, sidstorlek, sortering och valda aspekter). Alla e-handelstjänster som implementerar söknings-API:t får instanser av den här klassen för att kunna utföra sökningen. A CommerceQuery kan instansieras från ett begäranobjekt ( HttpServletRequest).

  2. FacetParamHelper

    Är en verktygsklass som innehåller en statisk metod - toParams - som används för att generera GET parametersträngar från en lista med facets och ett sammankopplat värde. Detta är användbart på användargränssnittssidan, där du behöver visa en hyperlänk för varje värde i varje aspekt, så att respektive värde växlas när användaren klickar på hyperlänken (d.v.s. om den markerats tas det bort från frågan, annars läggs det till). Detta tar hand om all logik för hantering av flera-/enkelvärdesfaktorer, åsidosättningsvärden osv.

Startpunkten för sökgränssnittet är CommerceService#search metod som returnerar en CommerceResult -objekt. Mer information om det här avsnittet finns i API-dokumentationen.

Utveckla kampanjer och Vouchers

  • Vouchers:

    • En Voucher är en sidbaserad komponent som skapas/redigeras med webbplatskonsolen och lagras under:

      /content/campaigns

    • Kuponger:

      • En kupongkod (som anges i kundvagnen av kunden).
      • En verifikationsetikett (visas när kunden har skrivit in den i kundvagnen).
      • En kampanjsökväg (som definierar den åtgärd som vouchern tillämpar).

    • Vouchers har inte sina egna datum- och datumtider, utan använder dem från sina överordnade kampanjer.

    • Externa handelsmotorer kan också tillhandahålla vouchers, kräver minst

      • En verifikationskod
      • An isValid() method

    • The Voucher komponent ( /libs/commerce/components/voucher) innehåller:

      • En renderare för kupongadministration. visar eventuella verifikationer som finns i kundvagnen.
      • Redigeringsdialogrutorna (formuläret) för att administrera (lägga till/ta bort) verifikationerna.
      • De åtgärder som krävs för att lägga till/ta bort verifikationer i/från kundvagnen.

  • Kampanjer:

    • En kampanj är en sidbaserad komponent som skapas/redigeras med webbplatskonsolen och lagras under:

      /content/campaigns

    • Erbjudanden:

      • En prioritet
      • En sökväg till en erbjudandehanterare

    • Du kan koppla kampanjer till en kampanj för att definiera datum/tid för på/av-kampanjer.

    • Du kan koppla kampanjer till en upplevelse för att definiera deras segment.

    • Kampanjer som inte är kopplade till en upplevelse kommer inte att utlösas fristående, men de kan fortfarande utlösas av en Voucher.

    • Komponenten Promotion ( /libs/commerce/components/promotion) innehåller:

      • renderare och dialogrutor för kampanjadministration
      • underkomponenter för återgivning och redigering av konfigurationsparametrar som är specifika för kampanjhanterarna

    • Två marknadsföringshanterare medföljer:

      • DiscountPromotionHandlersom ger en absolut rabatt eller en procentuell rabatt som gäller för hela varukorgen
      • PerfectPartnerPromotionHandler, som ger en produkt i absolut eller procentuell rabatt om partnerprodukten också finns i kundvagnen

    • ClientContext SegmentMgr löser segment och ClientContext CartMgr löser kampanjer. Varje kampanj som gäller minst ett löst segment kommer att utlösas.

      • Utlösta kampanjer skickas tillbaka till servern via ett AJAX samtal för att beräkna kundvagnen på nytt.
      • Utlösta kampanjer (och tillagda Vouchers) visas också på panelen ClientContext.

Du kan lägga till/ta bort en verifikation från en kundvagn via CommerceSession API:

/**
 * Apply a voucher to this session's cart.
 *
 * @param code the voucher's code
 * @throws CommerceException
 */
public void addVoucher(String code) throws CommerceException;

/**
 * Remove a voucher that was previously added with {@link #addVoucher(String)}.
 *
 * @param code the voucher's code
 * @throws CommerceException
 */
public void removeVoucher(String code) throws CommerceException;

/**
 * Get a list of vouchers that were added to this cart via {@link #addVoucher(String)}.
 *
 * @throws CommerceException
 */
public List<Voucher> getVouchers() throws CommerceException;

Den här vägen, CommerceSession ansvarar för att kontrollera om det finns en verifikation och om den kan användas eller inte. Detta kan vara för kuponger som bara kan tillämpas om ett visst villkor är uppfyllt. till exempel om det totala kundvagnspriset är större än $100). Om en verifikation inte kan användas av någon anledning addVoucher -metoden genererar ett undantag. Dessutom CommerceSession ansvarar för att uppdatera kundvagnens priser efter att en verifikation har lagts till/tagits bort.

The Voucher är en böldliknande klass som innehåller fält för:

  • Verifikationskod
  • En kort beskrivning
  • Referera till den relaterade kampanjen som anger rabattypen och värdet

The AbstractJcrCommerceSession kan använda verifikationer. Verifikationerna som returneras av klassen getVouchers() är förekomster av cq:Page som innehåller en jcr:content-nod med följande egenskaper (bland annat):

  • sling:resourceType (String) - det här måste vara commerce/components/voucher

  • jcr:title (String) - för voucherns beskrivning

  • code (String) - den kod som användaren måste ange för att kunna använda vouchern

  • promotion (String) - den befordran som ska genomföras. t.ex. /content/campaigns/geometrixx-outdoors/article/10-bucks-off

Kampanjhanterare är OSGi-tjänster som ändrar kundvagnen. Kundvagnen har stöd för flera krokar som definieras i PromotionHandler gränssnitt.

/**
 * Apply promotion to a cart line item. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @param cartEntry The cart line item
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyCartEntryPromotion(CommerceSession commerceSession,
                                         Promotion promotion, CartEntry cartEntry)
    throws CommerceException;

/**
 * Apply promotion to an order. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyOrderPromotion(CommerceSession commerceSession, Promotion promotion)
    throws CommerceException;

public PriceInfo applyShippingPromotion(CommerceSession commerceSession, Promotion promotion)
    throws CommerceException;

/**
 * Allows a promotion handler to define a custom, author-oriented message for a promotion.
 * The {@link com.adobe.cq.commerce.common.promotion.PerfectPartnerPromotionHandler}, for instance,
 * uses this to list the qualifying pairs of products in the current cart.
 * @param commerceSession
 * @param promotion
 * @return A message to display
 * @throws CommerceException
 */
public String getMessage(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) throws CommerceException;

/**
 * Informs the promotion handler that something under the promotions root has been edited, and the handler
 * should invalidate any caches it might be keeping.
 */
public void invalidateCaches();

Tre marknadsföringshanterare ingår:

  • DiscountPromotionHandler använder en absolut rabatt eller en procentuell rabatt för hela varukorgen
  • PerfectPartnerPromotionHandler tillämpar en absolut eller procentuell rabatt på produkten om produktpartnern också finns i kundvagnen
  • FreeShippingPromotionHandler kostnadsfri frakt
Föregående sida
Nästa sida

Experience Manager