Retrieve List Item activity

An activity that gets list item field values to update your process variables.

Configure the Retrieve List Item activity

To configure the Retrieve List Item activity, do the procedure in this topic.

Examples

(Example) Create a SharePoint Access Token

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, and open the SharePoint tab.
On the SharePoint tab, drag the Retrieve List Item activity onto your process.

General Configuration

Specifies the basic settings for the Retrieve List Item activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Function: Specifies the activity name that shows in your process. Accepted Values: One line of text that can have spaces. 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.
Description	Function: Specifies an optional text description for your activity. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No

Field Name

Definition

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

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.

Description

Function:: Specifies an optional text description for your activity.
Accepted Values:: More than one line of text.
Default Value:: None
Accepts Process Data Variables:: No

Retrieve List Item Configuration > Configuration tab

Specifies how to retrieve list item field values to update your process data variables.

Fields

Field Name	Definition
SharePoint	Function: Specifies the access token that connects to your SharePoint site. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site	Function: Specifies the URL for your SharePoint site. Accepted Values: A valid SharePoint site URL. Default Value: None Accepts Process Data Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
List	Function: Specifies the name of your SharePoint list. Accepted Values: The name of your SharePoint list. Default Value: None Accepts Process Data Variables: Yes Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List
List Field Name	Function: Specifies the name of a SharePoint list column. Accepted Values: Read only. "ID", the list column that specifies the unique list item ID.
List Item Field Value	Function: Specifies the SharePoint list column's value. This value can be used as a filter to limit the scope of the action. Accepted Values: The list column's value. Default Value: None Accepts Process Data Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Retrieve List Item Configuration > SharePoint List tab

Specifies how to update process data variables with values from a SharePoint list.

Fields

Field Name	Definition
Display Name	Function: Specifies the name of the SharePoint library column. Accepted Values: Read only.
Internal Value	Function: Specifies the value of the SharePoint list column. Accepted Values: Read only.
Field Display Name	Function: Specifies the SharePoint column names for your list or library. Accepted Values: Read only. The values show when you select a list item.
Field Internal Value	Function: Specifies the internal names of the SharePoint columns for your list or library. Accepted Values: Read only. The values show when you select a list item
Meta Data Name	Function: The name of the process data variable to store the list item field values. The values can be changed to a process attribute, an XML schema element, or SharePoint variable. Accepted Values: A process attribute. An Xpath to a schema element. To add XML metadata associated with the process model, click the button in the MetaData Name field. SharePoint metadata. The URI for one or more files. You can attach one or more files separated by semicolons (;) using: Local file path - c:\[path]\[file name] URL - http://[URL]/[file name] Default Value: None. When you add a field, the Meta Data Name column shows the internal name of the SharePoint column. Accepts Process Data Variables: Yes
Filter	Function: Shows the items in the list based on the values you enter. To Open this Field: Click Filter . On the filter screen, select your operator. Enter the values to show in your list. Accepted Values: Is equal to Is not equal to Starts with Contains Does not contain Ends with Default Value: Is equal to