Moving from one Edition of PaperCut to Another

KB Home   |   Moving from one Edition of PaperCut to Another

Main.MovingPaperCutFromOneEditionToAnother History

Show minor edits - Show changes to output

February 24, 2015, at 04:40 AM by Peter Fitzgerald - Added details surrounding the version 15.0 ability to cross-grade editions without DB backup/restore
Deleted line 2:
Changed lines 5-14 from:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes.  It is also possible to upgrade versions while changing editions (i.e. there is no need to match version numbers).

[-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 [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| 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.
to:
Use the following procedure to move PaperCut from one edition to another without setting/data loss. The procedure takes around 30 minutes. 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

[-In summary
, the process involves backing up your PaperCut install directory, then installing the new version.-]

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 [[https://www.papercut.com/kb/Main/UpgradingNG | regular PaperCut upgrade process]].

->1. Stop
the PaperCut application server on your primary server. Operating system specific instructions can be found in the manual [[https://www.papercut.com/products/ng/manual/apdx-tools-start-stop-app.html | 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 [[https://www.papercut.com/kb/Main/UpgradingNG | 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 [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | 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.
Changed lines 47-48 from:
-->'''If using an external database''': Simply modify the [@server.properties@] file to point to your existing database as explained in the [[https://www.papercut.com/products/ng/manual/ch-ext-db.html|manual here]].
to:
-->'''If using an external database''': Simply modify the [@server.properties@] file to point to your existing database as explained in the [[https://www.papercut.com/products/ng/manual/ch-ext-db.html | manual here]].
Changed lines 57-58 from:
If, during this process, you have also upgraded software versions (i.e. 9.2 to 13.3) please review the [[https://www.papercut.com/kb/Main/UpgradingNG|upgrade instructions]]. For larger sites it includes post-upgrade test plans which you may find useful.
to:
If, during this process, you have also upgraded software versions (i.e. 9.2 to 13.3) please review the [[https://www.papercut.com/kb/Main/UpgradingNG | upgrade instructions]]. For larger sites it includes post-upgrade test plans which you may find useful.
Deleted line 62:
Changed line 66 from:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions, ng to mf, changing to mf-]
to:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions, ng to mf, changing to mf-]
October 01, 2013, at 06:47 AM by Kelby - Database Exports
Changed lines 10-13 from:
->1. Backup the data from the current installed PaperCut. Follow the instructions as described in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| manual here]].

->2. Take a copy of the database backup 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.
to:
->1. Export the database from the current installed PaperCut. Follow the instructions as described in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| 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.
Changed lines 26-27 from:
-->'''If using the internal database''': restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | manual here]]. 
to:
-->'''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 [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | manual here]]. 
Changed lines 34-35 from:
->11. '''If you had any a payment gateway nstalled''': 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.
to:
->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.
Changed lines 14-15 from:
->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. customized web tools interface.
to:
->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.
Changed lines 34-37 from:
->11. 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 11.4)
please review the [[https://www.papercut.com/kb/Main/UpgradingNG|upgrade instructions]]. For larger sites it includes post-upgrade test plans which you may find useful.
to:
->11. '''If you had any a payment gateway nstalled''': 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 [[https://www.papercut.com/kb/Main/UpgradingNG|upgrade instructions]]. For larger sites it includes post-upgrade test plans which you may find useful.
October 20, 2011, at 05:39 AM by 202.129.124.120 -
Added lines 34-37:
->11. 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 11.4) please review the [[https://www.papercut.com/kb/Main/UpgradingNG|upgrade instructions]]. For larger sites it includes post-upgrade test plans which you may find useful.

Changed lines 6-7 from:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes. 
to:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes.  It is also possible to upgrade versions while changing editions (i.e. there is no need to match version numbers).
May 30, 2011, at 12:40 AM by tim - fix typo/grammar
Changed lines 16-17 from:
->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 preferable all backup files) outside the PaperCut directory or even onto another disk for safe storage.
to:
->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.
March 03, 2011, at 01:25 AM by 192.148.117.79 -
Changed line 42 from:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions-]
to:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions, ng to mf, changing to mf-]
Changed lines 4-5 from:
'''To move from PaperCut Edition X to PaperCut Edition Y follow the steps described below:'''
to:
'''To move from PaperCut Edition X to PaperCut Edition Y (also known as a cross-grade) follow the steps described below:'''
October 10, 2010, at 11:07 PM by 202.129.124.120 -
Added lines 32-33:
->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.
May 18, 2010, at 03:53 AM by 202.129.124.120 -
Changed lines 32-36 from:
'''To upgrade from PaperCut Quota to PaperCut NG follow the upgrading procedure listed in the manual here:''' \\\

->[[https://www.papercut.com/products/ng/manual/apdx-upgrade-from-quota.html]].

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

->[[https://www.papercut.com/kb/Main/UpgradingFromPaperCutQuotaToPaperCutNG]].

Changed lines 30-31 from:
to:
->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.
Changed lines 20-21 from:
->6. Install the new PaperCut edition.
to:
->6. Install the new PaperCut edition following the standard setup procedure for your platform, architecture and environment.
Changed lines 6-7 from:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes.
to:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes. 

[-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.-]

Changed lines 10-21 from:
->2. Take a copy of the database backup 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. It would be a good idea to copy the entire backups directory for safety.

->3. Double check that you have a copy of the database backup files outside the PaperCut directory. When you uninstall the current version of PaperCut all files will be deleted
. So it is very important to copy this file (or preferable all backup files) outside the PaperCut directory.

->4. Uninstall
the current PaperCut.

->5. Install the new PaperCut edition
.

->6. Complete the setup wizard for the new PaperCut edition.
(e.g. setting up the admin password, etc).

->7. Once the setup is completed:
to:
->2. Take a copy of the database backup 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. 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 preferable 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.

->7. Complete the setup wizard for the new PaperCut edition. (e.g. setting up the admin password, etc).

->8
. Once the setup is completed:
Changed line 35 from:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf-]
to:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf, editions-]
Changed lines 24-26 from:
-->'''If using an external database''': Simply modify the [@server.properties@] file to point to your existing database as explained [[https://www.papercut.com/products/ng/manual/ch-ext-db.html|here]].

to:
-->'''If using an external database''': Simply modify the [@server.properties@] file to point to your existing database as explained in the [[https://www.papercut.com/products/ng/manual/ch-ext-db.html|manual here]].

Changed lines 20-22 from:
->7. Once the setup is completed, restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | manual here]]. 

to:
->7. Once the setup is completed:

-->'''If using
the internal database''': restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | manual here]]. 

-->'''If using an external database''': Simply modify the [@server.properties@] file to point to your existing database as explained [[https://www.papercut.com/products/ng/manual/ch-ext-db.html|here]].


Changed line 31 from:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version-]
to:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version, cross grade, ng, chargeback, mf-]
Added lines 6-7:
Use the following procedure to move PaperCut from one edition to another without setting/data loss.  The procedure takes around 30 minutes.
Changed lines 4-5 from:
'''To move from PaperCut Edition X to PaperCut Edition Y (or vice versa) follow the steps described below:'''
to:
'''To move from PaperCut Edition X to PaperCut Edition Y follow the steps described below:'''
Changed lines 4-7 from:
'''To move from PaperCut ''Edition X'' to PaperCut ''Edition Y'' (or vice versa) follow the steps described below:'''

->1. Backup the data from PaperCut NG. Follow the instructions as described in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| manual here]].
to:
'''To move from PaperCut Edition X to PaperCut Edition Y (or vice versa) follow the steps described below:'''

->1. Backup the data from the current installed PaperCut. Follow the instructions as described in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| manual here]].
Changed lines 12-17 from:
->4. Uninstall PaperCut NG.

->5. Install PaperCut ChargeBack.

->6. Complete the PaperCut ChargeBack setup wizard. (e.g. setting up the admin password, etc).
to:
->4. Uninstall the current PaperCut.

->5. Install the new PaperCut edition.

->6. Complete the setup wizard for the new PaperCut edition. (e.g. setting up the admin password, etc).
Changed lines 2-5 from:
''Note: Please swap the names if you want to move from PaperCut ChargeBack to PaperCut NG.''

'''To move from PaperCut NG to ChargeBack
(or vice versa) follow the steps described below:'''
to:


'''To move from PaperCut ''Edition X'' to PaperCut ''Edition Y'' (or vice versa) follow the steps described below:'''
Changed line 29 from:
[-keywords: move, migrating, transfer, migrate, change, old, version-]
to:
[-keywords: move, migrating, transfer, migrate, change, changing, old, version-]
March 20, 2008, at 02:34 AM by 218.214.136.161 -
Changed lines 18-20 from:
->7. Once the setup is completed, restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found  in [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | the manual here]]. 

to:
->7. Once the setup is completed, restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | manual here]]. 

March 20, 2008, at 02:33 AM by 218.214.136.161 -
Added lines 1-29:
(:title Moving from one Edition of PaperCut to Another :)
''Note: Please swap the names if you want to move from PaperCut ChargeBack to PaperCut NG.''

'''To move from PaperCut NG to ChargeBack (or vice versa) follow the steps described below:'''

->1. Backup the data from PaperCut NG. Follow the instructions as described in the [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html| manual here]].

->2. Take a copy of the database backup 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. It would be a good idea to copy the entire backups directory for safety.

->3. Double check that you have a copy of the database backup files outside the PaperCut directory. When you uninstall the current version of PaperCut all files will be deleted. So it is very important to copy this file (or preferable all backup files) outside the PaperCut directory.

->4. Uninstall PaperCut NG.

->5. Install PaperCut ChargeBack.

->6. Complete the PaperCut ChargeBack setup wizard. (e.g. setting up the admin password, etc).

->7. Once the setup is completed, restore the data from your backup file ( E.g. export-2008-01-18T14-22-03.zip ). The restore instructions can be found  in [[https://www.papercut.com/products/ng/manual/ch-sys-mgmt-backups.html | the manual here]]. 


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

->[[https://www.papercut.com/products/ng/manual/apdx-upgrade-from-quota.html]].


If you have any questions about this process please [[https://www.papercut.com/contact/ | email support]].

----
[-keywords: move, migrating, transfer, migrate, change, old, version-]

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on March 17, 2016, at 02:58 AM
Printable View   |   Article History   |   Edit Article