Model Backup/Restore
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Model Backup/Restore

  • Dark
    Light
  • PDF

Article summary

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.

Note:
If you are backing up a Master model that is connected to HACPM_Financial, you might be able to restore it as a Direct Access to PCR model. This functionality is available only in the Web version of Spotlight. See Converting a Master Model into a Direct Access to PCR Model.

Backing Up a Model

In Practice

  1. Select the Backup radio button.

  2. 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 (such as 2015 Model – Not Generated).

  3. Select the Leaf drop-down option from the Model Backup/Restore Include Data option page to backup leaf level data only. The default setting is set to None. Select All to backup all metadata and data.

  4. Click Backup

  5. Select the location where you want the backup file stored.

  6. Click Save.

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

Note:
If required, contact Planful Support to increase this default. The limit is 500 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.

  • Users, Groups, 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

Note:
Models can be restored from SpotlightXL model backup files only.

Overview

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 in a different manner.

For reports, a folder is created with the name of the model you restored and each report is appended with an underscore. In the example below, the Expenses Model_bkp was restored. This model had 6 associated reports, all of which were restored up the folder named after the name entered in the Restore As field.

ModelingImagesmodelrestore1.png

In Practice

  1. Access the Manage task and the 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.

    ModelingImagesmodelrestore.png

  5. Click Restore.

Note:
If you try to restore a model that already exists, a message will appear. Change the Restore As name to prevent this or delete the model.

Best Practices When Restoring a Model

  • Remove unwanted models. Having several backups or somewhat duplicate models impacts performance.

  • Organize reports after the restore. Move them out of the folder and change the report name to prevent several similar or duplicate reports, which impacts performance.


Was this article helpful?