Upload Document Set activity

An activity that uploads one or more documents from the local AgilePoint Server machine to a specified document set within a SharePoint document library.


Upload Document Set activity

Configure the Upload Document Set activity

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

Examples

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, and open the SharePoint tab.

    Open SharePoint tab
  3. On the SharePoint tab, drag the Upload Document Set activity onto your process.

    Drag Upload Document Set activity

General Configuration

Specifies the basic settings for the Upload Document Set activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

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

Upload Document Set Configuration

Specifies the details for uploading one or more documents to the document set.

Figure: Upload Document Set Configuration screen

Upload Document Set Configuration screen

Fields

Field NameDefinition

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:

Create Add Token icon
Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

Site
Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:

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