Steps to create a cms component

To develop a new CMS component in SAP Hybris depending of its complexity you must do some of these steps.

• Modify items.xml and add at least one new Hybris type for the component. The component is usually a subclass of SimpleCMSComponent. For example: CMSMainPriceChartComponent.
• Add the localization of the new types and their attributes.
• Access rights: In some projects you have to modify an impex file with the read, write, create and remove rights.

• If your component is a container —it has attributes with CMS components—, you need to add these fields to the Spring configuration of the CMSSynchronizationService. Here are the details: Synchronization of Parent-Child CMS Components: A working example
• Update the configuration of the slots to allow instances of the new component in it.

$katalog-id=Content-Energie
$katalog-version=Staged
$contentCV=catalogVersion(catalog(id[default=$katalog-id]),version[default=$katalog-version])[default=$katalog-id:$katalog-version]
 
INSERT_UPDATE ContentSlotName;name[unique=true];template(uid,$contentCV)[unique=true];validComponentTypes(code)
;main_priceChartEvolutionPage_pos;$priceChartEvolutionPage_template_id;CMSMainPriceChartComponent

• If some of the values which are displayed by the component require calculations, you should create a controller.
  • Following our example, the controller would be MainPriceChartComponentController. In this case it would be called by Hybris automatically. If it doesn't, you should add:

@RequestMapping("/CMSMainPriceChartComponentController")

• Most of the controllers are subclasses from DefaultCMSComponentController or AbstractCMSComponentController.
• If you create a controller, you usually create a new facade or add new methods to an existing one. The facade symplifies the uses of the services and avoids putting business logic into the controllers
• You may also change some service.
• Create a JSP file which renders your CMS component
  • If you have a custom storefrontend, you have to create your view where other component's view are stored
  • If you are using the B2B or B2C accelerators, you have to create an addon, which includes your view and all the code related to your CMS component.
• Add new testing cases to the initial data impex files. The location of this files depends on the project.
• Write the unit tests for the controller, facade and service.

• Compare the HTML code with the specification.
• Rendering of the component
  • in different pages
  • with test cases
  • with different sizes (if applicable)
  • with different Browsers
• Rendering of the component in SmartEdit

Adding a Feedback CMS Component to the Accelerator - Tutorial

– Based on SAP hybris 1905