Upgrading Episerver Commerce from version 1 R2 to 1 R2 SP1

Product version:	Episerver Commerce 1 R2/1 R2 SP1
Document last saved:

Introduction

This document describes the procedure for upgrading EPiServer Commerce from version 1 R2 to 1 R2 SP1. These instructions apply to a website with a working installation of EPiServer Commerce 1 R2. To upgrade from previous versions, refer to the information under Upgrading from Previous Versions below.

Prerequisites

Check the following requirements and considerations before you start the upgrade:

The database server must have full text search service enabled.
You have to open Commerce Manager from your browser and login at least one time. The first time you login to Commerce Manager, the system will do an initialization and generate new database tables.

Preparing for the Upgrade

Uninstall the current EPiServer Commerce 1 R2 version from your computer/server (under "Programs/Uninstall...", select EPiServer Commerce build 1.1.0.216).
Download and install EPiServer Commerce 1 R2 SP1.
Download and extract the upgrading files for EPiServer Commerce 1 R2 SP1 to your computer.
NOTE This upgrade cannot be undone, please back up your target sites and database (both EPiServer Commerce and Commerce Manager) before applying the upgrade!
Follow the manual upgrading instructions as described below.

Upgrading Configuration Files and Database

STEP 1: Update configuration files

1. In the episerver.config file:

Add the following config to the episerver/virtualPath/providers section:

<add showInFileManager="false" virtualName="DynamicContentPreview" virtualPath="~/Edit/Dialogs/DynamicContentPreview.aspx" bypassAccessCheck="false" name="DynamicContentPreview" type="EPiServer.Web.Hosting.VirtualPathMappedProvider, EPiServer" />

Add the following configuration to the episerver/virtualPath/virtualPathMappings section (the uiUrl value can be found in episerver.config e.g. “uiUrl=~/epi/CMS”):

<add url="{uiUrl}/Editor/Dialogs/DynamicContentPreview.aspx" mappedUrl="~/Edit/Dialogs/DynamicContentPreview.aspx" />

2. In the web.config file of the EPiServer Commerce site:

Go to the section /configuration/episerver.shell/protectedModules:

Add

<add name="Commerce" resourcePath="~/modules/Commerce/"/>

Change

<add name="Shell"> <assemblies> <add assembly="EPiServer.Business.Commerce.UI" /> </assemblies> </add>

<add name="Shell" />

3. Update the content of Variation-Edit.xml, Product-Edit.xml and Bundle-Edit.xml:

Navigate to {ApplicationFolder}\<SiteName>\Shared\Apps\Catalog\Config\View (e.g C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Shared\Apps\Catalog\Config\View).

Change {ProductRelations:Tab_Label} to {SharedStrings:Product_Relations_Tab_Label}

4. In the web.config file of the Commerce Manager site:

Add the following to /configuration/system.webServer:

<httpProtocol> <customHeaders> <add name="X-UA-Compatible" value="IE=7" /> </customHeaders> </httpProtocol>

5. Locate the web.config files in the following folders:

C:\EPiServer\Sites\<SiteName>,
{Application folder}\<Sitename>\Sites\B2CSampleSite
{Application folder}\<Sitename>\Sites\ConsoleSite

Example:
C:\EPiServer\Sites\ CommerceR2Manager
C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Sites\B2CSampleSite
C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Sites\ConsoleSite

In /configuration/Mediachase.RssNews/Items, change http://world.episerver.com/System/Site-footer/RSS/News/ to http://world.episerver.com/?feed=RSS

6. Locate the web.config files in the following folders:
C:\EPiServer\Sites\<SiteName>,
{Application folder}\<Sitename>\Sites\B2CSampleSite
Example:
C:\EPiServer\Sites\ CommerceR2Manager C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Sites\B2CSampleSite

In /configuration/system.web/authentication, change timeout="45" to timeout="4320"

