How to create catalog aware ItemType in Hybris?

Scenario

Create an Item type which can have two versions(stage/online) like the product type. In simple word, it should be catalog aware.

Solution

We can declare any Item type as catalog aware using in *-items.xml
<itemtype code="MyConfiguratorSetting"  extends="GenericItem" autocreate="true" generate="true">
       <deployment table="ConfiguratorSettings" typecode="1301" />
       <custom-properties>
           <property name="catalogItemType"><value>java.lang.Boolean.TRUE</value></property>
           <property name="catalogVersionAttributeQualifier"><value>"catalogVersion"</value></property>
           <property name="uniqueKeyAttributeQualifier"><value>"code"</value></property>
       </custom-properties>
       <attributes>
           <attribute qualifier="code" type="java.lang.String">
               <description>Identifier</description>
               <persistence type="property"/>
               <modifiers read="true" write="true" search="true" optional="false" unique="true"/>
           </attribute>
           <attribute qualifier="catalogVersion" type="CatalogVersion">
               <description>Catalog Version</description>
               <modifiers optional="false" write="false" initial="true"/>
               <persistence type="property"/>
           </attribute>
           <attribute qualifier="configValue" type="java.lang.String">
               <description>configValue</description>
               <persistence type="property"/>
               <modifiers optional="false" write="false" initial="true" />
           </attribute>
       </attributes>
</itemtype>

Use of <custom-properties>

catalogItemType - To declare current itemType is catalogItemType
catalogVersionAttributeQualifier - An attribute from our itemType, which will qualify the catalog. In our case it's catalogVersion. 
uniqueKeyAttributeQualifier - An attribute from our itemType, which can define each record/instance as unique. In our case it's "code". But it also can be a combination of multiple fields.


Author Image

Ankitkumar Patel

Sr. SAP Hybris consultant, having 15+ years experience in SAP Commerce Cloud (Hybris), SAP Spartacus. Extensive experience in SAP Hybris development, third-party integrations, project architecture and design... Read more

Comments

Post a Comment

Popular posts from this blog

Hybris flexible search query examples

Use of Enum in the query Find all running Solr Index jobs select {cj.code},{enum:code},{cj.startTime},{cj.endTime} from { SolrIndexerCronJob! as cj join EnumerationValue as enum on {cj.status}={enum.pk} } where {enum:code} = 'RUNNING' Compare Date in the flexiblesearch query Find all running Solr Index jobs from the given date select {cj.code},{enum:code},{cj.startTime},{cj.endTime} from { SolrIndexerCronJob! as cj join EnumerationValue as enum on {cj.status}={enum.pk} } where {enum:code} = 'RUNNING' and {cj.startTime} >= TO_DATE('2021/12/25','YYYY/MM/DD') Basic  JOIN  and  IN  query Get the most recent order for each customer using flexible search. select {o.code} as orderCode, {c.name} as name, {a.cellphone} as cellphone from {order as o join Customer as c on {c.pk} = {o.user} join Address as a on {o.deliveryaddress} = {a.pk} } where {o.code} in ({{select max({cod
Read more

How to remove or update all data records in Hybris?

Scenario 1: I want to remove all the data from the Hybris ItemType. Solution: If you want to remove all records for particular itemType. Then you can do it using HAC Impex import. Open HAC (/hac) Go to console > ImpEx Import Run the below Impex (Change MyItemType with the ItemType for which you want to remove the data) $targetType=MyItemType REMOVE $targetType[batchmode=true];itemtype(code)[unique=true] ;$targetType Scenario 2: Sometimes, you want to remove selected data based on some condition or probably want to run complex SQL query. Then we wish if we could do it by writing SQL query, as many of developers are aware of syntax and its resources are easily available. Solution: Yes, you can do it in Hybris HAC also. Only thing is you should know the appropriate table and attribute/fields names in DB. If you don't, you can always run the select flexible search query and can see generated SQL query. Open HAC (/hac) Go to console > FlexibleSearch Se
Read more

How to Install temporary Hybris license?

LICENSE VERIFICATION HAS FAILED! Your demo/develop license has expired, it is valid only for 30 days. How to install temp SAP Hybris license? Don't worry, you can install a temporary license. To install a temporary license 1) Remove  installedSaplicenses.properties  from the license folder \hybris\config\licence 2) Go to the Platform directory and run the  ./license.sh -temp CPS_SQL  or  license.bat -temp CPS_SQL . If you are using DB other than HSQL you can choose the right command based on your DB.   Windows run  license.bat  instead of  ./license.sh OOTB HSQL DB ./license.sh -temp CPS_SQL MySQL DB ./license.sh -temp CPS_MYS Oracle DB ./license.sh -temp CPS_ORA SQL Server DB ./license.sh -temp CPS_MSS SAP Hana DB ./license.sh -temp CPS_HDB Once you install using the above command, You will get a message like First temporary license key installed. 3) Verify your license by running  ./license.sh -show , which will give you System, Hardwar
Read more