Download for SharePoint 2013 - Data360_Analyze - 3 - 3.12

Data360 Analyze Server Help

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Analyze
Version
3.12
Language
English
Product name
Data360 Analyze
Title
Data360 Analyze Server Help
Copyright
2023
First publish date
2016

Downloads files from a specified SharePoint server using the SharePoint API.

Note: When the files are downloaded and the default DataOutputDirectory is used the content of the files on SharePoint site are saved, not the physical files themselves. As a result of this behavior we do not keep the file extension due to potential base64 encoding. It is also worth noting that the temporary files that have been created have the modified date of when the content was originally written.

Properties

ServerUrl

Specify the URL of the SharePoint server hosting the SharePoint site (e.g. http://www.sharepoint-server.example.com). The URL must be correctly formatted, or the node will fail.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

A value is required for this property.

ServerPath

Specify the SharePoint server path to a file or a directory to download.

The path includes the SharePoint Site name, the Document Library and any nested folders within the Document Library e.g. MySharePointSite/SharedDocuments/SalesData MySharePointSite/SharedDocuments/SalesData/data.csv

If ServerPath points to a directory the Pattern property may also be defined to narrow down the returned result set. Pattern property will be ignored if ServerPath points to a single file. See the Pattern property for further information.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

Pattern

Optionally specify a case sensitive expression used to select which files to download from the SharePoint Folder.

e.g. "Data" would match files in the Folder named Region1Data.xlsx, Region2Data.xlsx, DataForPreviousYears.csv but would not match testdata.txt

"*" indicates all files in the Folder are to be listed. Note that wildcards can't be used for defining part of a name e.g. data*.txt - this will generate an error.

The default value is "*".

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

DataOutputMode

Optionally specify whether data is written to a file on disk or to an output field. Choose from:

  • Field
  • File

The default value is Field.

The value of this property determines how DataOutputField and DataOutputDirectory behave.

DataOutputField

Optionally specify the name of the output field that contains either the response body or the filenames where the response body has been written.

The behavior of this property depends upon the DataOutputMode. If the DataOutputMode is Field, it names the field where the response body is output.

If the DataOutputMode is File, the output field named in the property contains the full path of the files that contain the response bodies.

The data type of this field is set by the DataOutputFieldType property . The DataOutputFieldType property is useful if the response body has Unicode text data and property is set to Field.

The default value is Output.

DataOutputDirectory

Optionally specify the directory where response bodies are written when DataOutputMode is set to File. When DataOutputDirectory is blank, files are written to the Data360 Analyze temporary directory. Otherwise, the files are written to the specified directory - the specified directory must exist and be writeable. This node will not overwrite existing files by default. Behavior can be set by configuring the ExceptionBehavior properties.

This property should only be filled in when DataOutputMode is set to File.

ContentTypeOutputField

Optionally specify an easy way to output the Content-Type header of the HTTP response separately from the rest of the HTTP headers. Since the Content-Type identifies the type of file that is returned with the response (it functions very similarly to a file extension) this header is most commonly the only header that the user needs to output. Placing a field name in this property will cause the value of the Content-Type header to be output separately in a field of this type.

If this property is left blank, then the content type is not output via this property.

StatusCodeOutputField

Optionally specify the name of the field that will contain the HTTP response status code. This status code is a numeric value that indicates whether the HTTP request succeeded, failed, or needs more information.

Common status codes are the following:

2xx - The request succeeded, but there could be qualifications depending on the specific code.

3xx - The server needs more information in order to fulfill your request. Typically, the server responds with a list of URL's for you to choose from for your next step.

4xx - Error. The request reached the server, but the server could not fulfill it.

The status code is most commonly used to group HTTP responses by these three types.

If not set, the status code will not be output.

StatusMessageOutputField

Optionally specify the name of the field that will contain the HTTP response status message. The status message explains the status code in plain language. The status message is most often used to provide a reason for a failure indicated by a HTTP status code of 4xx.

If not set, the response status message will not be output.

DataOutputFieldEncoding

Optionally specify when to encode the HTTP response data when writing to the field specified by DataOutputField.

The data returned from a SharePoint server via HTTP call can be either ASCII text, Unicode text, or binary. Since Data360 Analyze does not support binary data in records, this data must be encoded, or put in a valid data format, before being output to a pin. In addition, if DataOutputFieldType is set to String, then any Unicode data will also have to be encoded in order to avoid errors.

The following options are available:

  • Auto - Determines whether to Base64 encode the data based on the Content-Type of the HTTP response. This setting will encode all data types except for text, html, and xml.
  • Base64 - Encodes all DataOutputField values using Base64 encoding. This is the safest option.
  • None - Do not encode any of the output data. If binary data comes in an HTTP response, then an error will be thrown, and the node will stop processing. This option should only be used when the user can guarantee that the returned data is not binary and is of the same type as the DataOutputFieldType.

The default value is Auto.

DataOutputFieldType

Optionally specify the type of the field named in DataOutputField.

The following options are available:

  • String - The data output field will be a Data360 Analyze string type.
  • Unicode - The data output field will be a Data360 Analyze Unicode string type.

The default value is Unicode.

FileNameOutputField

Optionally specify the field that will contain the name of the downloaded file.

The default value is "_FileName".

LengthOutputField

Optionally specify the field that will contain the length of the downloaded file.

The default value is "_Length".

ServerRelativeUrlOutputField

Optionally specify the field that contains the location for Files/Folders that were downloaded from the SharePoint server. e.g. /Documents/TestFolder/testFile.txt

The default value is "_ServerRelativeUrl".

TimeCreatedOutputField

Optionally specify the field that will contain the time the downloaded file was created on the SharePoint server.

The default value is "_TimeCreated".

TimeLastModifiedOutputField

Optionally specify the field that will contain the time the downloaded file was last modified on the SharePoint server.

The default value is "_TimeLastModified".

ConvertTimesToLocal

Optionally specify whether to convert server times from UTC time zone to local time.

The default value is True.

PassThroughFields

Optionally specify which input fields will "pass through" the node unchanged from the input to the output, assuming that the input exists. The input fields specified will appear on those output records which were produced as a result of the input fields.

The following options are available:

  • All - Passes through all the input data fields to the output.
  • None - Passes none of the input data fields to the output; as such, only the fields created by the node appear on the output.
  • Used - Passes through all the fields that the node used to create the output. Used fields include any input field referenced by a property, be it explicitly (i.e., via a 'field1' reference) or via a field pattern (i.e., '1:foo*').
  • Unused - Passes through all the fields that the node did not use to create the output.

If a naming conflict exists between a pass-through field and an explicitly named output field, an error will occur.

The default value is Used.

ServerUsername

Specify the username to login to the SharePoint server. May contain name of domain if necessary in format "Domain\Username".

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

ServerPassword

Specify the password to login to the SharePoint server.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

ServerAuthenticationMethod

Optionally specify the authentication method used to verify the user of the SharePoint site. The following options are available:

  • Basic
  • Digest
  • NTLM

If it is not set, it will try to automatically detect the best one.

Not set by default.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

ServerPreemptiveAuthentication

Optionally specify whether the basic authentication response is sent before the server gives an unauthorized response. The server returns immediately the resource (if the credentials are valid)

The default value is False.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

ProxyUrl

Optionally specify the URL specifying the proxy server to use for the HTTP requests. The URL should contain the protocol (http or https), the host, and the port. All other parts of the URL will be ignored.

The URL should be in a format similar to the following:

  • HTTP proxy: http://proxy.example.com:1234
  • HTTPS proxy: https://proxy.example.com:443

The node supports automatic detection of system proxy settings To override system proxy settings see the IgnoreSystemProxy property.

ProxyUsername

Optionally specify the proxy username, where the proxy requires authentication.

This property should be left blank if ProxyUrl is not set.

ProxyPassword

Optionally specify the proxy password, where the proxy requires authentication.

This property should be left blank if ProxyUrl is not set.

ProxyAuthenticationMethod

Optionally specify the authentication method used to verify the user of the proxy server. The following options are available:

  • Basic
  • Digest
  • NTLM

If it is not set - it will try to automatically detect the best one.

Not set by default.

ProxyPreemptiveAuthentication

Optionally specify whether the proxy basic authentication response is sent before the server gives an unauthorized response. The server returns immediately the resource (if the credentials are valid)

The default value is False.

IgnoreSystemProxy

If proxy settings are not defined then the system proxy is automatically used. This optional property tells Data360 Analyze to Ignore the system proxy when set to True.

The default value is False.

FileExistsBehavior

Optionally specify what to do when a file being downloaded already exists on the local machine. Choose from:

  • Error - Give a transfer error and skip the file.
  • Log - Log a warning message and skip the file.
  • Ignore - Skip the file.
  • Overwrite - Overwrite the file.
  • Update - Overwrite if the file being downloaded is newer than the existing file.

The default value is Error.

ErrorThreshold

Optionally specify the number of transfer errors that will cause the node to give up and fail.

Each record on the input pin is a "request". A transfer error is any error that causes a request to fail (e.g. a requested file does not exist). Setting this property instructs the node to continue processing requests as long as the number of errors remains below the given threshold.

An error threshold of 0 means never fail on a transfer error (the node will still fail on more serious errors).

The default value is 1(i.e. the node fails on the first error that is encountered).

DownloadStatusCodeOutputField

Optionally specify the name of the field that will contain the download status code.

Possible status code values are:

  • DOWNLOADED - File successfully downloaded;
  • HTTP_REPORTED_ERROR - Server returned unsuccessful HTTP status code;
  • DOWNLOAD_FAILED - Retrieving file from server failed;
  • DOWNLOADED_DATA_PROCESSINGD_FAILED - File content was retrieved, but handling of the content failed;
  • DESTINATION_FILE_ALREADY_EXISTS - File already exists (see "FileExistsBehavior" property);
  • IGNORED - File already exists. Downloading ignored (see "FileExistsBehavior" property).

The DownloadStatusMessageOutputField property can be configured to output a more user friendly description of the status.

If not set, the download status code will not be output.

DownloadStatusMessageOutputField

Optionally specify the name of the field that will contain the user friendly message that describes the status of the download.

If not set, the download status message will not be output.

Inputs and outputs

Inputs: 1 optional (filenames).

Outputs: downloaded files.