Comment on page
Dropbox
Discover more about the Dropbox component and how to use it on the Digibee Integration Platform.
The Dropbox component allows a connection with the Dropbox service to be established, on top of enabling the following operations with files: Download, Upload and Delete.
Take a look at the configuration parameters of the component. Parameters supported by Double Braces expressions are marked with
(DB)
.Parameter | Description | Default value | Data type |
---|---|---|---|
Account | Account for the component to make the service authentication. It’s necessary to use an Oauth-Bearer account type. Check the official documentation to know more about Dropbox credentials. | N/A | String |
Operation | Operation to be executed, which can be Download, Upload, or Delete. | Download | String |
File Name | File name or full file path (i.e. tmp/processed/file.txt) of the local file. Applicable only in the Download and Upload operations. | N/A | String |
Remote File Name | File name or full file path of the remote file (e.g. tmp/file.txt). | N/A | String |
Remote Directory | Dropbox remote directory in which the selected operation will take place. | N/A | String |
Fail On Error | If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property. | False | Boolean |
The component expects the following mandatory fields to be filled:
- Account
- File Name
- Remote File Name
- Remote Directory
It is also possible to provide the parameters (except to Account and Operation) related to the file inside the integration flow. In this case, the component expects a message in the following format:
{
"filename": "data.csv",
"remoteFileName": "data.csv,
"remoteDirectory": "/"
}
When executing the component, the following JSON structure will be generated when the action is successfully completed:
{
"fileName": "data.csv",
"remoteDirectory": "/",
"remoteFileName": "data.csv",
"success": true
}
If an error occurs during the operation execution, the following JSON structure will be generated:
{
"error": {"exception": "<ERROR DETAILS>",
"message": "<ERROR MESSAGE>",
"success": false
},
"success": false
}
Important: 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.
- Local file: data.csv
Parameters:
- Account: dropbox-test
- Operation: Upload
- File Name: data.csv
- Remote File Name: data.csv
- Remote Directory: /Public
or
- Account: dropbox-test (via component configuration screen)
- Operation: Upload (via component configuration screen)
- Payload:
{
"fileName": "data.csv",
"remoteFileName": "data.csv",
"remoteDirectory": "/Public"
}
{
"fileName": "data.csv",
"remoteDirectory": "/Public",
"remoteFileName": "data.csv",
"success": true
}
Parameters:
- Account: dropbox-test
- Operation: Download
- File Name: data.csv
- Remote File Name: data.csv
- Remote Directory: /Public
or
- Account: dropbox-test (via component configuration screen)
- Operation: Download (via component configuration screen)
- Payload:
{
"fileName": "data.csv",
"remoteFileName": "data.csv",
"remoteDirectory": "/Public"
}
{
"fileName": "data.csv",
"remoteDirectory": "/Public",
"remoteFileName": "data.csv",
"success": true
}
The file download will be made in the pipeline local directory.
Parameters
- Account: dropbox-test
- Operation: Delete
- File Name: data.csv
- Remote File Name: data.csv
- Remote Directory: /Public
or
- Account: dropbox-test (via component configuration screen)
- Operation: Delete (via component configuration screen)
- Payload:
{
"fileName": "data.csv",
"remoteFileName": "data.csv",
"remoteDirectory": "/Public"
}
{
"fileName": "data.csv",
"remoteDirectory": "/Public",
"remoteFileName": "data.csv",
"success": true
}
Last modified 1mo ago