Loading...

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.

CRM Filtered View

Properties Related
Widget Type:
Page Widgets
TPC Version:
  • 3.3 +
VideoLogos
The CRM Filtered View widget is a grid widget that will retrieve specified records. In addition, it also allows you to attach a form from which you can use to look up a specific record. 

Configuration

Basic Settings

  1. From the Portal Connector widget list, click and drag the CRM Filtered View into the body of your page.

  2. In order for the widget to function properly, there are a variety of options to be configured. Click on the edit button to display the prompt. It should look like this:

    Filtered View Basic Settings

Data

When you are finished configuring the Basic settings of the widget, click on the Data tab. It should look like this:

Filtered View Data Settings

 

Filter Form 

When you are finished configuring the Data settings, click on the Filter Form tab. It should look like this: 

Filtered View Filter Form Settings

The Filter Form settings will allow you to choose a published form that you can use to look up a specific record.


 

Filters

When you are finished configuring the Filter Form settings, click on the Filters tab. It should look like this: 

Filtered View Filters Settings 

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


When you are finished configuring the widget, click on the save button to save it.

Widget Properties

Basic Properties

Frozen Columns

The Frozen Columns advanced property accepts a column number disregarding the Edit and Delete columns and will not allow the affected columns to move when the user scrolls left or right. For example, we have four columns in a Grid View widget of sorts. If we were to set the Frozen Columns property to two (2), the second column to the fourth column will not be affected by scrolling while all others to the left (Just column one in the example) will be affected by scrolling.

Append Current URL

When set to true, the Append Current URL advanced property will add the current URL to a querystring so that the user is redirected back to the current page after they complete the form.

UseUnencryptedGuids

The UseUnencryptedGuids advanced property will decrypt any query string values that are passed through the URL. If a widget has been set to pass a query-string to another widget, the Use Unencrypted Guids properties must match each other or the widgets will be unable to communicate with each other.

Column Definition Default Width

The Column Definition Default Width advanced property will allow you to set the default width of a column in pixels to be used when there isn't a width defined. By default this is set to null. Please note that a value of zero (0) or null will represent automatically sized columns.

Hide Grid on Load

When set to true, the Hide Grid on Load advanced property will hide the Filtered Grid on page load until the user submits the filter form. By default, it is set to false.

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.

CRM Entity

A CRM Entity is a collection of fields related to a topic. For example, a CRM Entity of Contacts would have fields like: Contact Name, Telephone Number, Address, etc. CRM Entity will allow you to save a successful form submission to a particular entity. Depending on the widget and CRM Entity chosen.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

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 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 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.

Frozen Columns

The Frozen Columns advanced property accepts a column number disregarding the Edit and Delete columns and will not allow the affected columns to move when the user scrolls left or right. For example, we have four columns in a Grid View widget of sorts. If we were to set the Frozen Columns property to two (2), the second column to the fourth column will not be affected by scrolling while all others to the left (Just column one in the example) will be affected by scrolling.

Append Current URL

When set to true, the Append Current URL advanced property will add the current URL to a querystring so that the user is redirected back to the current page after they complete the form.

UseUnencryptedGuids

The UseUnencryptedGuids advanced property will decrypt any query string values that are passed through the URL. If a widget has been set to pass a query-string to another widget, the Use Unencrypted Guids properties must match each other or the widgets will be unable to communicate with each other.

Column Definition Default Width

The Column Definition Default Width advanced property will allow you to set the default width of a column in pixels to be used when there isn't a width defined. By default this is set to null. Please note that a value of zero (0) or null will represent automatically sized columns.

Hide Grid on Load

When set to true, the Hide Grid on Load advanced property will hide the Filtered Grid on page load until the user submits the filter form. By default, it is set to false.

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.

CRM Entity

A CRM Entity is a collection of fields related to a topic. For example, a CRM Entity of Contacts would have fields like: Contact Name, Telephone Number, Address, etc. CRM Entity will allow you to save a successful form submission to a particular entity. Depending on the widget and CRM Entity chosen.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

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 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 widget will use to add records.

Related examples of CRM Filtered View Configuration