Loading...

CRM QueryString

Properties API

Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
querystringlogo
The CRM QueryString widget accepts a specified querystring parameter, allowing you to automatically fill a field by its value that is passed through the URL. The widget does not physically appear in the form but instead provides additional functionality.

Configuration

Basic Setup

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

  2. There are a few options that must be configured in order for the widget to function properly. Click on the edit button to display the prompt. It should look like this: 

    Query String Properties

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

 

Regarding the 'Regarding' Option

The CRM Query String widget is also capable of using the Regarding option which allows you to link the form submission to another CRM Entity. The Regarding option is only available to Activities. For example, the CRM Entity of Email makes use of the regarding option which allows email records (Or email logs) to be attached to other entites such as Accounts and Contacts. When the Regarding option is selected from the Target CRM Field, the prompt should resemble this:

CRM Query String Regarding

Widget Properties

Basic Properties

Querystring Key

The Querystring Key text box looks for the associated identifier and value in the URL string. For example, if our link happened to be: http://forum.com?forumName=Technology and our Querystring Key was forumName, the value that would be read into the CRM Querystring widget would be Technology. The value 'Technology' would then be saved into whatever the Target CRM Field is.

Target CRM Field

The Target CRM Field drop down list allows you to save the value to a particular data field. For example, if our link happened to be http://forum.com?forumName=Technology and our Target CRM Field was a textbox with a CRM Attribute of Forum Name; a Querystring Key of forumName would automatically fill out the Forum Name text box; in this case the forum name would be 'Technology'.

Ignore Empty Query Value

The Ignore Empty Query Value advanced property is used to affect the CRM Query String widget in the event of a missing query string. If set to true, the CRM Query String widget will be disabled if the parameter and value that it's set to work with are not in the query string. Please note that a query value will not be considered to be empty if the parameter is present in the URL string (Even without a corresponding value, ie: www.site.com?parameter= ).

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.

Querystring Key

The Querystring Key text box looks for the associated identifier and value in the URL string. For example, if our link happened to be: http://forum.com?forumName=Technology and our Querystring Key was forumName, the value that would be read into the CRM Querystring widget would be Technology. The value 'Technology' would then be saved into whatever the Target CRM Field is.

Target CRM Field

The Target CRM Field drop down list allows you to save the value to a particular data field. For example, if our link happened to be http://forum.com?forumName=Technology and our Target CRM Field was a textbox with a CRM Attribute of Forum Name; a Querystring Key of forumName would automatically fill out the Forum Name text box; in this case the forum name would be 'Technology'.

Ignore Empty Query Value

The Ignore Empty Query Value advanced property is used to affect the CRM Query String widget in the event of a missing query string. If set to true, the CRM Query String widget will be disabled if the parameter and value that it's set to work with are not in the query string. Please note that a query value will not be considered to be empty if the parameter is present in the URL string (Even without a corresponding value, ie: www.site.com?parameter= ).

API

get_dataFieldName()

Returns developer name for the control.

Returns

String

Full API With Examples

How to's

Examples of CRM QueryString Configuration