Skip to main content

Best Practices: Ceres

Here, you find best practices on subjects such as Ceres and the online store.

1. Testing Ceres updates for theme compatibility

In this best practice you will learn which steps are necessary in order to test newly published version upgrades of the Ceres online store template plugin without impacting the productive live operation of your online store. Due to implementations of new features, bugfixes and changes to the user interface, dependencies between external plugins (for instance layout themes) and Ceres may lead to issues when updating to a new Ceres version. Therefore it is advisable to create a copy of your current plugin set configuration, with which you can test the compatibility of the newly released Ceres version and external plugins.

1.1. Copying a plugin set

First, you should create a new Plugin set, onto which you can transfer the current settings of your Ceres online store. To do so, proceed as follows:

Copying a plugin set:

  1. Go to Plugins » Plugin overview.

  2. Click on Create new set.
    → The New plugin set window opens.

  3. Enter a name for the plugin set, which should ideally communicate that this is a copy of your Ceres online store.

  4. Select the plugin set for which you want to copy the current configuration from the Copy plugin set drop-down list.

  5. Save the settings.
    → The new plugin set will be created.

The plugin set copy now contains the exact same settings as the one used as your Ceres online store. At this point, both the original set and its copy are identical. It is advisable to repeat this process before any major update, so that the plugin set is up to date.

1.2. Updating Ceres for the copied plugin set

In the next step, you need to update the copied plugin set to the current Ceres version.

Updating the plugin set:

  1. Go to Plugins » Plugin overview.

  2. Select the newly created copy of the plugin set.
    → The Plugin set details window opens.

  3. In the line of the Ceres plugin, click on Update in the Action column.
    → The Install plugin window opens. → The most current version of the plugin is preselected.

  4. Click on Install.
    → The plugin will open.

  5. Repeat steps 3 and 4 for the plugin IO.

  6. Click on Save & publish plugins.

The copy of the plugin set is now at a more current stage than the plugin set of your Ceres online store. Click on the plugin set copy in the list of plugin sets on the left side of the interface. You can access your Ceres online store in combination with the plugin set copy in preview mode via the button Plugin set preview. That way, you can assess whether the current changes to the Ceres plugin result in incompatibilities with external plugins, like a theme, that your are using. If the external plugins are functioning correctly under the new Ceres version, you can either activate the plugin set copy for the relevant client or Update the original plugin set, as detailed above.

Some dependencies betwen external plugins and Ceres/IO may not be immediately apparent. For this reason it is advisable to not dismiss the original plugin set prematurely, so that the switch to the previous version is still possible after a number of days without adjusting the Ceres settings again. If you want to be informed about incompatabilities or other issues between external plugins and a new version of Ceres/IO, you are invited to visit the forum.

2. Changing from Callisto to Ceres

In this Best Practice you will learn how to set up a Ceres online store in preview mode, while maintaining the productive operation of your Callisto online store at the same time.

2.1. Creating a new plugin set

In order to set up your Ceres online store without affecting your Callisto store, you will first have to create a new plugin set.

Creating a new plugin set:

  1. Go to Plugins » Plugin Overview.

  2. Click on Create new Set in the upper left corner.
    → The window New Plugin Set opens.

  3. Enter a name for the plugin set.

  4. Save the settings.
    → The plugin set has been created.

The newly created plugin set must not be published for a client at this point. If you do publish the plugin set, it will overwrite your Callisto online store.

You can now begin to set up your Ceres online store in the newly created plugin set. This will not affect the productive operation of your Callisto store.

2.2. Setting up the plugin set

After you have purchased the plugins Ceres and IO, you need to install and activate these plugins for the plugin set you created.

Setting up the plugin set:

  1. Go to Plugins » Plugin Overview.

  2. Click on the plugin set you created.
    → The window Plugin Set Details opens.

  3. Select the option All in the search filters Source, Installed and Active.

  4. Click on Search.
    → All purchased plugins are listed.

  5. Click on Install plugin in the Action column in the Ceres line.
    → Das Install plugin window opens.
    → The most current version of the plugin is preselected.

  6. Click on Install.

  7. Repeat steps 5 and 6 for the plugin IO.

  8. Click on Save & publish plugins.
    → The notification Deploying Plugin Set is displayed.

This concludes the preliminary work and you can now begin to set up the Ceres online store. Take a look at the manual chapters Quick start and Setting up Ceres to learn how to do this. In the following you will learn how to test your online store in the preview mode.

2.3. Testing your Ceres online store in preview mode

In order to keep track of your changes in the online store, the Plugin overview offers you the option of accessing the store in a preview mode. Before opening the Ceres online store in preview mode, you should deploy your plugin set one more time via the Save & publish plugins button. Please note that this may take a few moments.

