Extensions in SAP Commerce [Hybris]

By Ramesh V

In this article, I will explain in details about the extensions in SAP Commerce and demonstrate how to create our own custom extension using ant extgen command.


SAP Commerce has a modular architecture, where new business logic is developed in a separate, function specific modules called extensions.

Extension in SAP Commerce is very similar to project in Java.

An extension contains business logic, type definitions, back-office configurations and some configuration files like xml, properties and etc.

SAP Commerce ships with a number of template extensions and we can use ant extgen for generating new extensions based on these template extensions.

Every extension in Hybris contains one important file called extensioninfo.xml file which contains information about extension name, extension module and its dependencies. 

To make any custom as template extension using below meta tag:

<meta key=’extgen-template-extension’ value=’true’/>


Create a New Extension:

Creating a new extension means start developing our own SAP Commerce functionalities. We can use yempty template for our custom extension as shown below:

Step1: Navigate into the platform folder:

Step2: Run the setantenv command to configure the Ant build tool:


Step3: Run the ant extgen to create a new extension, with name mycustomextesnion and package com.hybris.training:

ant extgen -Dinput.template="yempty" -Dinput.name="mycustomextension" -Dinput.package="com.hybris.training"


Note: We can also run ant extgen command and then select yempty as template extension and enter package name. 

Step4: Add your newly created extension in localextensions.xml file.


Step5: Run ant all from the hybris/platform folder.

Step6: Start Hybris server.

Now we can start implementing our custom login in the newly created custom extension as per business requirement.


If you have any questions or need further clarification on any of the steps, feel free to reach out to me at rameshvanka8@gmail.com. I’m happy to help and would love to hear your feedback!  


Location:Hyderabad Hyderabad, Telangana, India
SAP CX Senior Consultant[Hybris]

Comments

Post a Comment

Popular posts from this blog

Type System in SAP Commerce [Hybris]

By Ramesh V
In this article, I have explained in details about what is a Type System in SAP Commerce [Hybris] and how the data can be organized in the Hybris system. Type System in SAP Commerce is a data modeling framework . It defines the structure and organization of data within the platform. In SAP Commerce data can be organized in the form of types , for example product information, customer information, address information, cart information and order information etc. A type is a template for objects and every object stored in a platform is a type instance. Types can be defined in an items.xml file using following aspects: the deployment : It defines the database table where objects stored. attributes : Manage and store data for the object. the java class of the object. In SAP Commerce, Type is a blueprint of an Item and Item is an instance of a Type . Types can inherit from other types, allowing for a hierarchical organization of data. Attributes define the properties of a type. They can ...
Read more

Differences between Extension and AddOn in SAP Hybris

By Ramesh V
In this article, I have explained differences between Extension and AddOn in details in SAP Commerce [Hybris] and also described when to use Extensions and when to use AddOn's. An Extension is a self-contained module that adds or modifies functionality in SAP Commerce.   An Extension generally represents a larger functionality and it contains business logic, type definitions, back-office configurations and other configuration files like xml, properties and etc, whereas AddOns are used to extend the functionality of SAP Commerce Accelerator[storefront] without modifying the core code base. AddOns are plugin kind of extension, you can easily remove your AddOns without refactoring the code of your Accelerator extension. Extension can work independently or extend the another extension whereas AddOn always depends on an existing extension (e.g. acceleratorstorefront). Extensions are used for business logic whereas AddOns are mostly used for Frontend/UI customization.     ...
Read more

items.xml in SAP Commerce [Hybris]

By Ramesh V
The items.xml file specifies types of an extension for defining the data model . By editing the items.xml file, you can define new types or extend existing types. In addition, you can define, override, and extend attributes of the types. Location of the items.xml file: The items.xml is located in the resources directory of an extension. The items.xml files are prefixed with the name of their respective extension in the form of extension name-items.xml. For example: For the core extension, the file will be core-items.xml . For the catalog extension, the file will be catalog-items.xml . Basic structure of the items.xml file: The items.xml defines the types for an extension in XML format and the basic structure is as follows: <items   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"               xsi:noNamespaceSchemaLocation="items.xsd">           ...
Read more