Process Activities / SharePoint tab
Parent topic: SharePoint tab

Copy Document Set activity

An activity that copies a document set from one SharePoint document folder or library to a different SharePoint document folder or library.



Configure the Copy Document Set activity

To configure the Copy Document Set 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 Copy Document Set 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 Copy Source Document Set Configuration .
  3. Configure your source location on the Copy Document Set Source Configuration screen.

    For more information, refer to Copy a Document Set.

  4. Click Copy Target Document Set Configuration .
  5. Configure your target location on the Copy Document Set Target Configuration screen.

    For more information, refer to Copy a Document Set.

  6. (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

Copy Document Set Source Configuration

Specifies the source SharePoint location from which to copy your document set.



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

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. The source site contains your SharePoint document library and document set — for example, the document set to copy or move to the target document library.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
No

Document Library
Function:
Specifies the name of the SharePoint document library. The source document library contains the document set to copy or move to the target document library.
Accepted Values:
The name of your SharePoint library.
Default Value:
None
Accepts Process Data Variables:
No

Document Set
Function:
Specifies the name of the document set.
Accepted Values:
The name of your document set.
Default Value:
None
Accepts Process Data Variables:
Yes

Site
Function:
Specifies the URL for your SharePoint site. The target site contains the document library to copy or move the document set from the source document library.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
No

Document Library
Function:
Specifies the name of the destination SharePoint document library where you want to copy or move the document set.
Accepted Values:
The name of your SharePoint document library.
Default Value:
None
Accepts Process Data Variables:
No

Folder
Function:
Specifies the name of the SharePoint folder to copy or move the document set from the source location.
Accepted Values:
The name of your SharePoint folder

If the folder is not in the specified SharePoint list, the AgilePoint system creates the folder.

Default Value:
None
Accepts Process Data Variables:
No

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.

Overwrite File
Function:
Specifies if the activity overwrites the files if they already exist at the specified destination location.
Accepted Values:
  • Deselected - The activity does not overwrite any existing file..
  • Selected - The activity overwrites the file if it exists with the same name at the destination location..
Default Value:
Deselected

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

Copy Document Set Target Configuration

Specifies the target SharePoint location to which you want to copy your document set.



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

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. The target site contains the document library to copy or move the document set from the source document library.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
No

Document Library
Function:
Specifies the name of the destination SharePoint document library where you want to copy or move the document set.
Accepted Values:
The name of your SharePoint document library.
Default Value:
None
Accepts Process Data Variables:
No

Folder
Function:
Specifies the name of the SharePoint folder to copy or move the document set from the source location.
Accepted Values:
The name of your SharePoint folder

If the folder is not in the specified SharePoint list, the AgilePoint system creates the folder.

Default Value:
None
Accepts Process Data Variables:
No
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.