Retrieve Property activity

An activity that gets the value of the property from SharePoint property bag.


Retrieve Property activity

Configure the Retrieve Property activity

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

Examples

Prerequisites

  • Access Tokens for your SharePoint application.
  • On-premises SharePoint 2013 or higher or SharePoint for Microsoft 365 is required.
  • 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?

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, and open the SharePoint tab.

    Open SharePoint tab
  3. On the SharePoint tab, drag the Retrieve Property activity onto your process.

    Drag Retrieve Property activity

General Configuration

Specifies the basic settings for the Retrieve Property activity.

Figure: General Configuration screen

General Configuration screen

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

Retrieve Property Configuration

Specifies the details to get the value of the property from SharePoint property bag.

Figure: Retrieve Property Configuration > Property Bag tab

Retrieve Property Configuration Property Bag 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:

Create 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:

Property Scope

Function:
Specifies the kind of object to which the property bag belongs.
Accepted Values:
  • Site
  • List/Library
  • Folder
  • List Item
Default Value:
Site
Accepts Process Data Variables:
No

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/Library

Function:
Specifies the name of the SharePoint library or list.
To Open this Field:
  1. In the Property Scope list, select List/Library, Folder, or List Item.
Accepted Values:
A valid SharePoint library name or list name.
Default Value:
None
Accepts Process Data Variables:
Yes

Folder

Function:
Specifies the name of your SharePoint folder.
To Open this Field:
  1. In the Property Scope list, select Folder.
Accepted Values:
The name of your SharePoint folder

If the folder does not exist within the specified SharePoint list, the AgilePoint system creates it.

Default Value:
None
Accepts Process Data Variables:
Yes

List Item

Function:
Specifies the name of a SharePoint list column or field.
To Open this Field:
  1. In the Property Scope list, select List Item.
Accepted Values:
The name of your SharePoint list column.
Default Value:
${ListItemID}
Accepts Process Data Variables:
Yes

Available Properties

Function:
Shows all the properties of the selected property bag.
Accepted Values:
The list of properties of the selected property bag.
Default Value:
None
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?

Selected Properties

Function:
Specifies the properties to get the value.
Accepted Values:
A list of properties moved from the Available Properties box with the Left Arrow button.

To remove a property from the list, select the property, and then click the Right Arrow button.

Default Value:
None
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?

Left Arrow Left Arrow icon

Function:
Moves the selected fields from the Available Properties box to the Selected Properties box.

Right Arrow Right Arrow icon

Function:
Removes the selected fields from the Selected Properties box.

Map Response

Function:
Specifies the connection from the SharePoint API response parameter to your process schema.
To Open this Field:
On the Retrieve Property Configuration screen, click the Response tab
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None
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?