Retrieve List Item activity

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


Retrieve List Item activity

Configure the Retrieve List Item activity

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

Examples

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, go to the Activity Library, and open the SharePoint SharePoint icon tab.
      2. On the SharePoint SharePoint icon tab, drag the Retrieve List Item Retrieve List Item icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Retrieve List Item activity.

Figure: General Configuration screen

General Configuration screen

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

Retrieve List Item Configuration > Configuration tab

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

Figure: Retrieve List Item Configuration > Configuration tab

Retrieve List Item Configuration Configuration tab

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:

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

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:

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:

List Item Field
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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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.

Figure: Retrieve List Item Configuration > SharePoint List tab

Retrieve List Item Configuration SharePoint List tab

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 semicolon (;) 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 Filter icon
Function:
Shows the items in the list based on the values you enter.
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. 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