Delete List Item activity

An activity that deletes SharePoint list items.


Delete List Item activity

Configure the Delete List Item activity

To configure the Delete List Item activity, do the procedure in this topic.

Examples

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 Delete List Item activity onto your process.

    Drag Delete List Item activity

General Configuration

Specifies the basic settings for the Delete List Item 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

Delete List Items Configuration

Specifies the SharePoint list items you want to delete. You can delete all list items within a SharePoint list or a folder, or you can specify a field name and value pair to delete a set of list items.

Figure: Delete List Items Configuration screen

Delete List Items Configuration 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:

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:

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

Function:
Specifies the name of your SharePoint list.
Accepted Values:
The name of your SharePoint list.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Refer to:

Folder

Function:
Specifies the name of your SharePoint 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 Field

Function:
Specifies the name of a SharePoint list column or field.

Each field name-value pair specifies a list item to delete.

Accepted Values:
The name of your SharePoint list column.
Default Value:
ID
Accepts Process Data Variables:
Yes
Example:
If ListItem Field Name is set to ID, and ListItem Field Value is set to 5, only the list item with the ID equal to 5 is deleted.

If ListItem Field Name is set to Created By, and ListItem Field Value is set to Mary Jones, all list items created by Mary Jones are deleted.

List Item Field Value

Function:
Specifies the value of the field defined in ListItem Field Name.

Each field name-value pair specifies a list item to delete..

Accepted Values:
The value of the list column specified in the ListItem Field Name.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
If ListItem Field Name is set to ID, and ListItem Field Value is set to 5, only the list item with the ID equal to 5 is deleted.

If ListItem Field Name is set to Created By, and ListItem Field Value is set to Mary Jones, all list items created by Mary Jones are deleted.