Delete Files activity

An activity that deletes files from SharePoint


Delete Files activity

Configure the Delete Files activity

To configure the Delete Files 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 Files activity onto your process.

    Drag Delete Files activity

General Configuration

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

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 Files Configuration

Specifies the SharePoint files to delete.

Figure: Delete File Configuration screen

Delete File Configuration screen

Fields

Field NameDefinition

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:

Library

Function:
Specifies the name for the new document library.
Accepted Values:
One line of text that can have spaces.
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

Filter

Function:
Specifies the file name or a set of files expressed with the filter expression to search within the specified source location.
Accepted Values:
  • File Name - Specifies the name of the file in your storage source location.
  • Filter - Specifies a file name or a filter string that uses asterisks (*) as wildcards.
Default Value:
Filter
Accepts Process Data Variables:
Yes
Example:
These are some examples of filter expressions:
  • *.* - All files are searched.
  • *.txt - The files that have the .txt file extension are searched.
  • *.pdf - The files that have the .pdf file extension are searched.
  • MyFile.* - All files start with MyFile are searched.
  • *[part of file name]* - All files that contain the specified part of file name are searched.
  • *.xml - The files that have the .xml file extension are searched.
  • *.doc - The files that have the .doc file extension are searched.
  • MyFile.xml - Only the specific file MyFile.xml is searched.

The filter action is done at the source location specified in the activity.

File Not Found

Function:
Specifies what to do if the process does not find your files.
Accepted Values:
  • Complete Activity - The task status changes to Complete, and the process continues.
  • Suspend Process - The process status changes to Suspended.
Default Value:
None
Accepts Process Data Variables:
No

Recursive

Function:
Specifies if the activity's action — such as copy, upload, or delete — is recursive. In other words, it specifies if the activity does the action again in the subfolders of the target location
Accepted Values:
  • Deselected - The activity does the action only on the files in the specified source folder. There is no effect on files in subfolders.
  • Selected - The activity does the action on the files in the specified source folder, as well as the files in the subfolders.
Default Value:
Deselected