Opening the plugin set in preview mode:

  1. Go to Plugins » Plugin overview.

  2. Click on the previously created plugin set.
    → The window Plugin Set Details opens.

  3. Click on Plugin Set Preview. → The online store opens in a new browser tab with the configurations of the selected plugin set.

Please note that you need to allow pop-ups, so that the store will open in a new browser tab.

2.4. Going live with the Ceres online store

Once you have completed testing your online store in preview mode and you are ready to replace your Callisto store with Ceres, you need to publish the plugin set for the relevant client. If necessary, this link can be reverted. You can return to your old Callisto online store at any time.

Activating a plugin set for a client:

  1. Go to Plugins » Plugin overview.

  2. Click on the previously created plugin set.
    → The window Plugin Set Details opens.

  3. Click on Publish Plugin Set in the upper left corner of the interface.
    → The window Activate Sets opens.

  4. Select the plugin set you want to publish for the desired client from the drop-down list.
    → The notification For webstore X, Plugin Set y is active is displayed.

Your Ceres online store has now been put in productive operation and replaces your Callisto online store.

3. Callisto OL (End of Life) - Which order process am I using?

Ceres-based online stores will in the medium term replaced all former Callisto online stores. In this context, particular functions of Callisto are successively shut down over the next few months. The EOL manual page provides you with all the dates relevant to the shut down of Callisto.
This chapter’s goal is to help you understand the current state of your Callisto shop and will inform you about the time you need to become active and implement parts of the Ceres online store.

First things first
  • This chapter is only relevant for users who use a Callisto online store. If your online store uses the Ceres plugin technology, this chapter does not concern you.

  • We advise you to inform yourself about the change from Callisto to Ceres sooner rather than later. Even though certain Callisto online stores can still be operated until the first quarter of 2020, we no longer support the old software and bundle our resources for the further development of Ceres online stores.

3.1. The three different order processes in Callisto

Since particular functions of Callisto are shut down at different points in time, it is understandable that some customers might not be sure whether or not the changes affect them and at what point they have to become active in order for their stores to operate smoothly.

The most important aspect of the shut down are the three different order processes in Callisto and the dates at which they are no longer available:

Table 1. Order processes in Callisto
Order process Date of deactivation

Individual shopping cart

01.03.2019

Standard order process

01.06.2019

Individual order process

01.09.2019

For customers who are using one of these order processes in their online shop (i.e. everyone who does not use a Ceres online shop) this means that they have to implement the Ceres checkout (the Ceres order process) by the specified date. The linked best practice guide provides step by step instructions on how to integrate the Ceres checkout. The best practice provides instructions for all three Callisto order processes.

If you feel overwhelmed by the prospect of integrating the Ceres checkout yourself, there are several professional agencies providing this service in the plentyMarketplace.
Our partner agencies might also be of service.

Integrating the Ceres checkout or switching to complete Ceres online store before the specified dates is absolutely necessary. Otherwise, your customers will not be able to place orders in your store.

3.2. Which order process am I currently using in my Callisto store?

In this forum thread we announced that your plentymarkets back end will now display a message informing you about which order process is used in your system. The message also specifies the date this order process is deactivated.

  • The message concerning the Individual shopping cart is displayed in red.

  • The message concerning the Standard order process is displayed in orange.

  • The message concerning the Individual order process is displayed in yellow.

     [[EOL-Note]]
    .EOL message in the back end
    image::_best-practices/omni-channel/online-shop/assets/bp-EOL-hinweis.png[]

This suffices to find out which order process you are currently employing in your Callisto store. If you still want to check for yourself, follow these steps:

Checking the order process:

  1. Go to the CMS » Web design menu.

  2. Select the layout you want to check from the drop-down list on the left side. If you have multiple clients, multiple layouts may be active. In this case you should check all layouts individually.

  3. Click on Settings.

  4. Click on the Client tab.

  5. Select the client that is active for the layout on the left. → If you need to find out which client has been activated for the layout, hover over the layout drop-down list with your mouse. Active clients are displayed in the tooltip.

  6. On the right side, open the tab Order process.

  7. The Type of order process states which order process is active in the selected layout. → Depending on whether you see the Individual shopping cart, Default order process or Individual order process, you need to switch to Ceres before the specified dates listed above.

3.3. Next steps

You determined the type of order process in your Callisto online store and now know on which date it is deactivated.

You now have the following options:

  • You can integrate the Ceres checkout in your Callisto online store and still operate it until the first quarter of 2020.

  • You can set up your Ceres online store and forego an additional adaptation in the first quarter of 2020.

