Retrieve Property activity

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

Configure the Retrieve Property activity

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

Examples

(Example) Create a SharePoint Access Token

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

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.
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:
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?

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 Property activity onto your process.

General Configuration

Specifies the basic settings for the Retrieve Property activity.

Good to Know

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

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts 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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Retrieve Property Configuration

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

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts 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
Property Scope	Description: Specifies the kind of object to which the property bag belongs. Allowed Values: Site List/Library Folder List Item Default Value: Site Accepts Variables: No
Site	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts 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/Library	Description: Specifies the name of the SharePoint library or list. To Open this Field: In the Property Scope list, select List/Library, Folder, or List Item. Allowed Values: A valid SharePoint library name or list name. Default Value: None Accepts Variables: Yes
Folder	Description: Specifies the name of your SharePoint folder. To Open this Field: In the Property Scope list, select Folder. Allowed 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 Variables: Yes
List Item	Description: Specifies the name of a SharePoint list column or field. To Open this Field: In the Property Scope list, select List Item. Allowed Values: The name of your SharePoint list column. Default Value: ${ListItemID} Accepts Variables: Yes
Available Properties	Description: Shows all the properties of the selected property bag. Allowed 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	Description: Specifies the properties to get the value. Allowed 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	Function: Moves the selected fields from the Available Properties box to the Selected Properties box.
Right Arrow	Function: Removes the selected fields from the Selected Properties box.
Map Response	Description: 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 Allowed Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper