Crop & resize in Product Cockpit 2.0: A bridge over the Impossible

 

tetiana This article is brought by 
Tetiana Antonenko, 
EPAM Java developer

Here I’m going to share some things we made possible together with Rauf for the “EPAM Hybris Competency Center Contest – Fall 2016”. We were tasked with building from scratch an extension for the SAP Hybris Commerce platform. tropheyWe decided to chose the topic Rauf explained in this blog before, “Crop and resize in Product Cockpit“, and extended it with new features. Even though the idea and title were not new, our vision on the implementation and user interface was completely different and seemed very challenging. Eventually we won the contest!  

[Scroll to the end of the article to see a demonstration]

Crop and resize module: The what, why and how

The target is to resize and crop images to a given size directly in hybris Product Cockpit. With this extension, you no longer need to resize and crop each image by hand using such tools as Photoshop or Gimp; image renditions will be generated on-the-fly based on the transformation rules managed by the administrators.

The way things are in hybris

There are different image types in the product data in Hybris, to name a few:

  • Thumbnail type, for search results and category pages
  • Normal/picture type, for the product page, as the main picture
  • Detailed type, for pop-up gallery pages and other needs

mediahybris.pngHybris expects that all uploaded images have

  • Right format (JPG/GIF/PNG)
  • Right proportions/ image size
  • Autocorrected
  • Already web-optimized

Hybris provides no validation for image data; There is no interactive image processing tool.

Why it is not good?

Thumbnails

Thumbnails are not simply downscaled versions of the full size image. Displaying a significant part of the picture instead of the full frame can allow the use of a smaller thumbnail while maintaining recognizability.

For example, when thumbnailing a full-body portrait of a person, it may be better to show the face slightly reduced than an indistinct figure.

2017-03-21_23h06_22.png

Product Page Images

Product page images are commonly similar in terms of proportions what might not be true for the detailed images of the same products.

Sometimes we need to have different product page templates for different types of products to present the products better:

2017-03-21_23h07_11.png

Breakpoints

If you want to use different images for different devices/resolutions and make your website responsive, you need to standartize the resolutions.

2017-03-21_23h10_50.png

Browser scaling: easy-to-miss errors

Different images need different rendering/scaling algorithms. Below you can see that crisp edges works better for some images (checkers as an example), while real life images require another scaling algorithm to look better in a different size.

2017-03-21_23h12_44.png

Manual solution ? – yes!

Cropping and resizing an image is easy in any image editor. Where it becomes tedious though, is when you have to repeat this process for dozens or hundreds of images. Think: open the image in Photoshop, crop it, create a thumbnail, save it and repeat for each of your images.

And if the result is not good, you have to do it all over again. One could define a macro to do it quickly, but unfortunately every image has to cropped in another area, which is why this process can only be done by hand.

We propose a totally different approach, allowing you to set a cropping area in seconds and to redefine it if you don’t like it.

2017-03-21_23h16_37.png

hybris OOTB automation?

In the default hybris package, the automatic image resize functionality is provided by Mediaconversion.

The module has some severe limitations that make it hardly suitable for most of the projects. To name a few:

  • MAJOR: MediaConversion module is not integrated into Product Cockpit.
  • MAJOR: No cropping feature in MediaConversion.
  • MAJOR: OOTB MediaConversion module is not interactive.
  • minor: OOTB MediaConversion module uses the 3rd party tool, imageMagick.

Our solution

Interactive cropping tool. The cropping area is configurable for each cropping group.

2017-03-21_23h27_41.png

Configurable. You can specify one or more source fields and one or more target fields, as well as the conversion rules and parameters. Data-driven: all configuration is in the database.

2017-03-21_23h23_36.png

one target field can have more than one source field.

  • This pattern can be used for applying different types of renditions for the same target field. For example, different watermarks* for the same field.

one source field can have more than one conversion rules (and target fields). 

  • This pattern can be used if you have one master image and a number of renditions (thumbnail, product page image, detailed image) of different proportions.

Product Cockpit integration

