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:
Form Widgets
TPC Version:
  • 6.0
Sub-List View allows you to retrieve CRM data and display it on a form using your own custom HTML template. To configure this widget, you'll need to have a basic understanding of HTML.

Configuration

Getting Started

To start, make sure you have added a TPC Form Layout to your form, with a TPC Form Configuration widget added and configured to an entity.

Then, drag and drop the Sub-List View widget from The Portal Connector tools into the body of your form, then click Edit to configure Sub-List View properties.

Basic

The Basic tab contains a number of options allowing you to determine user abilities for adding, editing and deleting records.

Data

The data tab is used for defining FetchXML, which will determine what records the Sub-List View will display. The Sub-List View inherits the configured entity from the Form Configuration widget, and the following options are used to determine what related data will be included.

Records - Select Only Related Records (to the configured entity) or All Record Types.
Relationship 
Build - Opens the TPC FetchXML builder. Add attributes that you want to display, as well as Linked-Entities and Filters. For more information, see the How To's section at the bottom of this page.

Filters

The Filters option allows you to filter the data that is retrieved for the grid.

Columns

The Columns tab provides options to Add Column, edit the Column Type, Name, or Header, or even Format HTML for the column. For example, a column displaying email addresses could be formatted as clickable "mailto:" links.

Widget Properties

Basic Properties

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget

Hidden

The Hidden checkbox will hide the widget from the page when checked.

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

Allow Exporting Records

The Allow Exporting Records checkbox allows you to export and download the entirety of a CRM Entity in spreadsheet (.xls) format. Please note that this spreadsheet will include all selected data fields as per the BuildXML even if they don't physically appear on the widget.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Adding Records

The Allow Adding Records checkbox allows users to add records to theCRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.

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.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget

Hidden

The Hidden checkbox will hide the widget from the page when checked.

FetchXML

The FetchXML text area determines what sort of data a widget will be populated with. Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen.  By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function, please see the FetchXML Builder How-To.

Allow Exporting Records

The Allow Exporting Records checkbox allows you to export and download the entirety of a CRM Entity in spreadsheet (.xls) format. Please note that this spreadsheet will include all selected data fields as per the BuildXML even if they don't physically appear on the widget.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Adding Records

The Allow Adding Records checkbox allows users to add records to theCRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.