Migrating from one Edition of PaperCut to Another (e.g. from NG to MF)

We call this cross-grading… but basically it’s when you’re wanting to move from (for example) PaperCut NG to PaperCut MF… or PaperCut MF to PaperCut NG. For simplicity, we recommend sticking with the same version of PaperCut (e.g. NG 19 to MF 19, or MF 21 to NG 21) so that things go as smoothly as possible.

Use the following procedure to move PaperCut from one edition to another without losing any settings, print logs, transaction and user history and other historical data. It is also possible to upgrade versions while changing editions (i.e. there is no need to match version numbers).

Moving to an Edition of PaperCut Version 15.0 or Higher

TL;DR - this process involves backing up your PaperCut install directory, then installing the new version. Simple!

If you’re cross-grading to an edition of PaperCut of version 15.0 or higher, the process is quite straightforward, and in fact much the same as the regular PaperCut upgrade process.

  1. Stop the PaperCut application server on your primary server. Operating system specific instructions can be found in the manual here.
  2. As a precaution, create a backup copy of the entire PaperCut install directory. Your system backups may have such a copy, but it is recommended you create your own backup of the directory to ensure it is as recent as possible.
  3. Run the PaperCut installer for the new edition, and install it in the same location as the pre-existing install. Make sure to install and configure the new edition of PaperCut using the same configuration as the prior installation.
  4. If moving from PaperCut NG to PaperCut MF, make sure to enable external device integration by logging into the PaperCut administration console, navigating to the “Options” tab, then the “Advanced” subtab, and then turning on the “Enable external hardware integration” option.
  5. If you have also upgraded software versions (i.e. 14.3 to 15.0) as part of the edition cross-grade, please review the regular upgrade instructions to determine if there are any other PaperCut components that should be upgraded. Those instructions also include post-upgrade test plans which you may find useful for larger scale deployments.
    TIP: Client software should be automatically updated if you have deployed it using the zero-install method. Alternately, whilst local client installs from an older edition will continue to work with the newer edition, it is recommended that they are manually upgraded to keep them at the same version level as your primary server.

Moving to an Edition of PaperCut Version 14.3 or Lower

In summary, the process involves backing up the data, uninstalling the old edition, installing the new, then restoring the data. All database backups are compatible between editions.

  1. Export the database from the current installed PaperCut. Follow the instructions as described in the manual here.
  2. Take a copy of the database export which is saved in [appdir]\server\data\backups\. The filename will look like: “export-<timestamp>.zip” (e.g. export-2008–01–18T14–22–03.zip ). Make sure you copy this file somewhere safe, and importantly outside of the PaperCut directory.
  3. In line with best practice, we also recommend taking a backup copy of the entire PaperCut install directory. This will ensure you have a copy of other files that may need to be restored. e.g. payment gateway settings, customized web tools interface.
  4. Double check that you have a copy of the database copies in a safe location! When you uninstall the current version of PaperCut all files will be deleted. So it is very important to copy files (or preferably all backup files) outside the PaperCut directory or even onto another disk for safe storage.
  5. Uninstall the current PaperCut.
  6. Install the new PaperCut edition following the standard setup procedure for your platform, architecture and environment.
  7. Complete the setup wizard for the new PaperCut edition. (e.g. setting up the admin password, etc).
  8. Once the setup is completed:
    If using the internal database: restore the data from your export file ( E.g. export-2008–01–18T14–22–03.zip ). The restore instructions can be found in the manual here.
    If using an external database: Simply modify the server.properties file to point to your existing database as explained in the manual here.
  9. If moving from PaperCut NG, to PaperCut MF, you should enable the external device integration by logging into PaperCut and enabling option “Enable external hardware integration” under the Options→Advanced tab.
  10. If you had any custom SSL certificates installed: You will have to migrate them manually by copying your custom keystore my-ssl-keystore (or similarly named) from the old [app-dir]/server/custom directory to the new one. Also copy the following parameters from the old [app-dir]/server/server.properties to the new one: server.ssl.keystore, server.ssl.keystore-password, server.ssl.key-password.
  11. If you had any a payment gateway installed: You will have to reinstall the Payment Gateway module and restore the configuration by copying the properties files from the old [app-dir]/server/lib-ext directory to the new one.
  12. Client software will usually automatically upgrade if you are using the zero-install (local cache) method for deployment. If the client is installed locally, a client from one edition will continue to work with the new installation however if you have upgraded versions during this process, it would be wise to keep the client and server software in sync.

If, during this process, you have also upgraded software versions (i.e. 9.2 to 13.3) please review the upgrade instructions. For larger sites it includes post-upgrade test plans which you may find useful.

To upgrade from PaperCut Quota to PaperCut NG follow the upgrading procedure listed in this manual article here:

If you have any questions about this process please email support.

keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions, ng to mf, changing to mf


Categories: How-to Articles, Upgrading or Downgrading