Internet - Download Web File

This action downloads a specific file from the Web and saves it to a specific folder.

Action ID:
Action Category:
Action List Syntax:

15
Internet 
Internet.DownloadWebFile (<<URL>>, <<LOCALFOLDER>>)

Settings

Location/Connection

URL:

The full URL to the file that will be downloaded. This field cannot be empty.

If you're using a redirected URL (where the filename isn't contained within the URL or includes invalid characters), you can use the %NextDownloadWebFilename% variable to specify a valid filename for the downloaded file.

Note: This action accepts up to 5 redirects.

Local download folder:

This is the folder where the file will be saved.

Connection timeout:

The maximum time in seconds that the connection will be allowed to remain idle.

Port:

The port to use, generally this should remain 80.

Download Verification

Verify file size

If checked the size of the download file will be verified against the size specified in the File size field.

File size:

The file size (in bytes) that the downloaded file's size will be verified against, if the Verify file size checkbox is selected.

Verify file CRC

If checked the CRC of the download file will be verified against the CRC specified in the File CRC field.

File CRC:

The CRC value that the downloaded file's CRC will be verified against, if the Verify file CRC checkbox is selected.

Authentication

Use HTTP basic authentication

If check HTTP basic authentication will be used in order to gain access to the file.

User name:

The user name to be used during HTTP authentication.

Password:

The password to be used during HTTP authentication.

Proxy Settings

Proxy server address:

The proxy server address.

Proxy server port:

The proxy server port.

User name:

The proxy user name.

Password:

The proxy password.

Dialog

Dialog title:

The title that will appear on the "download progress" dialog.

Dialog text:

The text that will appear on the "download progress" dialog.

Error Codes

Value
(%LastErrorNum%)

Simple Message
(%LastErrorMsg%)

Verbose Message
(%LastErrorDetails%)

0 (OK)

 

 

1

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_NOCONNECT_SERVER_PROXY
<<URL>>

2

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_REQUEST_DENIED_SERVER
<<URL>>

3

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_INVALID_URL
<<URL>>

4

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_OPERATION_TERMINATED
<<URL>>

5

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_INVALID_TYPE
<<URL>>

6

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_UNABLE_OPENDATASOURCE
<<URL>>

7

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_TIMEOUT
<<URL>>

8

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_SOCKET_RECEIVE
<<URL>>

9

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_DATASOURCE_WRITE
<<URL>>

10

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_OPERATION_ABORTED
<<URL>>

11

MSG_ERR_INVALID_PARAMETER

MSG_ERR_INVALID_PARAMETER
MSG_ERR_CONNECTION_TIMEOUT
<<URL>>
<<TIMEOUT>>

12

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_SETPORT
<<URL>>

13

MSG_ERR_FILE_VERIFICATION

MSG_ERR_FILE_VERIFICATION
MSG_ERR_FILE_SIZE
<<URL>>
<<LOCALFOLDER>>

14

MSG_ERR_FILE_VERIFICATION

MSG_ERR_FILE_VERIFICATION
MSG_ERR_FILE_CRC
<<URL>>
<<LOCALFOLDER>>

50

MSG_ERR_WEB_DOWNLOAD

MSG_ERR_WEB_DOWNLOAD
MSG_ERR_SERVER_ERRORCODE
<<URL>>

Examples

Downloading a file