WebDAV Connector

Version 20.0.7681


WebDAV Connector


WebDAV Connectors support uploading resources to and downloading resources from an HTTP server.

Overview

Each WebDAV Connector is configured with an upload path and download paths on the remote server. Files processed by the connector will automatically be uploaded at the specified upload path, and the download paths will be polled for resources to retrieve.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Authentication

Settings related to authenticating with the remote connection target.

  • Connector Id The static name of the connector. All connector-specific files are held in a folder by the same name within the Data Directory.
  • Connector Description An optional field to provide free-form description of the connector and its role in the flow.
  • URL The URL of the remote HTTP server host.

Auth Scheme

The type of authentication that should be performed against the server.

  • User Name The username credential for authenticating with the server.
  • Password The password credential for authenticating with the server.
  • Authorization Token The token required for authorization when Auth Scheme is set to ‘Proprietary’.

Server Authentication

Settings related to authenticating the identity of an SSL server.

  • Server Public Certificate The expected public certificate for the target server. Only necessary if the target URL is an HTTPS URL (rather than HTTP). This setting can be set to ‘Any Certificate’ to implicitly trust the certificate presented by the server.

Send

Settings related to uploading files to the remote server.

  • Remote Folder The folder on the server where files will be uploaded.
  • Overwrite remote files Whether files that already exist in the specified folder should be overwritten during upload.

Receive

Settings related to downloading resources from the remote server.

  • Remote Folder The folder on the remote server that will be polled for resources to download. Multiple folders can be specified in a comma-delimited list.
  • File Mask A glob pattern that determines which files within the Remote Folder should be downloaded. Multiple patterns may be specified in a comma-delimited list.
  • Overwrite local files Whether files that already exist locally should be overwritten during download.
  • Delete files (after received) Whether files that are successfully downloaded should be deleted from the remote server.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

  • Send Whether files arriving at the connector will automatically be uploaded.
  • Retry Interval The amount of time before a failed upload is retried.
  • Retry Maximum Attempts The maximum number of times a failed upload will be retried.
  • Receive Whether the connector should automatically poll the remote download folder for files to download.
  • Receive Interval The interval between automatic download attempts.
  • Minutes The number of minutes to wait before downloading. Only applicable when Receive Interval is set to Minute.
  • Minutes Past the Hour The minutes offset for an hourly schedule. Only applicable when Receive Interval is set to Hourly. For example, if this value is set to 5, the automation service will download at 1:05, 2:05, 3:05, etc.
  • Time The time within a given day that the download should occur. Only applicable when Receive Interval is set to Daily, or Weekly, or Monthly.
  • Day The day on which the download should occur. Only applicable when Receive Interval is set to Weekly or Monthly.
  • Cron Expression An arbitrary string representing a cron expression that determines when the download should occur. Only applicable when Receive Interval is set to Advanced.

Advanced Tab

SSL Client Authentication

Settings related to client authentication when two-way SSL authentication is required.

  • Private Certificate The private certificate presented during SSL client authentication.
  • Certificate Password The password required to access the SSL client certificate.

Local Folders

Settings that determine where files will be uploaded from and downloaded to.

  • Input Folder (Send) Files placed here will be uploaded by the connector. If Send Automation is enabled, the connector will automatically poll this location for files to upload.
  • Output Folder (Receive) Files that are downloaded by the connector will be placed here. If the connector is connected to another connector in the flow, files will not remain here and will instead be passed along to the Input/Send folder for the connected connector.
  • Processed Folder (Sent) The connector will place a copy of uploaded files here if Save to Sent Folder is enabled. This copy of the file will not be passed along to the next connector in the flow.

Performance

Settings related to the allocation of resources to the connector.

  • Max Workers The maximum number of worker threads that will be consumed from the threadpool to process files on this connector. If set, overrides the default setting from the Profile tab.
  • Max Files The maximum number of files that will be processed by the connector each time worker threads are assigned to the connector. If set, overrides the default setting from the Profile tab.

Other Settings

Settings not included in the previous categories.

  • Enable File Size Comparison Whether to cache downloaded file names and sizes; if True then files will only be downloaded if they have not been downloaded before or have changed in size.
  • Enable Timestamp Comparison Whether to cache downloaded file names and last-modified timestamps; if True then files will only be downloaded if they have not been downloaded before or have been modified since they were downloaded.
  • Recurse Subdirectories Whether to download files in subfolders of the target remote path.
  • Timeout The duration that the connector will wait for a connection response before throwing an error.
  • Log Level The verbosity of logs generated by the connector. When requesting support, it is recommended to set this to Debug.
  • Parent Connectors The connector from which settings should be inherited, unless explicitly overwritten within the existing connector configuration. Must be set to a connector of the same type as the current connector.

Establishing a Connection

To establish a connection, the WebDAV Connector requires the URL of the target HTTP server and any authentication credentials required by the server.

The Auth Scheme property should be set to the appropriate authentication mechanism, and the settings tab will automatically update with the appropriate set of credentials to enter.

Uploading

The Remote Folder setting within the Send section specifies the path on the remote HTTP server where files should be uploaded.

The WebDAV Connector supports automatic upload via the Automation tab in the connector configuration panel. When Upload automation is enabled, files that reach the Input folder for the connector will be automatically uploaded to the specified Remote Path.

If a file fails to upload, the application will attempt to send it again after the Retry Interval has elapsed. This process will continue until the Retry Maximum Attempts has been reached, after which the connector will raise an error.

Downloading

The Remote Path setting within the Download section specifies the path on the remote HTTP server where files will be downloaded.

The File Mask setting provides a way to only download filenames that match a specific pattern.

The WebDAV Connector supports automatic download via the Automation tab in the connector configuration panel. When Download automation is enabled, will be automatically downloaded according to the specified Download Interval.

If a file fails to download, the application will attempt to send it again after the Retry Interval has elapsed. This process will continue until the Retry Maximum Attempts has been reached, after which the connector will raise an error.