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.

Examples

(Example) Create a SharePoint Access Token

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, and open the SharePoint tab.
On the SharePoint tab, drag the Copy Document Set activity onto your process.

General Configuration

Specifies the basic settings for the Copy Document Set activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

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

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:

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 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 Example: Refer to: (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
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: Yes Example: http://APDesktop:8000/sites/MySite
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: Yes
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
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.
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
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 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 Example: Refer to: (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
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: Yes
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: Yes
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: Yes

Target Site Configuration > Item Ownership tab

Specifies the owner of the copied document set.

Fields

Field Name	Definition
Item Ownership	Function: Specifies the owner of the copied document set. Accepted Values: Access Token Credentials - The account specified in the SharePoint access token. For more information, refer to Access Token for SharePoint. App Initiators - App Initiators is a permission group for users or groups who have access rights to start a process-based app or form-based app App Owners - App Owners configured in Manage Center or App Builder is a permission group for users or groups who have full access rights for a specific app in App Builder.. SharePoint User Name - Specifies a SharePoint user name or a process data variable that contains the SharePoint user name. Default Value: Service Account used in Access Token

Field Name

Definition

Item Ownership

Function:

Specifies the owner of the copied document set.

Accepted Values:

Access Token Credentials - The account specified in the SharePoint access token.
For more information, refer to Access Token for SharePoint.
App Initiators - App Initiators is a permission group for users or groups who have access rights to start a process-based app or form-based app
App Owners - App Owners configured in Manage Center or App Builder is a permission group for users or groups who have full access rights for a specific app in App Builder..
SharePoint User Name - Specifies a SharePoint user name or a process data variable that contains the SharePoint user name.

Default Value:

Service Account used in Access Token