Web Request control

Enterprise Edition for Nintex Forms 2016 is required for this feature.

The Web Request control allows you to look up data using external web services. Use this control to populate form fields using data managed in business applications and cloud services. Call REST APIs by specifying the service URL, request method (GET or POST), and authentication type, or create SOAP envelopes using the POST method. 

Credentials must be stored in the SharePoint Secure Store service. You can test configuration using the Run Now dialog box.​

Example scenarios: 

  • Display a live weather feed using the Yahoo weather API.​
  • Display products for user selection and filter by specified location using an external web service.

This feature is not supported in Nintex Mobile.

SOAP envelopes

You can create a SOAP envelope within the request body, using the POST method. The referenced SOAP connections must be correctly encoded. 

Example configuration (Connection section):

​Selection Setting
Request Method POST
​Request Header
​Request Body ​<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'>
<soapenv:Body>
<GetListCollection xmlns='http://schemas.microsoft.com/sharepoint/soap/'></GetListCollection>
</soapenv:Body>
</soapenv:Envelope>
Content Type ​text/xml; charset="utf-8"

For information about SOAP syntax, see http://www.w3schools.com/webservices/ws_soap_syntax.asp.

Ribbon

The ribbon for the Web Service control displays the following buttons.

Run Now: Displays the Run Now dialog box. For more information, see Run Now dialog box.

Note: For information about the control properties tab in the Nintex Forms ribbon, see Control properties tab.

Control settings  

Following are the fields and options visible in the control settings dialog box for this form control.

Note: Several settings allow selection of Yes, No, or Expression. Selecting Expression allows you to construct a formula from reference tokens and functions. The expression must resolve to a Yes/No value at runtime to be valid. If the expression does not resolve to a Yes/No value, it will revert to the default.

Section Field Description

General

Name

The name of the control. The name is used for comparison validation and other control references.

 

Title

(Responsive Forms Designer only)

Title of the control. The title is displayed as the label for the control.

Yes

 

Description

(Responsive Forms Designer only)

Description of the control. The description displays additional information or instructions for the control.

Yes

  ID connected to

The column to which to bind the XPath for value field. For more information, see Connect controls to fields.

Note: The selected column must be within the current list and must be of the type “Single line of text.”

Note: When Label or Text is selected for Display format, this field can only bind to XPath for display; XPath for value cannot be bound.

 

Text connected to

​The column to which to bind the XPath for display field. For more information, see Connect controls to fields.

Note: The selected column must be within the current list and must be of the type “Single line of text.” ​

 

Display format

The type of control to display. Select one of the following options. 

  • Check boxes (multiple selection)
  • Drop down list
  • Label
  • Option buttons
  • Text

Default value: Drop down list

 

Service URL

​Path to REST or SOAP service. Example: http://sales.crestan.com:8084/ProductService.svc/web/products

Note: You can insert references to named controls. For example, the form might have a named control for specifying the service URL to use for the call. Inserted references are formatted as red underlined font.

 

Request method

Select an option.

  • GET
  • POST
 

Timeout (seconds)

Period of time to attempt sending the request.

Note: The request is not executed if the value is 0.

Default value: 10.

 

Request body

​(This field is displayed when POST is selected for Request method.)

 

Content type

​Specify the body type. Example: text/xml; charset="utf-8"

​(This field is displayed when POST is selected for Request method.)

 

Authentication type

Select an option.

  • Anonymous: No credentials required.
  • Basic authentication: Credentials required.

  • Windows authentication: Credentials required. 

 

Secure Store target application ID

Enter the target application ID stored in SharePoint Secure Store Service containing credentials for the service. The Secure Store Service must be in the default application proxy group. To view the proxy group for the service, use the Service Application Associations page in Central Administration. For more information about Secure Store Service on SharePoint, see the Microsoft article Configure the Secure Store Service in SharePoint 2013.

(This field is displayed when the value selected for Authentication Type is something other than Anonymous.) 

 

XPath for value

Value element for the XPath expression of the request. Example: //ID

For information about XPath syntax, see http://www.w3schools.com/xpath/xpath_syntax.asp.

(This field is displayed when Drop down list is selected for Display format.)

Note: Items lacking value or display are ignored.

 

XPath for display

Display element for the XPath expression of the request. Example 1: //Name Example 2: //*[name() ='List']/@Title

For information about XPath syntax, see http://www.w3schools.com/xpath/xpath_syntax.asp​.

​(This field is displayed when Drop down list is selected for Display format.)

Note: Items lacking value or display are ignored.

 

Execute in new mode

Default: Yes.

 

Execute in edit mode

Default: Yes.

 

Execute in view mode

Default: No.

Appearance

Visible

Hide or show the control at runtime.

 

Enabled

​Enable the control to receive user input at run time.

 

Use custom "Please select" text

Specify whether or not to use custom "Please select" text.

​(This field is displayed when Drop down list is selected for Display format.)

Filtering

Filter available selections

