Copy Files activity

An activity that copies one or more files from one SharePoint folder or library to another SharePoint folder or library.


Copy Files activity

Configure the Copy Files activity

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

    Open SharePoint tab
  3. On the SharePoint tab, drag the Copy Files activity onto your process.

    Copy Files activity

General Configuration

Specifies the basic settings for the Copy Files activity.

Figure: General Configuration screen

General Configuration 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:
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

Source Site Configuration

Specifies the original, or source, location where your files are stored on SharePoint.

Figure: Source Site Configuration screen

Source Site Configuration 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:
Limitations:
  • OAuth 2.0 authentication is not supported for this activity.

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.

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

Target Site Configuration > Configuration tab

Specifies the SharePoint target, or destination, location to place your files.

Figure: Target Site Configuration > Configuration tab

Configuration tab

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:
Limitations:
  • OAuth 2.0 authentication is not supported for this activity.

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

Overwrite File

Function:
Specifies if the activity replaces the file if it already exist with the same name at the specified target location.
Accepted Values:
  • Selected - The activity replaces the file if it exists with the same name at the target location.
  • Deselected - The activity saves the file with a different name.
Default Value:
Selected

Store Response in Process Attribute

Function:
Specifies a process data variable that stores the copied files.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Target Site Configuration > Item Ownership tab

Specifies the owner of the copied SharePoint files.

Figure: Target Site Configuration > Item Ownership tab

Item Ownership tab

Fields

Field Name Definition

Item Ownership

Function:
Specifies the owner of the copied SharePoint files.
Accepted Values:
Default Value:
Service Account used in Access Token