SharePoint - Download file(s)

SharePoint - Download Files

Declaration

<AMSHAREPOINT ACTIVITY="download_files" SITE="text" SOURCE="text" 
DEST="text" RESULTDATASET="text" SUBFOLDERS="YES/NO" 
KEEPFOLDERSTRUCT="YES/NO" OVERWRITE="YES/NO" 
EXCLUDE="text" RE="YES/NO" />

Description: Downloads one or more file(s) from the SharePoint site to a local directory. To specify more than one file, use wildcard characters (e.g., * or ?). To specify multiple files or wildcard masks, separate them with a pipe character (e.g., source/*.txt|source/*.bak).

Practical Usage

Ideal for automated retrieval of files from a SharePoint site.

Connection Parameters

Property	Type	Required	Default	Markup	Description
Connection	---	---	---	---	Indicates where this activity's SharePoint credentials should originate from. This is a design-time parameter used only during task construction, thus, contains no properties or markups. The available options are: Host - Specifies that a custom set of credentials will be entered for this activity. This option is normally selected if only a single SharePoint activity is required to complete the operation. Session - Specifies that credentials should derive from a session created in a previous Create session step. This allows several activities to be linked to a specific session, eliminating redundancy. Multiple sessions can exist within a single task, allowing several SharePoint operations to be automated simultaneously.
Session	Text	Yes if Connection set to Session	SharePoint Session1	SESSION="mySession1"	The name of the session to associate this activity with. This parameter is active only if the Connection parameter is set to Session. The default value is SharePointSession1. NOTE: Use the End Session activity to end an active SharePoint session.
Version	Text (options)	Yes if Connection set to Host	SharePoint 2010	VERSION="sharepointonline" VERSION="sharepoint2010" VERSION="sharepoint2007"	The SharePoint version to associate with this session. The available options are: SharePoint Online - A cloud-based service, hosted by Microsoft as an alternative to installing and deploying SharePoint Server on premises. SharePoint 2010 and newer (default) - SharePoint version 2010 or newer - includes SharePoint Foundation 2010/2013 and SharePoint Server 2010/2013. SharePoint 2007 and older - SharePoint 2007 version - includes Windows SharePoint Services (WSS) v3 edition and Microsoft Office SharePoint Server 2007 (MOSS 2007) edition. NOTE: Some SharePoint activities are only supported in SharePoint 2010 or newer.
Site	Text	Yes	(Empty)	SITE="http://myServer/tech"	An existing SharePoint site to associate with this session. SharePoint sites are, functionally, ASP.NET 2.0 web applications that are served using IIS and a SQL Server database as a data storage back end. Active only if the Version parameter is set to SharePoint Online or SharePoint 2010 and newer.
Authentication type	Text (options)	No	Basic	AUTHTYPE="form" AUTHTYPE="anonymous" AUTHTYPE="basic" AUTHTYPE="digest" AUTHTYPE="proprietary" AUTHTYPE="ntlm"	The method of authentication to use. Certain parameters become active depending on which authentication method is selected. Authentication types vary depending on the SharePoint version. Below lists available authentication methods and their compatibility. Default - Compatible withSharePoint 2010 or newer. Form - Compatible withSharePoint 2010 or newer. Anonymous - Compatible withSharePoint 2010 or newer. Basic - Compatible withall SharePoint versions. Digest - Compatible withSharePoint 2007 or older. Proprietary - Compatible withSharePoint 2007 or older. None - Compatible withSharePoint 2007 or older. NTLM - Compatible withSharePoint 2007 or older.
Username	Text	Yes	(Empty)	USERNAME="theUserName"	A valid SharePoint username. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.
Password	Text	Yes	(Empty)	PASSWORD="encryptedText"	A valid SharePoint password. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.
Domain	Text	Yes	(Empty)	DOMAIN="myServer"	The domain that the username (specified in the Username parameter) belongs to. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.
Certificate	Text	No	(Empty)	CERTIFICATE="C:\Temp\file.cer"	The (DER encoded) certificate to use for SharePoint authentication. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.
Ignore invalid certificate	Yes/No	No	No	IGNOREINVALIDCERTIFICATE="yes"	If set to YES, specifies that invalid server certificates that are detected will be automatically ignored. Set to NO by default.
Timeout (seconds)	Number	No	600	TIMEOUT="500"	The total number of seconds allowed to connect to the SharePoint server, otherwise a time out error is generated. The default value is 600 seconds.
Proxy type	Text (options)	No	Default	PROXYTYPE="none" PROXYTYPE="http"	The proxy type to use. Required for SharePoint connections that pass through a proxy server. The available options are: System default (default) - Points to the default proxy used by the system. None - No proxy authentication required. HTTP - Proxytype is HTTP.
Use authentication	---	---	---	---	If enabled, specifies that proxy authentication is required, enabling authentication-based parameters (disabled by default). This is a design-time parameter, therefore, contains no properties or markups. It is active only if the Proxy type parameter is set to HTTP.
Proxy server	Text	No	(Empty)	PROXYSERVER="proxy.host.com"	The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP.
Proxy username	Text	No	(Empty)	PROXYUSERNAME="username"	The proxy username to authenticate with. This parameter is available only if the Use Authentication parameter is enabled.
Proxy password	Text	No	(Empty)	PROXYPASSWORD="encrypted_text"	The proxy password to authenticate with. This parameter is available only if the Use Authentication parameter is enabled.
Proxy port	Number	No	8080	PROXYPORT="8080"	The port that should be used to connect to the proxy server. The default port is 8080. This parameter is available only if the Proxy type parameter is set to HTTP.

File Parameters

Property	Type	Required	Default	Markup	Description
Remote file(s)	Text	Yes	(Empty)	SOURCE="folder/file.txt" SOURCE="folder/.txt" SOURCE="folder/.*"	The source file(s) to download. Wildcard characters (e.g., * or ?) may be used to download files matching a certain mask. Multiple files and/or file masks may be specified by separating the entries with the pipe symbol (i.e./ source/.txt\|/source/.bak\|/source/*.log). Click the folder icon to use the SharePoint Browser, a user-friendly interface that enables connection to a SharePoint site to view or select specific contents.
Local file(s)	Text	Yes	(Empty)	DEST="c:\folder\file.txt" DEST="c:\folder\.txt" DEST="folder/.*"	The destination folder of the downloaded file(s). This requires an absolute path/file name. This can be a fully qualified path or a path and filename. Folders that do not exist will be automatically created at runtime.
Create and populate download dataset	Text	Yes	(Empty)	RESULTDATASET="theDownloadInfo"	The name of the dataset to create and populate with information regarding the download that took place. For more details, see Datasets below.

Property

Type

Required

Default

Markup

Description

Remote file(s)

Text

Yes

(Empty)

SOURCE="folder/file.txt"
SOURCE="folder/*.txt"
SOURCE="folder/*.*"

The source file(s) to download. Wildcard characters (e.g., * or ?) may be used to download files matching a certain mask. Multiple files and/or file masks may be specified by separating the entries with the pipe symbol (i.e./ source/*.txt|/source/*.bak|/source/*.log).

Click the folder icon to use the SharePoint Browser, a user-friendly interface that enables connection to a SharePoint site to view or select specific contents.

Local file(s)

Text

Yes

(Empty)

DEST="c:\folder\file.txt"
DEST="c:\folder\*.txt"
DEST="folder/*.*"

The destination folder of the downloaded file(s). This requires an absolute path/file name. This can be a fully qualified path or a path and filename. Folders that do not exist will be automatically created at runtime.

Create and populate download dataset

Text

Yes

(Empty)

RESULTDATASET="theDownloadInfo"

The name of the dataset to create and populate with information regarding the download that took place. For more details, see Datasets below.

File Options Parameters

Property	Type	Required	Default	Markup	Description
Exclude mask	Text	No	(Empty)	EXCLUDE="*.txt"	Causes this activity to omit any files matching the mask(s) specified. Filenames or wildcard masks (e.g., * or ?) may be used. Multiple entries may be specified by separating them with the pipe ("\|") symbol (e.g., .txt\|.bak).
Regular expression	Yes/No	No	No	RE="YES"	If set to YES, specifies that the value entered in the Exclude mask parameter is interpreted as a regular expression (also referred to as regex or regexp) which provides a concise and flexible means for matching strings of text. If set to NO (default) the value is interpreted as plain, readable text.
Only if newer than	Date	No	(Empty)	ISNEWERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"	If enabled, causes this activity to only act on files that are newer than the date/time specified. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression. If this parameter is disabled (default), file "newer than" dates are ignored.
Only if older than	Date	No	(Empty)	ISOLDERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"	If enabled, causes this action to only act on files that are older than the date/time specified. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression. If this parameter is disabled (default), file "older than" dates are ignored.
Overwrite if exists	Yes/No	No	No	OVERWRITE="YES"	If set to YES, matching destination files will be overwritten. If set to NO, matching files will not be overwritten, however, an error will occur as a result.
Include subfolders	Yes/No	No	No	SUBFOLDERS="YES"	If set to YES, specifies that, if present, sub-folders should be searched for files matching the mask specified in the Remote file(s) parameter. The default value is NO.
Preserve folder structure	Yes/No	No	No	KEEPFOLDERSTRUCT="YES"	If set to YES, specifies that sub-folders found in the source folder should be created in the destination folder and source files should be copied into their respective folders rather than directly into the root of the target folder specified in the Local file(s) parameter. The default value is NO. This option is available only if the Include subfolders parameter is set to YES.

Description

Error Causes

On Error

Datasets

A dataset is a multiple column, multiple row container object where every column represents a particular variable, and each row corresponds to a given member of the dataset in question. This activity creates and populates a dataset containing specific fields (rows) in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).

Name	Type	Return Value
theDataset.Error	Text	A textual description of the error that occurred (if any). If no errors occurred during the download step, this dataset will remain empty.
theDataset.DownloadResult	True/False	The download result. The value is either True or False.
theDataset.LocalFileName	Date	The local (destination) filename of the file being downloaded.
theDataset.SharePointFileDate	Text	The current date of the source file being downloaded. The date format will be similar to 11/12/2014 09:18:08 AM.
theDataset.SharePointFileSize	Text	The size (in KB) of the source file being downloaded.
theDataset.SharePointFileName	Text	The name of the source file being downloaded.

Example

Description: This sample task demonstrates the use of sessions as well as ability to download all files from a SharePoint library and thereafter, delete the empty library.

This sample is for AML viewing purposes only. In order for the task to work, it must be modified to fit your SharePoint credentials.

<AMSHAREPOINT ACTIVITY="create_session" 
SITE="https://netauto.sharepoint.com/awesome/site" 
VERSION="sharepointonline" USERNAME="theMan@netauto.com" 
PASSWORD="AM48swl5oDSFYhKASv/xC8SyB1QuzwD97yoaME" 
SESSION="SharePointSession1" />
<AMSHAREPOINT ACTIVITY="download_files" 
SESSION="SharePointSesion1" SOURCE="MyLibrary/*.*" 
DEST="C:\Logs\Download\*.*" RESULTDATASET="downloadDataset" 
SUBFOLDERS="YES" KEEPFOLDERSTRUCT="YES" />
<AMSHAREPOINT ACTIVITY="delete_list" 
SESSION="SharePointSession1" LIST="MyLibrary" />
<AMSHAREPOINT ACTIVITY="end_session" 
SESSION="SharePointSession1" />

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.
v10 | 202212080228 | December 2022