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.

Prerequisites

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 tab.
      2. On the SharePoint tab, drag the Retrieve Property activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Retrieve Property .
  3. Complete the fields on the Retrieve Property Configuration screen.

    For more information, refer to Get the Value of the Property from a SharePoint Property Bag.

  4. (Optional) Click Advanced > E-mail Notifications .

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the common information for a system activity.

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:
Refer to:

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.

Screen



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

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

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

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

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

Function:
Specifies the connection from the SharePoint API response parameter to your schema.
To Open this Field:
On the Retrieve Property Configuration screen, click the Response tab
Accepted 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