Commerce Engine and Storefront configuration settings

Abstract

Overview of the Commerce Control Panel , which enables you to configure commerce engines, your storefronts, and business tools in Sitecore.

The Commerce Control Panel is installed when you install Commerce Connect. The Commerce Control Panel enables you to configure commerce engines, your storefronts, and business tools by editing content in Sitecore. You can edit the Commerce Control Panel content in the Content Editor, under the sitecore/Commerce/Commerce Control Panel folder. 

Note

For information on how to define the storefront environment, see Configure the storefront environment.

The control panel content is organized in three folders.

The Commerce Engine Settings folder contains Commerce Term items for the Commerce Engine or related business tools. Each Commerce term represents a user interface string or system message that can be translated or localized. A number of terms are created in the Commerce Terms folder when the Commerce Engine is installed; other terms are added when the business tools are installed. These terms are similar to the Dictionary entry items in the Sitecore dictionary (in the Content Editor: sitecore/System/Dictionary) but are only used for Sitecore Experience Commerce, and are therefore stored in the Commerce Control Panel folder.

System messages in Commerce terms folder.

A Commerce Term item has the following fields:

  • Value field – contains the localizable text string. The value can be a fixed string or, for example, a system message based on .NET string format that is interpreted by the Commerce Engine. This field is mandatory. 

  • Description field – contains a description or explanation of the term, or a tool tip. It can also be empty; using this field is optional.

In the Shared Settings folder, you can define the options for a number of different configuration settings for your commerce engines and storefronts. When you configure the content in the Storefront Settings folder, you select from among the options that you have defined in the Shared Settings folder.

Shared settings in the Commerce Control Panel

You can define the options for the following:

Setting

Sub-setting

Description

Countries/Regions

Create a Country-Region item for every country or region that you want to use in your commerce engines or storefronts.

In the Code field, enter the ISO 3166-1 country code.

Subdivisions

Use Subdivision items for subdivisions of countries, such as states, provinces, or regions. You must create a Subdivision item for every subdivision that you want to use in your commerce engines or storefronts.

In the Code field, enter the ISO 3166-2 country subdivision code.

Currency Sets

Define sets of currencies in the Shared Settings folder and assign them to storefronts in the Storefront Settings folder. For example, you might have a North American storefront that accepts payments in USD and CAD, and a European website that accepts EUR, GBP, and USD. You would then set up a currency set for each storefront.

You must include the currency in the Default Currency field in the list of Selected currencies.

Fulfillment Option Types

Use to link fulfillment options to related code in Commerce Connect. The Type ID field refers to a ShippingOptionType value that is defined in the code. The following types are installed when Commerce Connect is installed, and should not be changed:

  • Deliver Items Individually - split shipment

  • Deliver To Address

  • Digital Delivery

  • Pick Up From Store

You can add more fulfillment option types, but then you must add the definition of the ShippingOptionType values in the underlying code.

Fulfillment Options

Create one fulfillment option for each fulfillment option type that you want to use on your storefront.

Fulfillment Methods

Create fulfillment methods for each fulfillment option that requires suboptions.

For example: the Deliver To Address fulfillment option type could correspond to the Ship To Address fulfillment option, which could have two methods, Standard Shipping and Express Shipping.

Indexing Settings

Use to ensure no duplicate products are displayed in search results when a product exists under multiple categories.

Language Sets

Define sets of languages in the Shared Settings folder and assign them to storefronts in the Storefront Settings folder. For example, you might have a North American storefront that can be displayed in English, French, or Spanish, and a European website that can be displayed in any European language. You would then set up a language set for each storefront.

You must include the language in the Default Language field in the list of Selected languages.

The Fallback Language field is not currently used.

Payment Option Types

Use to link payment options to related code in Commerce Connect. The Type ID field refers to a PaymentOptionType value that is defined in the code. The following types are installed when Commerce Connect is installed, and should not be changed:

  • Card Payment

  • Federated Payment

  • Gift Card Payment

  • Loyalty Card Payment