7. Locate the appSettings.config files in the following folders:
C:\EPiServer\Sites\<SiteName>,
{Application folder}\<Sitename>\Sites\B2CSampleSite
Example:
C:\EPiServer\Sites\ CommerceR2Manager C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Sites\B2CSampleSite

In the appSetings section add:

<add key="EnableAdminSso" value="false" /> <add key="SsoSharedSecret" value="set shared secret here" />

8. Locate the ecf.catalog.config files in the following folders:

C:\EPiServer\Sites\<SiteName>\Configs,
{Application folder}\<Sitename>\Sites\B2CSampleSite\Configs ,
{Application folder}\<SiteName> \QuartzService\Configs
Example:
C:\EPiServer\Sites\ CommerceR2Manager \Configs
C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager\Sites\B2CSampleSite\Configs
C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager \QuartzService\Configs

Change [enable=”false”] to [enable=”true”] in the /Catalog/Cache tag.

STEP 2: Update the Database

Execute the scripts in the "Scripts" folder of the downloaded file package:

ecf_db_Reporting_storedprocedures.sql
ecf_db_ApplicationSystem_update.sql
ecf_db_CatalogSystem_update.sql
ecf_db_MarketingSystem_update.sql
ecf_db_MetaDataSystem_update.sql
ecf_db_OrderSystem_update.sql
ecf_db_SecuritySystem_update.sql

In ecf_db_SecuritySystem_update.sql: update $(EcfApplicationName) to <SiteName> (SiteName: Name of Commerce Manager site E.g CommerceR2Manager), and then execute.

STEP 3: Deploy Files

Get the following files from the downloaded file package:

Copy all files and folders in the "Commerce" folder to the root folder of the Commerce site (E.g C:\EPiServer\Sites\CommerceR2).
Copy all files and folders in the "Commerce Manager" folder to the root folder of the Commerce Manager site (E.g. C:\EPiServer\Sites\CommerceR2Manager).
Copy all files and folders in the "Application" folder to {ApplicationFolder}\<SiteName> (E.g. C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager).

STEP 4: Update the configuration

1. Update the web.config file of the EPiServer Commerce site:

Add the following configuration to the configuration/runtime section:

2. Update the web.config file of the EPiServer Commerce Manager site:

Add the following configuration to the configuration/runtime section:

3. Update the following in the web.config of the EPIServer Commerce site:

Search for:

<add name="ProfileModule" type="EPiServer.Business.Commerce.Sample.HttpModules.ProfileModule, EPiServer.Business.Commerce.Sample"/>

and replace with:

<add name="ProfileModule" type="EPiServer.Business.Commerce.HttpModules.ProfileModule, EPiServer.Business.Commerce "/>

Upgrading the Sample Site

STEP 1: Deploy Files

Get the following files from the downloaded file package:

Copy all files in the "Sample" folder to the root folder of the EPiServer Commerce site.
Copy the "bin" folder of the "Payment" folder to the root folder of the Commerce Manager site.
Copy the "Shared" folder of the "Payment" folder to {ApplicationFolder}\<SiteName> (E.g. C:\EPiServer\eCommerceFramework\5.2\CommerceR2Manager).

NOTE the following:

If your website uses assemblies from Commerce Manager which are not listed in the redirecting configuration above, you will need to add a redirecting configuration to the web.config with the latest version.
Example:

<dependentAssembly> <assemblyIdentity name="Mediachase.FileUploader" publicKeyToken="41d2e7a615ba286c" culture="neutral" /> <bindingRedirect oldVersion="1.0.0.0-65535.65535.65535.65535" newVersion="2.3.4174.28315" /> </dependentAssembly>

Upgrading from Previous Versions

Related Information

For information on how to work with the EPiServer Commerce Sample site, see the EPiServer Commerce 1 R2 SP1 User Guide.
For information on how to customize and extend the EPiServer Commerce Sample site, see the EPiServer Commerce 1 R2 SP1 Developer Guide.

Try our conversational search powered by Generative AI!