Download Document Set activity

An activity that downloads one or more documents from a SharePoint document to the local file system of the AgilePoint Server machine.

Configure the Download Document Set activity

To configure the Download 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 Download Document Set activity onto your process.

General Configuration

Specifies the basic settings for the Download 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	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts 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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Download Document Set Configuration

Specifies the documents to download from a SharePoint document set.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed 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	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Document Library	Description: Specifies the name for the new document library. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: Yes
Document Set	Description: Specifies the name of the document set. Allowed Values: The name of your document set. Default Value: None Accepts Variables: Yes
Local Path	Description: 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. Allowed Values: A file path relative to the AgilePoint Server application's root directory. Default Value: None Accepts 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	Description: Specifies the file name or a set of files expressed with the filter expression to search within the specified source location. Allowed 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 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	Description: Specifies if the activity replaces the file if it already exist with the same name at the specified target location. Allowed 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	Description: 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 Allowed 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