Backup

<< Click to Display Table of Contents >>

Navigation:  Getting Started > Multi System Configuration >

Backup

There's 2 options for backup in VERTEX: partial backup and redundant backup.

Switching between the modes can be done via UI or triggered with a script command.

Default backup mode is partial - the mode can be set in the project settings.

Backup Mode

Partial

A backup system is a session member that takes over the role of another session member or the master.
The master role can be taken over from every system in your project.
A system can take over the render part of another system.
VERTEX offers a great flexibility managing the amount of backup systems per project.

Redundant

Your live-setup is completely mirrored on a backup group:
A group of live systems for instance could consist of one master and two session member systems.  

In a redundant setting, a mirrored group of one backup master and two backup session members is held in reserve,  ready to take over any time.

Set Backup Mode

The default mode for backups is Partial
The mode can be set for a project in the Project Settings.

Depending on the selected mode, the menu entries for Backup in the main menu will change.

backup-project-settings_zoom75

Partial Backup

Master

Every system in your project - including a session member that is kept in case a backup is needed - can take over the master role.

 
How to switch:

 

1.Via the UI
Go to the Session Member System that should take over the master role,
Go to Backup tab of the Main Menu there and select "Takeover Master Role"
The Session Member switched its role to Master. Now the former master ( if still alive) will become a Session Member.

backup-takeover-master-role

 

2. Use a Script Command

SystemsManager.BackupTakeOverMasterRole

 
This script command can only be triggered on the local system and also externally via VERTEX API.

warningSync-Clock Source System
Switching the Master Role will not change the Sync Clock Source System of a project.
If the former Master is defined as Sync Clock Source System and still alive, it keeps this function even after a master switch.
If the former Master is dead for some reason, the Backup Sync Clock Source System that is defined in the Project Settings, will take over this function.
Please consider this, if you want to change also the Sync Clock Source System  on a master switch. You can e.g. do this with an additional script command in a backup script.

Session Member

Your backup system is already a session member in your current project - there is no role change needed as for master.
 
Each VERTEX system has a property in advanced mode called Render System and Audio System.
In a backup case for one session member, another session member can simply take over the tasks for rendering or audio playback.
Condition of course: it has the same number of outputs with the same resolution. The backup system must have the same numbers of surfaces with the same render target size.
 

Example:

System2 should render content for System1
Select System1 in the inspector.

Change the Render System property by dragging System2 from the project explorer and dropping it into the property field of the inspector.
Now System2 takes over all render tasks from System1.
The same works for audio systems.
 
How to switch:
 

1.Via the UI
In the inspector select the faulty system that needs to be backed up.
Drag a new system from your project explorer and drop it into the render system property.

backup-render-system_zoom75
 

2.Script Commands

// Set System2 as Render and Audio Backup for System1
System1.Settings.RenderSystem.Value = System2
System1.Settings.AudioSystem.Value = System2

Redundant Backup

Backup Group

a live group consists of

live master

number of live session members

 

a backup group consist of

backup master

number of backup session members
 

Backup groups can have one of the following two states:
 

1.Connected:
All changes on the live system are pushed to the backup system.
When connected, the project state from backup master will be overwritten with the project state from live master.
Use to update your backup group to the newest project changes. The project state on backup master is overwritten and updated.
When connected,  the live master also acts as master for all members of the backup group.
 

2.Disconnected:
If the backup group is disconnected, both groups - live and backup - act autonomous.
The live master controls all session members of the live group.
The backup master controls all session members of the backup group.
Changes on the live group will not be pushed to the backup group.
The project state of the backup group corresponds to the time when the groups were separated.

Define Members for Backup Group

1.Add all systems as session members to your Project.

2.Switch Backup Mode in your project settings to "Redundant".

3.Select Systems in the inspector and enable the following:
Backup Master: if enabled, this system will become master of the backup group.
Backup System: enable Backup System for all Session Members of the Backup Group

backup-redundant-inspector_zoom75

informationPlease take care, that all members of a Backup Group have assigned the Content they need to play back
when sharing content only to certain Target Systems, please check your System and content settings into Inspector

Connect and Disconnect Backup Group

 

1.Via User Interface
Go to Backup Tab into Main Menu
Disconnect or Reconnect backup Group

backup-redundant_zoom75

 

2.Script Command

SystemsManager.BackupGroupReconnect
Systemsmanager.BackupGroupSeparate

 

This Script Command could only be triggered on the local System - of course also from external over the VERTEX API