Regardless of whether you want to use the Ceres checkout or a complete Ceres online store: Please make sure that you always make changes in a separate plugin set, so that the live operation of your online store is not impaired. Here you can find out how to safely navigate the change from Callisto to Ceres.

3.4. Further reading

  • Please find all EOL data here.

  • You can read the forum thread about the shutdown of the individual shopping cart here.

  • Further information about the EOL of Callisto in the forum.

  • The collected threads on the shutdown of the three different order processes.

4. Setting up Ceres checkout in Callisto online stores

You want to use the new checkout in your Callisto online store and benefit from its plugin capabilities and individual customisability? No problem - we’ll guide you through the necessary steps. In case you need professional support for the integration of the Ceres checkout in Callisto, our marketplace can lead you in the right direction.

First things first:
  • This Best Practice describes the setup of the Ceres checkout in a Callisto template. Please copy your design first. Do not make modifications to your active layout.

  • To use the Ceres checkout, you need the current version of the Ceres and the IO plugins. You can find both on the plentyMarketplace. Both plugins have to be installed and deployed in a plugin set copy.

  • In order to use your payment providers and shipping service providers in the Ceres checkout, you will have to load and install the relevant plugins from the marketplace. Please note that there are payment providers that at this point do not offer a plugin alternative and whose services can therefore not be implemented in the Ceres checkout.

Working in a plugin set copy

To ensure that the live operations of your online store are not impaired while testing the Ceres checkout, we recommend that you initially make all of your changes in a plugin set copy. This best practice explains how to create a copy for your plugin sets. Test your changes in the preview mode before you integrate them into your live online store.

4.1. Ceres checkout for Callisto online stores that use the individual shopping cart or the standard order process

If you operate a Callisto online store that uses the individual shopping cart or the standard order process, you will have to integrate the Ceres checkout sooner: The individual shopping cart will be deactivated on 01 March 2019; the standard order process will be deactivated on 01 June 2019. This chapter explains how you find out which order process you are currently using.

If you follow the step-by-step instruction below, you can integrate the Ceres checkout in your Callisto online store in a few simple steps.

4.1.1. Managing routes

Ceres online stores use the logic of the plugin IO. In order to use the checkout with all the correct routes, proceed as follows:

Carry out settings in the IO plugin:

  1. Go to Plugins » Plugin overview.

  2. Click on IO.
    → The plugin opens.

  3. Click on Configuration in the directory tree.

  4. Click on the Routing tab.

  5. Deactivate the checkbox next to Enable routes.
    → All routes are deactivated.

  6. Activate the routes /basket, /checkout, /confirmation, /login, /register, /password-reset, as well as /place-order and /execute-payment.

  7. Save the settings.

Using the ShopBuilder in Callisto online stores that use the Ceres checkout

If you operate a Callisto online store with Ceres checkout and want to use the ShopBuilder, you also need to activate the first route /. Otherwise, the ShopBuilder will not load in your back end. Please note that this will overwrite your Callisto homepage. We recommend that you always make changes in a plugin set copy. After you have made changes, you can deactivate the homepage route / again.

Carry out settings in the Ceres plugin:

  1. Go to Plugins » Plugin overview.

  2. Click on Ceres.
    → The plugin opens.

  3. Click on Configuration in the directory tree.
    → The Global tab is pre-selected.

  4. Click on Enable Callisto route pattern for items.
    → The Callisto routes are activated.

  5. Save the settings.
    → The Ceres checkout is now active in your Callisto online store.

For the majority of users, this concludes the steps necessary to implement the Ceres checkout in Callisto stores. Purchase and install the relevant plugins for payment providers and shipping service providers in your plugin set. You should test your new checkout thoroughly before you activate the plugin set for your client.

Users who have made additional adjustments to their layout need to check whether any other links on their website lead customers to the checkout. These links have to be changed so that they link to the route /checkout. We are not able to intercept all individual changes to the layout, since these can vary from user to user.

The visual design of the Ceres checkout will differ from your Callisto layout. You can edit the header and footer of the checkout and the shopping cart globally via the ShopBuilder. With the release of Ceres 3.1, you will be able to edit the entire checkout via the ShopBuilder. You can make further adjustments to the design with the help of a theme.

In a next step you need to adjust the routes for your legal information.

The four pieces of legal information - Terms and conditions, Privacy policy, Legal disclosure and Cancellation rights have to be connected in a different way in order to be displayed correctly.

Adjusting the terms and conditions:

  1. Go to the Item » Categories menu.

  2. Open the Callisto category.

  3. Copy the category Terms and conditions as a main category.
    → The new main category Terms and conditions opens.

  4. Enter gtc as the URL name of the category.

  5. Save the settings.

