Backup and Restore - Revision history

Vmurrell: /* Creating a Backup */

2025-11-03T17:33:21Z

‎Creating a Backup

Vmurrell: /* Creating a Backup */

2025-11-03T17:29:34Z

‎Creating a Backup

Vmurrell: /* Creating a Backup */

2025-11-03T17:26:16Z

‎Creating a Backup

Vmurrell: /* Overview */

2025-11-03T17:15:37Z

‎Overview

Vmurrell: /* Overview */

2025-11-03T17:12:06Z

‎Overview

Vmurrell at 14:35, 9 October 2025

2025-10-09T14:35:27Z

Vmurrell: /* Parameters */

2025-10-09T14:33:31Z

‎Parameters

Vmurrell: /* Creating a Backup */

2023-10-06T09:54:09Z

‎Creating a Backup

Vmurrell: /* Troubleshooting */

2023-09-11T08:00:11Z

‎Troubleshooting

Vmurrell at 16:50, 2 August 2023

2023-08-02T16:50:49Z

@@ Line 6: / Line 6: @@
 = Creating a Backup =
-The backup process requires the FMRCL Command Line Application, which can be downloaded from here [[File:FMRCL-V1B.zip]].
+The backup process requires the FMRCL Command Line Application, which can be downloaded from here [[File:FMRCL-1-2.zip]].
 Extract the contents of the zip file to a folder (example C:\FMRCL). Do NOT place these files in the webapps folder of the Tomcat.

@@ Line 6: / Line 6: @@
 = Creating a Backup =
-The backup process requires the FMRCL Command Line Application, which can be downloaded from [[File:FMRCL-V1B.zip]].
+The backup process requires the FMRCL Command Line Application, which can be downloaded from here [[File:FMRCL-V1B.zip]].
- https://sdmxio.s3.eu-west-2.amazonaws.com/FMRCL/fmr-cl-1.0.0.zip. '''''Note:''''' clicking this link will download a zip file.
+Extract the contents of the zip file to a folder (example C:\FMRCL). Do NOT place these files in the webapps folder of the Tomcat.
 The command line application creates the backup by issuing requests to the web services of a running Registry instance.  The requests must be run as an admin user (or as the root user) from the directory where the file backup.bat has been installed.

@@ Line 6: / Line 6: @@
 = Creating a Backup =
-The backup process requires the FMRCL Command Line Application, which can be downloaded from https://sdmxio.s3.eu-west-2.amazonaws.com/FMRCL/fmr-cl-1.0.0.zip. '''''Note:''''' clicking this link will download a zip file.
+The backup process requires the FMRCL Command Line Application, which can be downloaded from [[File:FMRCL-V1B.zip]].
 The files should not be placed in the webapps folder of the Tomcat.

@@ Line 3: / Line 3: @@
 = Overview =
-From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application FMRCL) is used to create a backup from a running Registry instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
+From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application (FMRCL) is used to create a backup from a running Registry instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
 = Creating a Backup =

@@ Line 3: / Line 3: @@
 = Overview =
-From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application ([[FMR-CL]]) is used to create a backup from a running Registry instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
+From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application FMRCL) is used to create a backup from a running Registry instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
 = Creating a Backup =

@@ Line 3: / Line 3: @@
 = Overview =
-From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application ([[FMR-CL]]) is used to create a backup from a running FMR instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
+From Version '''11.5.0''' it is possible to restore the live structures and transaction history from another Registry.  The restore can only be run at install time.  In order to make use of this feature, a Command Line application ([[FMR-CL]]) is used to create a backup from a running Registry instance.  On installation of V 11.5.0 or later, the installation process will enable the Registry to load the backup to restore the state.
 = Creating a Backup =
@@ Line 10: / Line 10: @@
 The files should not be placed in the webapps folder of the Tomcat.
-The command line application creates the backup by issuing requests to the web services of a running FMR instance.  The requests must be run as an admin user (or as the root user) from the directory where the file backup.bat has been installed.
+The command line application creates the backup by issuing requests to the web services of a running Registry instance.  The requests must be run as an admin user (or as the root user) from the directory where the file backup.bat has been installed.
 The output of a backup request is a folder named "structures" which contains subfolder(s)/files and a zip file obtained from the running Registry instance.
