Using Model Backup/Restore

Overview

All models, whether they have been generated or not, can be backed up and restored. To perform a backup and restore, select the Manage task and the Application Administration, Model Backup/Restore subtask. You can back up the entire model or select to export leaf level data only, reducing the size of the backup, which is helpful when moving large models across environments.

How to Back Up a Model in SpotlightXL?

1. In SpotlightXL, navigate to the Manage task and Application Administration > Model Backup/Restore subtask.
2. Select the Backup radio button.
3. Select the Model you want to back up from the list box. The models that are in a Not Generated state will have a text string with “ – Not Generated” added to the end of the model name.
4. From the Data drop-down menu, select the Leaf Level option to backup leaf level data only. The default setting is set to None. Select All to back up all metadata and data.
5. Click Backup.
6. Select the location where you want the backup file stored.
7. Click Save.

The maximum size of a model backup and/or restore is defaulted to 200 MB.

Best Practice When Backing Up a Model

Use Leaf Level for Data when backing up big models, and do not exceed the limit of 500 MB.

Items NOT Backed Up During a Model Backup

• Model Permissions – these would need to be recreated in the target application. The default behavior is that the Power users in the target application will have access to the newly added model, but no other users will be able to access it.
• Users, Groups, and User Groups are not backed up as they are application specific, not model specific.
• Additional Data Sources – data sources other than Planful Structured Planning, Consolidation, or Reporting applications that are not backed up currently.

Additional information about writeback maps for Master models with traditional integration with PCR:

• If the model you are backing up was sourced from PCR and you use a map to write back data from Dynamic Planning to PCR, the model you are backing up is called a Master model.
• Although the writeback map is not stored with the Master model (it is stored with the HACPM_Financial Source model), when you back up the Master model, the writeback map is backed up also.
• Restore will restore the writeback map and store it with the HACPM_Financial Source model.
• Restore As will restore the writeback map to HACPM_Financial with the new model name if the original map is removed or renamed.

Restoring a Model

Restoring a model restores all related artifacts (for example, calculations, views, reports, maps, formulas, and so on). Organization folders within views and calculations, for example, are also restored. However, reports are restored differently.

For reports, a folder is created with the name of the model you restored, and each report is appended with an underscore. 

How to Restore a Model?

1. In SpotlightXL, navigate to the Manage task and Application Administration > Model Backup/Restore subtask.
2. Click the Restore radio button.
3. Click Browse to select the location of the model you want to restore.
4. Enter any name in the Restore As field as shown below.
   
5. Click Restore.

Backup and Restore of External Source Models in SpotlightXL

Power users can back up and restore External Source Models (ESMs) and their associated artifacts. There are two backup options available:

• None: This option backs up the model metadata, including the ESM model definition, fields, formulas, ESM maps, and view artifacts.
• All: This option includes everything from the None backup plus all the data associated with the model. 

Dynamic Planning creates a .ZIP file containing the backup and saves it to your local Downloads folder. The maximum size for this .ZIP file is 500MB, or it can be configured based on your application settings. For more information, refer to How to Restore a Model?, and How to Back Up a Model?

Best Practices When Restoring a Model

• Remove unwanted models. Having several backups or somewhat duplicate models impacts performance.
• Organize reports after the restoration. Move them out of the folder and change the report name to prevent several similar or duplicate reports, which impacts performance.