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 Form Configuration

Properties API
Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
VideoLogo-form
The CRM Form Configuration widget is used to store a group of form widgets and determine what fields are available to the widgets based upon the chosen CRM Entity. Every form is required to have a CRM Form Layout and CRM Form Configuration.

Configuration

Basic Setup

  1. From the main form design page, click the Layout button, located to the right of the Content button.

  2. Click and drag a pink CRM Form Layout widget into the body of your page.

  3. Click on the Content button and open the Portal Connector collapsible tab, located just under the Common Controls tab. Please note that forms that use the CRM Form Configuration widget will only work with Portal Connector widgets.

  4. Click and drag a CRM Form Configuration widget into your CRM Form Layout. It should look like this: 

    Form Configuration Editor

  5. In order for the form to work properly, there are some settings that need to be configured. Click on the edit button to display the prompt, which should look like this:

     Form Configuration Basic Properties

ECommerce

  1. When you are finished configuring the basic settings for the widget, you may navigate to the ECommerce tab to configure it, which looks like this: 

    Form Configuration ECommerce Properties

  2. After you are finished configuring the CRM Form Configuration widget, click the save button to save it.

Widget Properties

Basic Properties

Use Logged in User Parent Customer ID

The Use Logged in User Parent Customer ID check box 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.

Use Logged in User Contact ID

The Use Logged in User Contact ID check box 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 - form-config

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, there will be a number of checkboxes below this. For example, selecting the CRM Entity 'Account' will give you a checkbox that reads: 'Use Logged in User Parent Customer Id'. This will use the User's Account Id to submit data.

SalesOrder Field

The Sales Order Field drop down list will allow you to select a field to be populated upon completion of the form.

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.

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.

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.

Use Logged in User Parent Customer ID

The Use Logged in User Parent Customer ID check box 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.

Use Logged in User Contact ID

The Use Logged in User Contact ID check box 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 - form-config

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, there will be a number of checkboxes below this. For example, selecting the CRM Entity 'Account' will give you a checkbox that reads: 'Use Logged in User Parent Customer Id'. This will use the User's Account Id to submit data.

SalesOrder Field

The Sales Order Field drop down list will allow you to select a field to be populated upon completion of the form.

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.

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.

API

get_dataFieldName()

Returns developer name for the control.

Returns

String

Full API With Examples

How to's

Related examples of CRM Form Configuration Configuration