[Ultimate PDF] How to upgrade UltimatePDF to version 4.0.0 (or higher)?
Reactive icon
Forge component by Leonardo Fernandes

Ultimate PDF has undergone a major change on version 4.0.0 to become a reactive component. If you have Traditional Web applications that are using older versions of Ultimate PDF, please use this upgrade guide in order to benefit from the latest version of Ultimate PDF.

1. Install Ultimate PDF version 3.0.5. This is the last version that is still bundled as a Traditional Web component, and it was released to ease the transition to the Reactive Web version.

2. Upgrade Ultimate PDF to the latest version. If forge complains of incompatibilities, use Force Install. This will temporarily break references in your applications, and they might stop working. Don't worry, keep following this upgrade guide and it will fix it in step 4.

3. Install the Ultimate PDF for Traditional Web component. Again, you might need to use Force Install. This new component offers the Ultimate PDF web blocks to Traditional Web applications. You will eventually refactor your applications to be using this component.

4. Install the solution file UltimatePDF_TraditionalWeb_Compatibility_v[v4_0_0].osp attached to this post. This will create a new application called Ultimate PDF Deprecated, and it will contain the deprecated modules. These modules have the same API as version 3.0.5 (with a few exceptions noted below), and your applications will work without requiring any major refactoring.

5. Migrate any site properties you might have customized. Check in Service Center if the UltimatePDF_Deprecated module has any site properties using a custom value. Migrate these values to the corresponding site property on the UltimatePDF module.

At this point, you may resume your operations. Developers and testers can continue working, and PDF reports will work as expected. You can also release applications to Production while at this stage, however be careful to execute this upgrade guide in each and every environment of your pipeline.

But we're not done!

6. Refactor all your applications to remove references to UltimatePDF_Deprecated. Replace any references by their counterpart in either UltimatePDF or UltimatePDF_TraditionalWeb modules. This is an important step to move away from deprecated modules. This step can be done progressively, one application at a time. But eventually all your applications should no longer reference UltimatePDF_Deprecated.

7. Delete the Ultimate PDF Deprecated application. This application can be deleted safely, provided UltimatePDF_Deprecated is no longer referenced. You can also delete the solution UltimatePDF_TraditionalWeb_Compatibility in Service Center.

Note: the following functionality is not provided for backwards compatibility, but you are not expected to be using these functionalities anyway.

All actions from the Setup folder were removed: GetDefaultChromiumBrowserRevision, GetLocalServerURL, SetupBrowserRevision, SetupDefaultChromiumBrowserRevision, SetupLocalServerURL.

Input parameter WaitForSelector of the action PrintToPDF_Advanced was removed.

If you have any questions, or need help, please use this discussion.



Hi @Leonardo Fernandes if we already have UltimatePDF and unable to proceed with step 1 ( Install Ultimate PDF version 3.0.5 ) should we delete existing one and reinstall with version 3.0.5?



Hi nadzir. From your image, it looks like you have already the reactive version installed, so you don't need to use these steps. You can simply download the latest version and install it.

These steps are only required if you're upgrading from the Traditional (before 4.0.0) to Reactive.

Hi @Leonardo Fernandes we actually from the Traditional version (image below from QA Environment)

But after install the latest version at our Dev Environment, there is an error "Cannot publish 'UltimatePDF' because another module with the same name already exists in the environment." and image below show what happen at our UltimatePDF.

attached error log during upgrade to the latest version. What should we do to fix this?

Cannot publish 'UltimatePDF' because another module with the same name already exists in the environment..txt


You should have followed the steps in this post, which included installing the version 3.0.5 before upgrading to the latest version. The version 3.0.5 renames the traditional modules, so it doesn't cause a conflict when upgrading to the reactive version.

If your factory is small enough, you can simply uninstall Ultimate PDF and install the latest version.

Otherwise, I would recommend installing the version 3.0.5 again, and follow at least the first 5 steps in this post.

Hi Leo,

I am using this component but facing one issue. The issue is when i am not selecting the fields on browser.
I am getting blank pages in the pdf. Can you help us on this?

Thanks & Regards,
Abhinav Shilwant

@Leonardo Fernandes  Why making this so hard? The old traditional web version should have been renamed and the reactive web version should have been a completely different component. Then all these steps wouldn't have been necessary, everything remained backwards compatible and at no point would you have broken any application, unlike the current solution.

Was there a very good reason I'm not seeing to do this the hard way?

(oh, and maybe you can "sticky" this topic, because it is critically important to the component in my opinion)

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.