CMS component detailed documentation

[Former Member]

Hi experts,

B2B Accelerator 5.1.0

Cant find any detailed documentation for some CMS components:

1. Dynamic banner component. What's the main feature? mediaCodePattern? How do it works?

2. Simple Suggestion Component and its descendants: Cart Suggestion Component and Purchased Category Suggestion Component. What are they differ from each other? What's the main features? How do they work?

[Former Member · Accepted solution]

Both components ship with the source code.

de.hybris.platform.yacceleratorstorefront.controllers.cms.DynamicBannerComponentController

In a nutshell the Dynamic Banner Component Controller works on category pages and allows you to insert the current category code into a pattern that is used to find a media. For example if we have category code 123 and 124 and mediaCodePattern of apparel-brand-banner-{VARIABLE}, then on category 123 page it will look in the database for a banner with code apparel-brand-banner-123. The advantage here is it saves you needing to make hundreds of category specific banner components if you just follow a simple media code naming convention.

The CartSuggestionComponent de.hybris.platform.yacceleratorstorefront.controllers.cms.CartSuggestionComponentController

differs from ProductReferenceComponent as ProductReferenceComponent works of Product on Product Page and Cart Suggestion works of all items in the Cart. Both show Product References according to the types configured on the WCMS component. One is Cnd One is Product Page Level. The Cart one also filters out products a logged in user has already purchased.

[Former Member · Accepted solution]

This actually was very helpful! Thanks!

[Former Member · Accepted solution]

Well glad to help ;-)

[Former Member]

Thanks a lot.

[ian_matthias]

Have you tried manipulating these components in the various accelerators? Probably you can answer your questions most quickly through a combination of manipulating the components to see how they behave and by inspecting the code.

Concepts you mention like "base products" and "product references" are standard hybris concepts and further information is available on the wiki for these. For example https://wiki.hybris.com/display/release5/Modeling+Product+Variants gives you information about how to model variants and what a base product represents.

[Former Member]

Thank you. But there there are no details about "how it works"...

How do I setup mediaCodePattern in DynamicBannerComponent? Is there are any rules or parameters to fill its value?

What's the difference between ProductReferenceComponet and SimpleSuggestionComponent? Which product are "base products" for CartSuggestionComponent? All of carts' products or exactly one particular product...? The same question about PurchasedCategorySuggestionComponent...

I need more details to understand the functionality and make a desicion "could these components be usefull in my project".

[raghavendra_desu]

Hi Vladimir,

You can get more details on simple suggestions component from https://wiki.hybris.com/display/accdoc/Simple+Suggestions+Component.

For more details on different components in Hybris you can refer to https://wiki.hybris.com/display/accdoc/WCMS+Components+in+the+hybris+Commerce+Accelerator