WebDav (Deprecated)

Discover more about the WebDav component and how to use it on the Digibee Integration Platform.

The WebDav component is deprecated and no longer updated. Please refer to the document with the most recent version of the feature: WebDav V2.

WebDav connects to WebDAV endpoints and issues Upload, Download, List and Delete commands.

Parameters

Take a look at the configuration parameters of the component:

Parameter	Description	Default value	Data type
Account	Account to be used by the component.	N/A	String
Host	Name of the host for connection.	N/A	String
File Name	Name of the local file without path.	N/A	String
Remote File Name	Name of the remote file without path.	N/A	String
Remote Directory	Remote directory.	N/A	String
FTP Operation	Command used to Download, Upload, List, or Delete.	N/A	String
Fail On Error	If the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Messages flow

Input

The component waits for a message in the following format:

{        
    "fileName": "file",
    "remoteFileName": "remoteFileName",
    "remoteDirectory": "remoteDirectory"
}

Local File Name overrides the default local file and Remote File Name substitutes the default remote file.

Output

{        
    "status" : {
        "fileName": "",
        "remoteFileName": "",
        "remoteDirectory": "",
        "success": ""
    }
}

Local File Name is the local file generated from a download. Remote File Name is the remote file generated from a successful upload.

The files manipulation inside a pipeline occurs in a protected way. All the files can be accessed with a temporary directory only, where each pipeline key gives access to its own files set.

WebDav in Action

Delete

• Configuration

{
    "type": "connector",
    "name": "webdav-connector",
    "stepName": "test-ftp",
    "accountLabel": "webdav",
    "params": {
        "operation": "DELE",
        "fileName": "data.csv",
        "remoteFileName": "data11.csv",
        "host": "https://ftp13.interfile.com.br/",
        "remoteDirectory": "/remote.php/webdav"
    }
}

• Output

{
    "fileName": "data.csv",
    "remoteFileName": "data11.csv",
    "remoteDirectory": "/remote.php/webdav",
    "success": true
}

Download

• Configuration

{
    "type": "connector",
    "name": "webdav-connector",
    "stepName": "test-ftp",
    "accountLabel": "webdav",
    "params": {
        "operation": "RETR",
        "host": "https://ftp13.interfile.com.br/"
    }
}

• Input

{
    "fileName": "data.csv",
    "remoteFileName": "data11.csv",
    "remoteDirectory": "/remote.php/webdav"
}

• Output

{
    "fileName": "data.csv",
    "remoteFileName": "data11.csv",
    "remoteDirectory": "/remote.php/webdav",
    "success": true
}

Upload

• Configuration

{
    "type": "connector",
    "name": "webdav-connector",
    "stepName": "test-ftp",
    "accountLabel": "webdav",
    "params": {
        "operation": "STOR",
        "host": "https://ftp13.interfile.com.br/"
    }
}

• Input

{
    "fileName": "data.csv",
    "remoteFileName": "data11.csv",
    "remoteDirectory": "/remote.php/webdav"
}

• Output

{
    "fileName": "data.csv",
    "remoteFileName": "data11.csv",
    "remoteDirectory": "/remote.php/webdav",
    "success": true
}