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.
Widget Type:
Form Widgets
TPC Version:
  • 4.0
querystringlogo
The Query String widget reads in a query string parameter from the URL and save its corresponding value to a chosen field on the form.

Configuration

Basic

CRM Form Configuration and a TPC Form Layout already attached and configured. This would reveal the Attributes available to the Entity Selected in the Form Configuration. 

Drag and drop the Query String widget from The Portal Connector tools into the body of your form and click edit to display the properties prompt.

The QueryString textfield is used to define a parameter for the widget to look up in the URL.
The Attribute dropdown list allows you to select an attribute for the widget to submit data to. This will save the value of the query string to the selected field.


query-string-instruction-1

Widget Properties

Basic Properties

Querystring

The Querystring textfield looks for the specified parameter in the URL string. For example, if our link happened to be: 

http://forum.com?forumName=Technology 

and our Querystring was forumName, the value that would be read into the CRM Querystring widget would be Technology. 

The value 'Technology' will then be saved into the selected Attribute.

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

AlwaysSubmit

By default this widget will not submit unless there are other dirty fields submitting on the form. This property ensures the widget always submits it's data to Dynamics CRM

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

The Querystring textfield looks for the specified parameter in the URL string. For example, if our link happened to be: 

http://forum.com?forumName=Technology 

and our Querystring was forumName, the value that would be read into the CRM Querystring widget would be Technology. 

The value 'Technology' will then be saved into the selected Attribute.

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

AlwaysSubmit

By default this widget will not submit unless there are other dirty fields submitting on the form. This property ensures the widget always submits it's data to Dynamics CRM

API

get_input()

Returns the input element of the widget.

Returns

JQuery Object

enable()

Enable the widget on the page.

Returns

None

get_element()

Returns the element of the widget.

Returns

JQuery Object

disable()

Disable the widget on the page.

Returns

None

get_model()

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

Returns

Object

get_type()

Returns the widget type.

Returns

String

get_value()

Returns the value of the widget.

Returns

String if text attribute.
Integer or Decimal if Numeric attribute.

get_container()

Returns the container element of the widget.

Returns

JQuery Object