Folder List 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

Lists the contents of a SharePoint document library or folder using the SharePoint API.

Note: If the ServerPath does not exist then no records will be output. If the ServerPath exists but there are no files contained there will be no output.

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

Optionally specify the SharePoint server path to scan.

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

The Pattern property may also be defined to narrow down the returned result set. See the Pattern property for further information.

The default value is "/" and it points to the root of the SharePoint server.

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 to select which files to list 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 cannot 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.

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 search results for Files/Folders on 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 uploaded file was created.

The default value is "_TimeCreated".

TimeLastModifiedOutputField

Optionally specify the field that will contain the time the uploaded file was last modified.

The default value is "_TimeLastModified".

ConvertTimesToLocal

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

By default times will be converted to local time.

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.

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

Inputs and outputs

Inputs: 1 optional (input fields).

Outputs: out1.