Add Property activity

An activity that adds a property to the SharePoint property bag.


Add Property activity

Configure the Add Property activity

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

Examples

Prerequisites

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 Process Builder, in the Activity Library, and open the SharePoint tab.

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

    Add Property activity

General Configuration

Specifies the basic settings for the Add 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 NameDefinition

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

Add Property Configuration > Configuration

Specifies the hierarchical level for the property in SharePoint.

Figure: Add Property Configuration > Configuration tab

Add Property Configuration Configuration tab

Fields

Field NameDefinition

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

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:

List/Library

Description:
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.
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:
  1. 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:
  1. In the Property Scope list, select List Item.
Allowed Values:
The name of your SharePoint list column.
Default Value:
${ListItemID}
Accepts Variables:
Yes

Add Property Configuration > Property Settings

Specifies the name and value of the SharePoint property bag.

Figure: Add Property Configuration > Property Settings tab

Add Property Configuration Property Settings tab

Fields

Field NameDefinition

Existing Properties - Key

Description:
Shows the name of the properties that exist.
Allowed Values:
Read only.
Default Value:
A valid property key that exists.
Accepts Variables:
Yes

Existing Properties - Value

Description:
Shows the value of the property bag that exists.
Allowed Values:
Read only.
Default Value:
A valid property value that exists.
Accepts Variables:
Yes

Filter Filter icon

Function:
Shows the items in the list based on the values you enter.
To Open this Field:
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Allowed Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to

Add New Add New icon

Function:
Adds a row to create a new SharePoint property.

Add New Properties - Key

Description:
Specifies the name of the property bag to create.
Allowed Values:
  • One line of text that can have spaces.
  • A process data variable.

    You can use App Data screen to specify a process data variable.

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

Add New Properties - Value

Description:
Specifies the value of the property bag to create.
Allowed Values:
  • One line of text that can have spaces.
  • A process data variable.

    You can use App Data screen to specify a process data variable.

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

Delete Delete icon

Function:
Deletes the row.