Share via


How to Deploy the Web Parts in Silent Mode

You can use the SharePoint Commerce Services Configuration tool to configure and deploy SharePoint Commerce Services in silent mode, by setting attributes in the XML-formatted SharePoint Commerce Services configuration file and running the tool from the command line.

  • Setting XML Configuration Options for Web Part Deployment

  • Deploying the Commerce Server Web Parts from the Command Line

Setting XML Configuration Options for Web Part Deployment

The SharePointCommerceServicesConfiguration.exe.config file is an XML-formatted file that specifies the deployment options for the SharePoint Commerce Services. The SharePoint Commerce Services Configuration tool uses this file to determine which SharePoint Commerce Services to deploy. The file is located in the <Commerce Server Root>\SharePointServices\Site folder.

All SharePoint Commerce Services deployment attributes are contained in the sharePointSolutionGroups element. There is a separate sharePointSolutionGroup element for the following SharePoint solution deployment types:

  • Commerce Server Web Parts only

  • Commerce Server Solution Storefront and Web Parts (for SharePoint Server 2010)

  • Commerce Server Solution Storefront and Web Parts (for SharePoint Foundation 2010)

You modify the attribute values in the SharePoint solution group that corresponds to the solution you are deploying. The following code snippet represents the attributes that are used for Commerce Server Web Part deployment.

<SharePointSolutionGroups>
  <SharePointSolutionGroup name="CommerceWebParts" defaultInSilentMode="True" />
    <SharePointSolutions>
      <SharePointSolution id="7b93b2ca-e1e4-4783-a038-14094933c002" file="MicrosoftCommerceWebParts.wsp" version="1.0.0.0" wspKey="1"/>  
    </SharePointSolutions>
    <defaultWebApplicationSettings name="SharePoint-8088"/>
    <defaultSiteCollectionSettings create="False" title="Home"/>
    <defaultCommerceServerSiteSettings create="true" name="Site1" description="Commerce Server site for Site1" siteWithSampleData="False" databaseServer="."/>
  </SharePointSolutionGroup>

See the following sections for a description of the attributes you need to set to deploy the Commerce Server Web Parts in silent mode.

  • sharePointSolutionGroup (to specify that you are deploying the SharePoint solution in silent mode)

  • defaultWebApplicationSettings (to identify the Web application that is hosting the Web Parts)

  • defaultSiteCollectionSettings (to identify the site collection for the Web Parts)

  • defaultCommerceServerSiteSettings (to identify the Commerce Server site for the Web Parts)

Note

You should make a backup copy of the configuration file before changing any of the contents.

sharePointSolutionGroup

The sharePointSolutionGroup element contains the attributes that identify the SharePoint solution being deployed and the mode of deployment.

Attribute name

Description

name

Identifies the SharePoint solution being deployed. Do not change this value.

defaultInSilentMode

Set this attribute to true to deploy the Web Parts solution in silent mode.

If you want to deploy the Web Parts only, and not the Solution Storefront, you must delete this attribute from the two sharePointSolutionGroup elements that describe the Solution Storefront solutions.

defaultWebApplicationSettings

The defaultWebApplicationSettings element contains the attribute that identifies the SharePoint Web application to which the Commerce Server Web Parts are being deployed. The Web application must exist already.

Attribute name

Description

name

Name of the SharePoint Web application where you want to deploy the Commerce Server Web Parts. For example, name="SharePoint - 8088".

defaultSiteCollectionSettings

The defaultSiteCollectionSettings element contains the attributes that identify the site collection for the Commerce Server Web Parts. You must specify an existing site collection when deploying the Web Parts only.

Attribute name

Description

create

Specifies whether the tool creates a new site collection for the SharePoint Commerce Services.

Must be set to false for the Web Parts solution. The SharePoint Commerce Services Configuration tool always deploys the Web Parts to an existing site collection.

title

Name of the site collection.

defaultCommerceServerSiteSettings

The defaultCommerceServerSiteSettings element contains the attributes that identify the Commerce Server site for the Commerce Server Web Parts. You can specify an existing Commerce Server site, or have the SharePoint Commerce Services Configuration tool create one.

Attribute name

Description

create

Specifies whether the tool creates a new Commerce Server site for the Web Parts. Possible values are true or false.

Hh567693.alert_caution(en-us,CS.95).gifImportant Note:
If you are using an existing Commerce Server site, the site you select must have been unpacked from one of the PuP files included with Commerce Server 2009 R2. These files are located in the <Commerce Server root>\Pup Packages folder.

name

Name of the Commerce Server site. If you are not creating a new Commerce Server site, this name must correspond to an existing Commerce Server site.

description

(Optional) Text describing the Commerce Server site.

siteWithSampleData

Specifies whether the new Commerce Server site includes Commerce Server schema only, or Commerce Server schema and sample data. Only required when creating a new Commerce Server site. Possible values are true or false.

databaseServer

Identifies the server that is running SQL Server where the Commerce Server database(s) are stored. Only required when creating a new Commerce Server site.

Hh567693.alert_note(en-us,CS.95).gifNote:
The option of installing the Commerce Server site's databases on several different SQL Server hosts is not available in the configuration file. To use this option, you must run the SharePoint Commerce Services Configuration tool in wizard mode.

Note

The SharePoint Commerce Services Configuration tool does not unpack the Commerce Server Web services (Catalog, Marketing, Orders, and Profiles Web services) to the new site. You unpack the Web services separately.

Deploying the Commerce Server Web Parts from the Command Line

Once you have set the deployment options for the Web Parts in the SharePoint Commerce Services configuration file, you can launch the SharePoint Commerce Services Configuration tool from the command line to deploy the Web Parts silently. The SharePoint Commerce Services Configuration tool always uses the XML configuration file to deploy SharePoint Commerce Services when launched from the command line.

If you are deploying the Web Parts on a system that already has Web Parts installed, the SharePoint Commerce Services Configuration tool detects and replaces the existing Web Parts. When deploying from the command line, you must confirm that the Web Parts that an upgrade of the Web Parts is allowed, using the options described in the following procedure.

Hh567693.alert_caution(en-us,CS.95).gifImportant Note:

Before running the SharePoint Commerce Services Configuration utility, you must turn off the User Account Control feature in Windows. To do so, go to the Control Panel, double-click User Accounts, click the Turn User Account Control on or off link, and clear the check box. You will have to restart Windows after turning off the feature.

To deploy the Commerce Server Web Parts in silent mode

  1. Log on to the server under a user account that has the required permissions.

  2. Open a Command Prompt window and navigate to the <Commerce Server root>\SharePointServices\Site directory.

  3. Type the following and press Enter:

    SharePointCommerceServicesConfiguration -q <options>  
    

    The following table contains information about the options that you can use with the SharePointCommerceServicesConfiguration command.

    Option

    Description

    -h, or -?

    Provides help and quick reference.

    -q

    Configures the specified components in silent mode (that is, without user interaction). This option can be combined with the -u option.

    -upgrade

    Upgrades the existing Web Parts only.

    -allowUpgrade

    Confirms that existing Web Parts will be upgraded (as part of the SharePoint solution deployment specified in the configuration file).

    You must specify this option if you have existing Web Parts, but have chosen to deploy the new Web Parts.

    -u

    Uninstalls (retracts and removes) all deployed SharePoint Commerce Services. This option can be combined with the -q option.

    You can follow the installation progress by reviewing logs in the event viewer and Sharepoint Commerce Services Config.log.