@@ Line 33: / Line 33: @@
 | p || Password to authenticate with the Registry || -p password
 |-
-| url || URL of running FMR instance || -url http://localhost:8080/FMR
+| url || URL of running Registry instance || -url http://localhost:8080/FMR
 |-
-| v || Version of the FMR which is only required if you are referring to version 10 || -v 10
+| v || Version of the Registry which is only required if you are referring to version 10 || -v 10
 |}
 = Included in the Backup =
 The backup contains:
-* current (live) structural metadata from the FMR.
+* current (live) structural metadata from the Registry.
 * a history of the structural metadata edits
 * the related audit entries for the structure metadata edits
 = Restoring from a Backup =
-A backup is restored during the FMR 11 installation process.  The V11 install wizard provides the option to include the path on the local file system to the backup folder (or the path to a zip file).
+A backup is restored during the Registry 11 installation process.  The V11 install wizard provides the option to include the path on the local file system to the backup folder (or the path to a zip file).
 If the backup is being provided as a zip file, the contents of the backup folder must be zipped from within the backup root folder - the zip file should NOT include the root backup folder itself.  For example if the -o argument is Backups/BackupFeb, the zip should be created from within the BackupFeb folder (it should contain only the contents of the BackupFeb folder). The zip should not be of the BackupFeb folder itself and its contents.
 The time taken to complete the restore process depends on the number and size of the transactions that were backed up.  The install wizard initiates the restore process once the Finish button is clicked.
-The progress of the restore is frequently updated and reported to the user on the install page.  Whilst it is possible to close the web browser during the restore process, it is recommended to keep the web browser page open and not to navigate away from the install page.  It will not be possible to view the restore progress from the web browser if the browser navigates off the install page.  The install wizard will redirect to the FMR overview page once the restoration and installation is complete.
+The progress of the restore is frequently updated and reported to the user on the install page.  Whilst it is possible to close the web browser during the restore process, it is recommended to keep the web browser page open and not to navigate away from the install page.  It will not be possible to view the restore progress from the web browser if the browser navigates off the install page.  The install wizard will redirect to the Registry overview page once the restoration and installation is complete.
 The restore can only be run once, it will not be possible to re-run a restore if there was an error during the restoring of state.  The restore can only run against a clean (empty) database schema and as such can only be run on install.
@@ Line 57: / Line 57: @@
 ==Results==
-It is strongly recommended to check the FMR tomcat log files after a restore is complete to ensure all transactions were successfully restored.  It is possible for the restore to complete even if some transactions or audits could not be fully restored - the tomcat log files will contain details if this is the case.
+It is strongly recommended to check the Registry tomcat log files after a restore is complete to ensure all transactions were successfully restored.  It is possible for the restore to complete even if some transactions or audits could not be fully restored - the tomcat log files will contain details if this is the case.
 = Troubleshooting =

@@ Line 29: / Line 29: @@
 | o || The output directory that the backup will be written to || -o Backup/Jan
 |-
-| u || Username to authenticate with FMR || -u root
+| u || Username to authenticate with the Registry || -u root
 |-
-| p || Password to authenticate with FMR || -p password
+| p || Password to authenticate with the Registry || -p password
 |-
 | url || URL of running FMR instance || -url http://localhost:8080/FMR

← Older revision		Revision as of 08:00, 11 September 2023
Line 65:		Line 65:
	== Restore is either running, or failed part way. Please check the log files. A restore can not be re-run without first emptying the database tables ==		== Restore is either running, or failed part way. Please check the log files. A restore can not be re-run without first emptying the database tables ==
	If this error is displayed it is highly recommended to check your Registry log to see if you can determine what caused the backup to fail. If in doubt, please contact Metadata Technology, supplying the log file for further analysis. To restart the backup process, terminate the Tomcat and then clear out the tables from the database schema. Then restart Tomcat and go through the install process again.		If this error is displayed it is highly recommended to check your Registry log to see if you can determine what caused the backup to fail. If in doubt, please contact Metadata Technology, supplying the log file for further analysis. To restart the backup process, terminate the Tomcat and then clear out the tables from the database schema. Then restart Tomcat and go through the install process again.
		+
		+	= Change Log =
		+	See [[Change_Log_Registry_Command_Line\|Command Line Change Log]]