​Select one of the following options. 

  • Display all items: Do not filter selections.

  • By a specified value: Filter selections by the specified value.
    Use this option to dynamically change the contents of the control. For example, you can filter the list of product names returned from the request to a specific location by inserting a reference to a named control on the form that is used to specify the location. 

 

XPath for Where field

XPath expression for the field in the source list to apply the filter to.​

For example, you might specify an XPath expression for a field that lists product names: //ProductName 

 

Filtered by value

​The value to filter selections by.

Note: You can insert references to named controls. ​Inserted references are formatted as red underlined font. 

For example, you might insert a reference to a named control on the form that is used to specify the location. 

Formatting

(Classic Forms Designer only)

Control CSS class

The CSS class to apply to the inner elements of the control.

 

CSS class

The CSS class to apply to the control. This is used to apply advanced styling options. The Custom CSS class is defined in Form Settings (refer to Form and Layout settings).

 

Border

​Draws a line along the select border of the control.

 

Border Style

The style of the border.

 

Border Width (Pixels)

​The width of the border in pixels.

 

Border Color

The color of the border. This can either be a HEX code or a named color that is supported by html.

 

Padding Width (Pixels)

The amount of padding in pixels that will appear between the top, left and right border and the inner control.

Validation

Required

The form will not submit unless this control is completed correctly.

 

Required error message

Text to display if the control is not completed correctly.

(This field is displayed when Yes is selected for Required.)

 

Use custom validation

Enables custom JavaScript validation for the control.

Note:  Custom JavaScript is available in the Classic Forms Designer only.

 

Custom validation function

Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings.

​(This field is displayed when Yes is selected for Use custom validation.)

Note:  Custom JavaScript is available in the Classic Forms Designer only.

 

Custom error message

The error message to display when an invalid value is entered. ​

​​(This field is displayed when Yes is selected for Use custom validation.)

Advanced

Custom headers

(Optional.) ​Headers for the request, as name/value pairs. For examples of header values, see "Supported headers" below.

Click Add to specify a header.

Note: When specifying values, you can insert references to named controls.

 

Help text

Text that will be displayed to the user as a tooltip to guide the completion of the form.

 

Control Mode

​Force control to be in Edit mode, Display mode, or set to Auto.

 

Confirm value in connected column

When enabled, displays a warning on form submission if bound column values were updated outside Nintex Forms.

Note: Columns are bound to the control via the fields ID connected to ​and Text connected to. An example scenario for display of this warning is updating the value of the "Department" column for the related list item using SharePoint and then attempting to submit the form for that list item where the form control is bound to the "Department" column.

 

Store Client ID in JavaScript variable

A JavaScript Variable will be created that references the Client ID of this control.

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.

Note:  Custom JavaScript is available in the Classic Forms Designer only.

 

Resize at runtime

Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.

Supported headers

This section lists supported and unsupported headers for use in the Custom headers field. Examples are provided for supported headers.

Examples of supported headers

Accept-Charset: utf-8

Accept-Datetime: Thu, 31 May 2007 20:35:00 GMT

Accept-Encoding: gzip, deflate

Accept-Language: en-US

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Cache-Control: no-cache

Cookie: $Version=1; Skin=new;

DNT: 1

From: user@example.com

Front-End-Https: on

If-Match: "737060cd8c284d8af7ad3082f209582d"

If-None-Match: "737060cd8c284d8af7ad3082f209582d"

If-Range: "737060cd8c284d8af7ad3082f209582d"

If-Unmodified-Since: Sat, 29 Oct 2014 19:43:31 GMT

Keep-Alive: 300

Max-Forwards: 10

Origin: http://www.example-social-network.com

Pragma: no-cache

Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

TE: trailers, deflate

Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11

Via: 1.0 fred, 1.1 example.com (Apache/1.1)

Warning: 199 Miscellaneous warning

X-Att-Deviceid: GT-P7320/P7320XXLPG

X-Csrf-Token: i8XNjC4b8KVok4uw5RftR38Wgp2BFwql

X-Forwarded-For: client1, proxy1, proxy2

X-Forwarded-Host: en.wikipedia.org

X-Forwarded-Proto: https

X-HTTP-Method-Override: DELETE

X-Requested-With: XMLHttpRequest

X-wap-profile: http://wap.samsungmobile.com/uaprof/SGH-I777.xml

Ignored headers (see parenthetical comments)​

Accept: application/xml (default)

Connection: keep-alive

Content-Length: 348 (value is based on length of content)

Content-Type: application/xml (this value is set in the Content type field)

Date: Tue, 15 Nov 2014 08:12:31 GMT (default to system time)

Expect: 100-continue

Host: en.wikipedia.org:80 (extracted from url)

If-Modified-Since: Sat, 29 Oct 2014 19:43:31 GMT

Proxy-Connection: keep-alive

Range: bytes=500-999

Referer: http://en.wikipedia.org/wiki/Main_Page

User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0

Related Topics

Forms designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Shortcut keys
Inserting reference fields
Control Properties Ribbon