Download Documents from a Document Set

To download documents from a document set to the local file system of the AgilePoint Server machine, ​do the procedure in this topic.

Download Document Set 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 Download Document Set Download Document Set icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click Download Document Set Configuration Download Document Set Configuration icon.

Procedure

  1. To configure your settings to download a document set, on the Download Document Set 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.

    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:

    Document 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

    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

    Local Path

    Function:
    Specifies the location of the file system folder on the local computer where the activity does an action, such as uploading or downloading files.

    This setting gives the source location for the files to be uploaded and the target location for the files to be downloaded.

    Accepted Values:
    A file path relative to the AgilePoint Server application's root directory.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
    Example:
    • If AgilePoint Server is installed at:

      c:\Inetpub\wwwroot\AgilePointServer\

      And, the file once downloaded is to be located at:

      c:\Inetpub\wwwroot\AgilePointServer\files\MyFile.txt

      Then, the LocalPath property must be set to the following value:

      files

    • If AgilePoint Server is installed at:

      c:\Inetpub\wwwroot\AgilePointServer\

      And, the file once downloaded is to be located at:

      c:\Inetpub\wwwroot\AgilePointServer\files\temp\MyFile.txt

      Then, the LocalPath property must be set to the following value:

      files\temp

    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

Related Topics