PDF Document Generation
Content Type: Module
Categories: Utility,Import/Export
Overview
The Document Generation module allows you to generate pixel-perfect PDF documents based on regular pages in your app. Make use of the full capabilities of the page editor, including the use of snippets, text templates, conditional visibility based on expressions, dynamic classes, etc. Add any existing web widget from the marketplace to your documents, or create your own.
Documentation
Please see Document Generation in the Mendix documentation for details.
Releases
Version: 1.10.0
Framework Version: 9.24.0
Release Notes: - We added support for the custom 'URL prefix' runtime setting for apps running in Mendix 10.5.0 or higher.
- We upgraded the 'axios' library used in the local service to v1.7.7.
- We removed the dependency on 'commons-io' library.
Note:
- After upgrading to this version, make sure to remove the corresponding 'commons-io-2.11.0.DocumentGeneration.1.x.x' and 'commons-io-2.11.0.DocumentGeneration.RequiredLib' files from your 'userlib' folder. If the library is not used by another module in your project, then make sure to remove the 'commons.io-2.11.0.jar' file as well.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue. - When using the cloud service, media queries are evaluated incorrectly. This can result in unexpected widths for layout grids and other widgets in your PDF document. As a workaround, we recommend to set the 'Tablet width' and 'Phone width' to the same value as 'Desktop width'.
Version: 1.9.0
Framework Version: 9.24.0
Release Notes: - We upgraded the module to Mendix 9.24.0
- We added support for React client, introduced as public beta in Mendix 10.7.0. As part of this, we switched to the new Combo Box widget for selecting the deployment type when registering your app environment.
Notes:
- Make sure that you have the Combo Box widget installed in your project. If you do not already have it, you can download it from the marketplace.
- When importing the module in Mendix 10.6.0 or above, you might get consistency error CE6087 for renamed design properties. Right-click and update all renamed design properties in the project.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
- When using the cloud service, media queries are evaluated incorrectly. This can result in unexpected widths for layout grids and other widgets in your PDF document. As a workaround, we recommend to set the 'Tablet width' and 'Phone width' to the same value as 'Desktop width'.
Version: 1.8.0
Framework Version: 9.18.0
Release Notes: - We added additional error handling to provide more detailed error information and easier error resolution. Errors that occur during the document generation process while calling the PDF document generation service, will result in specific exception types. See section 6.2.1 in the module documentation for exception details and resolutions.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.7.0
Framework Version: 9.18.0
Release Notes: - We added `Mendix Cloud Dedicated` to the supported deployment types. Note that we only support apps that allow bi-directional communication with the PDF Service in the Mendix Public Platform.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.6.0
Framework Version: 9.18.0
Release Notes: - We added a button "Renew app registration" to "Snip_AppRegistration" snippet to manually renew your app registration. This is most useful for apps deployed on Mendix Free Cloud since it's not possible to execute scheduled events. This button will be visible when the app registration is about to be expired within 24 hours or has already expired.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.5.0
Framework Version: 9.18.0
Release Notes: - We added support for apps running on-premises on Windows or Linux. On-premises apps can make use of Chromium installed on the same (virtual) machine to generate PDFs, instead of connecting to our free PDF document generation service on the Mendix platform. See section 3.3 in the module documentation for details.
- We now automatically remove the trailing slash from the App URL when registering your app environment.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.4.0
Framework Version: 9.18.0
Release Notes: - We added support for Studio Pro for Mac (future release)
- We fixed the inconsistent letter spacing in font rendering when using the PDF document generation service in the Mendix Public Cloud (ticket #203484)
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.3.0
Framework Version: 9.18.0
Release Notes: - We added “Mendix for Private Cloud Connected” to the supported deployment types. Note that we only support apps that allow bi-directional communication with the PDF Service in the Mendix Public Platform.
- For registering your app environment(s), we now require a personal access token (PAT) instead of your developer API key. The PAT can be created in your Developer Settings in the Mendix Developer portal. For the scope, select 'mx:deployment:read' of the applicable deployment type. Existing app environment registrations stay valid after the module update, you do not need to re-register your app.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.2.1
Framework Version: 9.18.0
Release Notes: - We aligned the behavior between the local service and the online service, so that redirects to external URLs are no longer allowed.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.
Version: 1.2.0
Framework Version: 9.18.0
Release Notes: - We included a migration file for the Java dependencies for Studio Pro 10 compatibility.
Known issues:
- When testing the PDF document generation locally using Chrome or Chromium version 117 or 118, the scaling of your PDF document might be different compared to generated document from the PDF document generation service that is using Chromium version 112 in the Mendix Public Cloud. This issue has been fixed in Chrome version 119, we recommend to update to the latest Chrome release if you run into this issue.