Adjusting the privacy policy:

  1. Go to the Item » Categories menu.

  2. Open the Callisto category.

  3. Copy the category Privacy policy as a main category.
    → The new main category Privacy policy opens.

  4. Enter privacy-policy as the URL name of the category.

  5. Save the settings.

Adjusting the legal disclosure:

  1. Go to the Item » Categories menu.

  2. Open the Callisto category.

  3. Copy the category Legal disclosure as a main category.
    → The new main category Legal disclosure opens.

  4. Enter legal-disclosure as the URL name of the category.

  5. Save the settings.

Adjusting the cancellation rights:

  1. Go to the Item » Categories menu.

  2. Open the Callisto category.

  3. Copy the category Cancellation rights as a main category.
    → The new main category Cancellation rights opens.

  4. Enter cancellation-rights as the URL name of the category.

  5. Save the settings.

When you have saved the routes for your legal information, activated the routes as described above and integrated all relevant payment and shipping service providers via plugins, your Ceres checkout is ready for action and you have successfully overcome the obstacles of the Callisto EOL.

4.2. Ceres checkout for Callisto online stores that use the individual order process

If you are currently using the individual order process in your Callisto online store, you need to integrate the Ceres checkout by 01 September 2019 at the latest. Otherwise, your customers will not be able to place orders in your online store.

This chapter explains how you find out which order process you are currently using.

If you follow the step-by-step instruction below, you can integrate the Ceres checkout in your Callisto online store in a few simple steps.

4.2.1. Managing routes

Ceres online stores use the logic of the plugin IO. In order to use the checkout with all the correct routes, proceed as follows:

Carry out settings in the IO plugin:

  1. Go to Plugins » Plugin overview.

  2. Click on IO.
    → The plugin opens.

  3. Click on Configuration in the directory tree.

  4. Click on the Routing tab.

  5. Deactivate the checkbox next to Enable routes.
    → All routes are deactivated.

  6. Activate the routes /checkout, /confirmation, /login, /register, /password-reset as well as /place-order & /execute payment.

  7. Save the settings.

Using the ShopBuilder in Callisto online stores that use the Ceres checkout

If you operate a Callisto online store with Ceres checkout and want to use the ShopBuilder, you also need to activate the first route /. Otherwise, the ShopBuilder will not load in your back end. Please note that this will overwrite your Callisto homepage. We recommend that you always make changes in a plugin set copy. After you have made changes, you can deactivate the homepage route / again.

Carry out settings in the Ceres plugin:

  1. Go to Plugins » Plugin overview.

  2. Click on Ceres.
    → The plugin opens.

  3. Click on Configuration in the directory tree.
    → The Global tab is pre-selected.

  4. Click on Enable Callisto route pattern for items.
    → The Callisto routes are activated.

  5. Save the settings.
    → The Ceres checkout is now active in your Callisto online store.

4.2.2. Adjusting the order process

You need to adjust several categories in order for the checkout process to be working properly. To do so, proceed as follows:

Creating categories:

  1. Go to the Item » Categories menu.

  2. Create a new main category with the name login.

  3. Open the category login.

  4. Select the category type Container.

  5. Save the settings.

  6. Create a new main category with the name checkout.

  7. Open the category checkout.

  8. Select the category type Container.

  9. Save the settings.

Afterwards, link the new categories to the Callisto order process.

Adjusting the order process:

  1. Go to the CMS » Web design.

  2. Click on Settings.
    → The menu Design settings opens.

  3. Click on the tab Clients.

  4. Select the client you want to edit.

  5. Click on the tab Order process.

  6. Click on Search next to 2nd order process step.

  7. Select the newly created category login.

  8. Click on Search next to 3rd order process step.

  9. Select the newly created category checkout.

  10. Save the settings.

Now, once you go to the checkout from the basket, you will be forwarded to the Ceres checkout, which offers new functions, such as payment plugins like PayPal.

You need to adjust the Callisto code in a few places so that users that are not logged in to your store are redirected to the order process after clicking the To the checkout button. To do so, proceed as follows:

Creating backlinks for the shopping cart:

  1. Go to Item » Categories.

  2. Open the Callisto category.

  3. Click on the category Shopping cart.

  4. Click on the tab Description 1.

  5. Search for the code {% if ( $CustomerID ) { Link_Checkout(3); } else { Link_Checkout(2); } %}

  6. Replace this code with: {% if( $CustomerID ) { $_check = Link_Checkout(3); $_backlink = ''; } else { $_check = Link_Checkout(2); $_backlink = '?backlink=/checkout'; } %} $_check.$_backlink

  7. Save the settings.

