Appboard/old/backup and restore - Revision history

imported>Jason.nicholls at 10:35, 17 July 2014

2014-07-17T10:35:58Z

← Older revision		Revision as of 10:35, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:Backup & Restore}}
			[[Category:AppBoard old]]
	AppBoard/enPortal provides utilities for backing up and restoring system data and configuration settings. This page details the commands and procedures for managing this aspect of the system.		AppBoard/enPortal provides utilities for backing up and restoring system data and configuration settings. This page details the commands and procedures for managing this aspect of the system.

imported>Jason.nicholls: moved Backup and Restore to appboard/old/backup and restore

2014-07-17T10:32:52Z

moved Backup and Restore to appboard/old/backup and restore

← Older revision	Revision as of 10:32, 17 July 2014
(No difference)

imported>Jason.nicholls: /* Deciding Whether To Use the "Apply" or "Restore" Command */

2014-07-17T05:15:25Z

Deciding Whether To Use the "Apply" or "Restore" Command

← Older revision		Revision as of 05:15, 17 July 2014
Line 85:		Line 85:
	{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}		{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}

	{{Note\|On Unix systems, after restoring an archive you need to verify that some of the server settings are correct. For more information, see [[~~UnixInstallation~~#Restoring_an_Archive\|Unix Installation - restoring an archive]]}}		{{Note\|On Unix systems, after restoring an archive you need to verify that some of the server settings are correct. For more information, see [[appboard/old/unix_installation#Restoring_an_Archive\|Unix Installation - restoring an archive]]}}


	== Advanced Configuration ==		== Advanced Configuration ==

imported>Mike.berman: provide additional detail on backup types and options

2013-05-21T13:47:01Z

provide additional detail on backup types and options

@@ Line 25: / Line 25: @@
 ## <b>Backup All</b> - [Recommended] Backs up all AppBoard and enPortal content
 ## <b>Backup AppBoard</b> - Backs up only AppBoard components such as configuration of Stacks, Widgets, Data Sources, and adapters
 ## <b>Backup Portal</b> - Backs up only system configuration, including the following:
 ##* setenv-custom configuration settings
@@ Line 30: / Line 31: @@
 ##* other system configuration files
 # Observe the JAR file created in <tt>\server\webapps\enportal\WEB-INF\archive\</tt>.  The filename contains a timestamp, so previous backups are not erased, and so you can differentiate between different backups and when they were generated.

imported>Mike.berman: add Deciding Whether To Use the "Apply" or "Restore" Command

2013-04-29T20:02:52Z

add Deciding Whether To Use the "Apply" or "Restore" Command

← Older revision		Revision as of 20:02, 29 April 2013
Line 48:		Line 48:
	# Enter “yes” to confirm replacing any existing content.		# Enter “yes” to confirm replacing any existing content.
	# Start AppBoard and confirm that the exported content was loaded successfully.		# Start AppBoard and confirm that the exported content was loaded successfully.


			==== Deciding Whether To Use the "Apply" or "Restore" Command ====

			When to use "portal apply":
			* You do not want any customization to affect your local /server/bin/setenv-custom scripts (port overrides; memory settings, etc).
			* You do not want /server/webapps/enportal/WEB-INF/config/license.properties or any license.* files to affect your local server settings.
			* You do not want SSL configuration changes in /server/conf/ to affect your local server settings.
			* You only want elements such as Stacks, Channels, Users, or personalizations to be imported.


			When to use "portal restore":
			* You want the restore to truly mirror the full configuration from the original server where the backup archive was created.


			Note: In both cases (portal restore and portal apply), the command will reset the database. Once started, the system will only load the stock configurations plus the configurations imported by the overlay.

imported>Mike.berman: add troubleshooting section

2013-04-29T19:47:48Z

add troubleshooting section

← Older revision		Revision as of 19:47, 29 April 2013
Line 76:		Line 76:
	export-appboard.data=${webapp.webinf}/data		export-appboard.data=${webapp.webinf}/data
	</code>		</code>


			== Troubleshooting ==

			*<b>Issue:</b> When restoring an archive, you receive the following message in the console: <tt>System must be shutdown prior to resetting the database.</tt>
			*<b>Possible Causes</b>:
			** AppBoard is still running. Make sure AppBoard is shut down prior to running the restore command.
			** The system was improperly shut down and there is a lock file in the H2 folder (/server/webapps/enportal/WEB-INF/h2/). Delete the lock file (persist.lock.db) and run the restore command again.

imported>Mike.berman: add details for export options and new apply command

2013-04-29T19:38:03Z

add details for export options and new apply command

← Older revision		Revision as of 19:38, 29 April 2013
Line 1:		Line 1:
	{{Note\|The instructions on this page are for versions 2.2.x of AppBoard. For versions 2.1.x of AppBoard, please see [[Backup_and_Restore_2.1.x\|Backup and Restore 2.1.x]]. For versions 2.0.x of AppBoard, please see [[Backup_and_Restore_2.0.x\|Backup and Restore 2.0.x]].}}

	AppBoard/enPortal provides utilities for backing up and restoring system data and configuration settings. This page details the commands and procedures for managing this aspect of the system.		AppBoard/enPortal provides utilities for backing up and restoring system data and configuration settings. This page details the commands and procedures for managing this aspect of the system.

Line 20:		Line 18:


	# On the original AppBoard system, log in to AppBoard as administrator		# On the original AppBoard system, log in to AppBoard as administrator.
	# Under <b>Builder Modes</b>, select <b>Settings</b>		# Under <b>Builder Modes</b>, select <b>Settings</b>.
	# Under <b>System Settings</b>, select <b>Backup</b>		# Under <b>System Settings</b>, select <b>Backup</b>.
	# Click <b>Create</b>		# Click <b>Create</b>.
	# Select <b>Backup All</b> and ~~click~~ <b>~~Create~~ Backup</b>		# Select the desired backup option and click <b>Create Backup</b>:
	# Observe JAR file created in <tt>\server\webapps\enportal\WEB-INF\archive\</tt>		## <b>Backup All</b> - [Recommended] Backs up all AppBoard and enPortal content
			## <b>Backup AppBoard</b> - Backs up only AppBoard components such as configuration of Stacks, Widgets, Data Sources, and adapters
			## <b>Backup Portal</b> - Backs up only system configuration, including the following:
			##* setenv-custom configuration settings
			##* SSL certificate files
			##* other system configuration files
			# Observe the JAR file created in <tt>\server\webapps\enportal\WEB-INF\archive\</tt>. The filename contains a timestamp, so previous backups are not erased, and so you can differentiate between different backups and when they were generated.


Line 35:		Line 39:
	===How To Restore AppBoard/enPortal===		===How To Restore AppBoard/enPortal===

	# Shut down AppBoard		# Shut down AppBoard.
	# On the command line in the destination system, go to <tt>\server\bin\</tt>		# On the command line in the destination system, go to <tt>\server\bin\</tt>.
	# Enter the ~~command~~:		# Enter one of the following commands:
	#: <tt>Portal restore –jar ..\webapps\enportal\WEB-INF\archive\<<i>name of backup jar file</i>></tt>		#: <tt>Portal restore –jar ..\webapps\enportal\WEB-INF\archive\<<i>name of backup jar file</i>></tt>
	# Enter “yes” to confirm replacing any existing content		#:* The "restore" command is intended for doing a complete rebuild of AppBoard, such as when you are migrating AppBoard to a new server or upgrading to a new AppBoard version. It will copy all of the files from the archive JAR on to the destination server where you are running the command.
	# Start AppBoard and confirm that the exported content was loaded successfully		#: <tt>Portal apply –jar ..\webapps\enportal\WEB-INF\archive\<<i>name of backup jar file</i>></tt>
			#:* The "apply" command skips over copying some of the config files from the archive JAR. It can be used, for example, if you are loading an archive on to a test server and you do not want the command to extract all of the system configuration settings and wipe out the local settings that are in place (for example, the license file). The list of files that is skipped by the apply command can be seen (and configured) in <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/export.properties</tt> under the section labeled "import.skip.apply".
			# Enter “yes” to confirm replacing any existing content.
			# Start AppBoard and confirm that the exported content was loaded successfully.

	{{Note\|The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.}}

	{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}		{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}
Line 52:		Line 57:
	== Advanced Configuration ==		== Advanced Configuration ==

	The set of files that are included in the backup archive is configured in the file <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/export-appboard.properties</tt>. You can customize the process by adding files to be included in the backup archive. To do so, create a file called <tt>custom.properties</tt>, and include any custom export commands.		The set of files that are included in the backup archive is configured in the file <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/export-appboard.properties</tt> and <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/export.properties</tt>. You can customize the process by adding files to be included in the backup archive. To do so, create a file called <tt>custom.properties</tt>, and include any custom export commands.

imported>Mike.berman: add note regarding Unix additional steps

2012-11-11T21:36:45Z

add note regarding Unix additional steps

← Older revision		Revision as of 21:36, 11 November 2012
Line 46:		Line 46:

	{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}		{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}

			{{Note\|On Unix systems, after restoring an archive you need to verify that some of the server settings are correct. For more information, see [[UnixInstallation#Restoring_an_Archive\|Unix Installation - restoring an archive]]}}

imported>Mike.berman: add note about re-naming driver to preserve on upgrade

2012-11-08T02:03:51Z

add note about re-naming driver to preserve on upgrade

← Older revision		Revision as of 02:03, 8 November 2012
Line 45:		Line 45:
	{{Note\|The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.}}		{{Note\|The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.}}

	{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log.}}		{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.}}

imported>Mike.berman: add note about database driver support in 2.3.x upgrade

2012-11-08T01:42:10Z

add note about database driver support in 2.3.x upgrade

← Older revision		Revision as of 01:42, 8 November 2012
Line 44:		Line 44:

	{{Note\|The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.}}		{{Note\|The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.}}

			{{Note\|If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log.}}