Copy a Document Set

To copy a document set from one SharePoint location to a different location, do the procedure in this topic.

Copy Document Set Source Configuration Screen



Copy Document Set Target Configuration Screen



Good to Know

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.
  3. Click Copy Source Document Set Configuration Copy Source Document Set Configuration icon.

Procedure

  1. To configure your SharePoint connection, on the Copy Document Set Source Configuration screen, complete these fields as necessary.
    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.
  2. To configure your SharePoint source location, complete these fields as necessary.
    Field Name Definition

    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
  3. To configure additional settings, complete these fields as necessary.
    Field Name Definition

    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
  4. Click Copy Target Document Set Configuration Copy Target Document Set Configuration icon.
  5. To configure your SharePoint target location, complete these fields as necessary.
    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

Related Topics