Deploy the Integration Packages

Current version: 8.2

Configure your existing Sitecore site to use Sitecore Commerce 8.2 powered by Commerce Server and Commerce Server 11.4 data providers.

Complete the following prerequisites:

  • Install Sitecore

  • Install Commerce Server

  • Sitecore Commerce 8.2 powered by Commerce Server and Commerce Server 11.4 acts as a data provider for your site and does not dictate what techniques or technologies you use to build out your presentation components. If you prefer MVC, WebForms, or Xslt, you can follow the normal Sitecore development practices to develop your look and feel.


By default the scripts will create some local user accounts for app pools and two websites in IIS called CSSitecore and CSServices to hold the Sitecore site and Commerce Server web services. If are ok with this then you can just run the scripts as is, otherwise you will need to update the environment.xml file to match you desired settings.


During the deployment of the update packages, the system will issue warnings and errors in deployment summary. It is safe to disregard this information

At your development machine:

  1. Download Sitecore Commerce Connect from the Sitecore Developers Portal.

  2. Download Sitecore Commerce Server Connect, Sitecore Commerce Server Connect Sample MVC site, and Sitecore Merchandising Manager from Sitecore Developers Portal.

  3. Download

  4. Extract to a temporary location.

  5. Ensure your site variables are correct. Open and edit the deployment\environment.xml and edit the following sections:

    <Configuration identity="Domain.Dev.Existing">
    <Configuration identity="Domain.Dev.Merge">
    <Configuration identity="Domain.Dev.SC">
    1. Ensure that the instanceName variable is set as your Sitecore instance name, and the vvariable is correct. In the following example, the installDir variable is pointing to c:\inetpub\SitecoreInstance.

      <Variable identity="instanceName" value="SitecoreInstance" description="" />
      <Variable identity="installDir" value="$(Join-Path -Path $INETPUB_DIRECTORY -ChildPath $instanceName)" description="" />

      In the following example the installDir variable is changed to c:\inetpub\wwwroot. However, you can also specify the absolute path to your Sitecore solution as a value of the installDir variable.

      <Variable identity="installDir" value="$(Join-Path -Path $INETPUB_DIRECTORY\wwwroot -ChildPath $instanceName)" description="" />
    2. Ensure that the SitecorePort variable is set correctly. Use IIS Manager to determine your site settings.

      <Variable identity="SitecorePort" value="7655" description="" />
    3. Ensure that the scHostHeaderName variable is set correctly. Use IIS Manager to determine your site settings.

      <Variable identity="scHostHeaderName" value="SitecoreHost" description="" />
    4. Ensure that the MONGO_EXE_PATH variable is set correctly. This variable indicates the root path of the Mongo DB installation. The script, Deploy-Mongo-Clean.ps1 uses this variable to locate the Mongo DB executable to use for dropping the analytics databases.

      <Variable identity="MONGO_EXE_PATH" value="C:\MongoDB" description="MongoDB Installation path" />
  6. Set permissions to allow Sitecore Commerce 8.2 powered by Commerce Server and Commerce Server 11.4 to integrate with Sitecore and unpup the sample site.

    1. Open a Powershell window.

    2. Change the execution policy. Enter Set-ExecutionPolicy Unrestricted and select Y.

    3. Browse in the Powershell window to the location of the extraction folder.

    4. Run the Deploy-UnPup.ps1 from the deployment folder.

    5. Run the Deploy-Base-SC-Existing.ps1 from the deployment folder.

  7. Install Commerce Connect.

    1. At the Sitecore desktop, select Sitecore Development ToolsInstallation Wizard.

    2. Use the wizard to upload the hotfix package and follow all of the instructions to install. If you are prompted to overwrite an existing item then you should accept this option.

  8. Install the Sitecore Commerce 8.2 powered by Commerce Server and Commerce Server 11.4 update packages.

    1. Within a browser, browse to http://<your Sitecore site>/sitecore/admin/UpdateInstallationWizard.aspx .

    2. Import the Commerce Server plug-in update package named Sitecore Commerce Server Connect.update with the Installation wizard.

    3. Import the runtime site package named MVCSite.update with the Installation wizard.

    4. Perform an IISReset.

  9. Run the merge script.

    Using powershell, run Deploy-Base-SC-Merge.ps1 from the deployment folder to merge the config files.


    There is a known possible issue when installing Sitecore Commerce. Depending on your configuration, the maximum default file size for ASP.NET web.config may be exceeded. The workaround is to create a key:

    1. In REGEDIT, navigate to HKLM \Software\Microsoft\InetStp.

    2. Add a new Key named Configuration.

    3. Add a new DWORD for MaxWebConfigFileSizeInKB, and set the value in KB.

    4. Restart the app pool.

    For more information, see the following KB article:

  10. Update Windows performance groups. Add the Sitecore application pool user into the two windows groups named Performance Log Users and Performance Monitor Users.

  11. Change the Commerce Server site name on the siteName attribute.


    You can skip this step if your site is called SolutionStorefrontSite.

    In the Sitecore web.config file, edit the Sitecore Commerce 8.2 powered by Commerce Server and Commerce Server 11.4 site name on the siteName attribute of the application element to match the name of the Commerce Server site.

    <CommerceServer> <application siteName="YourCommerceSitename" debugLevel="Production" />
  12. Publish the site to the Web.

  13. Rebuild the Sitecore indexes.

Do you have some feedback for us?

If you have suggestions for improving this article,