Download Files

AbsoluteURL

Definition:

Specifies the absolute URL for the source folder on SharePoint server.

Allowed Values:

A valid SharePoint absolute URL.

Default Value:

None

Custom Attributes:

No

Example:

• http://[machine name]:[port]/sites/[site name]/[document library name]/[folder name]

Filter

Definition:

Specifies the file name or a set of files expressed using the filter expression you want to search within the specified source location. For example, files to be downloaded by the Download Files AgilePart, to be uploaded by the Upload Files AgilePart, or to be converted to PDF by the PDF Converter AgilePart.

Allowed Values:

• A file name.
• A filter string that uses asterisks (*) as wildcards.

Default Value:

None

Custom Attributes:

No

Example:

Following 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 performed at the source location, that vary depending upon the AgileShape.

LocalPath

Definition:

Specifies the location of the file system folder on the local computer where the AgileShape performs the certain action such as uploading or downloading files.

This property defines the source location for the files to be uploaded and the destination location for the files to be downloaded.

Allowed Values:

A file path relative to the AgilePoint Server application's root directory.

Default Value:

None

Custom Attributes:

No

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

OverWriteFile

Definition:

Specifies whether the AgileShape overwrites the files if they already exist at the specified destination location.

Allowed Values:

• False - The AgileShape does not overwrite any existing file.
• True - The AgileShape overwrites the file if it exists with the same name at the destination location.

Default Value:

False

Recursive

Definition:

Determines whether the AgileShape's specified action － such as copying, uploading, or deleting － is recursive. In other words, it determines whether the action is repeated in subfolders of the target folder or document library.

Allowed Values:

• False - The AgileShape performs the action only on the files located at the specified source folder. Files within subfolders aren't affected.
• True - The AgileShape performs the action on the files located at the specified source folder, as well as the files that are located within the subfolders.

Default Value:

False