SAP Commerce Cloud V2 (Spartacus)

Written By Devin O'Neill ()

Updated at April 15th, 2025

Connector Base Code Installation Steps

  • Get Annex Cloud code base. It will consist of five extensions:
    AnnexCloudAddon
    AnnexCloudBackoffice
    AnnexCloudFullfillmentProcess
    AnnexCloudv3Facades
    AnnexCloudv3Services
  •  Copy all five extensions inside {base_directory}/hybris/bin/custom.
  • Include all five extensions in the localextensions.xml file. Also, add the “addonsupport” OOTB extension which is required for Add On installation.
  • Install the following Add On: annexcloudaddon
  •  Now, go to {base_directory}/hybris/bin/platform directory and execute the following Add On install commands.
ant addoninstall -Daddonnames="annexcloudaddon" DaddonStorefront.yacceleratorstorefront="<Name of the storefront extension>"
  • Define dependency by updating the extensioninfo.xml of annexcloudv3facades extension.
<requires-extension name="annexcloudv3services"/>
<requires-extension name="Here you need to add name of your core extension"/>
<requires-extension name="acceleratorfacades"/>

Example: If the name of your accelerator core is annexcloudcore, then put the same name above.

  • After the Add On installation, your storefront will get updated.

Installation

  • Do system update from HAC. Select only create essential data as shown below.

 Steps:
→ First, go to HMAC/console.
→ Go to the platform tab. You will get the update option over there.
→ Click on that.

It will display the following window:

  • Execute the electronic catalog sync job so that the components get copied from staged to online.
  • After the system update from HAC, your database will get updated.

Customer Loyalty

Import the impex code provided by Annex Cloud 

$contentCatalog=electronics-spaContentCatalog
$contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),CatalogV ersion.version[default=Staged])[default=$contentCatalog:Staged]
$siteResource=jar:de.hybris.platform.spartacussampledataaddon.constants.Spartacussampledataad donConstants&/spartacussampledataaddon/import/contentCatalogs/electronicsContentCatalog

## Delivery mode page (/checkout/points-redemption) INSERT_UPDATE
ContentPage;$contentCV[unique=true];uid[unique=true];name;masterTemplate(uid,$contentCV);lab el;defaultPage[default='true'];approvalStatus(code)[default='approved'];homepage[default='false']
;;ACPointsRedemptionMode;Points Redemption Mode Page;MultiStepCheckoutSummaryPageTemplate;/checkout/points-redemption
;;loyalty-dashboard;My Loyalty Dashboard;ContentPage1Template;/my-account/loyalty-dashboard

INSERT_UPDATE
ContentSlot;$contentCV[unique=true];uid[unique=true];name;cmsComponents(uid, $contentCV)
;;BodyContentSlot-acPointsRedemptionMode;Points Redemption Mode Slot;CheckoutProgressComponent,CheckoutProgressMobileTopComponent,ACPointsRedemptionM odeComponent,CheckoutProgressMobileBottomComponent
;;SideContentSlot-acPointsRedemptionMode;Order Summary Slot;CheckoutOrderSummaryComponent

INSERT_UPDATE
ContentSlotForPage;$contentCV[unique=true];uid[unique=true];position[unique=true];page(uid,$cont entCV)[unique=true];contentSlot(uid,$contentCV)[unique=true]
;;BodyContent- acPointsRedemptionMode;BodyContent;ACPointsRedemptionMode;BodyContentSlot- acPointsRedemptionMode
;;SideContent-acPointsRedemptionMode;SideContent;ACPointsRedemptionMode;SideContentSlot- acPointsRedemptionMode

INSERT_UPDATE
CMSFlexComponent;$contentCV[unique=true];uid[unique=true];name;flexType
;;ACPointsRedemptionModeComponent;ACPointsRedemptionModeComponent;ACPointsRedemptio nMode

INSERT_UPDATE
CMSLinkComponent;$contentCV[unique=true];uid[unique=true];name;url;&linkRef;target(code)[defa ult='sameWindow']
;;LoyaltyDashboardLink;LoyaltyDashboardLink;/my-account/loyalty- dashboard;LoyaltyDashboardLink;

# create navigation root node for my account & child nodes for the root node INSERT_UPDATE
CMSNavigationNode;uid[unique=true];$contentCV[unique=true];name;title;parent(uid,
$contentCV);links(&linkRef);&nodeRef #Root node is already added...
;LoyaltyDashboardNavNode;;Loyalty Dashboard;Loyalty Dashboard;MyAccountNavNode;;LoyaltyDashboardNavNode

# create cms navigation entry for navigation child nodes INSERT_UPDATE
CMSNavigationEntry;uid[unique=true];$contentCV[unique=true];name;navigationNode(&nodeRef);ite m(&linkRef);

;LoyaltyDashboardNavNodeEntry;;LoyaltyDashboardNavNodeEntry;LoyaltyDashboardNavNode;Loy altyDashboardLink;

#$contentCatalog=electronics-spaContentCatalog #$contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),Catalog Version.version[default=Staged])[default=$contentCatalog:Staged]

#INSERT_UPDATE
CMSFlexComponent;$contentCV[unique=true];uid[unique=true];name;flexType;&componentRef #;;ACReviewsTabComponent;Annex Cloud reviews Tab;ACReviewsTabComponent;ACReviewsTabComponent
#;;ACQaTabComponent;Annex Cloud Q&A Tab;ACQaTabComponent;ACQaTabComponent

