Integrating the Cross-Sell/Up-Sell Relationship Manager

The Cross-Sell/Up-Sell Relationship Manager is a Silverlight control. This feature allows you to create cross-sell and up-sell relationships between products and categories.

Integrating the Cross-Sell/Up-Sell Relationship Manager

Html environment

The Cross-Sell/Up-Sell Relationship Manager requires certain Silverlight initialization parameters and JavaScript functions. The initialization parameters can be passed directly to the component by using the "InitParams" property on the Silverlight component. If the InitParams does not specify a value, the Cross-Sell/Up-Sell Relationship Manager calls the function MSCS_GetParameter.

Script functions

The Cross-Sell/Up-Sell Relationship Manager depends on the following script functions. These should be added, either directly or via script tag link (using the "src" attribute) on any page that uses the Cross-Sell/Up-Sell Relationship Manager.

Parameters used with MSCS_GetParameter

The following table contains the parameter names and a description of the values returned by the MSCS_GetParameter function.

Integration with the Business Administration Ribbon

To integrate the Cross-Sell/Up-Sell Relationship Manager with the Commerce Server Business Administration Ribbon, a configuration file must be created and must be referenced in the Commerce Server Business Administration Ribbon configuration.

To integrate the Cross Sell/Up Sell Relationship Manager with the Business Administration Ribbon

1. Create a configuration file called "MicrosoftCommerceCatalogItemRelationship.xml" that contains the following code:

   <?xml version="1.0" encoding="utf-8" ?>
   <Plugin>
     <Context>CatalogRelationship</Context>
   <ControlName>Microsoft.Commerce.BusinessManagement.CatalogItemRelationships.Controls.PlugIn</ControlName>
     <Assembly>Microsoft.Commerce.BusinessManagement.CatalogItemRelationships.Application.dll</Assembly>
     <Xap>MicrosoftCommerceCatalogItemRelationship.xap</Xap>
   </Plugin>
   

2. Create a server-side resources file called MicrosoftCommerceCatalogItemRelationshipResources.xaml. If you are using the Solution Storefront catalog definition, the following code is used. If your site uses different properties, you may need to alter this file as well as the UI template for the CatalogItemDisplay control:

   <ResourceDictionary
   xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation" 
   xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
     xmlns:sys="clr-namespace:System;assembly=mscorlib"
   xmlns:mCore="clr-namespace:Microsoft.Commerce.BusinessManagement;assembly=Microsoft.Commerce.BusinessManagement"
   >
   
       <mCore:StringCollection x:Key="RelationshipSearchPropertiesToReturn">
           <sys:String>DisplayName</sys:String>
           <sys:String>Image_filename</sys:String>
           <sys:String>ListPrice</sys:String>
           <sys:String>Name</sys:String>
           <sys:String>ProductCode</sys:String>
           <sys:String>Description</sys:String>
       </mCore:StringCollection>
   
   </ResourceDictionary>Copy these three files to the virtual directory of the business user web application: c:\inetpub\wwwroot\wss\virtualdirectories\[port of the business user web application or host header]
   

MicrosoftCommerceCatalogItemRelationship.xap

MicrosoftCommerceCatalogItemRelationship.xml

MicrosoftCommerceCatalogItemRelationshipResources.xaml

1. Edit the MSCS_GetParameter function in the CommerceManagement.js file to return values for the following three parameter keys: Catalog, CatalogItemType and CatalogItemId. Your site should be prepared to make these values available in the Html mark-up, so that when the Silverlight application calls the script function, the latter is able to produce a value. Note that expecting values to be in the URL(for example, query-string parameters ) may not be sufficient if that information cannot be guaranteed to always be present.

2. Edit the Commerce Server Business Administration Ribbon configuration file (Toolbar.xml) to add the Cross-Sell/Up-Sell Relationship Manager to its display. To edit the Commerce Server Business Administration Ribbon configuration file, find the TabItem in which you wish this module to display, and add the following:

   <controls:ToolBarModule ConfigFile="MicrosoftCommerceCatalogItemRelationship.xml" >
             <controls:ToolBarModule.InitResources>
               <ResourceDictionary>
                 <sys:String x:Key="RelationshipToEdit">CrossSells</sys:String>
                 <sys:String x:Key="OnClick">FloatSilverlight("CrossSellEditSilverlight", "/ClientBin/MicrosoftCommerceCatalogItemRelationship.xap", "CatalogItemRelationshipToEdit=CrossSells,ChannelName=,ResourceFileUris=CsManagementResources.xml MicrosoftCommerceCatalogItemRelationshipResources.xml", 10, 10, 800, 618, 800, 618, true, "App.RequestClose()")</sys:String>
                 <mCore:LocalizedValueDictionary x:Key="Label">
                   <sys:String x:Key="en-US">Cross-sell</sys:String>
                   <sys:String x:Key="en-CA">Cross-sell</sys:String>
                 </mCore:LocalizedValueDictionary>
                 <sys:String x:Key="LabelColor">Black</sys:String>
               </ResourceDictionary>
             </controls:ToolBarModule.InitResources>
           </controls:ToolBarModule>
   

Troubleshooting

The following table describes error messages and directions on how to fix the errors. If the error is not due to connectivity, the details of the error will be reported to the server by the logging system.

See Also

Other Resources

Silverlight Business Administration Tools Integration