Delete Document Set activity

An activity that deletes a specified document set from your SharePoint document library.


Delete Document Set activity

Configure the Delete Document Set activity

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

    Open SharePoint tab
  3. On the SharePoint tab, drag the Delete Document Set activity onto your process.

    Drag Delete Document Set activity

General Configuration

Specifies the basic settings for the Delete Document Set 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

Delete Document Set Configuration

Specifies the document set you want to delete.

Figure: Delete Document Set Configuration screen

Delete Document Set Configuration screen

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:

Site

Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:

Document Library

Description:
Specifies the name for the new document library.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes

Document Set

Description:
Specifies the name of the document set.
Allowed Values:
The name of your document set.
Default Value:
None
Accepts Variables:
Yes

Move To Recycle Bin

Description:
Specifies whether to move the document set from the SharePoint document library to the recycle bin.
Allowed Values:
  • Selected - Deletes the document set from the SharePoint document library and moves it to the recycle bin.
  • Deselected - Deletes the document set permanently from SharePoint.
Default Value:
Deselected
Limitations:

This field is available in these releases: