Process Builder Procedures / SharePoint
Parent topic: SharePoint

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 Organizer, 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 tab.
      2. On the SharePoint tab, drag the Download Document Set activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click Download Document Set Configuration .

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

    Opens this Screen:
    New SharePoint Access Token
    Function of this Screen:
    Configures a new access token for SharePoint.

    Site
    Function:
    Specifies the URL for your SharePoint site.
    Accepted Values:
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
    Example:

    • http://[machine name]:[port]/sites/[site name]

      You must include the /sites in the Site URL for the site to be created successfully.

    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:
    No

    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

    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:
    • A file name.
    • A filter string that uses asterisks (*) as wildcards.
    Default Value:
    None
    Accepts Process Data Variables:
    No
    Example:
    These are some examples of filter expressions:
    • *.* - All files 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 overwrites the files if they already exist at the specified destination location.
    Accepted Values:
    • Deselected - The activity does not overwrite any existing file..
    • Selected - The activity overwrites the file if it exists with the same name at the destination location..
    Default Value:
    Deselected

    Recursive (Include Subfolders)
    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

RelatedTopics

Parent topic: SharePoint

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.