#UPDATE
CMSTabParagraphContainer;$contentCV[unique=true];uid[unique=true];simpleCMSComponents(uid
, $contentCV);&componentRef #;;TabPanelContainer;ProductDetailsTabComponent,ProductSpecsTabComponent,deliveryTab,ACR eviewsTabComponent;TabPanelContainer

Home Page

 To enroll in the loyalty program, select the HomePage and choose the Loyalty Dashboard from the drop-down list.

  • Component: ACLoyaltyDashboardComponent

 Click Join Now, the loyalty dashboard will be displayed.

Newsletter Sign up

  • Component: NewsLetterSignupComponent

Product Display Page (PDP Page)

Component: ACProductPointComponent

Cart Page

  • Component: ACCartTotalComponent

Checkout Page

Checkout pages consist of three different pages.

  1. Redeem points:
    • Component:- AcPointCheckoutComponent
    • Component:- AcCouponCheckout Component
  2. Review Order
    • Component: AcCheckoutorderSummaryComponent

Refer A Friend Dashboard

  • Component - AcRafComponent

Import this impex from the HAC

$contentCatalog=electronics-spaContentCatalog
$contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),CatalogVersion.version[default=Online])[default=$contentCatalog:Online]
$siteResource=jar:de.hybris.platform.spartacussampledataaddon.constants.SpartacussampledataaddonConstants&/spartacussampledataaddon/import/contentCatalogs/electronicsContentCatalog
############################ Start Impex for RAF ########################################
INSERT_UPDATE CMSLinkComponent;$contentCV[unique=true];uid[unique=true];name;url;&linkRef;target(code)[default='sameWindow']
;;RafDashboardLink;RafDashboardLink;/my-account/ac-raf;RafDashboardLink;
# create navigation root node for my account & child nodes for the root node
INSERT_UPDATE CMSNavigationNode;uid[unique=true];$contentCV[unique=true];name;title;parent(uid, $contentCV);links(&linkRef);&nodeRef
#Root node is already added...
;RafDashboardNavNode;;Refer A friend;Refer A friend;MyAccountNavNode;;RafDashboardNavNode
# create cms navigation entry for nvaigation child nodes
INSERT_UPDATE CMSNavigationEntry;uid[unique=true];$contentCV[unique=true];name;navigationNode(&nodeRef);item(&linkRef);
;RafDasUnlockDashboardLinkhboardNavNodeEntry;;RafDashboardNavNodeEntry;RafDashboardNavNode;RafDashboardLink;
############################ End Impex for RAF ########################################
  1. Log in to the site and hover on My Account
  2. Click Refer A friend from the drop-down list.
  3. Once you click Refer A Friend link, then it will redirect to the RAF page and enter the details and click Start Sharing.
  4. Once you click the start sharing, the page below will open. Click on check the referral status.
  5. You can check the referral status.

Display (RAF) Refer A Friend On PDP

  • Component - AcPdpRafComponent
    1.  To Enroll the (RAF) Refer A Friend program on Product detail page (PDP) go to any PDP page and

Click Refer A Friend.

  1. Click Refer A Friend link, then RAF popup will open and enters detail to click start sharing.
  2. Click start sharing, the refer a friend popup will open. Here you can share via email, Facebook, Twitter and by copying the link itself.

Unlock Dashboard

  • Component - AcUnlockdashboardComponent

Import this impex into hybris system from the HAC.

############################ Start Impex for unlocakdeshboard #######################
$contentCatalog=electronics-spaContentCatalog
$contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),CatalogVersion.version[default=Staged])[default=$contentCatalog:Staged]
$siteResource=jar:de.hybris.platform.spartacussampledataaddon.constants.SpartacussampledataaddonConstants&/spartacussampledataaddon/import/contentCatalogs/electronicsContentCatalog
INSERT_UPDATE CMSLinkComponent;$contentCV[unique=true];uid[unique=true];name;url;&linkRef;target(code)[default='sameWindow']
;;UnlockDashboardLink;UnlockDashboardLink;/my-account/ac-unlockdashboard;UnlockDashboardLink;
# create navigation root node for my account & child nodes for the root node
INSERT_UPDATE CMSNavigationNode;uid[unique=true];$contentCV[unique=true];name;title;parent(uid, $contentCV);links(&linkRef);&nodeRef
#Root node is already added...
;UnlockDashboardNavNode;;Unlock Deshboard;Unlock Deshboard;MyAccountNavNode;;UnlockDashboardNavNode
# create cms navigation entry for nvaigation child nodes
INSERT_UPDATE CMSNavigationEntry;uid[unique=true];$contentCV[unique=true];name;navigationNode(&nodeRef);item(&linkRef);
;UnlockDashboardNavNodeEntry;;UnlockDashboardNavNodeEntry;UnlockDashboardNavNode;UnlockDashboardLink;
############################ End Impex for unlocakdeshboard ############################

To Enroll the Unlock Dashboard program, login with your username and password, and hover on

My Account.

  • Click Unlock Dashboard link from the drop-down list.
  • Once you click Unlock Dashboard, the page will redirect to where you need to enter your email id and click Unlock.