NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Carbone

carbone

Carbone is a fast and simple report generator that converts JSON data into various document formats such as PDF, DOCX, XLSX, ODT, and more, using templates.

DocumentsWeb del proveedor
Acciones
7
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (7)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Delete Carbone TemplateCARBONE_DELETE_TEMPLATEAcción

Tool to delete a template from the carbone server. use after confirming you have the correct template id.

Parámetros de entrada

  • templateIdstringObligatorio

    Unique identifier (SHA-256 hash) of the template to delete, as returned when uploading

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Download TemplateCARBONE_DOWNLOAD_TEMPLATEAcción

Tool to download a template from carbone by template id. use when you need to retrieve the original template file.

Parámetros de entrada

  • template_idstringObligatorio

    The unique identifier (SHA256) of the template to download.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Carbone ReportCARBONE_GENERATE_REPORTAcción

Tool to generate a carbone report from a template and json data. use when you need to render documents in various formats.

Parámetros de entrada

  • dataobjectObligatorio

    Data to merge into the template as a JSON object or an array of objects

  • enumobject

    Enumerations to use with convEnum formatter, e.g. {'ORDER_STATUS': ['open', 'close']}

  • langstring

    Locale of the generated document, e.g. 'en-us'

  • timezonestring

    Convert document dates to this timezone, e.g. 'Europe/Paris'

  • convertTostring

    Output file format as a string, e.g. 'pdf', or an object with formatName and formatOptions

  • complementobject

    Extra data object merged into the template with tags {c.}

  • reportNamestring

    Static or dynamic file name returned in the content-disposition header, e.g. '{d.date}.odt'

  • templateIdstringObligatorio

    Unique identifier of the Carbone template used to generate the report

  • batchOutputstringenum

    Output type for batch processing: 'zip' or 'pdf'

    zippdf
  • hardRefreshboolean

    Force recompute pagination and table of contents

  • variableStrstring

    Predefined alias for template variables, e.g. '{#def = d.id}'

  • batchSplitBystring

    Batch processing split key, e.g. 'd.items'

  • translationsobject

    Localization dictionary for translations formatter, e.g. {'fr-ca': {'one': 'un'}}

  • currencyRatesobject

    Mapping of currency codes to exchange rates

  • currencySourcestring

    Currency source code for conversions, e.g. 'EUR'

  • currencyTargetstring

    Target currency code for conversions, e.g. 'USD'

  • carbone-webhook-urlstring

    Webhook URL for asynchronous report generation. Include to enable async jobs.

  • carbone-webhook-headersobject

    Custom headers for webhook calls, as a map of header name to value.

Parámetros de salida

  • dataobject

    Data containing the renderId if the generation succeeded

  • errorstring

    Error if any occurred during the execution of the action

  • successbooleanObligatorio

    Whether the generation was successful

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Template IDCARBONE_GENERATE_TEMPLATE_IDAcción

Tool to generate a unique template id for a new template. use when you need the template identifier before uploading.

Parámetros de entrada

  • templatestringObligatorio

    Base64-encoded content of the template file (pure base64 or data-URI), used to compute the template ID without uploading.

Parámetros de salida

  • dataobjectObligatorio

    Container for the generated template ID.

  • errorstring

    Error if any occurred during the execution of the action

  • successbooleanObligatorio

    Indicates if the ID generation was successful.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Carbone Server StatusCARBONE_GET_STATUSAcción

Tool to retrieve the current status and health of the carbone server. use before generating reports to ensure the service is operational.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Carbone API VersionCARBONE_SET_API_VERSIONAcción

Tool to set the carbone api version to be used for subsequent requests. use before rendering or managing templates to ensure correct version is applied.

Parámetros de entrada

  • versionintegerObligatorio

    Major Carbone API version (e.g., 4)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload a templateCARBONE_UPLOAD_TEMPLATEAcción

Tool to upload a template to the carbone server. use when you need to add or replace a template by providing its content.

Parámetros de entrada

  • templatestringObligatorio

    Template file content to upload. Provide raw bytes for multipart/form-data upload, or a base64-encoded string (pure base64 or data-URI) for JSON upload.

Parámetros de salida

  • dataobjectObligatorio

    Container for the template ID of the uploaded file.

  • errorstring

    Error if any occurred during the execution of the action

  • successbooleanObligatorio

    True if the upload was successful.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not