Creating backlinks for the shopping cart preview:

  1. Go to the CMS » Web design » Layout » ItemView » ItemViewBasketPreviewList.

  2. Search for the code: {% if( $CustomerID ) { Link_Checkout(3); } else { Link_Checkout(2); } %}

  3. Replace this code with: {% if( $CustomerID ) { $_check = Link_Checkout(3); $_backlink = ''; } else { $_check = Link_Checkout(2); $_backlink = '?backlink=/checkout'; } %} $_check.$_backlink

  4. Save the settings.

Creating backlinks for the shopping cart overlay:

  1. Go to the CMS » Web design » Layout » ItemView » ItemViewItemToBasketConfirmationOverlay.

  2. Search for the code: {% if ( $CustomerID ) { Link_Checkout(3); } else { Link_Checkout(2); } %}

  3. Replace this code with: {% if( $CustomerID ) { $_check = Link_Checkout(3); $_backlink = ''; } else { $_check = Link_Checkout(2); $_backlink = '?backlink=/checkout'; } %} $_check.$_backlink

  4. Save the settings.

Users who have made additional adjustments to their layout need to check whether any other links on their website lead customers to the checkout. These links have to be changed so that they link to the route /checkout. We are not able to intercept all individual changes to the layout, since these can vary from user to user.

The visual design of the Ceres checkout will differ from your Callisto layout. You can edit the header and footer of the checkout and the shopping cart globally via the ShopBuilder. With the release of Ceres 3.1, you will be able to edit the entire checkout via the ShopBuilder. You can make further adjustments to the design with the help of a theme.

In a next step, adapt the routes for your legal information.

The four pieces of legal information - Terms and conditions, Privacy policy, Legal disclosure and Cancellation rights have to be connected in a different way in order to be displayed correctly.

Adjusting the terms and conditions:

  1. Go to Item » Categories.

  2. Open the Callisto category.

  3. Copy the category Terms and conditions as a main category.
    → The new main category Terms and conditions opens.

  4. Enter gtc as the URL name of the category.

  5. Save the settings.

Adjusting the privacy policy:

  1. Go to Item » Categories.

  2. Open the Callisto category.

  3. Copy the category Privacy policy as a main category.
    → The new main category Privacy policy opens.

  4. Enter privacy-policy as the URL name of the category.

  5. Save the settings.

Adjusting the legal disclosure:

  1. Go to Item » Categories.

  2. Open the Callisto category.

  3. Copy the category Legal disclosure as a main category.
    → The new main category Legal disclosure opens.

  4. Enter legal-disclosure as the URL name of the category.

  5. Save the settings.

Adjusting the cancellation rights:

  1. Go to Item » Categories.

  2. Open the Callisto category.

  3. Copy the category Cancellation rights as a main category.
    → The new main category Cancellation rights opens.

  4. Enter cancellation-rights as the URL name of the category.

  5. Save the settings.

After you have saved your legal information, activated the routes as described above, adjusted the categories, created the backlinks and integrated all relevant payment and shipping service providers via plugins, your Ceres checkout is ready for action and you have successfully overcome the hurdles of the Callisto EOL.

4.3. Theme

You have personalised your Callisto online store just the way you like it and are afraid that the Ceres design might interfere with it? You can easily download the Coconut theme for Ceres and apply your own design to guarantee a consistent user experience.

5. Setting up filters

In Ceres Filters are realized by means of attributes and properties. This Best Practice describes how the filter Colour with the two values Red and Black is displayed in the category view of the online store. The corresponding filters are only available in the category view if there are items that are linked to the filter values.

First things first:
  • This is a Best Practice for the online store plugin Ceres. Ceres is available in the plentyMarketplace and runs on plentymarkets 7 systems. The filters from Ceres are also displayed in individual theme plugins, as long as these themes did not overwrite them.

  • The integration into individual or altered template plugins is possible. This, however, requires individual adjustments which cannot be considered here.

  • Filters can be realized by means of facets through attributes and properties. This Best Practice exemplifies the setup of filters by means of attributes. Filters based on properties have to be setup manually. Create a Property group in which you organise properties of the type None. Properties are linked to facet values.

  • For plentymarkets Zero systems, the System » Client » Settings » Services » Faceted search menu is only activated in the central login.

5.1. Creating an attribute

