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.

Screen



Configure the Copy Document Set activity

To configure the Copy Document Set activity, do the procedure in this topic.

Good to Know

  • 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?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, 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 SharePoint icon tab.
      2. On the SharePoint SharePoint icon tab, drag the Copy Document Set Copy Document Set icon 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 Copy Source Document Set Configuration icon.
  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 Copy Target Document Set Configuration icon.
  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 Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the common information for a system activity.

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:
Refer to:

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

Copy Document Set Source Configuration

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

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

Add Token Add Token icon

Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to 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:
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

File Name/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

Copy Document Set Target Configuration

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

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

Add Token Add Token icon

Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to 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:
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