WebDAV Task

Properties   Config Settings  

The WebDAV Component adds SSL-enabled WebDAV send and receive capabilities to your SSIS Package.

Remarks

The WebDAV Task provides support for uploading and downloading files to and from a WebDAV server.

WebDAV Receive Task

The WebDAV Receive Task is used to download files from the WebDAV Server. To begin set the URL and FileMask properties.

URL should be set to the URL including the directory from which the files will be downloaded. For instance:

https://www.test.com/DAV/pictures/animals/cats/

FileMask should be set to a pattern like *.png. The task will download files matching the specified pattern. The default value is *.*.

The Depth property specifies how deep the server should operate within a directory.

Authentication to the WebDAV server is supported by setting User and Password. A Variety of authentication methods are supported via the AuthScheme property.

The task will connect to the WebDAV server and list the directory at URL. All files that match the FileMask will be downloaded and submitted to the SSIS Package as individual messages.

In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. Alternatively, you may use the Other property to configure either the DownloadCacheFile and EnableFileDetailsComparison settings, or the RenameTo and RenameMode settings.

WebDAV Send Task

The WebDAV Send Task is used to upload files to the WebDAV Server. To begin set the URL and RemoteFile properties.

URL should be set to the URL including the directory from which the files will be downloaded. For instance:

https://www.test.com/DAV/pictures/animals/cats/

RemoteFile should be set to the name of the file to be uploaded. For instance %RemoteFile%.

Authentication to the WebDAV server is supported by setting User and Password. A Variety of authentication methods are supported via the AuthScheme property.

The task will connect to the WebDAV server whenever it has a message to send. The task will attempt to upload to a resource URI generated based on the values of URL and RemoteFile.

In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension.

Receiver Property List

---

The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.

AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Delete	Controls if the remote file is deleted after download.
Depth	How deep the server should operate within a directory.
DirList	String denoting the name of the variable which contains the last directory listing entries.
FileMask	Indicates the type of files to download from the server.
Firewall	A set of properties related to firewall access.
HTTPProxy	A set of properties related to proxy access.
LocalDirectory	The directory on the local machine to write downloaded files to.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Operation	The operation which will be executed by the task.
Other	Defines a set of configuration settings to be used by the component.
Overwrite	Whether or not the component should overwrite files during transfer.
Password	The password for login.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.
URL	The URL of the WebDAV location to which the request is made.
User	The user id for login.

Sender Property List

---

The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.

AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Firewall	A set of properties related to firewall access.
HTTPProxy	A set of properties related to proxy access.
LocalFile	The path to a local file for upload.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Other	Defines a set of configuration settings to be used by the component.
Password	The password for login.
RemoteFile	The name of the destination file on the server for uploading.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.
URL	The URL of the WebDAV location to which the request is made.
User	The user id for login.

Config Settings

---

The following is a list of config settings for the task with short descriptions. Click on the links for further details.

Authorization	The Authorization string to be sent to the server.
DownloadCacheFile	When set, only new files will be downloaded from the server.
DownloadCacheFileDuration	The number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparison	Whether the receive component should consider metadata differences when deciding whether to download a file again.
FollowRedirects	Determines what happens when the server issues a redirect.
LocalFile	The name of the LocalFile to which the remote file will be saved.
RenameMode	The condition under which RenameTo is used.
RenameTo	A filename to which RemoteFile will be renamed.
TemporaryDownloadExtension	An extension to be appended during download.
TemporaryUploadExtension	An extension to be appended during upload.
TempURL	A temporary location on the server to store files before moving them to URL.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

AuthScheme Property (WebDAV Task)

The authorization scheme to be used when server authorization is to be performed.

Data Type

Enumeration

Possible Values

Basic (0)
Digest (1)
Proprietary (2)
None (3)
Ntlm (4)
Negotiate (5)
OAuth (6)

Default Value

0

Remarks

This property specifies the type of authentication to perform. Possible values are:

• Basic
• Digest
• Proprietary
• None
• NTLM
• Negotiate
• OAuth

In most cases this setting is only applicable if User and Password is set.

This property is also applicable without setting User and Password if the AuthScheme is set to NTLM or Negotiate. In that case the current user credentials will be used.

AuthScheme should be set to authNone (3) when no authentication is to be performed (or do not set User and Password).

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the task will attempt basic authentication. If AuthScheme is set to authDigest (1) or authNtlm (4), digest or NTLM authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through the Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the task.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Delete Property (WebDAV Task)

Controls if the remote file is deleted after download.

Data Type

Boolean

Default Value

false

Remarks

If this property is set to True, each file is deleted from the server after download.

This property is not available in the Sender.

Depth Property (WebDAV Task)

How deep the server should operate within a directory.

Data Type

Enumeration

Possible Values

Unspecified (0)
Resource Only (1)
Immediate Children (2)
Infinity (3)

Default Value

0

Remarks

During its operation, the task will use Depth to instruct the server on how deep to operate within a directory. Depth is an enumerated type with the following possible values:

This property is not available in the Sender.

DirList Property (WebDAV Task)

String denoting the name of the variable which contains the last directory listing entries.

Data Type

String

Default Value

"<none>"

Remarks

This property denotes a variable name which contains the collection of directory listings returned from the server when the Operation property has been set to opListDirectory. The collection is made up of entries for each listing in the current directory, specified by the URL property.

The variable is in the form of a datatable. The table's rows represent a directory listing, and the columns represent a different property of the listing. The columns of the datatable are listed below:

NOTE: If this property is set to a valid ADO object when the Operation property is set to ReceiveFiles, the task will populate this table with a directory listing of all the files matching the FileMask on the server. The columns of this datatable are listed below:

This property is read-only.

This property is not available in the Sender.

FileMask Property (WebDAV Task)

Indicates the type of files to download from the server.

Data Type

String

Default Value

"*.*"

Remarks

This property will limit what kinds of files the task will download from the server. Only files matching the pattern specified in FileMask will be retrieved.

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

This property is not available in the Sender.

Firewall Property (WebDAV Task)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the task will attempt to connect.

HTTPProxy Property (WebDAV Task)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the task will attempt to connect.

LocalDirectory Property (WebDAV Task)

The directory on the local machine to write downloaded files to.

Data Type

String

Default Value

""

Remarks

This property tells the task where to write all downloaded files to on the local machine. The downloaded files will be written to the remote file name in the specified directory.

This property is not available in the Sender.

LocalFile Property (WebDAV Task)

The path to a local file for upload.

Data Type

String

Default Value

""

Remarks

The LocalFile property is the name of the file or a file mask on the local host to be uploaded to the server. For instance "C:\files\*.txt".

This property is not available in the Receiver.

LogFile Property (WebDAV Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (WebDAV Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:

Operation Property (WebDAV Task)

The operation which will be executed by the task.

Data Type

Enumeration

Possible Values

Receive Files (0)
List Directory (1)
Delete Files (2)

Default Value

0

Remarks

This property specifies the operation to be performed. Possible values are:

• opReceiveFiles (default)
• opListDirectory
• opDeleteFiles

When set to opListDirectory DirList defines the package variable which will be populated with the results.

This property is not available in the Sender.

Other Property (WebDAV Task)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The task accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Overwrite Property (WebDAV Task)

Whether or not the component should overwrite files during transfer.

Data Type

Boolean

Default Value

false

Remarks

This property is a value indicating whether or not the task should overwrite files on the local system if they already exist. If Overwrite is false, an error will be thrown whenever the file exists in LocalDirectory before a download operation.

This property is not available in the Sender.

Password Property (WebDAV Task)

The password for login.

Data Type

Password

Default Value

""

Remarks

This property must be set before the task connects to the server.

RemoteFile Property (WebDAV Task)

The name of the destination file on the server for uploading.

Data Type

String

Default Value

"%SourceFileName%"

Remarks

The value of RemoteFile should be a file name or path relative to URL.

This property is not available in the Receiver.

RuntimeLicense Property (WebDAV Task)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

SSLAcceptServerCert Property (WebDAV Task)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the task will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the task will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (WebDAV Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (WebDAV Task)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Timeout Property (WebDAV Task)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the task will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the task fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the task may be changed to absolute timeouts, i.e. the task will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

URL Property (WebDAV Task)

The URL of the WebDAV location to which the request is made.

Data Type

String

Default Value

""

Remarks

This property specifies the URL of the WebDAV folder to which the request is made. For instance: https://www.test.com/DAV/pictures/animals/cats/.

TLS/SSL will be used if and only if the URL scheme is "https".

User Property (WebDAV Task)

The user id for login.

Data Type

String

Default Value

""

Remarks

This property must be set before the task connects to the server.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

Config Settings (WebDAV Task)

The task accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

WebDAV Config Settings

SSL Config Settings

General Config Settings