Syntax:

Backup;<filename=name;><comment=text>;<imagedirs=dir1|dir2|...|dirn>;<source=PROFILE|STORAGE>;<archive=directory>

When using multiple imagedirs, directories must be separated by '|' (pipe) character.

If ImageDirs is specified, all files in the profiles 'Images' directory are excluded unless specified in the command as imagedirs item.

Source may be specified to backup the profile or profile's Storage folder. Abbreviations for backup source is either 'PROFILE' or 'STORAGE'.

Archive may be specified to override user selected Archive folder in GUI.

If filename is omitted, filename will be profile/storage name with serial number postfix.

 

 

Example 1: Sample Backup

Backup;comment=AutoBackup

The above example backups all profile with a AutoBackup comment.

 

Backup;comment=AutoBackup;imagedirs=Images\Left|Images\Right

The above example backups the profile but includes only specified image directories "Images\Left" and "Images\Right". Any other files in Images folder and its sub folders are excluded.

 

Example 2: Python backup script examples

#complete profile backup, default location and name with serial no
ExecuteCmd('Backup','comment=Autobackup')

#save all except Storage Images
ExecuteCmd('Backup','source=STORAGE;imagedirs=""') 

#backup storage including specific image folder Images\Scan (note double backslash)
ExecuteCmd('Backup','source=STORAGE;imagedirs=Images\\Scan') 

#backup profile without images at specific destination with increasing serial no name
ExecuteCmd('Backup','archive=c:\\backup;imagedirs=""')

Notes:

1. Default filename is profilename_nnn.zip, where nnn is increased by one for each backup, starting at 1. If filename contains no path information the backup will be stored at the configured Archive directory - more information.
2. Comment is appended to the default comment. The default comment contains key values for backup creation time, Scorpion version, profile version and profile name. The comment may be viewed/edited with WinZip.