Page History
HTML Wrap | ||||||
---|---|---|---|---|---|---|
| ||||||
|
HTML Wrap | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Related topics: |
The Magnolia Commerce Connector Pack modules allow you to connect your external e-commerce solution to Magnolia. You can use e-commerce content within Magnolia as if it were native Magnolia content. The modules provide access to shopping cart management and checkout functionality that directly interacts with your e-commerce solution via REST.
Table of Contents | ||
---|---|---|
|
Module structure
artifactID | Description |
---|---|
| Parent reactor. |
| Provides the API for the e-commerce add-on. |
| Provides a default implementation to connect to the commercetools e-commerce solution. |
| Provides a default implementation to connect to the Magento e-commerce solution. |
| Provides a default implementation to connect to the Salesforce Commerce Cloud e-commerce solution. |
| Provides a default implementation to connect to the SAP Commerce Cloud e-commerce solution (formerly Hybris) |
| Provides the ecomfn templating functions. |
| Provides the E-commerce app. |
| Provides app actions and enables text classification and image recognition through decoration. |
Installing
Maven is the easiest way to install the modules. Add the following dependencies to your webapp. All the other necessary dependencies will be brought in automatically:
Multiexcerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Configuration
This section explains how to configure the connection between the E-commerce module and your external e-commerce solution.
You can create or edit the configuration in the JCR or the File System (YAML) under <module-name>/ecommerces/<definition-name>
.
Before you configure the connection, make sure you know:
- Which solution you want to connect to. Default implementations are provided for:
- commercetools
- Magento
- Salesforce Commerce Cloud
- SAP Commerce Cloud (formerly Hybris)
- The relevant URLs to connect to your e-commerce solution.
- Connection credentials for your e-commerce solution.
Tip |
---|
The Commerce Connector Pack provides out-of-the-box connectors to commercetools, Magento, Salesforce Commerce Cloud and SAP Commerce Cloud. If you use another third-party e-commerce solution, you can configure your own connector. |
Anchor | ||||
---|---|---|---|---|
|
You can add your connection configuration to the connections list (see YAML example line 15) or in the JCR under <ecommerce-<your-third-party-solution>-connector>/ecommerces/<definition-name>/connections/<connection-name>
.
If you do not want the connection definition to appear in any of the subapps, set the enabled
property (YAML line 3) to false
.
Note that you can write your own implementation (YAML lines 4-14) or in the JCR under <module-name>/ecommerces/<definition-name>/implementation
to suit your requirements, for example, to use additional features such as cross- and up-selling or custom features such as your own checkout solution.
Tip |
---|
Select the tab for your third-party e-commerce solution below. The connection properties vary. |
Localtab Group | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Viewing and testing connections
This section explains how to view and test the connection between the Magnolia E-commerce add-on module and your external commerce solution using the E-commerce app.
- Open the E-commerce app Configuration tab.
- Select a connection.
- Click View to see the details of your connection to an external e-commerce solution.
Depending on your external e-commerce solution, the connection information displayed may be:
- Definition name – The unique definition name. This name appears in the Catalogs subapp.
- Connection name – The unique name for the connection configured.
- E-commerce type – The type of external e-commerce solution you are connected to.
- Authentication URL – Authentication URL for the solution you are connected to.
- Base URL – Base URL for the solution you are connected to.
- Username and Password – Credentials to access the external solution. Passwords or client secrets can be managed in the Passwords app.
- Connection enabled – Shows if the connection is enabled or not. You may choose to disable the configuration, for example, to improve performance times or to test a connection in one environment before enabling it in another.
Click the Test connection button to check the connection configuration is correct. A message appears indicating if the test is successful or not.
Once you've tested your connection, go to the E-commerce tab. You can see the connections you have configured listed with the catalogs they contain.
Configuring the cache
By default, the content pulled from your external e-commerce solution is updated every 300 seconds (5 minutes). You can configure the cache setting via YAML:
Code Block | ||||
---|---|---|---|---|
| ||||
cachingDefinition: enabled: true invalidateInSeconds: 300 |
Configuring the images displayed in the E-commerce app
Images stored in your third-party e-commerce solution are displayed in the product detail view of the app from E-commerce module v1.1.1+.
You can configure:
- If a single image or multiple images are displayed
- The size of image(s) displayed.
For example:
Code Block | ||||
---|---|---|---|---|
| ||||
form: properties: images: label: Product image(s) $type: multipleImageField converterClass: info.magnolia.ecommerce.app.productdetail.field.URLsToStrings imageRatio: 60 |
Property | Description |
---|---|
| required |
| optional Field label displayed to editors. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. If you do not want a label at all, define the property and set its value to a blank space such as |
| required Field type:
|
| required
info.magnolia.ecommerce.app.productdetail.field.ListOfURLsToString converts only the first image for the product. |
| optional Defines the ratio of displayed images to the original images in percentage. In the example above, the value If the property isn't set, the images are displayed in their original size. |
Configuring text classification and image recognition for e-commerce content
If you have configured them, both Image Recognition and Text Classification are enabled for your e-commerce content.
To trigger the tagging operation, select a product and click Tag product in the E-commerce app action bar. You can view the tags generated in the ecommerce
workspace in JCR Browser app (system properties view) or in the Tags app. You can search for products based on the tags in the find bar.
Default configuration:
Code Block | ||||
---|---|---|---|---|
| ||||
imageRecogniserEnabled: true textClassifierEnabled: true autoRecognitionEnabled: false |
Property | Description |
---|---|
imageRecogniserEnabled | required, default is Enables image recognition functionality for e-commerce content. Disable this functionality by setting the property to |
textClassifierEnabled | required, default is Enables text classification functionality for e-commerce content. Disable this functionality by setting the property to |
autoRecognitionEnabled | required, default is Enables automatic tagging. You can enable automatic tagging by setting the autoRecognitionEnabled property to This action starts when the user opens a product list and may take a long time to execute. |