WebDAV Adapter
Properties Configuration Settings
The WebDAV Adapter adds SSL-enabled WebDAV send and receive capabilities to your BizTalk Server.
Remarks
The WebDAV Adapter provides support for uploading and downloading files to and from a WebDAV server.
WebDAV Receive Adapter
The WebDAV Receive Adapter 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 adapter 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 adapter will connect to the WebDAV server every PollingInterval and list the directory at URL. All files that match the FileMask will be downloaded and submitted to the BizTalk Message Engine 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 Adapter
The WebDAV Send Adapter 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 adapter will connect to the WebDAV server whenever it has a message to send. The adapter 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.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.
| AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
| DeleteMode | Controls if and when the remote file is deleted after download. |
| Depth | How deep the server should operate within a directory. |
| ErrorThreshold | The maximum number of errors before the adapter shuts down. |
| 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. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| Password | The password for login. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileDate | The last modified date of the remote file received by the adapter. |
| ReceivedFileName | The name of the remote file received by the adapter. |
| ReceivedFileSize | The size of the remote file received by the adapter. |
| ReceivedFileURI | The resource URI of the remote file received by the adapter. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| SSLAcceptServerCert | Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| TempPath | A temporary local directory where data can be stored before the adapter processes it. |
| Timeout | A timeout for the adapter. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| 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 adapter 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. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| Password | The password for login. |
| RemoteFile | The name of the destination file on the server for uploading. |
| SSLAcceptServerCert | Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the adapter. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| URL | The URL of the WebDAV location to which the request is made. |
| User | The user id for login. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| Authorization | The Authorization string to be sent to the server. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| TempURL | A temporary location on the server to store files before moving them to URL. |
| 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 adapter should consider metadata differences when deciding whether to download a file again. |
| LocalFile | Specifies the local file to upload or download. |
| RenameTo | A filename to which RemoteFile will be renamed. |
| RenameMode | The condition under which RenameTo is used. |
| TemporaryDownloadExtension | An extension to be appended during download. |
| TemporaryUploadExtension | An extension to be appended during upload. |
| DownloadSingleFile | If set to true, the send adapter will download a file instead of upload. |
| Download | If set to true, the send adapter will download files instead of upload. |
| DeleteAfterDownload | If set to true, deletes the file after download. |
| DeleteOnUploadError | Whether to delete the remote file when an error occurs after upload begins. |
| ListDirectory | If set to true, the send adapter will list the directory instead of upload. |
| Depth | How deep the server should operate within a directory. (Send adapter only). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| 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. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLSNamedGroups | The supported (EC)DHE groups. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| 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 adapter whether or not to use the system security libraries or an internal implementation. |