We begin with an attribute.

  1. Go to System » Item » Attributes.

  2. Click on New attribute.

  3. Enter the internal name, e.g. Colour.

  4. Save the settings.
    → The attribute is created and the tab Basic settings is displayed.

  5. Click on the Name tab.

  6. Enter the translations for your attribute.

  7. Click on the Values tab.

  8. Click on New value.

  9. Enter the internal name, e.g. Red.

  10. Repeat steps 8 and 9 for the value Black.

  11. Save the settings.

The attribute with the two values Red and Black is created. You can also create additional values, such as Vermilion or Burgundy, and link them to the same Red facet.

5.2. Linking an attribute with an item

You can link attributes with the main variation of an item when creating the item. When creating additional variations, you can link these variations with attribute values, too. You will now create variations in the Variations tab of the item. These variations have to be active in the online store, so that the filter will be available later on.

bp ceres filter variations en
Figure 1. Linking a variation to suitable attribute values

5.3. Setting up facets

In the online store our filters are realized by means of facets. Therefore we have to create a new facet and link the attribute values and the desired client to it.

  1. Go to Systems » Client » Settings » Services » Faceted search.

  2. Click on New to create a new facet.

  3. Enter a Name for the facet in the default language of your system, e.g. Colour.

  4. Select the type Attribute/Property.

  5. Enter the facet’s position in the online store.

  6. Save the settings.

5.4. Linking attribute values to facets

  1. Go to Systems » Client » Settings » Services » Faceted search.

  2. Open the facet.

  3. Click on the Name tab.

  4. Enter the translation for your facet.

  5. Click on the Values tab.

  6. Click on Add new value.

  7. Enter the name, e.g. Red.

  8. Enter the position.

  9. Save the settings.
    → The facet value is added.

  10. Enter the translations for the facet value in th Name tab.

  11. Click on the Link tab.

  12. Open the attribute Attribute » Colour » Red.

  13. Click on Link.

  14. Repeat steps 6 to 13 for the value Black.

  15. Save the settings.

bp ceres filter facets en
Figure 2. Linked facet values

5.5. Linking clients to facets

  1. Go to Systems » Client » Select client » Services » Facet links.

  2. Select the facet.

  3. Click on Link facet.
    → The facet is linked to the selected client.

  4. Save the settings.

5.6. Deploying plugins

Now you will deploy the plugin set in order to apply the changes. The filters will be available in the search and in the category view.

bp ceres filter frontend en
Figure 3. Selected filter in the category view

6. Setting up order properties

In this Best Practice we will create a property through which you can enter a text that can be printed onto a T-shirt. The input will automatically calculate a surcharge for the product.

The most important things first:
  • This is a Best Practice for the online store plugin Ceres. Ceres is available on the plentyMarketplace and runs on plentymarkets 7 systems.

  • The integration into individual or modified template plugins is possible. This, however, requires individual adjustments which cannot be considered here.

  • Note: At the moment only properties of the type Text are active.

6.1. Creating order properties

We begin with an property.

  1. Go to System » Item » Properties.

  2. Click on the New property tab.

  3. Enter the Name (internal). This is the name of the property that is displayed in the back end.

  4. Enter the Name in the Online store area. This is the name that your customers see in the item view. In this example we choose “T-shirt print”.

  5. Choose Text from the Property type list.

  6. Enter the Surcharge that should be added if the property is used. In this example we choose 12,00 euros for a T-shirt print.
    → Check the box Display as surcharge so that the customer sees the surcharge for the property in the item view.

  7. Check all the boxes in the Display area in order to keep the additional charges transparent throughout the entire order process.

  8. Check the box Order property to define the property as such.

  9. Save the settings.
    → The property will be created.

Your property interface should now look like this:

bp ceres bestellmerkmale einstellungen
Figure 4. Settings for the order property

6.2. Linking an order property to an item

Properties are directly linked to the item. Proceed as follows:

  1. Go to Item » Edit item.

  2. Select an item with which the property should be linked.

  3. Click on the Properties tab.

  4. Go to Activate further properties » Properties not assigned to a group and check the box of the created property.

  5. Save the settings.
    → The property is linked to the item and is shown under Properties.

Surcharges

You can also enter a surcharge in the Properties options. If you enter a value here, it overwrites the value of the surcharge that was saved for the property.

bp ceres order properties item
Figure 5. Settings for the item

6.3. Deploying plugins

Now you will deploy the plugins in a plugin set in order to apply the changes. The order property will be available in the Item view and the Shopping cart.

bp ceres order properties item view
Figure 6. Item view in the online store

If the customer inputs something into the text field, the text is saved and the surcharge is added to the item price.

bp ceres bestellmerkmale warenkorb
Figure 7. Item view in the shopping cart

6.4. Setting up order properties with checkboxes

