How to Manage Backups

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Created page with "The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''. This guide will explain automatic and manual backups in Trainz.<br> <table cellpad...")
 
(added section on a backup plan)
Line 93: Line 93:
 
<table>
 
<table>
 
<tr valign="middle">
 
<tr valign="middle">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>[[file:LauncherSettingsDailyBackups7.png|link=|alt=Launcher Settings Tabs]]</td>
 
<td>[[file:LauncherSettingsDailyBackups7.png|link=|alt=Launcher Settings Tabs]]</td>
 
<td>If you are working on developing a new route or session then '''7''' daily backups could be a suitable number.</td>
 
<td>If you are working on developing a new route or session then '''7''' daily backups could be a suitable number.</td>
 
</tr>
 
</tr>
 
<tr valign="middle">
 
<tr valign="middle">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>[[file:LauncherSettingsDailyBackups3.png|link=|alt=Launcher Settings Tabs]]</td>
 
<td>[[file:LauncherSettingsDailyBackups3.png|link=|alt=Launcher Settings Tabs]]</td>
 
<td>If you are making minor changes to existing routes or sessions then '''3''' or '''4''' daily backups could be a suitable number.</td>
 
<td>If you are making minor changes to existing routes or sessions then '''3''' or '''4''' daily backups could be a suitable number.</td>
 
</tr>
 
</tr>
 
<tr valign="middle">
 
<tr valign="middle">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>[[file:LauncherSettingsDailyBackups0.png|link=|alt=Launcher Settings Tabs]]</td>
 
<td>[[file:LauncherSettingsDailyBackups0.png|link=|alt=Launcher Settings Tabs]]</td>
<td>If you are not working on any routes or sessions then '''0''' daily backups could be a suitable number.</td>
+
<td>If you are not working on any routes or sessions then '''0''' daily backups could be a suitable number - but '''remember to reset this when you do need the automatic backups again'''.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 298: Line 301:
 
<td colspan="2">
 
<td colspan="2">
 
----</td>
 
----</td>
 +
</tr>
 +
</table>
 +
 +
=='''Backup Plan Basics'''==
 +
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''If you are using a manual backup method then devise a simple backup plan and stick to it'''</td>
 +
</tr>
 +
</table>
 +
 +
The most important parts of any backup plan are:-
 +
*'''make regular backups''' - how often will depend on the complexity of the project
 +
*'''keep duplicate sets of backups''' including on offline storage
 +
*'''keep previous backup sets''', not just the latest ones - how many past sets you will want to keep will depend on factors such as available storage
 +
*'''have a simple but consistent file naming system''' to be able to quickly identify the backup you need to restore lost work
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px; font-weight: 700;">Sample Backup Plan:'''</span><br>
 +
*on a drive that is always attached to your system create a '''Project Backups Folder'''
 +
*in this folder create another folder named '''Today'''
 +
[[file:BackupsOnlineFolder.png|link=|alt=Online Project Backups folder]]
 +
*use this folder to store your regular backups for today. For example, when you take a break and exit from '''Surveyor''', start '''Content Manager''' and backup the current project (e.g. a route, a session or both) to the '''Today''' folder
 +
[[file:BackupsOnlineFolderToday.png|link=|alt=Todays Backups folder]]
 +
*name each backup using the name of the project and the time as shown in the example above
 +
*at the end of each day copy the '''Today''' folder to an external drive such as a USB or a detachable SSD into a folder also called '''Project Backups'''
 +
*rename the '''Today''' folder on the external drive to a format that identifies the date of the backups it contains (using the '''yyyy-mm-dd''' format) as shown below
 +
[[file:BackupsOfflineFolder.png|link=|alt=Offline Project Backups folder]]
 +
*copy this renamed folder to a second external detachable drive (if you have one) in its '''Project Backups''' folder
 +
*when starting work the next day, delete the contents of the '''Today''' folder on your main drive to start the process again
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Revision as of 23:11, 20 January 2020

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus. This guide will explain automatic and manual backups in Trainz.

Main Points:
DotPoint.JPG Trainz will automatically backup your current route and session while you work. You can set the number of backups created each day
DotPoint.JPG You can use Content Manager to manually create backups of routes, sessions and assets as often as you need
DotPoint.JPG Both the manual and automatic backups can be restored to Trainz by Content Manager


Contents


Automatic Backups vs Manual Backups

NotePad.PNG  Notes:
  Automatic Backups Manual Backups
Pros
  • set and forget - no need to remember to perform the backups
  • backups are stored in a set location
  • you control where the backups are stored
  • you control the backup file names
  • assets can be backed up, not just routes and sessions
Cons
  • identifying the exact backup file to restore may not be easy
  • only routes and sessions can be backed up
  • you have to remember to perform the backup
  • you have to remember where you stored the backups

Automatic Backups

Creating Automatic Backups

In Summary:
DotPoint.JPG Only a set number of backups are created each day
DotPoint.JPG Only 7 days of backups are kept

This is a Set and Forget operation. You simply tell Trainz how many backups you want created each day and the program takes care of the rest.


Steps.PNG Steps:

