Check Property activity

An activity that makes sure a property exists in the SharePoint property bag.


Check Property activity

Configure the Check Property activity

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

Examples

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

General Configuration

Specifies the basic settings for the Check Property 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

Check Property Configuration > Configuration

Specifies the hierarchical level for the property in SharePoint.

Figure: Check Property Configuration > Configuration tab

Check Property 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
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:

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

Store the Response in Custom Attribute

Function:
Specifies the process data variable that stores whether the property exists in the SharePoint property bag.
Accepted Values:
A process data variable that accepts a Boolean value, or the text true or false.
  • True - The Sharepoint property exists.
  • False - The Sharepoint property does not exist.
Default Value:
None
Accepts Process Data Variables:
Yes

Check Property Configuration > Property Settings

Specifies the name and value of the SharePoint property bag.

Figure: Check Property Configuration > Property Settings tab

Check Property Configuration Property Settings tab

Fields

Field Name Definition

Existing Properties - Key

Function:
Shows the name of the properties that exist.
Accepted Values:
Read only.
Default Value:
A valid property key that exists.
Accepts Process Data Variables:
Yes

Existing Properties - Value

Function:
Shows the value of the property bag that exists.
Accepted Values:
Read only.
Default Value:
A valid property value that exists.
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

Selected Properties - Key

Function:
Specifies the name of the property.
Accepted Values:
  • A property in your SharePoint environment.

    Drag the property to change from the Existing Properties list to the Selected Properties column.

  • One line of text that can have spaces.
  • A process data variable.

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

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?

Add New Add New icon

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

Delete Delete icon

Function:
Deletes the row.