KB-127461: BeforeRestoreBackup & AfterRestoreBackup

BeforeRestoreBackup & AfterRestoreBackup

The script applications that are triggered by this interface serve to influence the restore of a version from a backup.

Process

  1. A target directory is used

  2. The interface BeforeRestoreBackup is triggered before the restore begins and the associated script application is started.

  3. The restore is carried out.
  4. The interface AfterRestoreBackup is triggered and the associated script application is started
  5. The restore is ended.

The interface BeforeRestoreBackup starts the script application before a version is restored from a backup. The restore is carried out when the scripting application is ended (completed, cancelled or suspended due to timeout).

If the BeforeRestoreBackup has been successfully carried out, AfterRestoreBackup will also be carried out, regardless if an error occurred. If BeforeRestoreBackup ends in an error, the AfterRestoreBackup will not be carried out. Failure of the AfterRestoreBackup will not lead to the original state being restored.

Command lines for ScriptBeforeRestoreBackup

ScriptBeforeRestoreBackup.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the server archive] /at:c

Command lines for ScriptAfterRestoreBackup

ScriptAfterRestoreBackup.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the server archive] /at:c

Description of the interface file for BeforeRestoreBackup

The sections [Common], [User], [Component], [ExclusiveUse], [UnderDevelopment] and [Result] are described in Global interface file sections.

[Specific]

INI key I/O Description

WorkingDir I Complete path to the working directory of the component

DestinationDir I

Complete path to the target directory of the restore process

PathSourceBackup I Complete path to the backup (ZIP file) that you wish to restore

DeviceEquivalent I

Element that serves as the equivalent of the device in the offline project

Note

This key may be empty or contain “*” (UNC, Local, FTP)

Description of the interface file for BeforeRestoreBackup

The sections [Common], [User], [Component], [ExclusiveUse] and [Result] are described in Global interface file sections.

[Specific]

INI key I/O Description

WorkingDir I Complete path to the working directory of the component

DestinationDir I

Complete path to the target directory of the restore process

PathSourceBackup I Complete path to the backup (ZIP file) that you wish to restore

DeviceEquivalent I

Element that serves as the equivalent of the device in the offline project

Note

This key may be empty or contain “*” (UNC, local, FTP).


Last update: September 15, 2023

Related Articles

IMPRINT | PRIVACY POLICY | COOKIE POLICY

Privacy Preference Center