Loading...

CRM Add Edit Grid View

Properties Related

Widget Type:
Page Widgets
TPC Version:
  • 3.3 +
VideoLogos
The CRM Add Edit Grid View widget is a fully functional CRUD (Create, Read, Update, Delete) widget that allows you to retrieve a set of records, as well as add any new records, edit existing records, delete existing records, filter through your results, and export the grid as a spreadsheet (.xls). 

Configuration

Basic Setup

  1. From the Portal Connector widget list, click and drag the CRM Add Edit Grid View widget into the body of your page.
  2. In order for the widget to function properly, there are a few options that need to be configured. Click on the edit button to display the prompt. It should look like this:

    Add Edit Grid Basic Properties

Data 

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

Add Edit Grid Data Properties

Filters

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

Add Edit Grid Filters Properties 

The Filters option will allow you to filter for specific data in the widget based on what records it is retrieving.

Columns

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

    Add Edit Grid Columns Properties

    The Columns tab allows you to define what data fields will appear in the widget. It works alongside FetchXML to define new columns for your widget.

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

Widget Properties

Basic Properties

Form Custom Error Format

The Form Custom Error Format advanced property accepts a string which can be used to specify how an exception appears. This text field accepts a string format of {0}, which is the exception thrown.

Form Show Custom Error

The Form Show Custom Error advanced property is a Boolean that when set to true will allow you to define a custom error format.

Form Show Error Summary

The Form Show Error Summary advanced property is a Boolean that when set to true, will show an error upon a failed form submission and will also prevent the page from being redirected.

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.

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

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.

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.

Edit Column Width

The Edit Column Width advanced property allows you to define a width for the edit column in pixels. The default value is 30px.

Delete Column Width

The Delete Column Width advanced property allows you to define a width for the delete column in pixels. The default value for this is 30px.

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.

Edit Redirect After Add

When set to true, the Edit Redirect After Add advanced property is used to redirect the user to an editing form after they have added a new record. The editing form can be determined from the Basic tab if the Allow Editing of Records checkbox is enabled.

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.

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.

Form Custom Error Format

The Form Custom Error Format advanced property accepts a string which can be used to specify how an exception appears. This text field accepts a string format of {0}, which is the exception thrown.

Form Show Custom Error

The Form Show Custom Error advanced property is a Boolean that when set to true will allow you to define a custom error format.

Form Show Error Summary

The Form Show Error Summary advanced property is a Boolean that when set to true, will show an error upon a failed form submission and will also prevent the page from being redirected.

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.

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

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.

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.

Edit Column Width

The Edit Column Width advanced property allows you to define a width for the edit column in pixels. The default value is 30px.

Delete Column Width

The Delete Column Width advanced property allows you to define a width for the delete column in pixels. The default value for this is 30px.

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.

Edit Redirect After Add

When set to true, the Edit Redirect After Add advanced property is used to redirect the user to an editing form after they have added a new record. The editing form can be determined from the Basic tab if the Allow Editing of Records checkbox is enabled.

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.

Examples of CRM Add Edit Grid View Configuration