RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.
Widget Type:
Page Widgets
TPC Version:
  • 6.2
product-list

The Product List widget allows Portal users to see the Products they have in their CRM under the Productpricelevel entity that is presented either as a list view or cards on the frontend of the Portal site. Portal Administrators can set a Price List Id for any user.  Text BoxGraphical user interface, text, application, email Description automatically generatedFIGURE 1: LIST VIEW PRESENTATION OF PRODUCTS 

Graphical user interface, logo, company name Description automatically generated

FIGURE 2: CARDS VIEW PRESENTATION OF PRODUCTS 

To configure the widget, drag and drop the Product List widget into your page body and click the edit. This should open the widget designer and show the Basic tab view. 

Configuration

Basic

  • Configure the redirect to the Product Details Page
  •  Set a Default Image for your product
  • Enable hide and show options to sort your product list or to display paging

Graphical user interface, text, application, email Description automatically generated

Product Filters

In the Product Filters tab, you can configure the Products List such that it filters either by Product Family or Subject.

Graphical user interface, text, application Description automatically generated

Data

In the Data tab, the widget has a default FetchXml to get the ProductPriceLevel items, but in case you need additional information, you can customize the FetchXML to your needs like our Grid widget. If you change the default FetchXML, you will also need to adjust your template as well since the data retrieved will be different.

Graphical user interface, text, application Description automatically generated


Be aware that the FetchXML shown in the widget designer is not the complete fetch query sent to CRM. Internally, the widget also adds more information for our default template. 

Filters

Like the TPC Grid widget, users can filter the Product List by static types, a session, query string, etc.

Graphical user interface, application Description automatically generated 

Widget Properties

Basic Properties

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

API

get_productListSorter()

Returns the product list sort dropdown select tag.

Returns

jQuery object 

get_container()

Returns the div container of the widget.

Returns

jQuery Object

get_productViewSwitcher()

Returns the product view switcher ul tag. 

Returns

jQuery Object

get_errorTemplate()

Returns the kendo template for the error element of the widget.

Returns

jQuery object

hide()

Hides the widget from the form.

Returns

None

get_type()

Returns the type of widget it is. Can be used in conjunction with findAll().

Returns

String

get_productListview()

Returns information related to the product list.

Returns

Object

get_errorContainer()

Returns the error containing div. 

Returns

jQuery Object

get_element()

Returns the div containing the product list view.

Returns

jQuery Object

show()

Shows the widget on the form.

Returns

None

toggle()

Toggles the visibility of the widget.

Returns

None

get_model()

Returns the configuration information of the widget.

Returns

Object