In this Best Practice we will create an order property that is displayed with a checkbox in the single item view. If the checkbox is checked, the surcharge for the product will automatically be calculated.

6.4.1. Creating a property group

In the first step we will create a new property group. In our example we want customers to be able to purchase complementary couch accessories through checking the checkbox.

  1. Go to System » Item » Properties.

  2. Click on the New property group tab.

  3. Enter a Name (internal) for the property group to be displayed in the back end.

  4. In the Language area you can enter a name and a description for the property group in various languages to be displayed in the online store.

  5. Select None from the drop-down list Grouping of order properties (type: "none")

  6. Save the settings.

bp ceres order properties group
Figure 8. Creating a property group

6.4.2. Creating order properties

After we have created a property group for couch accessories, we now want to set up a new property, e.g. a couch cushion, and link it to the property group.

  1. Go to System » Item » Properties.

  2. Click on the New property tab.

  3. Enter a Name (internal) for the property to be displayed in the back end.

  4. In the Webshop area you can enter a name and a description for the property in various languages to be displayed in the online store.

  5. Select the newly created property group from the Property group drop-down list.

  6. Select None from the Property type drop-down list.

  7. Enter the Surcharge that should be added if the property is used. In this example we choose 15.00 euros for a couch cushion.
    → Check the box Display as surcharge so that the customer sees the surcharge for the property in the item view.

  8. Check the boxes in the Show area for the areas in which you want to display the property.

  9. Check the Order property box.

  10. Save the settings.

The order property couch cushion has been successfully created.

bp ceres order properties new property
Figure 9. Creating order properties

6.4.3. Linking an order property to an item

Last but not least, we ned to link the desired item with the newly created order property.

  1. Go to Item » Edit item.

  2. Select an item with which the property should be linked.

  3. Click on the Properties tab.

  4. Go to Activate further properties and check the box of the newly created property group.

  5. Save the settings.
    → The property will be linked with the item.

bp ceres order properties link
Figure 10. Linking an order property to an item
Displaying changes

Please note that it may take about 15 minutes until the changes are displayed in the online store. This is the interval in which the ElasticSearch index is refreshed.

7. Setting up cross-selling item lists

This Best Practice guide helps you set up item lists of the type cross-selling in Ceres.

First things first…​
  • This is a Best Practice for the online store plugin Ceres. Ceres is available in the plentyMarketplace and runs on plentymarkets 7 systems.

  • This guide assumes that you have already set up cross-selling relations for your items. You can learn how to configure cross-selling for your items here.

7.1. Setting up cross-selling item lists

Go to Plugins » Plugin overview » Ceres » Configuration » Item lists. In this menu you can determine which type of item list you want to use in your online store. Select the type of cross-selling relation that your item list should display from the Cross-selling: Cross-selling relation drop-down list (see box 1 in the image). You can choose from the options Similar, Accessory, Replacement parts and Collection. This cross-selling relation will apply to all cross-selling item lists in your online store.

In the next step you determine which item list you want to use. Edit the First item list, Second item list or Third item list and select Cross-selling from the drop-down list. In the example below, the Second item list is configured as a cross-selling list (Box 2 in the image). Enter a German and an English name for your item list in the input fields Name of the second item list (DE) and Name of the second item list (EN), respectively.

Save the settings you have carried out.

bp ceres cross selling config
Figure 11. Setting up cross-selling

7.2. Displaying cross-selling item lists in the online store

After you have determined which item list you want to use for your cross-selling items, you now choose where the item list is to be displayed in your online store.

Open the CMS » Container links menu.

Go to the item list that you have configured as your cross-selling item list, i.e. First item list, Second item list or Third item list. Choose the layout container in which you want to display your cross-selling item list. In the example below, the second item list is displayed in the container of the single item view.

bp ceres cross selling container
Figure 12. Choosing a container for item lists
Displaying changes

Please note that it may take about 15 minutes until the changes are displayed in the online store. This is the interval in which the ElasticSearch index is refreshed.

8. Displaying further cross-selling item lists

Since Ceres only displays one cross-selling item list, this Best Practice informs you about which adjustments are necessary in order to use multiple cross-selling item lists in your Ceres online store. This guide is primarily for experienced users, since the implementation of multiple cross-selling lists has to be done via a customised theme plugin.

Please note that you have to assign a position number to your theme plugin that lies between that of IO and that of Ceres. You do this in the actions column of the Plugins » Plugin overview menu.

8.1. Creating a context class

The implementation of cross-selling lists is done via extending the SingleItem context class. Therefore, you first need to create a PHP context class in your theme.

First, create a Contexts folder in the src folder of your theme. In the contexts folder you now create a PHP file for your own context class, e.g. MyThemeContext.php.

