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

  • In this activity, you can delete a specified list of SharePoint list items. If you want to delete all the items in a list, a loop is required.

    For more information, refer to (Example) Create a Loop to Repeat an Action and Store the Information in a SharePoint List.

    This example shows how to use a loop to add more than one list item. A similar loop procedure can be used to delete more than one list item.

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

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 Delete List Item Delete List Item icon 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 Delete List Item Configuration icon.
  3. Configure Delete List Items Configuration screen.

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

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

    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

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.

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 Add Token icon

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

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.