Process Activities / SharePoint tab
Parent topic: SharePoint tab

Delete Files activity

An activity that deletes files from SharePoint



Configure the Delete Files activity

To configure the Delete Files 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 Files 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 Files Configuration .
  3. Configure the Delete Files activity options on the Delete Files Configuration screen.

    For more information, refer to Delete Files from SharePoint.

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

Specifies the SharePoint files to delete.



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.

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:
No

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:
  • A file name.
  • A filter string that uses asterisks (*) as wildcards.
Default Value:
None
Accepts Process Data Variables:
No
Example:
These are some examples of filter expressions:
  • *.* - All files 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:
Complete Activity
Accepts Process Data Variables:
No

Recursive (Include Subfolders)
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
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.