Overview of the Restore Process | iFIX 2023 Documentation (2024)

You can restore your archived files to any computer that has iFIX installed. Prior to restoring the files, you can select the individual types of files you want to restore or you can restore the entire archive.

The Backup and Restore Wizard includes the following restore features:

• Ability to select a specified destination for the restored files, as well as the individual files you want to restore.
• Ability to delete all existing files under a target project path before performing a restore. This action removes any existing application files in the destination paths, with the exception of the security files.
• Ability to restore the iFIX factory defaults of your original install before restoring the backup files.
• Option to retain the current SCU security settings for the restore, replace the SCU settings with the ones in the archive, or create a new project requiring the input of a new project folder to complete the restore.

The steps below explain how to perform a restore with the Backup and Restore Wizard. For steps on how to use the command line, refer to the Using the Command Line Options section.

To restore an archive:

1. In the Backup and Restore Wizard main screen, select the Restore button.
2. On the first page of the wizard, enter the backup file name to restore or click browse to select one.

By default, backup files are stored in the C:\Program Files (x86)\Proficy\iFIX\ProjectBackup folder.

3. Click Next to continue. The following dialog box appears, allowing you to select the appropriate restore options.

iFIX Restore Wizard

4. Select the required options and click Finish.

To restore a factory default file:

1. Start the Backup and Restore Wizard with the /FactoryDefault command line option. For example:

BackupRestore.exe /FactoryDefault

Refer to the Using the Command Line Options section for more information on /FactoryDefault startup options.

2. In the Backup and Restore Wizard main screen, select the Restore button.
3. On the first page of the wizard, enter the file name of the factory default backup or click browse to select one.

To restore iFIX with the standard factory defaults, select the FactoryDefault.IFD file. If you installed iFIX to the default location, you can find this file in the C:\Program Files (x86)\GE\iFIX folder.

4. Click Next to continue.

5. Select the required options and click Finish.

Restore Destination Options

The Restore Destination Options allow you to select whether you restore the files to the current project path, the project path specified in the archived SCU, or into a separate new project path. The Create New Project option does not modify the existing SCU settings.

If you select to use the SCU file from the archive, this overwrites the SCU file on the target computer. Typically, you would only want to overwrite an SCU file if the target computer does not have an SCU file, or if you want to restore the target computer to its previous state.

If you choose to overwrite an existing SCU file, be sure to verify that the computer's hardware key supports all of the enabled SCU options and the software for these options is installed. For example, if SCADA support is enabled, verify that the hardware key has SCADA support and that the SCADA software is installed on the target node. You should also verify that the path for each start-up task, listed in the Task Configuration dialog box, is correct.

You can modify the node name and project path stored in the archived SCU file when you select to overwrite the existing SCU file. The Node field defines the node name stored in the archived SCU file; the Project Path field defines the project path.

When the restoration process begins, the wizard reads the text in the Node and Project Path fields to determine where to restore the files you selected. Next, the wizard restores the files using the relative paths stored in the selected SCU file. The wizard creates any non-existent paths.

NOTE: If multiple SCU files exist in the archive when you are restoring files, iFIX copies all existing SCU files to the Local path. The SCU file that was in use continues to be used by the system.

If you choose to Create a New Project, files are restored to a new project path with a default sub-project path. To modify the default sub-project paths, refer to the BackupRestore.ini or user-specified .INI file.

Optionally, once you have restored the file, you can create a new SCU file and point to these new paths.

Destination Info

The Destination Info section of the Restore screen displays the SCU file, node, and project path that the archive will be restored to. To display the configured paths for the restored files within the project, click the View Project Path Configuration button. The configured paths are determined by the destination option you selected. If you selected:

Use the current SCU – the paths are determined by the SCU file currently loaded.

Use SCU from archive – the paths are determined by the SCU file in the archive. You can modify the node name and project path. Sub-project paths are determined by the SCU file in the archive and cannot be modified.

Create a new project – the project path is determined by user input. Sub-project paths are determined by the .INI file settings. Refer to the BackupRestore.ini file for more information.

Restore File Options

To perform a clean restore, the Backup and Restore wizard allows you to delete all existing files or to restore default iFIX files before restoring the archive.

Select the Delete all existing files under target project path before the restore option to delete all existing files before restoring a Custom or Full backup file. This option will not delete existing security files or the current SCU file loaded in local startup.

Select the Restore default iFIX files before restoring your backup files option to return the files to their default state before performing a restore. For Custom and Full restores, the default iFIX files are restored from the FactoryDefault file.

To modify the default settings, modify the FactoryDefault definitions in the BackupRestore.ini file. For more information, refer to the BackupRestore.ini file.

Security File Option

If the Restore Wizard locates any security files in the archive that you are restoring, you can select from the following options:

Leave the current security settings alone – Select this option to maintain the current security settings and ignore security overwrites in the backup files during the restore.

Replace existing security files with archived files – Select this option to replace the current security settings with the security settings in the archived files.

Delete all existing security files and disable security – Select this option to delete all existing security files from the current iFIX system and disable security upon restore. This option also displays the current status of security (Enabled or Disabled). If you select this option, ensure that the Restore default iFIX files before restoring your backup files option is also selected to use the active iFIX project.

The restore destination for security files is determined by the presence of security files in the current iFIX system and the archive. The following table shows the sample configurations and the determined destination:

NOTE: In the previous table, node.dov denotes that local security settings related to a single project are found. Display.dov denotes that global security settings are found.

In the 2nd and 3rd configurations shown in the table, the security files are restored to the target local path. The user receives no warning message.

In the 4th and 5th configurations, the security files are also restored to the target local path. A warning message displays the current security path and the new security path. As node.dov relates to a specific single project, if the current path is not equal to the target path, the existing security settings remain and the archived security settings are restored to a new project path. If the current path is equal to the target path, the existing security files are deleted and then the archive is restored.

In the 6th configuration, the global security settings are removed and the security files are restored to the target local path. A warning message appears displaying the current security path and the new security path.

In the 7th configuration, security files are restored to the current global security path. A warning message displays, alerting the user that the current security path is the same as the new security path and will be overwritten.

Restore File Selection

Once you select the appropriate restore options, select which specific files you would like to restore to the project path. If you would like to restore all files, select the Restore the entire system check box.

See Also

How Do I...