Overview
The Carbone node for n8n enables users to interact with the Carbone API, specifically to download a rendered report using its ID. This operation is useful in scenarios where you have previously rendered a report (such as a PDF or document generated from a template and data) and need to retrieve the resulting file for further processing, storage, or distribution within your workflow.
Practical examples:
- Automatically downloading invoices, certificates, or reports generated by Carbone after rendering.
- Integrating document generation into automated business processes, such as sending out personalized reports to clients.
- Archiving generated documents in cloud storage or attaching them to emails.
Properties
| Name | Type | Meaning |
|---|---|---|
| ID | String | The unique identifier of the rendered report you wish to download. |
| Binary Property | String | The name of the binary property under which the downloaded file will be stored in the output item. |
Output
- json: Contains any JSON data passed through from the input item. No new JSON fields are added by this operation.
- binary: A new binary property (with the name specified in "Binary Property") is added to the output item. This property contains the downloaded rendered report file (e.g., a PDF or other document format).
Example output structure:
{
"json": { /* original json data */ },
"binary": {
"data": {
"data": "<Buffer ...>",
"fileName": "Report",
"mimeType": "application/pdf"
}
}
}
- The key under
binary(default:"data") can be customized via the "Binary Property" input.
Dependencies
- External Service: Requires access to the Carbone API.
- API Key/Credentials: You must configure Carbone API credentials in n8n under the name
carboneApi. - n8n Configuration: No special environment variables required beyond standard credential setup.
Troubleshooting
Common Issues:
- Invalid or missing ID: If the provided ID does not correspond to an existing rendered report, the node may throw an error indicating that the resource was not found.
- Missing binary property: If the binary property name is incorrect or missing, the output may not contain the expected file.
- Credential errors: If Carbone API credentials are not set up correctly, authentication errors will occur.
Error Messages & Resolutions:
"No binary data exists on item!": This should not occur for the "Download Rendered Report" operation, but if encountered, ensure the correct operation is selected."No binary data property \"...\" does not exists on item!": Ensure the "Binary Property" matches the expected property name.- Network/API errors: Check your Carbone API credentials and network connectivity.