Legacy platform

Implementation

The following section describes the configuration for the clienteling feature.
  • The store associate must have the following resource permissions:
    • Customer Profile: To view the Look up Customer portlet.
    • Show Product Recommendations: To view the Recommendations tab.
    • Show Last Viewed Products: To view the Interested Products tab.
    • Show Product Keywords Searched: To view the product search keywords in the Recently Viewed tab.
    • Show Customer’s Wishlist: To view the Wish List tab.
    • Show Customer’s Open Carts from Other channels: To view the Open Carts tab.
    For more information, see Administering user group permissions.
  • Configure the customer membership levels appropriately. For more information, see Configuring customer level.
  • Set up the following rules and services appropriately in the Sterling Business Center application.
    • Select either Recommended Products or Interested Products, depending on which tab should be displayed by default, when the Customer Profile screen loads.
    • Service to be executed for fetching recommended products
    • Number of recommended products to be shown in UI
    • Service to be executed for fetching last viewed products
    • Number of last viewed products to be shown in UI
    • Service to be executed for fetching products of keyword search
    • Number of products from keyword search to be shown in UI
    • Service to be executed for fetching customer's wish list
    • Number of wish list products to be shown in UI
    • Service to be executed to display online cart products in store
    • Service to be executed to notify the online channel about products added to store cart
    For more information, see Setting up clienteling rules.
  • The YCD_ProductDetails_Email service uses the StoreProductDetailsEmail_17_1_multiApi.xsl.sample and StoreProductDetailsEmail_GenerateData_17_1_multiApi.xsl.sample templates.
    Configure the YCD_ProductDetails_Email service for your email-server in the Applications Manager using the following steps:
    • Navigate to the email service using the following path in the Applications Manager: Applications > Application Platform > Process Modeling
    • Open the Order Fulfillment process type.
    • Select Service Definitions > Store > YCD_ProductDetails_Email
    In the E-mail component, set the E-mail Server field to point to your mail server. The Subject and From fields have certain default values as part of the service, which can be customized as required.
Implementing services to fetch product recommendations
  1. If you plan to implement a service to display product recommendations on the UI, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed for fetching recommended products
  2. Create a service in the Service Definition Framework. For example, getRecommendedItemList<external_service_name>.
  3. Ensure that the external service is implemented to take input in the following format:
    <Recommendations SellerOrganizationCode=""
    CallingOrganizationCode="" EnterpriseCode="" MaximumRecords="">
    <ItemList>
    <Item ItemID="" UnitOfMeasure="" OrganizationCode=""></Item>
    </ItemList>
    <Customer CustomerID="" CustomerKey="" OrganizationCode="">
    </Customer>
    </Recommendations> 

    The MaximumRecords attribute takes its value from the Number of recommended products to be shown in UI rule. The external service should limit the records returned to the application based on the value of this attribute.

  4. Ensure that the external service returns the output in the following format so that the product recommendations are displayed appropriately:
    <RecommendedItemList TotalItemList="" TotalNumberOfRecords="">
        <Item ItemID="" UnitOfMeasure="" OrganizationCode=""/>
    </RecommendedItemList>

A sample service YCD_StoreGetRecommendedItemListFromAssociation is provided out of the box, which provides recommendations based on product associations configured for a product.

Implementing services to fetch last viewed products
  1. If you plan to implement a service to display the last viewed products on the UI, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed for fetching last viewed products
  2. Create a service in Service Definition Framework. For example, getLastViewedItemList<external_service_name>.
  3. Ensure that the external service is implemented to take input in the following format:
    <LastViewed SellerOrganizationCode="" CallingOrganizationCode=""
    EnterpriseCode="" DisplayLocalizedFieldInLocale=""
    MaximumRecords="">
    <Customer CustomerID="" CustomerKey="">
    </Customer>
    </LastViewed>
  4. Ensure that the external service returns the output in the following format so that the last viewed products are displayed appropriately.
    <LastViewedItemList TotalItemList="" TotalNumberOfRecords="">
    <Item ItemID="" UnitOfMeasure="" OrganizationCode=""/>
    </LastViewedItemList>
