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.

Form Configuration

Properties API Related
Widget Type:
Form Widgets
TPC Version:
  • 4.0 +
VideoLogo-form

The  Form Configuration widget is used to group form widgets by connecting them to the same CRM Entity. The Form Configuration requires Form Layout. 

This should be the first widget to be configured on the Form. 

Configuration

Form Layout

From the main form design page, click the Layout button, located to the right of the Content button. Click and drag a pink TPC Form Layout into the body of your form. Without a TPC Form Layout, the Form Configuration and any other accompanying widgets will not work properly.

Once you have the Layout, drag and drop the Form Configuration on to the Layout.

form-config-1
Select any CRM Entity that you'd like. The entity must be published under the CRM Entities section in the Sitefinity backend.

Select the Populate Using or leave as Default. This determines how a form will populate records. Applicable options include using the current logged-in contact id, the current logged-in parent customer id, or a custom querystring parameter.

Click Save. You are now ready to configure form widgets.
 
form-config-2

Widget Properties

Basic Properties

LogicalName

This property hold the entity logical name to the current selected entity.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

Parent Customer ID

The Parent Customer ID will override any ID that is submitted through the form and will instead use the logged in user's Parent Customer ID to populate the form. If the user doesn't have an Account, the form will not load any records.

Custom Query String

The Custom Query String will override any ID that is submitted through the form and will instead use the provided custom query string to populate the form.

Contact ID

The Contact ID will override any ID that is submitted through the form and will instead use the logged in user's Contact ID to populate the form. If the user doesn't have a Contact ID, the form will not load any records.

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.

SerializedEntityOptions

Available options to connect the Form to an Entity.

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.

LogicalName

This property hold the entity logical name to the current selected entity.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

Parent Customer ID

The Parent Customer ID will override any ID that is submitted through the form and will instead use the logged in user's Parent Customer ID to populate the form. If the user doesn't have an Account, the form will not load any records.

Custom Query String

The Custom Query String will override any ID that is submitted through the form and will instead use the provided custom query string to populate the form.

Contact ID

The Contact ID will override any ID that is submitted through the form and will instead use the logged in user's Contact ID to populate the form. If the user doesn't have a Contact ID, the form will not load any records.

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.

SerializedEntityOptions

Available options to connect the Form to an Entity.

API

get_logicalName()

Returns the logical name of widget that is currently set up.

Returns

String

get_recordId()

Returns the record ID of the widget.

Returns

String

get_container()

Returns the container element of the widget.

Returns

jQuery Object

get_type()

Returns the widget type.

Returns

String

get_model()

Returns the model object of the widget, which contains a number of useful properties related to the widget.

Returns

Object

get_value()

Returns the value of the widget.

Returns

String

Full API With Examples

Related examples of Form Configuration Configuration