Launcher Settings Tabs

  1. To set the number of backups, select Trainz Settings from the Launcher and then click the Dev tab.
  2. One data entry box in this tab will be named Daily backups to keep and it will have a default value of 7. Set it to the number of backups you want each day.
DotPoint.JPG Launcher Settings Tabs If you are working on developing a new route or session then 7 daily backups could be a suitable number.
DotPoint.JPG Launcher Settings Tabs If you are making minor changes to existing routes or sessions then 3 or 4 daily backups could be a suitable number.
DotPoint.JPG Launcher Settings Tabs If you are not working on any routes or sessions then 0 daily backups could be a suitable number - but remember to reset this when you do need the automatic backups again.

NotePad.PNG  Notes:
Large Number of Daily Backups Small Number of Daily Backups
  • more backup storage space needed
  • shorter time between backups so less work can be lost in a crash
  • less backup storage space needed
  • longer time between backups so more work can be lost in a crash

Only the last 7 days of backups are kept and this number cannot be changed.

Restoring Automatic Backups

The automatic backups are stored in a backup folder in your Trainz local data folder. The location of this folder is held in your Launcher - Trainz Settings - Install tab.

DBR EDBR31.png


Steps.PNG Step 1: Open the Backups Folder
  1. using Windows File Explorer, open your local data folder and then open the backups folder.
  2. the backups that have been created during the past week will be listed by their dates using the YY-MM-DD date format.
LocalDataBackupFolder.png

Steps.PNG Step 2: Identify the Backup Folder
  1. open the backup folder for the date that you want. A list of backup files and folders created that day will be shown.

LocalDataBackupDaily.png

  • if you know the time of the backup then sort the entries by date. Some entries, as shown above, have randomised names and will have to be sorted by date.
  • if you know the kuid of the backup (it will be the same as used by the route/session) then sort the entries by name.

Steps.PNG Step 3: Restore the Backup To Trainz
  1. open Content Manager
  2. drag and drop the selected backup folder from Windows File Explorer into Content Manager
  3. the item will be shown in Content Manager as Open for Edit. Select the item and Submit it.


More details, including tips on troubleshooting, can be found in the Trainz Knowledge Base at Restoring Backups

Manual Backups

In Summary:
DotPoint.JPG You control the number and frequency of backups
DotPoint.JPG You control the backup location and filenames
DotPoint.JPG Assets, not just routes and sessions can be backed up

Creating Manual Backups

DotPoint.JPG Manual backups are stored as .CDP files
DotPoint.JPG Many assets can be stored in a single .CDP file

Steps.PNG Steps:
  • open Content Manager and use a search filter to identify the assets to be backed up. Some examples:-

DotPoint.JPG Today Filter to show all assets that have been altered today.

DotPoint.JPG Launcher Settings Tabs to show all installed routes that are yours.

  • highlight the asset or assets (more than one asset can be included in each backup file).
  • right mouse click on one of the highlighted assets and select Export to CDP.

Export to CDP

  • select a drive, folder and (if required) a backup filename.

Restoring Manual Backups

DotPoint.JPG Simply drag and drop the backup CDP file or files into Content Manager

Steps.PNG Steps:
  1. open Content Manager
  2. open Windows File Explorer and locate the backup folder
  3. highlight the .CDP file or files to be restored
  4. drag and drop the file or files from Windows File Explorer into Content Manager
  5. if the assets being restored are already installed in Content Manager then their status will be Open for Edit. Submit the assets.

Restore from backup


Backup Plan Basics

DotPoint.JPG If you are using a manual backup method then devise a simple backup plan and stick to it

The most important parts of any backup plan are:-

  • make regular backups - how often will depend on the complexity of the project
  • keep duplicate sets of backups including on offline storage
  • keep previous backup sets, not just the latest ones - how many past sets you will want to keep will depend on factors such as available storage
  • have a simple but consistent file naming system to be able to quickly identify the backup you need to restore lost work


NotePad.PNG Sample Backup Plan:
  • on a drive that is always attached to your system create a Project Backups Folder
  • in this folder create another folder named Today

Online Project Backups folder

  • use this folder to store your regular backups for today. For example, when you take a break and exit from Surveyor, start Content Manager and backup the current project (e.g. a route, a session or both) to the Today folder

Todays Backups folder

  • name each backup using the name of the project and the time as shown in the example above
  • at the end of each day copy the Today folder to an external drive such as a USB or a detachable SSD into a folder also called Project Backups
  • rename the Today folder on the external drive to a format that identifies the date of the backups it contains (using the yyyy-mm-dd format) as shown below

Offline Project Backups folder

  • copy this renamed folder to a second external detachable drive (if you have one) in its Project Backups folder
  • when starting work the next day, delete the contents of the Today folder on your main drive to start the process again

Backing Up and Restoring Picklists

DotPoint.JPG Picklists have to be exported and imported as text files

Picklists cannot be backed up manually using .CDP files. They must be exported as text files.

LinkWiki.PNG

Detailed instructions on backing up and restoring Picklists as text files can be found on the Trainz Wiki Page at:-



Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz


This page was created by Trainz user pware in January 2020 and was last updated as shown below.


Personal tools