Single Select Lookup > SharePoint > SharePoint Term Set

This topic shows how to create a lookup with SharePoint as a data source that uses metadata values for the Single Select Lookup form control.

Background and Setup

Examples

Prerequisites

Good to Know

How to Start

  1. On the Single Select Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Single Select Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select SharePoint.

    Select SharePoint
  3. Click Next.

SharePoint Type

Specifies the type of SharePoint lookup.

Figure: SharePoint Type screen

SharePoint Type screen

Good to Know

Fields

Field NameDefinition

SharePoint Type

Function:
Specifies the type of SharePoint lookup to create.
Accepted Values:
  • SharePoint Lookup - Creates a SharePoint lookup with a CAML query.
  • SharePoint Term Set Lookup - Creates a SharePoint lookup that uses metadata values.
Default Value:
SharePoint Lookup

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

Lookup Details screen

Fields

Field NameDefinition

Access Token

Function:
Specifies the access token that connects to your data source.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Add New Add New icon

Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

Lookup Name

Function:
Specifies the name you want to give to your lookup procedure.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Lookup Type

Function:
Specifies the Name/Value type for the lookup procedure.

The Single Select Lookup form control does not support Multiple Columns lookups. If you select the Multiple Columns, the configuration screen shows Name/Value lookup type.

Accepted Values:
Read only.
Default Value:
Name/Value

Configure Lookup > Taxonomy Fields tab

Configures a lookup with name/value pairs from SharePoint to get metadata values.

Figure: Configure Lookup Taxonomy Fields tab

Configure Lookup Taxonomy Fields tab

Fields

Field NameDefinition

Configuration Type

Function:
Specifies how selection works for the SharePoint taxonomy.
Accepted Values:
  • Select & Search - The user can search for a term to filter and select.
  • Select - The user can the select the term in the taxonomy.
Default Value:
Select & Search
Accepts Process Data Variables:
No

Find Term Sets that Include the following term

Function:
Specifies the name of term set to filter and search.
Accepted Values:
One line of text that can have spaces
Default Value:
None
Accepts Process Data Variables:
No

Filter

Function:
Filters what SharePoint shows with the specified term.

Clear

Function:
Clears the term in the Find Term Sets that include the following term.

Taxonomy

Function:
Specifies the SharePoint folder name from the list that has your metadata.
Accepted Values:
A SharePoint folder from the list.
Default Value:
None

Taxonomy Fields - Name

Function:
Specifies these Taxonomy field names in the selected SharePoint list:
  • TermID
  • TermName
  • TermDescription
Accepted Values:
Read only.

The values show when you complete the List Name field.

Accepts Process Data Variables:
Yes

Taxonomy Fields - Value

Function:
Specifies the value for the list field.
Accepted Values:
None.

When you add a field, this value shows the field name. Set the actual value.

Accepts Process Data Variables:
Yes

Configure Lookup > Error Messages tab

Configures the message to show if the lookup does not return any data..

Figure: Configure Lookup Error Messages tab

Configure Lookup Error Messages tab

Fields

Field NameDefinition

No Items Retrieved

Function:
Specifies the error message to show if the lookup does not return any data.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Lookup Failed

Function:
Specifies the message to show if the data fails to load.
Accepted Values:
More than one line of text.
Default Value:
Failed to load data.