Change Log
Carbone Enterprise Edition is one major version ahead of the Community Edition.
v5.0.0-beta.4
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-5.0.0-beta.4
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-5.0.0-beta.4
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-5.0.0-beta.4
Contact us to enable all Enterprise Features [EE]
- Release February 18th 2025
- [EE] Improve the position values returned by the
:sign
formatter:- Return integers instead of floats. Since a point is 1/72 inch, integer precision is sufficient.
- Set the origin
(x = 0, y = 0)
at the top-left corner of the page to simplify integration with third-party solutions. - Define the x-axis as extending to the right and the y-axis as extending downward.
- Enhance the precision of the X/Y position by ensuring the returned position corresponds to the top-left corner of the tag.
- [EE] For DOCX and ODT templates, two new HTML formatter options are available:
- inline: Render HTML within the current DOCX paragraph, at the same location, without moving or adding paragraphs. This option will only render the following HTML tags:
a
,b
,strong
,em
,i
,s
,del
,u
. Other HTML tags are skipped and not rendered. Example usage:{d.value:html(inline)}
- nospace: Render HTML without adding extra DOCX paragraphs at the end of each
<p>
tags.
- inline: Render HTML within the current DOCX paragraph, at the same location, without moving or adding paragraphs. This option will only render the following HTML tags:
- [EE] For DOCX templates, the HTML formatter has been updated with the following improvements:
- Hyperlinks (a
a
tags) are now rendered in headers and footers. - Images (a
img
tags) are now rendered in headers and footers. - If the HTML contains ordered (
ol
) or unordered (ul
) lists, there is no need to pre-create a list in the template using your text editor. Carbone will render the list directly in the DOCX format without any manual intervention. - When injecting multiple HTML lists using the HTML formatter, numbered lists now maintain consistent ordering. Previously, numbering might continue across multiple different lists.
- Hyperlinks (a
- [EE] For ODT templates, the HTML formatter is now supported in headers and footers.
v5.0.0-beta.3
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-5.0.0-beta.3
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-5.0.0-beta.3
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-5.0.0-beta.3
Contact us to enable all Enterprise Features [EE]
- Release February 3rd 2025
- The new templating engine preserves line breaks in templates! Now, you can create CSV or TXT templates. It fixes line breaks in XLSX files.
- [EE] Added the
batchOutput
option to thePOST /render
endpoint, to allow returning a single assembled PDF file instead of a ZIP file during batch processing. Accepted values:pdf
orzip
(default). - [EE] New formatter
:sign
. This can be used with PDF generation to place signatures at specific positions in a document. ThePOST /render
endpoint returns additional details indicating where each signature should be placed in the final PDF, along with its associated data. This information can be shared with any third-party tool to manage the signature process. For example, if the template contains the tags{d.owner:sign}
and{d.buyer:sign}
, the API returns the following information:
In a standard PDF coordinate system, the origin{ "debug": { "signatures": [ { "data" : "Bob", // Content of {d.owner}. Can be a string, number, object, or array "page" : 1, "x" : 72.1, "y" : 693.436 }, { "data" : "Alice", // Content of {d.buyer} "page" : 1, "x" : 72.1, "y" : 693.436 } ] } }
(x = 0, y = 0)
is at the bottom-left corner of the page. The x-axis extends to the right, and the y-axis extends upward. The API returns an error, and the report is not generated in the following cases:- If the number of injected signatures exceeds 999.
- If a signature position cannot be determined.
The
:sign
formatter prints a text in the final document in the format "ʕ010". Our recommendation is to set the text color to white in the template to make it invisible in the generated PDF.
v5.0.0-beta.2
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-5.0.0-beta.2
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-5.0.0-beta.2
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-5.0.0-beta.2
Contact us to enable all Enterprise Features [EE]
- Release January 30th 2025
- 👋 This is a minor release. A major update is coming soon with exciting features such as Signatures, PDF Merging, a Chrome converter, and Markdown/HTML templates in just a few days.
- Fixed a crash that occurred during a graceful exit when the systemd watchdog was activated.
- Includes all fixes from v4 up to v4.25.3.
- Show an error message if the studio is not running in a secure context.
- Improved Studio:
- Added text search functionality with a search button and shortcuts:
Ctrl+F
(open search)Ctrl+G
(next occurrence)Shift+Ctrl+G
(previous occurrence)
- Fixed inconsistent icon widths.
- Added functionality to switch between data/complement/enum/translations.
- Replaced the save button with a refresh button.
- Scroll position in the JSON editor/viewer is now preserved.
- Optimized JSON parsing between JSON editors for better performance.
- Modifications are now preserved when switching between JSON editor and viewer modes.
- Fixed language icon display issues on Windows.
- Prevent leaving the JSON editor when an error occurs.
- Updated PDF.js from version 4.7.76 to 4.10.38.
- Reduced gaps between icons for better alignment.
- Improved the design of the page input field in preview mode.
- Added text search functionality with a search button and shortcuts:
v5.0.0-beta.1
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-5.0.0-beta.1
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-5.0.0-beta.1
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-5.0.0-beta.1
Contact us to enable all Enterprise Features [EE]
- Release December 17th 2024
- Includes v4.25.0
v5.0.0-beta.0
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-5.0.0-beta.0
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-5.0.0-beta.0
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-5.0.0-beta.0
Contact us to enable all Enterprise Features [EE]
- Release October 29th 2024
- Check out the full release notes is here
v4.25.5
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.5
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.5
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.5
Contact us to enable all Enterprise Features [EE]
- Release February 8th 2025
- Fix: Carbone did not escape some forbidden characters in XML when an array was printed in the template without using the
arrayJoin
formatter. This fix is activated only when the prerelease tag{o.preReleaseFeatureIn=4024000}
is set.
v4.25.4
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.4
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.4
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.4
Contact us to enable all Enterprise Features [EE]
- Release February 6th 2025
- Fix: Carbone tags in sheet names were not updated since v4.25.3
v4.25.3
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.3
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.3
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.3
Contact us to enable all Enterprise Features [EE]
- Release January 28th 2025
- Fixed an issue with corrupted XLSX files caused by defined range names.
- Accepts array filters with colons and
&
, such as{d.myArray[filter='string&with:colons'].id}
, when{o.preReleaseFeatureIn=4022011}
is activated. Note: Array filters with commas are still not supported in v4. This will be addressed in v5. - Formatters containing '&' do not print '&' in the generated document, when
{o.preReleaseFeatureIn=4022011}
is activated.
v4.25.2
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.2
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.2
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.2
Contact us to enable all Enterprise Features [EE]
- Release January 20th 2025
- [EE] Fixed some issues with the
:set
formatter when{o.preReleaseFeatureIn=4022011}
is activated, especially in combination with array filters and conditions. The fix resolves the following cases for:set
:{d.myArray[filter=2].val:set(d.result)}
: Stores the first valueval
found in the array that matches the array filterfilter=2
(Now the behavior is the same with or without:set
).{d.myArray[filter=2].val:ifEM:show(10):set(d.result)}
: Stores the first valueval
found that matches the filterfilter=2
, otherwise stores "10".{d.myArray[filter=2].val:ifEM:show(10):set(.newAttribute)}
: Adds a new attribute inmyArray
(copy of.val
), setting its value to "10" for all items inmyArray
that do not match the filterfilter=2
.
- The
:convCRLF
option is now supported in ODP templates. - [EE] For ODT/ODS templates, you can now create dynamic bookmarks. To add a dynamic bookmark to a template, right-click on the selected text, navigate to the 'Insert' menu, select 'Bookmark,' and then write the Carbone tag. The value can be a single tag
{d.bookmark}
or a loop expression{d.list[i].bookmark}
. Please note that the following characters are not allowed in a bookmark:/@*?",#
. - Fixed invalid metrics for
fetchImageTime
,fetchFileTime
,fetchImageBytes
v4.25.1
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.1
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.1
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.1
Contact us to enable all Enterprise Features [EE]
- Release December 19th 2024
- [EE] Fixed a random crash occurring when multiple documents fail to download while using
:appendFile
. - [EE] Fixed crash when using an invalid image URL in injected HTML
v4.25.0
Show download links
Binaries Getting started
Docker Getting started
- Ready to use:
carbone/carbone-ee:full-4.25.0
- Includes 2GB of fonts :
carbone/carbone-ee:full-fonts-4.25.0
- Only Carbone (without document converters) :
carbone/carbone-ee:slim-4.25.0
Contact us to enable all Enterprise Features [EE]
- Release December 9th 2024
- Add a new option to the API endpoint
POST /render/:idTemplate
. The query parameter?download=true
can be used to download the rendered report directly.- When this option is used, the file is not stored on our servers. A single API call is enough to download the file. There is no need to call
GET /render
. - Important: The
Content-Disposition
header changes based on the HTTP status:- If the status is 200 (OK):
Content-Disposition: 'attachment; filename="report.pdf"' Content-Type: 'application/pdf'
- For all other statuses:
The response remains in
application/json
format as before.
- If the status is 200 (OK):
- When this option is used, the file is not stored on our servers. A single API call is enough to download the file. There is no need to call
v4.24.2
- Release November 7th 2024
- [EE] Fix: Accept array filters with commas enclosed in quotes when using the
:set()
formatter with the prerelease tag{o.preReleaseFeatureIn=4022011}
in ODT templates (enabled by default in Carbone v5). - Fix: Prevent generating corrupted documents when a custom iterator contains a
null
orundefined
value in a loop (e.g.,{d[sort].id} -> {d[sort+1].id}
). This fix is activated only if{o.preReleaseFeatureIn=4024000}
(enabled by default in Carbone v5).
v4.24.1
- Release November 6th 2024
- [EE] Fix: the
:html
formatter in DOCX templates where the default template style might not have been applied. - [EE] Fix: Accept array filters with commas enclosed in quotes when using the
:set()
formatter with the prerelease tag{o.preReleaseFeatureIn=4022011}
.
v4.24.0
- Release October 25th 2024
- Accept
xls
(Excel 2003) template files only for document conversion. - [EE] Fix the
:html
formatter in ODT templates where ordered and unordered lists contain mixed line break tags. - [EE] Generate a fully compliant Factur-X PDF when the attached XML file is named 'factur-x.xml' (
:attachFile('factur-x.xml')
). It automatically detects the Conformance Level from the attached XML ('MINIMUM', 'BASIC WL', 'BASIC', 'EXTENDED', 'EN 16931') and adjusts the PDF metadata accordingly. Additionally, it setsSelectPdfVersion = 3
(PDF Version 3B) by default if not specified and if the output file is a PDF. - [EE] Add a
type
parameter to theattachFile(filename, type)
formatter to specify the PDF AFRelationship. Options fortype
include: "Source", "Data" (default), "Alternative", "Supplement", "Unspecified", "FormData", and "Schema". - Close all pending TCP connections on exit to prevent indefinite waiting times.
- Fix: Allow
:convCRLF
to be used after:aggStrD
and:aggStr
. - New formatter
:preserveCharRef
to preserve character references. By default, Carbone removes all forbidden characters before injecting data into XML (e.g.,&
,>
,<
,