Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

Run a Backup from the Command Line

  • Last UpdatedJul 18, 2023
  • 3 minute read

You can execute the Plant SCADA backup program from the command line to back up and restore files other than Plant SCADA projects.

The backup program is called CtBack32.exe. By default, it is installed in the Plant SCADA project 'Bin' folder. The backup program archives files using a standard compression routine, producing Zip compatible files. The default extension for Plant SCADA backup files is .ctz, though any extension (including .zip) can be used. This means you can also use any Zip compatible program to extract files from a compressed Plant SCADA backup if you prefer.

Note: If you run the backup program from the command line, and you specify an INI file as a parameter, the specified INI file will be backed up instead of Citect.ini.

The backup program reads the citect.ini file for any parameters set using the [BACKUP] category. These settings (if any, and their defaults if not) are over-ridden by any values passed as command line options.

The table below describes the backup command line options.

Option

Description

-d<name>

Database name

-m<ext>

Include extension

-x<ext>

Exclude extension

-e (follow with a number e.g. -e1, -e0)

Encrypt with password

-p<password>

Encrypt/decrypt password

-s[+/-]

Recurse subdirectories

-u[+/-]

Save uncompiled, use -u- to save compiled

-g[+/-]

Show configure dialog

-c[+/-]

Compress files

-b<path>

Path to backup from

-r<path>

Path to restore to

-i<filename>

ini file name

-a

Run in auto mode

(Note: Every necessary input needs to be in command line or INI file.)

-o

Overwrite target ctz

Note: If -d is not specified and the application is not running in 'auto' mode (-a), the project will be restored to the path of the project from the [CtEdit]LastDatabase ini parameter. If the ini parameter is not present then the project will be restored to the location the -r option specifies. If you restore a project with the -d option on a configuration workstation the application will look in the master.dbf for this project and restore to the path specified in the master.dbf, therefore the project must exist. If you restore a project with the -d option on a runtime only workstation the application overwrites the -d parameter with the [CtEdit]Run parameter from the ini file and restores to this path.

Examples

  • To back up "c:\data" use the following command:

    CTBACK32 -g- -bc:\data

  • To restore the above data use:

    CTBACK32 -g -rc:\data

  • To backup a Plant SCADA database, for example, to backup "demo" use:

    CTBACK32 -dDEMO -b -u- -c+ -d-

Ctback32 also uses the following parameters in the citect.ini file:

[BACKUP]
Database= ! database to backup or restore
BackupPath= ! file to backup to, for example c:\temp\example.ctz.
FilePath= ! file path, used in not a database
Password= ! encryption password
Encrypt=0/1 ! encrypt backup
Configure=0/1 ! display configure dialog
Compress=0/1 ! compress backup
Overwrite=0/1 ! overwrite
SaveCompiled=0/1 ! save compiled
Recurse=0/1 ! recurse sub directories
DeleteAll=0/1 ! delete all before restore
SaveInclude=0/1 ! add included projects to backup file
IncludedDBOn=0/1 ! display a notification after backup if include projects found
SaveIniFiles=0/1! determines whether save ini files is checked
Operation=0/1 ! 0=backup, 1=restore
RestoreInclude=0/1 ! restore included projects contained in backup file
Include= ! include list
Exclude= ! exclude list, default DBK,_CI
CompiledFiles= ! compiled files, default RDB

Related Links
TitleResults for “How to create a CRG?”Also Available in