Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
ratingfieldlogos
The CRM Rating Field is a widget that allows the user to choose from a number of stars that represent numbers, usually to rate a product. The widget only works with numeric fields.

Configuration

Basic Setup


  1. From the Portal Connector widget list, click and drag the CRM Rating Field into the body of the form.

  2. There are a few options that can be configured for the widget. Click on the edit button to display the properties prompt. It should look like this: 

    CRM Rating Field Properties

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

Widget Properties

Basic Properties

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.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Max # of Items

The Max # of Items text field allows you to set the amount of stars that will appear in a CRM Rating Field widget.

Selection Mode

This setting allows for fractional rating, four options are available:

Item – Undivided stars, you will only be allowed to select whole stars. Each star represents a whole number. Example 4 our of 5.

Half – Each star is divided into two. For example, this would allow 1.5 or 3.5 star rating.

Exact – Each star is divided into a hundred segments. The precision is down to a pixel. 

Custom – Allows for a Custom Precision. A star can be divided into as many as a hundred segments.

Zero is Null ~ rating

The Zero is Null advanced property will automatically treat all submitted values of zero as null. In other words, there will be no value inserted into the corresponding data field if the form is completed.

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.

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.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Max # of Items

The Max # of Items text field allows you to set the amount of stars that will appear in a CRM Rating Field widget.

Selection Mode

This setting allows for fractional rating, four options are available:

Item – Undivided stars, you will only be allowed to select whole stars. Each star represents a whole number. Example 4 our of 5.

Half – Each star is divided into two. For example, this would allow 1.5 or 3.5 star rating.

Exact – Each star is divided into a hundred segments. The precision is down to a pixel. 

Custom – Allows for a Custom Precision. A star can be divided into as many as a hundred segments.

Zero is Null ~ rating

The Zero is Null advanced property will automatically treat all submitted values of zero as null. In other words, there will be no value inserted into the corresponding data field if the form is completed.

API

get_radRating()

Returns the parent div of the rating field widget.   

Returns

HTML Element

get_dataFieldName()

Returns developer name for the control.  

Returns

String

get_value()

Returns the number that the rating field is currently set to. 

Returns

Number

set_value()

Sets the widget to a specified value, depending on configuration. 

Returns

set_value()

get_textValue()

Returns the string of the number that the widget is currently set to. 

Returns

String

set_textValue()

Sets the widget to a specified string value, which will be converted to an integer.

Returns

none

enable ()

Enables the control. 

Returns

none

disable()

Disables the control.

Returns

none