The solution has already been integrated into Product Cockpit and can be easily integrated into CMS Cockpit or SmartEdit

Wizard

The solution is implemented as a wizard that helps administrator to populate the image-related fields with “one click”

2017-03-21_23h24_56.png

The system supports one or more source images. For example, administrator can upload one image for thumbnail and another image for the product page. After that the administrator will be asked to crop the images. The cropped and resized versions of these images will be saved into designated product attributes (configurable for each source image)

Ready to grow

At the moment the module is configured for crop&resize only. However, the data model and some components are ready for the next steps, Watermarking, rotate and flip images.

2017-03-21_23h22_30.png

Data model

In the diagram below you can see a simplified data model for the extension.

2017-03-21_22h55_46.png

  • CR_Configuration defines a configuration for each source image configuration. The configuration consists of conversion rules.
  • Conversion Rule defines a conversion parameters for each target field. Conversion Rule refers to the TargetImageFilterConfiguration..
  • TargetImageFilterConfiguration defines a image-specific parameters, such as dimensions, formats, cropping shapes etc.

User Interface

The launcher is integrated into Product Cockpit Editor area. 2017-03-21_23h33_14.png

The configuration says that imageOriginals1 and imageOriginals2 contain source images. You can create renditions separately for each source field or for all fields in one go.

“Create image variants” launches a cropping images window. Once the cropping is done, the downscaled and cropped version of the images are saved into the target product attributes. 

Challenges and technical details

GetMediaModelFromCurrentProduct

protected Optional<MediaModel> getMediaModelFromCurrentProduct(String sourceFieldName) {
    ObjectValueContainer.ObjectValueHolder value = UISessionUtils.getCurrentSession().getCurrentPerspective().getEditorArea().getEditorAreaController()
        	.getModel().getCurrentObjectValues()
        	.getValue(UISessionUtils.getCurrentSession().getTypeService().getPropertyDescriptor("Product." + sourceFieldName), null);

	if (value.getCurrentValue() instanceof TypedObject) {
    	return Optional.ofNullable((MediaModel) ((TypedObject) value.getCurrentValue()).getObject());
	}
	List currentValues = (List) value.getCurrentValue();
	return currentValues.stream().findAny();
}

Uploading an image by product attribute name

For uploading we used Fileupload.class

For saving the results we used:

modelService.setAttributeValue(productModel, targetAttributeName, imageMediaModel);

Image Crop interface

Integrating third party javascript libraries into hybris cockpit was one of the challenges in the project.  We used jquery.js and croppie.js for the pop up window. These libraries are completely incompatible with the old version (3.6.4) of ZK Framework. In addition to that hybris doesn’t allow to add/replace javascript libraries without touching the platform code.

Certainly, the solution is IFRAMEs.  

Window window = (Window) Executions.createComponents("/cropandresize/interactiveCropWindow.zul", null, params);
...
<strong>interactiveCropWindow</strong>.<strong>zul</strong>
<?xml version="1.0" encoding="UTF-8"?>
<?variable-resolver class="org.zkoss.zkplus.spring.DelegatingVariableResolver" ?>
<?taglib    uri="http://www.zkoss.org/dsp/web/core" prefix="c"?>
<zk xmlns:h="http://www.w3.org/1999/xhtml" xmlns:zk="http://www.zkoss.org/2005/zk">
       <window title="Image Crop" border="normal" id="win">
           <button onClick="wizardBean.doResizeAndSave(createCroppedImageEventListener);win.detach();" label="Close Window" visible="false" />
           <iframe id="iframe" width="100%" height="100%" src="/../cropandresize/doCrop?${arg.pathUrl}">
           </iframe>
       </window>
</zk>

If pushing data from ZK to Product Cockpit is a more or less trivial thing, the reverse operation  is much more challenging. We send an event to a ZK-powered button in the parent window to close the popup and perform the additional steps when the closing event is received.

Demo

One comment

  1. Matthias Heid · · Reply

    Great job.
    Try to port it to backoffice if feasible, 6.4 release will bring a totally new PCM experience

    Liked by 1 person

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: