WebDAV Task

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

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

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:


dpUnspecified (0)	The server will use the protocol default depth for the operation (this is normally "infinity").
dpResourceOnly (1)	The server will operate only on the directory resource URI, and not on any of its internal member resources.
dpImmediateChildren (2)	The server will operate on the directory resource URI and all of its immediate member resources (but on none of their member resources).
dpInfinity (3)	The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the directory hierarchy.

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:


(0) ResourceURI	The URI of the resource being listed.
(1) DisplayName	The name of the resource being listed.
(2) ContentLanguage	The language of the resource being listed.
(3) ContentLength	The length (in bytes) of the resource being listed.
(4) ContentType	The content-type of the resource being listed.
(5) LastModified	The last modified date/time of the resource being listed.
(6) IsDir	Denotes whether the listing is a directory or a file.

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:


(0) ReceivedFileURI	The resource URI of the received file.
(1) ReceivedFileName	The name of the received file.
(2) ReceivedFileSize	The size (in bytes) of the received file.
(3) ReceivedFileDate	The last modified date/time of the received file.

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:


?	Any single character.
*	Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-]	A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\	The slash is ignored and exact matching is performed on the next character.

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:


Character	Escape Sequence
?	[?]
*	[*]
[	[[]
\	[\]

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

Remarks

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


Verbose	The task will report all information regarding the transport.
Info	The task will report all major operations, as well as all warnings and errors.
Warning	The task will report any conditions that could result in unpredictable behavior as well as errors.
Error	The task will report all errors that prevent normal operations from completing.
Fatal	The task will report only serious errors that cause the task to completely stop functioning.

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

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.

Timeout Property (WebDAV Task)

A timeout for the component.

Data Type

Integer

Default Value

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

Store
String

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes

The type of certificate store for this certificate.

The task supports both public and private keys in a variety of formats. When the cstAuto value is used, the task will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR task. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String (read-only)

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

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

AutoDetect
Boolean

Tells the task whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String

Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting.

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

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

AuthScheme
ProxyAuthSchemes

Use the AuthScheme field to tell the task which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the task. Look at the configuration file for the task being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password.

AutoDetect
Boolean

Tells the task whether or not to automatically detect and use proxy system settings, if available.

Password
String

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
Integer

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
ProxySSLTypes

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String

A user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

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

Authorization: The Authorization string to be sent to the server.

If the Authorization setting contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the WebDAV task can be extended with other security schemes in addition to the authorization schemes already implemented by the task.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization header in the form "Basic [encoded-user-password]".

DownloadCacheFile: When set, only new files will be downloaded from the server.

This may be set to the location of a file on disk that will hold the names of files that were previously downloaded from the server. On each PollingInterval the task will check to see if the file on the server exists in this list. If the file exists in this list, it is determined that the file was previously downloaded and is not downloaded on the current polling interval. The list is automatically updated on each polling interval. Please see DownloadCacheFileDuration and EnableFileDetailsComparison for more configuration options.

DownloadCacheFileDuration: The number of minutes that a file name will remain in the download cache.

If a file name is added to the DownloadCacheFile and is not seen on the server again within DownloadCacheFileDuration minutes, it will be removed from the cache. This can prevent the download cache file from growing too large in certain cases.

The default value is 0, meaning that files will never be removed.

This setting is only applicable if DownloadCacheFile is set.

EnableFileDetailsComparison: Whether the receive task should consider metadata differences when deciding whether to download a file again.

This setting is used in conjunction with DownloadCacheFile, and is only available on the receive task. If DownloadCacheFile is enabled, this setting can be used to control how the receive task uses the download file cache information when deciding whether to download a file again. (Similar to the "Enable Timestamp Comparison" property on Microsoft's FTP BizTalk Adapter.)

If this is set to False, the receive task will not download a file again if the cache contains any information about it (that is, if it has been downloaded before).

If this is set to True, the receive task will check the metadata of the remote file against its cached metadata, and will download the file again if any of the metadata differs.

FollowRedirects: Determines what happens when the server issues a redirect.

This setting determines what happens when the server issues a redirect. Normally, the task returns an error if the server responds with an "Object Moved" message. If this setting is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this setting is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same, otherwise the task will throw an exception.

Note that following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this setting is set to 1 (Always), in which case the same credentials are used to connect to the new server.

The default value is 0 (Never). In this case, redirects are never followed, and the task will throw an exception instead.

Valid options are:

0 - Never
1 - Always
2 - Same Scheme

Note: This is applicable to the receive task only.

LocalFile: The name of the LocalFile to which the remote file will be saved.

When set to true, the task will use the specified filename when saving the file in LocalDirectory instead of the name of the file on the server.

Note that if multiple files are downloaded from the server, the task will attempt to save all files using the value specified. For this reason, it is recommended that this setting be used only in cases where only one file is being downloaded from the server.

RenameMode: The condition under which RenameTo is used.

This setting controls when the value specified by RenameTo is used. If RenameTo is not specified, this setting has no impact. By default, downloaded files are only renamed after being successfully submitted to BizTalk (a value of 1). Possible values are:


1 (OnSuccess - default)	The file is renamed using the value in RenameTo only after the message is successfully submitted to BizTalk.
2 (OnFailure)	The file is renamed using the value in RenameTo only after the message submission to BizTalk fails.
3 (Always)	The file is renamed using the value in RenameTo regardless of the message submission result.

RenameTo: A filename to which RemoteFile will be renamed.

After downloading a file, the file on the server may be renamed using this setting. This rename action will take place after the batch submission to BizTalk. If you need to perform actions on a file before this, use the AfterGet property. This setting is used in conjunction with RenameMode to conditionally rename a file. For instance, to rename a file after it has been successfully submitted to BizTalk set the Other property of the task like so: RenameTo=%SourceFileName%.done Macros such as %SourceFileName% are supported as in the given example. A full list of supported macros can be found at the bottom of this section.

TemporaryDownloadExtension: An extension to be appended during download.

During download, it may be necessary for the file on the server to be renamed. After the download is complete the file will be renamed back to the original name.

TemporaryUploadExtension: An extension to be appended during upload.

During upload, it may be necessary for the RemoteFile to be written to a temporary file name. For example, some business process may be set up to expect a specific file extension. Using this setting will allow the task to upload the file without the remainder of the process attempting to pick up the incomplete file.

TempURL: A temporary location on the server to store files before moving them to URL.

If a value is specified, the task will directly upload the file to TempURL. Once the file transfer is complete, the task will move the file to the URL.

Note: This is applicable to the send task only.

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the task will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the task is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the task will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the task will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the task will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the task initiate connections (or accept in the case of server tasks) only through that interface.

If the task is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the task will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to True.

Setting this configuration setting to True tells the task to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

If using the .NET Standard Library, this setting will be True on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all tasks used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.