Implementing a service to load Open Carts
  1. If you plan to implement a service to display online cart products in store, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed to display online cart products in store
  2. Create a service in Service Definition Framework. For example, getCartListForCustomer<external_service_name>
  3. Ensure that the external service is implemented to take input in the following format:
    <CartList SellerOrganizationCode=""  EnterpriseCode="" 
    CallingOrganizationCode="" DisplayLocalizedFieldInLocale=""  MaximumRecords="">
        <Customer CustomerID="" CustomerKey="" OrganizationCode="">
        </Customer>
    </CartList>
    
  4. Ensure that the external service returns the output in the following format so that the online cart products are displayed appropriately.
    <CartList TotalNumberOfRecords="">
        <Cart EnterpriseCode="" CartID="" CartDate="" TotalAmount="" Currency="">
                <ItemList TotalNumberOfRecords="">
                    <Item ItemID="" UnitOfMeasure="" OrganizationCode="" CartDeiveryMethod="" 
                       ShipNode="" OrderedQuantity="" ProductClass=""/>
                </ItemList>
        </Cart>
    </CartList>
Where,
CartID: The cart identifier in the online channel.
TotalAmount: The order total in the online channel.
Currency: Currency of the online channel.
OrderedQuantity: Quantity of the item in the cart.
CartDeliveryMethod: Delivery method of the item in the cart.
Implementing a service to fetch Keywords
  1. If you plan to implement a service to display online search keywords in store, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed for fetching products of keyword search
  2. Create a service in the Service Definition Framework. For example, YCD_StoreGetItemSearchKeywordList<external_service_name>
  3. Ensure that the external service is implemented to take input in the following format:
    <SearchTerm SellerOrganizationCode="" CallingOrganizationCode="" EnterpriseCode="" MaximumRecords="">
    	<Customer CustomerID="" CustomerKey=""/>
    	<OrderBy>
    	  <Attribute Name="Createts" DESC="Y"/>
    	</OrderBy>
    </SearchTerm>
  4. Ensure that the external service returns the output in the following format so that the keywords are displayed appropriately.
    <SearchTermList TotalNumberOfRecords="">
    	<SearchTerm Value="" TotalHits="" Createts="" EnterpriseCode="">
    		<Customer CustomerKey=""/>
    	</SearchTerm>
     </SearchTermList>
    
Implementing a service to load Wish List
  1. If you plan to implement a service to display customer's online wish list, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed for fetching customer's wish list
  2. Create a service in Service Definition Framework. For example, YCD_StoreGetWishList<external_service_name>
  3. Ensure that the external service is implemented to take input in the following format:
     <WishList SellerOrganizationCode="" EnterpriseCode="" CallingOrganizationCode=""
    	 DisplayLocalizedFieldInLocale=""  MaximumRecords="">
                <Customer CustomerID="" CustomerKey="" OrganizationCode="">
                </Customer>
      </WishList>
    
  4. Ensure that the external service returns the output in the following format so that the wish list is displayed appropriately.
    <WishList TotalItemList="" TotalNumberOfRecords="">
     <Item ItemID="" UnitOfMeasure="" OrganizationCode=""/>
    </WishList>
Implementing a service to Notify Cart Status
  1. If you plan to implement a service to notify the cart status to the online channel, ensure that the following rule in the Sterling Business Center is updated with the appropriate external service name.
    Service to be executed to notify the online channel about products added to store cart
  2. Create a service in Service Definition Framework. For example, notifyCartStatus<external_service_name>
  3. Ensure that the external service is implemented to take input in the following format:
    <CartStatus SellerOrganizationCode="" CallingOrganizationCode="" EnterpriseCode="" CartId="">
          <ItemList TotalNumberOfRecords="">
            <Item ItemID="" UnitOfMeasure="" OrganizationCode="" OrderedQuantity="" 
             ProductClass="" CartDeiveryMethod="" ShipNode=""/>
          </ItemList>
    </CartStatus>
  4. Ensure that the external service returns the output in the following format so that the cart status is notified appropriately.
    <CartStatus/>

For more information about service definitions, see Defining service definitions.