Now include the following code in this file. The first cross-selling item list you will create is of the accessory type.

<?php
namespace ThemeName\Contexts;

use IO\Helper\ContextInterface;
use Ceres\Contexts\SingleItemContext;

use IO\Services\ItemSearch\Services\ItemSearchService;
use IO\Services\ItemSearch\SearchPresets\CrossSellingItems;

class MyThemeContext extends SingleItemContext implements ContextInterface
{
	public $accessory;

	public function init($params)
	{
		parent::init($params);
		$options = array(
        			"itemId" => $this->item['documents'][0]['data']['item']['id'],
        			"relation" => "Accessory"      // Use the accessory list
       		);
     		$searchfactory = CrossSellingItems::getSearchFactory( $options );
     		$searchfactory->setPage(1, 4); // Limit to 4 items
      		$result = pluginApp(ItemSearchService::class)->getResult($searchfactory);
      		$this->accessory = $result['documents'];
	}
}

Save the file. Now you adapt the Provider of your theme in 2 steps. Open the file of the provider, located at /src/Providers/MythemesServiceProvider.php.

Add use Theme\Contexts\MyThemeContext.php; at the top of the file, so that the newly created context is read by the ServiceProvider.

Furthermore, you need to add the following code in the boot function:

$eventDispatcher->listen('IO.ctx.item', function (TemplateContainer $templateContainer, $templateData = [])
   {
       $templateContainer->setContext( MyThemeContext::class);
       return false;
   }, 0);

Save the file. This concludes the preparations for your context class.

8.2. Adapting the SingleItemView.twig

In order to display the cross-selling item lists in the single item view, you now have to adjust the <single-item>component in your theme. In the file structure of the unaltered Ceres template, the file is located at /resources/views/item/SingleItemView.twig; this has to be overwritten by your theme, so that the changes you make are not lost whenever you update IO or Ceres.

Add the following code before the closing </single-item> tag in the component:

<div slot="CrossSellingAccessory">
	
	{% if accessory|length > 0 %}
        		<div class="crossSelling">
        			<span class="h3">Das passt dazu:</span>
        			<container-item-list :items="null"></container-item-list>
      		</div>
	{% endif %}
   </div>

Change the heading, if necessary. After you have defined the slot for the cross-selling list, you can incorporate it via <slot name=“CrossSellingAccessory“></slot> in the desired component (/resources/views/Item/Components/). The location in which you need to include the code snippet depends on where you want to display the cross-selling list in the single item view.

As soon as the plugin set has been saved and deployed again, the cross-selling item list of the type accessory should be displayed in the selected place.

8.3. Including additional cross-selling lists

In order to display additional cross-selling lists in Ceres, the context class you created needs to be extended.

<?php
namespace ThemeName\Contexts;

use IO\Helper\ContextInterface;
use Ceres\Contexts\SingleItemContext;

use IO\Services\ItemSearch\Services\ItemSearchService;
use IO\Services\ItemSearch\SearchPresets\CrossSellingItems;

class MyThemeContext extends SingleItemContext implements ContextInterface
{
	public $accessory;
  public $similar;

	public function init($params)
	{
		parent::init($params);
		$options = array(
        			"itemId" => $this->item['documents'][0]['data']['item']['id'],
        			"relation" => "Accessory"      // Use the list accessory
       		);
     		$searchfactory = CrossSellingItems::getSearchFactory( $options );
     		$searchfactory->setPage(1, 4); // Limit to 4 items
      		$result = pluginApp(ItemSearchService::class)->getResult($searchfactory);
      		$this->accessory = $result['documents'];

    $options = array(
              "itemId" => $this->item['documents'][0]['data']['item']['id'],
              "relation" => "Similar"      // Use the list similar
          );
        $searchfactory = CrossSellingItems::getSearchFactory( $options );
      	$searchfactory->setPage(1, 4); // Limit to 4 items
        	$result = pluginApp(ItemSearchService::class)->getResult($searchfactory);
        	$this->similar= $result['documents'];
	}
}

Here, public $similar; has been added below public $accessory;. If you want to include a cross-selling list of the type Replacement part, add public $replacementPart instead.

Furthermore, an additional code block has been added below $this→accessory = $result[0]['documents'];, in which "relation" ⇒ "Accessory” has been replaced by "relation" ⇒ “Similar”. For lists of the type Replacement part, use "relation" ⇒ "ReplacementPart” instead.

As described above, you now create a new slot in the <single-item> component and call it at the desired place in the code.


Thanks to Jens Volke for contributing this HowTo. Read the original post in our forum.

To top