You can add more payment option types, but then you must add the definition of the PaymentOptionType values in the underlying code.

Payment Options

Create a payment option for each payment option type that you want to use on your storefront.

Payment Methods

Create payment methods for each payment option that requires suboptions.

For example: the Card Payment payment option type could correspond to the Pay by Card payment option, which could have a method for each type of card, for example, MasterCard, Visa, and so on.

You use the Storefront Settings folder to configure your storefront or storefronts with the options that you have defined in the Shared Settings folder.

Storefront settings folder.

For each storefront, you create a Storefront item, and under each Storefront item you can insert the configuration items that are needed for that storefront.

Setting

Subsetting

Description

Account Management Configuration

Determine the maximum number of addresses that can be registered per customer.

Catalog Configuration

Select the Use Index File for Product Status in Lists field to improve performance when retrieving the product status for lists of products, for example, for the Product List rendering. By default, product statuses are retrieved live from the commerce engine by separate calls.

The value in the Default Items Per Page field is used as the default for all categories. To change the setting for a single category, in the Sitecore/Sitecore Commerce/Catalog Management folder, change the value in the Items per page field.

In the Gift Card Product ID field, enter the product ID that the commerce system uses for gift cards.

The Gift Card Page Link field contains the URL for the gift card product page.

In the Shop Pages Root Paths section, the Shop Page Root Path, Category Page Root Path and Product Page Root Path fields must be set to the relative path for the items used when generating links for category and product navigation.

Renderings in the Commerce Catalog group that generate links will use the value of the Shop Page Root Path field to generate the URLs.

The Metadata meta rendering uses the values configured in the Category Page Root Path and Product Page Root Path fields to generate a canonical URL in the head section of each page that contains the rendering. Canonical URLs are used by search engines to improve indexing of categories and products.

For more information, see Configure a catalog.

Country/Region configuration

Assign one or more countries or regions to a storefront from the list that you defined in the Shared Settings folder.

Note

When you create a Country/Region configuration item, you must rename it without the /, for example, Country-Region configuration.

Storefront Configuration

Enforce SSL is enabled by default to ensure a private and secure connection between the client browser and the storefront. It is not recommended to disable this feature except during development and testing of the solution.

Currencies Display Adjustments

Each currency has a default currency symbol and display format (.NET standard). To use an alternative currency symbol or display format for one or more currencies, insert the Currencies Display Adjustments folder, and insert the relevant Currency items.

Currency

Currency Display

When you create a Currency item, the name for the new item must be the currency code.

In the Currency item, you can fill in the fields to change how the currency symbol or amount is displayed.

In the Currency Symbol field, enter a currency code or special character, for example USD or $.

The Currency Symbol Position field enables you to determine the position of the currency symbol in relation to the amount. To determine whether the symbol appears before or after the amount and whether or not a space is inserted, enter 0, 1, 2, or 3 according to the following key:

0 = $n, 1 = n$, 2 = $ n, 3 = n $

In the Currency Number Format field, you can specify a .NET culture code (for example, en-US, fr-CA, or en-CA) to determine how amounts are formatted, for example, which character is used to indicate the decimal place.

Use a Currency Display item if a currency requires more than one display option.

Currency Configuration

Select which currency set is available on the storefront. You can select from the sets that you created in the Shared Settings folder.

Email Configuration

In the From Email Address field, enter the email address to use as the sender address for email messages sent by the storefront.

The Email Address Validation Regex contains the regular expression used to validate email addresses, for example, for the Login, Registration, and Checkout Billing renderings.

Fulfillment Configuration

Specify which fulfillment options will be available on the storefront. Some fulfillment options might not be compatible with all items (for example, physical items cannot be delivered digitally), so the content of the shopping cart also influences which options are visible on the storefront.

Language Configuration

Select which language set is available on the storefront. You can select from the sets that you created in the Shared Settings folder.

Payment Configuration

Specify which payment options will be available on the storefront. Some payment options might not apply to all items (for example, some items might not be eligible for payment with loyalty points), so the content of the shopping cart also influences which options are visible on the storefront.