Backup and Recovery Guide

Introduction

The Backup and Recovery is a default feature for all Documents in Highstage. It provides automated backups of general Microsoft Office files (Word documents, Excel spreadsheets and PowerPoint presentations):

The Backup and Recovery feature provides Highstage system administrators with the capabilities of recovering and retrieving backed up versions of files in case current versions are lost or damaged. Backup and Recovery are supported by the Document module in Highstage.

Backup procedures

Highstage supports automated backup of files (Word documents, Excel spreadsheets and PowerPoint presentations) which are subjected to being updated by our Refinery processes in Highstage.

Info: Refinery is the process of automatically updating/synchronizing Microsoft office files with data From Highstage. Please refer to our documentation page to read more about Refinery.

Process

Files which are subjected to the Refinery process will now be automatically be backed up before being processed. In this manner, throughout the lifecycle of a Document - you will be able to recover an older version of a file without having to worry about creating manual copies or by creating temporary and frequent locked/frozen versions and revisions of the entire Document.

Conditions and Deletion

Any automated or manual initiation of Refinery will result in a backed-up copy of the affected files up until the Document is Approved (Document reaches 'Approved' status). This means that files are backed up as long as the document is in Working, Freeze, Review, and Approval.

By default, when a Document is Approved, all existing backups of files will be deleted and no automated or manual initiations of Refinery will result in file backups. Automated deletion of backed-up files can be enabled or disabled through the configuration options.

Tip: Deleting backed-up files for Approved Documents is to ensure that the file storage does not keep redundant copies of files that reflects its ongoing development.

Recovery

Files are stored in the root directory of the associated Document (.../files/workspace/itemtype/item) and can only be viewed and accessed by system administrators.

The folder containing backed-up versions of the files will include refinebackup in the folder name:

Each copy will be contained within its separate folder named according to the time in which it was created (YYYY-MM-DD-HH-MM-SS):

Configuration

Enabling and/or disabling Backup and Recovery

Backup and Recovery is enabled by default for all Documents in Highstage and does not require any initial setup or installation.

Disabling Backup and Recovery

Add the following sample to the custom.schema.xml located in the Tweak folder on the Highstage server:

x
<parameter name="DisableRefineBackup" value="1" />

Note: Changes to the custom.schema.xml requires a Restart of the Highstage application to take effect.

Enabling Backup and Recovery (Default configuration)

Add the following sample to the custom.schema.xml located in the Tweak folder on the Highstage server:

xxxxxxxxxx
<parameter name="DisableRefineBackup" value="0" />

Note: Changes to the custom.schema.xml requires a Restart of the Highstage application to take effect.

Enabling and/or disabling automated deletion of backed-up files

Backup and Recovery is automatically configured to delete all backed-up associated with a document when it reaches the Approved status.

Disabling automated deletion of backed-up files

Add the following sample to the custom.schema.xml located in the Tweak folder on the Highstage server:

xxxxxxxxxx
<parameter name="DisableRefineBackupDeletion" value="1" />

Note: Changes to the custom.schema.xml requires a Restart of the Highstage application to take effect.

Enabling automated deletion of backed-up files

Add the following sample to the custom.schema.xml located in the Tweak folder on the Highstage server:

xxxxxxxxxx
<parameter name="DisableRefineBackupDeletion" value="0" />

Note: Changes to the custom.schema.xml requires a Restart of the Highstage application to take effect.