Upload 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

Uploads files to a specified SharePoint server using the SharePoint API

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.

The path should contain the Document Library and may contain any nested folders within the Document Library e.g. SharedDocuments/SalesData 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.

A value is required for this property.

LocalPath

Specify the path of a file or directory to upload. Must be an absolute path.

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 insensitive expression used to select which files to upload.

e.g. "Data" would match files in the Folder named Region1Data.xlsx, Region2Data.xlsx, DataForPreviousYears.csv and 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.

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.

ServerRelativeUrlOutputField

Optionally specify the name of the field that contains the relative URL of the uploaded files. This will include the name of the file.

The default value is "_ServerRelativeUrl".

LengthOutputField

Optionally specify the name of the field that will contain the length of the uploaded files.

The default value is "_Length".

FileNameOutputField

Optionally specify the name of the field that will contain the name of the uploaded files.

The default value is "_FileName".

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. Choose from:

  • 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.

The default value is Used.

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

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. Choose from:

  • 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 of 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. Choose from:

  • 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 uploaded 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 uploaded 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 ErrorThreshold of 0 means never fail on a transfer error (the node will still fail on more serious errors).

The default value is 1; the node fails on the first error encountered.

UploadStatusCodeOutputField

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

The default value is "_UploadStatusCode".

Possible status code values are:

  • UPLOADED - File successfully uploaded;
  • HTTP_REPORTED_ERROR - Server returned unsuccessful HTTP status code;
  • DESTINATION_FILE_ALREADY_EXISTS - Destination file already exists(see FileExistsBehavior property);
  • EXISTED_FILE_IS_UP_TO_DATE - Uploading skipped due to already existed file is up to date;
  • SOURCE_FILE_DOES_NOT_EXIST - Local file or folder for uploading can't be found;
  • IGNORED - File already exists. Uploading ignored (see FileExistsBehavior property).

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

UploadStatusMessageOutputField

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

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

Inputs and outputs

Inputs: 1 optional.

Outputs: uploaded files.