Process Activities / SharePoint tab
Parent topic: SharePoint tab

Delete List Item activity

An activity that deletes SharePoint list items.



Configure the Delete List Item activity

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

Good to Know

How to Start

  1. On the Organizer, 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 Delete List Item 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 Delete List Item Configuration .
  3. Configure Delete List Items Configuration screen.

    For more information, refer to Delete a SharePoint List Item.

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

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

General Configuration

Specifies the common information for a system activity.



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

Description
Function:
Specifies an optional 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.



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

Add Token

Opens this Screen:
New SharePoint Access Token
Function of this Screen:
Configures a new access token for SharePoint.

Site
Function:
Specifies the URL for your SharePoint site.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes
Example:

  • http://[machine name]:[port]/sites/[site name]

    You must include the /sites in the Site URL for the site to be created successfully.

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

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. Along with the field value, the field name specifies a group of list items to delete.

To specify a list item group, you must give a field name and value. If you do not give a field name and value, all list items are deleted from your list or folder.

Accepted Values:
The name of your SharePoint list column.
Default Value:
None
Accepts Process Data Variables:
No
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.

To specify a list item group, you must give a field name and value. If you do not give a field name and value, all list items are deleted from your list or folder..

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.
Parent topic: SharePoint tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.