Getting Started With the Extensibility Kits
Microsoft Commerce Server 2009 R2 extensibility kits provide source code that allows you to extend business management tools and applications beyond their base capabilities. Also provided is the source code for the Commerce Web Parts and the Microsoft SharePoint 2010 Solution Storefront to use as a starting point to build custom e-commerce solutions.
This topic contains information to help you setup the extensibility kits in your development environment so that you can start developing using source code.
Introducing Commerce Server 2009 R2 Extensibility Kits
Setting Up the Extensibility Kits
Introducing Commerce Server 2009 R2 Extensibility Kits
The following table lists and provides a brief description of each extensibility kit provided with Commerce Server 2009 R2.
Extensibility kit |
Description |
File name |
|---|---|---|
Desktop Business Tools Extensibility Kit |
This kit provides the source code to customize the Desktop Business Tools (including the Catalog and Inventory Schema Manager, Catalog Manager, Customer and Orders Manager and Marketing Manager). |
BusinessToolsExtensibilityKit.zip |
SharePoint Commerce Services Extensibility Kit |
This kit provides the source code for the SharePoint 2010 Web parts and the Solution Storefront. Use this kit as a starting point to customize Web parts or to build your own SharePoint 2010 solution. |
CommerceSharePointExtensibilityKit.zip |
Web Business Tools Extensibility Kit |
This kit provides the source code that allows you to customize the Silverlight-based Web Business Tools provided by the Commerce Server Business Administration Ribbon. |
BusinessManagementExtensibilityKit.zip |
Setting Up the Extensibility Kits
Perform the following procedures to setup the extensibility kits so that you can start customizing Commerce Server 2009 R2 using out-of-the-box source code as your starting point:
How to Install the Extensibility Kits
How to Open an Extensibility Kit Solution File
How to Install the Extensibility Kits
You install extensibility kits using the Commerce Server 2009 R2 Installation Wizard. The extensibility kits are available as optional software components during Commerce Server 2009 R2 installation.
Prerequisites for Setting up Extensibility Kits
The following table lists the software prerequisites for each extensibility kit. Before installing the extensibility kit on your development workstation, ensure that you have the required software installed on your developer workstation.
Extensibility kit |
Commerce Server 2009 R2 software |
Visual Studio requirements |
SharePoint 2010 requirements |
Other |
|---|---|---|---|---|
Desktop Business Tools Extensibility Kit |
Commerce Foundation Components Commerce Presentation Components |
Full with SP1 |
Not required. |
None |
SharePoint Commerce Services Extensibility Kit |
Commerce Foundation Components Commerce Presentation Components Web Parts and Site Templates |
Visual Studio 2010 or Visual Studio 2008 with SP1 |
SharePoint Foundation 2010 or SharePoint Server 2010 |
None |
Web Business Tools Extensibility Kit |
Commerce Foundation Components Commerce Presentation Components Web Parts and Site Templates |
Visual Studio 2010 or Visual Studio 2008 with SP1 |
SharePoint Foundation 2010 or SharePoint Server 2010 |
Microsoft Silverlight Silverlight 3 SDK Silverlight 3 Toolkit November 2009 Silverlight 3 Tools for Visual Studio 2008 SP1 - ENU |
To Install One or Multiple Extensibility Kits
Launch the Commerce Server 2009 R2 installation wizard. For detailed instructions, see How to Add or Remove Commerce Server 2009 R2 Components.
From the installation wizard, in the Available components window, expand the Developer Kits section and then select the extensibility kit(s) to install. For information on the kits available, refer to the Prerequisites for Setting Up Extensibility Kits.
When installation is complete, verify that the .zip file for each selected kit is installed in the following location: %COMMERCE_SERVER_ROOT%\Extensibility Kits. See Commerce Server 2009 R2 Extensibility Kits for information about the name of the file that gets installed for each kit.
To Extract the Extensibility Kit
Go to %COMMERCE_SERVER_ROOT%\Extensibility Kits and perform the following steps:
Right-click the extensibility kit .zip file to extract, and then click Extract All…
Click Browse to select the target location.
Note
Make sure to create a folder in the desired location to contain the extracted files.
Click Extract to extract the files.
How to Open an Extensibility Kit Solution File
After you have extracted the extensibility kit .zip file to the target location, you use Visual Studio to open and build the solution file that contains the source code.
Note
The source code in Commerce Server 2009 R2 extensibility kits was created with Visual Studio 2008. When you open a solution file using Visual Studio 2010, the Visual Studio Conversion Wizard launches automatically to convert the files. Proceed with the conversion if you want to use an extensibility kit with Visual Studio 2010.
In Visual Studio, go to the location where you unzipped the extensibility kit.
Open the extensibility kit solution file.
.gif "Important note")
Important Note:The SharePoint Commerce Services Extensibility Kit contains two solution files. You must first open and build the file named Common.sln. Then repeat the steps with the solution file named SharePointCommon.sln.
If you are not working with the Web Business Tools Extensibility Kit, go to the next step. Otherwise, if you have opened the BusinessApplication.sln file that contains the source code for the Web Business Tools (Silverlight-based business management applications), copy the Microsoft.Commerce.Silverlight.dll file from %COMMERCE_SERVER_ROOT%\Assemblies to <unzip directory>\BusinessApplication\bin\Debug.
Build the solution. The build compiles the projects and generates Web solution package (WSP) files.
Note
Building the BusinessApplication.sln may generate cslcompliant warning messages. You can safely disregard these messages.
You can see the result of the compilation in the following location: <unzip directory>\<extensibility kit solution>\bin\Debug\WSP.