Overview
The "Carbone Lifecycle" node integrates with the Carbone API to manage document templates and reports through various lifecycle stages. It supports creating or uploading templates, generating reports from templates with data, checking the status of report generation, and downloading completed reports.
This node is beneficial in scenarios where automated document generation is required, such as generating invoices, contracts, or personalized reports based on dynamic data. For example, a user can upload a DOCX invoice template, generate invoices by providing customer data, check if the report is ready, and then download the final PDF invoice.
Specifically, the Get Report Status operation allows users to query the current processing status of a previously requested report generation by providing its report ID.
Properties
| Name | Meaning |
|---|---|
| Report ID | ID of the report to check. This is a required string input used to identify the report whose status you want to retrieve. |
Output
The output JSON for the Get Report Status operation contains the response from the Carbone API about the report's current status. This typically includes fields indicating whether the report is still processing, completed, or failed, along with any relevant metadata provided by the API.
No binary data is output for this operation.
Example output structure (simplified):
{
"status": "completed",
"reportId": "abc123",
"message": "Report is ready for download"
}
Dependencies
- Requires an API key credential for authenticating with the Carbone API.
- The node expects the Carbone API URL and API key to be configured in the credentials.
- Network access to the Carbone API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or expired API key leading to authentication errors.
- Providing an incorrect or non-existent Report ID will result in errors or empty status responses.
- Network connectivity problems may cause request failures.
Error messages:
- Authentication errors usually indicate invalid credentials; verify and update the API key.
- "Report not found" or similar messages suggest the Report ID does not exist or has expired.
- Timeout or network errors require checking internet connection and API endpoint accessibility.
Links and References
- Carbone API Documentation (for detailed API endpoints and report lifecycle)
- n8n documentation on Creating Custom Nodes