User manual for creating backups

User manual for the Ferro Backup System™ - Server

• Click on the heading of the column according to which you want to sort the table
• To reverse sorting order, click the column heading again
• To sort the table according to multiple columns, select their headings one by one while holding down SHIFT
• To disable sorting, click the column heading while holding down CTRL
• If after clicking on the column heading an arrow indicating the sorting order does not appear, it means that sorting is unavailable for that column

• Move the pointer over the column heading and click on the displayed filter button.
• To add a new filtering rule or modify an existing filter, click on Apply in the lower right corner of the table
• To turn off filtering, click on X in the lower-left corner of the table
• If the filter button does not appear when you move the pointer over a column heading, it means that filtering is unavailable for that column

• No connection
• Ready to work
• Task preparation on server side
• Task running
• Software update

• Stopped
• Running

• Full backup
• Differential backup
• Delta

• Station status – current status of workstation
• Station – name of workstation
• Task status - Current backup task status
• Task – Task name
• Last backup – date and time of last backup
• Delta time - time remaining until task execution (-), task duration (+) or task delay (+ red)
• Next backup – date and time of next backup
• Type – Backup type
• Schedule – Task schedule

Fig. 1.1 FBS Server - Backup

• Back up now – when the Stations tab is active, this command is used to immediately run the default backup tasks for the selected workstations. When the Tasks tab is active, it immediately runs the selected backup tasks
• Cancel – cancels the current backup task on the selected workstations
• Add – displays a configuration window for defining all backup parameters for a new workstation or a new backup task
• Change - displays a configuration window for adjusting the settings of the selected workstations or backup tasks
• Delete – deletes the selected workstations or backup tasks

Fig. 1.2 FBS Server - Backup – Workstation Settings window/General

• Computer name – workstation designation. This can be entered manually or selected from a list. The list only has those workstations which have been connected to the server and have not yet been defined. The field is inactive when changing settings for a previously defined workstation.
• Computer description – space for comments regarding a workstation.

• New – creates a new backup task
• Change – changes the name of the selected backup task
• Delete – deletes the selected task

• On demand – The backup operation will only be run by manually launching the task in the application’s main window (button: Back up now)
• Daily – The backup task will be run every day at the time indicated in the field Start time.
• Day Intervals – The backup task will be run automatically after a certain number of days. The interval must be set in the Days field.
• Hour Intervals – The backup task will be run automatically after a certain number of hours. The time interval must be set in the Hours field.
• Days of the week – The backup task will be run automatically on selected days of the week as defined in the Days of the Week field.
  
  
  
  
  Fig. 1.3 FBS Server – Workstation Settings - Tasks/Schedule
  
  
  
• Start Time - In the Start Time field you can schedule the archive task start time to 1 minute.
• Execute task only at a specified time – the task will only be executed at a specified Start Time. If the workstation is not connected to the server at this specified time, the task will not be executed until the next time. When this option is disabled, if the workstation was unavailable at the specified time, the task will be executed immediately upon connecting the workstation to the server.
  Note. It is recommended to disable this option for laptops as they are often unavailable at a specified time.
• Next Time - In the Next Time field you can set the date for the next backup operation.
• Last Time - The Last time field indicates the date of the last completed backup.
  
  

Fig. 1.4 FBS Server - Backup – Workstation Settings window/Tasks

• Remote File List – this field shows the directory tree of the workstation(remote computer). If you configure settings of a workstation currently not connected to the server, the window is empty. The Volumes button (“V”) is used to display the root directory tree, i.e. the volumes available at the workstation. The following abbreviations are used:
  • FDD – floppy disk drive
  • HDD – hard disk drive
  • CDR - CD/DVD reader or writer
  • NET – mapped network drive
  • DIR - directory
    
  • LNK - hard link, junction (soft link) or symbolic link
  • DEF - predefined position
    
    
• File Masks to Back up – a list of files and directories to back up. The list can include specific files or file masks.
• File Masks to Skip – a list of files and directories to be omitted from the backup operation. The field is used to exclude a file or a number of files from the File Masks to Back up list. The list can include specific files or file masks.
• Add – adds files or file masks to a list (back up list or skip list). If a file (or files) is selected in the field Remote File List, after clicking on Add it will be added to the list. If, however, a directory or a disk is highlighted in the field Remote File List, the path of this directory and the file mask shown next to the Add button will be added to the list.
• Delete – deletes selected entries from a list.

• hiberfil.sys
• pagefile.sys
• *\System Volume Information\*
• *\Temp\*
• *\Temporary Internet Files\*

• Backup of operating system or disk partition
• Backup of databases and mail files

Fig. 1.5 FBS Server - Backup – Workstation Settings/Task/Options

• Backup type
  • Full - full backup
  • Differential - differential backup. It is recommended in most cases due to greater speed and space savings on the backup server compared to full backup.
  • Delta - differential backup at file fragment level. An advanced option of the differential backup recommended for tasks including files larger than 20 MB which are often modified (mail files, databases, etc.).
    Note. Since additional information needs to be stored in backup archives (checksums), the “file fragment difference” option only works from the third backup operation on.
• Periodical full backup – this enables you to reduce the level of dependency between differential backup archives. In the case of differential backups the application only backs up those files which do not exist (or exist only in older versions) in the previous backup files. Thus after a certain time dependency develops between backup archives – newer archives which are connected with older ones. When information is restored from a differential copy, files are extracted from the selected differential backup archive and previous archives linked to it. If a large number of archives is stored (see: Rotation copies) and any of the differential backups is damaged or deleted, some of the files may not be recoverable. To reduce that risk, check this option.
  Note. This option is not required to ensure correct backup and restore.
  
  The period is calculated differently for various backup schedules. Two solutions are used: one based on the quantity of files (ZIP archives), and the other based on the quantity of scheduled dates. The first one is used for schedules where it is not important when (on what day) the full backup copy will be made. The other allows specifying the exact date and time of performing a full backup. See the table below for an overview of the Period option functionality along with examples.
  
  

  Backup schedule setting	Full backup period calculation
  - Only on demand - Daily - Once in a specified number of days	The period is determined based on the number of differential backup copies. In this case, a full backup will be executed once per given number of differential copies. Example (F = full; d = differential): - Period = 2; F/d/F/d/... - Period = 3; F/d/d/F/d/d/...
  - Once per given number of hours - On weekdays	The period is determined based on the scheduled dates. In this case, a full backup will be performed once per given number of scheduled dates. If backup cannot be performed on the scheduled date when the full backup falls (e.g. the computer is unavailable), full backup will be scheduled for another date as per the scheduled period. The field Period Start defines the date from which a period runs. Example: -Schedule: On weekdays = Mon Tue Wed Thu Fri; Period = 5; Period Start = Fri; Full backup performed every Friday -Schedule: On weekdays = Mon Tue Wed Thu Fri Sat; Period = 3; Period Start = Wed; Full backup performed every Wednesday and Saturday -Schedule: On weekdays = Mon Wed Fri; Period = 6; Period Start = Fri; Full backup performed every other Friday -Schedule: Once per given number of hours = 2; Period = 4; Period Start = 1.00 p.m.; Full backup performed once every 8 hours - at 1.00 p.m., 9.00 p.m., 5.00 a.m.

  
  
  
• File encryption algorithm – here you can select an algorithm for file encryption. Three encryption algorithms, currently considered the best, are available: Rijndael, Serpent, Twofish. Just as during compression, encryption is performed on the computer on which the backed up files are located. Thus the backup copies are already secured when they are sent to the backup server over the network. All of the implemented encryption algorithms use 256-bit keys. The encryption password must be set in the Password management window.
  Note. Encryption may significantly slow down the backup process (Twofish is the fastest encryption, Serpent the slowest). Please note that ZIP archives encrypted in the Ferro Backup System can only be opened with FBS Server - Restore tab.
• Back up before system shutdown – you can choose whether the application should back up files before shutting down the computer.
  • Only if no backup has been scheduled for today (1) – the backup will be performed before shutting down the system only if a backup operation has been scheduled for the current day. This option enables you to execute a backup operation scheduled for a given day even if the user shuts the computer down before the scheduled backup start time. After the backup is completed using this option, a new backup is scheduled based on the predefined schedule.
    Example:
    -Schedule: Daily, 5pm, Back up before system shutdown: YES
    -Next time: 2007-08-20 17:00:00
    -The system is shut down at 3:30pm. The task is launched. After the task is completed, the next backup is scheduled for: 2007-08-21 17:00:00
    
  • Always (2) - a backup will be performed at each system shutdown. Unlike the previous option, the backup schedule with the “always” option on is not updated after the backup is completed (no new backup is scheduled).
    
    
  • Allow user to cancel backup – if this option is active, the user may cancel the backup and shut down the computer immediately. (This option is global for all of a given workstation’s backup tasks. If this option is changed in one task, it will change in all other tasks.)
  
  Note. The “Back up before system shutdown” option can be turned on only for one backup task.
  
  
  
  
  Fig. 1.6 FBS Worker – the information window displayed during system shutdown
  
  Disk failures most often occur during power on or off. The “Back up before system shutdown” option is used to enhance data protection. It backs up all files created or modified since the last backup when the user shuts down the computer prior to the scheduled periodical backup. If this option is on, the backup is started when the user attempts to shut down the system (selecting “shut down” or pressing the power button on the computer). A dialog appears informing the user that the backup operation has started. The workstation user may cancel the backup and shut down the system immediately by pressing the Cancel button.
  Note. If the "Back up before system shutdown" option is on, the dialog may be displayed for a certain time (~10 seconds) at each system shutdown, even if no backup is required according to the current settings. During that time FBS Worker will interface with the FBS Server to check whether the task needs to be launched.
  If the user does not execute any command, the system shutdown will be completed after the backup operation is finished or connection with the backup server is lost.
  NOTE. The "Back up before system shutdown" option must be switched on only for workstations supporting APM / ACPI. For older workstations which do not support APM / ACPI, after the backup is completed the computer will not be shut down!
• Rotation backups (how many previous copies should be stored) – defines how many backup copies can be stored on the disk. If this option is on, the application will delete the oldest backup file (ZIP file) from the disk if the current number of backup files in the FBF directory is higher than the value set in this field. E.g. if the value is 7, after the 8th copy is completed the application will delete the oldest ZIP file.
  For differential backups, the last differential backup is deleted. The option “Optimize to save disk space” applies to differential backups. If it is on, the application will move files between different ZIP archives so that a ZIP file can be deleted as soon as possible, thus freeing up disk space.
  Note. Ferro Backup System uses advanced mechanisms to move files between ZIP files without actually unpacking and repacking (decrypting and encrypting) them again, which significantly speeds up the operation. This should not, however, be used on slower backup servers since the time to complete a backup task may then be significantly longer.
• Backup Location - can be defined by an alternative, in relation to the Main Backup Location, backup storage path for the selected backup task
  In order to ensure the necessary level of efficiency, the backup directory should be located on a local hard disk or an internal disk array (RAID). Using network disks is not recommended. A network disk can be used as an additional storage location. For details see:Replication.
• Comment – here a comment can be added to a backup task

Fig. 1.7 FBS Server - Backup – Workstation Settings window/Advanced

• Limit network load – defines a given workstation’s maximum network load. See also: Limit connection speed for all workstations
  • Maximum data transfer rate
    • Unit: kilobit/sec. [kb/s]
    • Range: 50 - 1 000 000
    • Default: 4,000 (= 4 MB/s)
  • From/Until - defines the time interval in which the restriction is active
  • Except – defines an exception or a situation when the restriction is not active
    • Saturdays and Sundays
    • Sundays
• Time to wait for packet - Time to wait for a packet. Currently this needs to be set to 0.
  • Unit: milliseconds [ms]
  • Range: 0 (no time limits) - 16777216
  • Default: 0
• Maximum packet size – Maximum size of transmitted packets. Entering a value higher than 16384 can increase the transfer rate but if the transmission is broken while the archive is being sent the received file may contain errors (packets lost).
  • Unit: bytes [B]
  • Range: 512 - 16777216
  • Default: 16384
• Time interval between reconnection attempts – Time interval between subsequent attempts to reconnect to the server.
  • Unit: milliseconds [ms]
  • Range: 0 (immediate) - 16777216
  • Default: 4000
• Interval between subsequent data sending attempts – Time interval between subsequent attempts to send data
  • Unit: milliseconds [ms]
  • Range: 0 (no delay) - 16777216
  • Default: 14000

• Compression priority – defines maximum CPU usage during backup. During a backup operation FBS Worker reads files from a disk, compresses them and sends them to the server. This places a significant load on the CPU, particularly using poor equipment. If the backup is performed while the user keeps working with the computer it is possible, for comfort, to set a lower compression priority. 0 means the lowest and 6 the highest priority. To ensure user comfort, you can set it to 0, meaning the application will only compress when the CPU is idle. Setting it to anything below default will involve less CPU usage and longer backup times. Setting it higher than default may shorten backup times.
  Note. Setting the priority to 6 may mean that the operating system will not respond to the user's commands until the backup is completed.
  • Range: 0 - Idle, 1 - Lowest, 2 - Lower, 3 - Normal, 4 - Higher, 5 - Highest, 6 - Time Critical
  • Default: 2
• ZIP compression level - ZIP compression level. Range: 0 (no compression), 1 - 3 (fast compression), 4 - 6 (normal compression), 7 - 9 (best compression). Default: 4. If set to 0, files will not be compressed. Values between 1 and 9 define compression level. Small values mean faster compression, less CPU usage and larger archives. High values mean better compression (smaller archives), longer compression times, more CPU and memory usage.
• Maximum cache – Maximum buffer used for file compression. If set to 0, the best buffer size will be used – ranging between 524288 and 1572864 B. If small values are used (less than the default) compression times are longer and the resulting ZIP archives are larger (lower compression). It is not recommended to use high values (higher than the default). This will consume more memory, lengthen compression times and only slightly improve compression.
  • Unit: bytes [B]
  • Range: 0 (default size), 512 - 16777216
  • Default: 0
• Cache size for ZIP stream – The size of the cache memory for the compressed ZIP stream. 0 means cache is switched off. The upper value is limited by the size of the available RAM. In order to limit demand on the application’s memory, you can reduce the cache below the default value. However, if the cache is set below 65536 B, transmission speeds fall dramatically, the amount of information sent over the network rises sharply and the load on the workstation’s and the backup server’s CPU increases. Values higher than the default may increase the backup speed, reduce the amount of data sent over the network and reduce the load on the workstation’s and the backup server’s CPU. If the set cache value is higher than the available RAM, backup will not be possible (error: no memory).
  • Unit: bytes [B]
  • Range: 0 - 1073741824
  • Default: 200000

• Open/locked file backup - (Open File Manager) this can be used to backup open files, i.e. files which are locked by other processes in the system. Files are backed up in the OFM only if they cannot be opened any other way. Most often locked files are database files and system files. For large files (> 100 MB) it is recommended to schedule backups for periods when information is saved less frequently. If the OFM cannot obtain a coherent file image (for database files this is the status after a transaction), the file will be skipped and a relevant note made in the Event log.
  Note. Files which are open (locked exclusively) can only be backed up under: Windows NT 4.0, Windows 2000, Windows XP, Windows 2003, Windows Vista, Windows 7, Windows 2008. Files need to be placed on a local, uncompressed FAT 12, FAT 16, FAT 32 or NTFS partition.
  
  
• File open retry – Number of attempts to open a file. This is used to define how many times the application should retry to open an input file if a read error is encountered. If during the backup operation there are errors caused by the application’s inability to ensure the integrity of input files, this should be set to a higher value.
  • Range: 0 (no retries) - 255
  • Default: 2
• Interval between subsequent read attempts – the interval between subsequent read attempts of source files. This defines the time interval between subsequent attempts to read a source file. Set this value higher if there are integrity errors in input files.
  • Range: 0 (immediate) - 65535
  • Default: 2
  • Unit: milliseconds [ms]
• Minimum file size to be broken down into fragments – sets the file size threshold – if this is exceeded, differential backups will be performed on the file fragment level. See also: Backup type - file fragment difference
  • Range: 100 - 2096128
  • Default: 20480
  • Unit: kilobyte [kB]
• Size of split file fragments – sets the size of fragments which the backed up file will be split into (virtually). Values lower than the default can save disk space on the backup server and speed up the backup process. The default value has been calculated for 1 GB files. If file(s) larger than that are backed up, setting this value lower may increase backup verification time and slow down backup preparation. See also: Backup type - file fragment difference
  • Range: 100 - 2006128
  • Default: 1024
  • Unit: kilobyte [kB]

• Synchronize workstation clock with server – if this field is active, the date and time on the workstation will be synced with the date and time on the server. The date and time are synced whenever a connection is established and whenever time or date settings are changed on the workstation.
• Restore default – restores default workstation settings in the Advanced tab.

Fig. 1.8 FBS Server - Backup – Workstation Settings window/Remote commands

• Add – displays a dialog to enter a new remote command
• Change - displays a dialog to change a selected remote command
• Delete - deletes a selected remote command

Fig. 1.8.1 FBS Server - Backup – Workstation Settings window/Remote commands - edit

• Remote Command – defines the name of an executable file (.exe, .bat, .cmd, etc.). If necessary, enter the full path before the file name.
• Parameters - (optional) list of parameters to be sent to the executable file when it is launched. You can use Windows environment variables (local variables and system variables) (e.g.. %COMPUTERNAME%, %USERNAME%) and software variables %TASKNAME%. The %TASKNAME% variable will be replaced with the name of the current backup task when the command is launched (e.g. BASIC). The use of the %TASKNAME% variable enables you to execute a remote command on a contingent basis, depending on the backup task in progress. A sample use of this variable in a batch file might look like this:
  
  Example 1 - passing %TASKNAME% variable value to a batch file as %1 parameter

  Command: C:\example.bat
  Parameters: %TASKNAME%
  

  
  Example 2 - conditional execution of "defrag C:" command
  

  Command: CMD
  Parameters: /C if %TASKNAME% == BASIC defrag C: 
  

  
  
• Launch – here you can specify when the remote command is supposed to be launched. The following types are available:
  • When starting the application (FBS Worker)
  • Before backup
  • After backup
• Wait until command is completed – here you can choose whether FBS Worker, after launching a remote command, should wait for its completion before continuing with the task or not. This option should be active if any subsequent tasks depend on the completion of the remote command.
• Test – sends a remote command to the workstation and launches it. The result of the remote command will be displayed in another window on the backup server.
• OK - accepts changes and closes the window
• Cancel - closes the window

• Mapping network drives using Remote Commands
• Local commands

Fig. 2.1 FBS Server - Replication.

• Replication (Replication mode):
  • Automatic – the replication will be performed automatically when backup and verification operations are completed.
  • Schedule – the replication will be performed according to a schedule defined by the administrator
  • Manual – the replication will be performed on demand only (Replicate now button)
• Choose Tasks - this opens a window in which you can choose which backup tasks should be replicated. Replication can be switched off for selected backup tasks, switched on for all backups or for full backups only (see also: Periodical full backup)
• Set Schedule - here the user can schedule replications. Replications can be performed at a preset time based on one of the following patterns: daily, every number of days, every number of hours, on selected days of the week. This option is only active when the replication mode is set to "Schedule".
• Replicate now - this will replicate all backups included in backup tasks selected for replication. This is only active when the replication mode is set to "Manual".
  • Writing simulation - this will check that the replication settings are correct and the drives are ready. This command will perform all activities involved in the replication of backups except the actual copying, deleting, writing and marking replicated backups.
• Cancel – use this to stop the current replication process. As writing must be successfully completed, it may take up to several minutes to cancel a replication to optical media or tape media.
• Next replication - here the user can choose the next scheduled time of replication. This option is only active when the replication mode is set to "Schedule".
• Events - an extract from the Event Log describing replication events for the selected drive type.

• Workstation – a drop-down list where you can select the computer to view or unpack files from. The name of the workstation can be selected from the list or entered by typing. The list includes the names of computers which are defined in the System (they are displayed in the Backup tab) or were defined (have been removed and no longer appear in the Backup tab) but their FBF directory containing ZIP files are on the server. You can thus restore information from currently defined workstations and from workstations which are no longer connected to the System.
  
  
  
  
  Fig. 3.1 FBS Server - Restore.
  
  After selecting a workstation a list of available backup files will be displayed in a field below.
  
  
• Search – use this to search for files and directories with a particular name in a selected backup task. In full tasks, only a full backup archive is searched. For differential tasks, the selected differential task is searched as well as all previous backup archives linked to it. Wildcards may be used for search.
• Available backup files – this shows a list of available backup files for a selected workstation. Each item specifies date and time of file creation. The number of items in this field corresponds to the number of backup files currently stored on the server. If no backups have been performed for a workstation, the field will be empty. Here you can choose, by selecting only one item, which data (from which day) is to be viewed. It is thus possible to restore data not only from the last backup copy but also data from a specific date.
  
  After selecting an item from the list, a directory tree will appear in the right-hand window showing a list of backup files.
  
  
• Directory tree – a list specifying file names, extensions, sizes and backup dates. After selecting a directory or a file, the Restore button above becomes active. Please note that if a large number of differential backup files from your workstation are stored on the server, building a directory tree might take a while.
  
  
• Restore... – use this to unpack (extract) selected files or directories from ZIP archives. In full tasks, only a full backup archive is restored. For differential tasks, the selected differential task is restored as well as all previous backup archives linked to it.
  
  After clicking on Restore a window will pop up in which you need to enter a destination path for the selected files or directories.
  
  
  
  
  Fig. 3.2 FBS Server - Restore -Unpack.
  
  
  • Destination Path – use this to define a location where to unpack files. Where network location is selected (Original Location or Selected Workstation) files are unpacked to a temporary file located on backup server and then sent to the workstation. FBS Worker receives files at the workstation’s end and saves them in a target directory.
    • Original Location – use this to restore files to their original location
    • Selected Workstation – use this to restore files to a selected workstation
    • Local directory – use this to unpack files to a local backup server directory
      
  • Create drive letter directory – use this to add a drive letter directory to the original path. Example:
    
    

    Original path	Destination path with “Create drive letter directory” on	Destination path with “Create drive letter directory” off
    C:\Program Files\	F:\C\Program Files\	F:\Program Files\

    
    
  • Replace existing files – use this to overwrite existing files without asking for confirmation. If this option is not selected, existing files are skipped.
  • If a file cannot be replaced, switch the file on reboot – if a given file is used during restore and cannot be overwritten, the program will copy the file to the target location with a temporary “.fbr” file extension and add a relevant entry in the system registry:

    HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\
      Session Manager\PendingFileRenameOperations

    Based on this entry, the operating system will delete the locked file and replace it with an “.fbr” file on reboot. A list of files to be restored on reboot is saved in the Event Log.
    
    The selected items will be saved in a designated location, preserving the original directory tree layout, file modification date and file attribute.
    
    
  
  See also:
  Restoring operating system or entire disk partition from backup copy

• Computer name (server) - NetBIOS or DNS of the computer on which the FBS Server is running (see: Backup server).
• IP address - Internet Protocol (IP) address of the computer on which the FBS Server is running
• Launch – date and time of TCP server launch
• Status – current status of TCP server
• Active connections - number of workstations connected with the server. The number of connections in progress (when the server and a workstation are still negotiating a connection) can be displayed in brackets.
• Inactive connections - number of workstations defined in the Backup tab which have not established connections with the server.
• Maximum number of connections – the maximum number of remote computers that can connect to the server. Maximum number of connections depends on the purchased license (number of stations). In the evaluation version it is 2, which means that only 2 workstations can connect to the server. Exceeding the connection limit by installing the FBS Worker on more workstations than permitted in the license will shut down the TCP server.
• Download rate - displays the current rate at which data is being downloaded from workstations

Fig. 4.1 FBS Server - Network monitor.

• Name - NetBIOS or DNS of the workstation
• IP address - Internet Protocol (IP) address of the workstation
• FBS Worker version – version of the FBS Worker software installed on the workstation.

• Launch – launches the TCP server. The TCP server is launched and waits on port 4531 for incoming connections initiated automatically by the FBS Worker software installed on workstations. The Launch command is executed automatically when the FBS Server is run.
• Stop – this disconnects all workstations and shuts down the TCP server. This command is initiated automatically when the FBS Server software is stopped.

• Event type (icon) – specifies the event type. Three types are available: error, warning, notification
• Station – name of the workstation or server component (marked with “*”)
• Time – date and time of event
• Task – backup task name (or empty)
• Event – event description (message)
  
  
  
  
  Fig. 5.1 FBS Server - Event log.
  
  

• Track events – if you turn this on, the event list will be scrolled automatically to the last logged event. Turning it off will enable you to view the whole history of logged events. If you do not analyze the contents of the event log, it is recommended to switch this off to reduce server load.
• Show Details – use this to see detailed entries. By default, detailed information on backup and auxiliary operations progress is hidden (this is not applicable to errors and warning, which are always shown). When this option is activated, all entries are shown.
• Filter – use this to enable or disable entry filtering.
• Group – use this to group events by dates. For a large number of entries, grouping may take a while as all the information must be loaded to RAM. For the sake of performance, it is not recommended to leave this option on at a time of intensive server operation.
• Horizontal Scroll - a horizontal scroll bar enables you to scroll the content of the event log window to the left or right.
• Clear - clears the whole event history saved in the database. Events will be removed when the FBS Server is launched again. It is recommended to clear the event log regularly to increase system performance.
• Export – this saves an event log in a file. The available file formats: txt file, HTML, Excel, XM or SQL. This is useful when the software developer’s technical support wants to inspect the operation of the system.

• Main Backup Location – this field should specify the full path of the backup copy (ZIP files) location. If the specified directory does not exist, it will be created automatically on the first reference to that directory. If the path is invalid (it points to a missing drive or contains invalid characters), an error message will be shown and the server will be stopped. The directory will include FBF subdirectories for all workstations.
  The main backup storage location can be changed in the Workstation Settings window, setting a different path for each backup task (different hard disk or disk array).
  In order to ensure adequate performance, the backup storage directory should be located on a local hard disk or an internal disk array (RAID). Using network disks is not recommended. A network disk can be used as an additional storage location. For details see: Replicate..
  
  
  
  
  Fig. 7.1 FBS Server - Settings.
  
  
• Minimize to tray – after minimizing the main window the application icon will be placed in the system tray.
• Minimize on startup - after startup the application will be automatically minimized to the taskbar or system tray
• Do not allow shutdown if server is running – prevents accidental application shutdown
• Limit network load – you can set the maximum network load here. See also: Limit connection speed for a selected workstation
• Protect program access with a password – use this to protect access to the program console. It is a simple protective measure that prevents users who do not know the password from starting the program console. It does not protect against disabling FBS server, copying program database or backup archive deletion. A higher level security is only available in the operating system.
  Users who should not have access to the backup system or backup copy files should not be allowed to log on to the backup server from administrator account nor have access rights to the program directory or to the directory containing backup copies.
• Maximum number of Event Log entries – use this option to limit the amount of information stored in the Event Log and so reduce the FBS Server launch time.
• Administrative alerts... - opens the administrative alerts management dialog.
  
  
  
  
  Fig. 7.2 FBS Server - Settings - Administrative Alerts.
  
  Administrative alerts are notifications including reports or events which can be scheduled to be sent to designated email addresses or web servers (see: FTPUSE command)
  • Alert – alert name
  • Type – alert type
  • For – alert time and duration
  • Schedule – alert schedule
  • Send to – email address or target directory (located, for example, on a web server)
  • Add – creates new alert
  • Delete – deletes selected alert
  • Send now – use this to test current settings.
  
  
  
• Encryption passwords... - opens a dialog for the management of archive encryption and decryption passwords.
  
  
  
  
  Fig. 7.3 FBS Server - Settings - Password management.
  
  The window includes a list of passwords used during backup and restore operations. The first password from the top is used to encrypt (backup) and decrypt archives (restore). Other passwords are only used during restore operations.
  Note. Deleting a password used to encrypt an archive will make subsequent restoration of information from that archive impossible.
  
  See also: Workstation settings - File encryption method
  
  

Automatic updates

Fig. 7.4 Backup server and client automatic updates

• Update backup server online
  • Disable - deactivates backup server automatic updates
  • Notify me but don’t download updates - the program will, at a given time, check if a newer program version is available online. If a newer version is available, a warning will be recorded in the Log Event, stating that the installed version is not up to date.
  • Automatically download and install updates - the program will, at a given time, check if a newer program version is available online. If a newer version is available, the program will automatically download and install the update. The program update process can be postponed if the program is performing other tasks or the user is working on the computer.
• Update work stations from backup server
  • Disable - deactivates work stations automatic updates
  • Enable - enables automatic software updates for work stations. The update is executed while connecting the work station to the backup server. After backup server (FBS Server) software installation (manual or automatic), the current work station software version (FBS Worker) is also stored on the server. The server sends a software copy to a work station while establishing a connection. The work station installs the new software version. While executing the update, the work station disconnects itself from the backup server for about 1 minute. The program update process can be postponed if the program is performing other tasks (backup).
• Execute now - performs selected actions for the backup server and work stations.

Settings - Local commands

Local commands are intended to extend the FBS Server functionality. They allow the running of external programs, scripts or input files, perform operations on files, use ActiveX components, control Active Directory services etc.

Local commands are built based on Windows Script infrastructure. FBS Server, like Windows Script Host (WSH) or Internet Explorer, is a script host independent from the language. Local Command scripts have access to Microsoft ActiveX (COM) components, Application Programming Interfaces (API) for Windows Management Instrumentation (WMI) and ADSI as well as additional functions integrated in FBS Server.

The Local Commands code can be written in any script language installed in the operating system. By default, two Active Script engines are available in Windows: JScript and VBScript. To use other script languages, first install an engine for a given language in the operating system.

The integrated IDE environment
The code editor integrated in FBS Server supports script languages such as: JScript, VBScript, Perl, PHP, Python, Ruby, Object Pascal, Forth, Haskell, TCL. The editor can highlight syntax and has simple script testing (debugging) mechanisms.

Rys. 7.4 FBS Server - Local Commands

Integrated script editor functions:

• New – delete the current script
  • A new script with event template – delete the current script and load a template for a selected language with definitions of all the events available
• Open – load a script from file
• Save – save a script in a file
• Language – choose a script language. By default, only JScript and VBScript are installed in Windows
• Start Debugging – check the script syntax as a whole and run a procedure indicated in procedure launch edit field
• Stop – stop running the script
• Procedure launch edit field – used to provide the name of the procedure to be run (test run), along with all the parameters to be sent to the procedure. A syntax as per the script language chosen must be used in this field.

Events
Local Commands use an events mechanism. FBS Server generates events in a given program operating status and runs a procedure to handle this event as defined by the administrator in Local Commands. For example: “BeforeBackup” event is generated before backup and control is transferred to “BeforeBackup” procedure. If the procedure to handle an event has not been defined, FBS Server will not generate the event.

A procedure to handle an event is a code fragment (procedure or function) defined in the chosen script language. Sample procedures to handle “BeforeBackup” event:

function BeforeBackup(Comp, Task, File) {
  if (Comp == 'SERVER_BB')
    SScript.Echo('Task name:' + Task);
}

All the available events along with declarations of procedures to handle events and parameters are described below in detail.

• OnStart
  An event generated when starting the program
  
  • Declaration
    OnStart(AppType)
  • Parameters
    AppType - a number that specifies the program running mode. This parameter may have the following values.
    • 0 – system service
    • 1 – user application
  • Example
    Copy a directory using a FileSystemObject

    function OnStart(AppType) {
      var fso = new ActiveXObject("Scripting.FileSystemObject");
      fso.CopyFolder("c:\\wmpub", "d:\\");
    }
    

  
  
• OnStop
  
• An event generated when shutting the program
  • Declaration
    OnStop(AppType)
  • Parameters
    AppType - a number that specifies the program running mode. This parameter may have the following values.
    • 0 – system service
    • 1 – user application
  
  
• BeforeBackup
  An event generated before backup
  
  • Declaration
    BeforeBackup(Comp, Task, File)
  • Parameters
    Comp - a string of characters that specifies the computer name
    Task - a string of characters that specifies the backup task name
    File - a string of characters that specifies the path and target file name (ZIP archive)
    
  • Example
    Shutting down the system service and completing the process

    function BeforeBackup(Comp, Task, File) {
      SScript.Run('sc config srv_name start= disabled');
      SScript.Run('taskkill /im process_name /f');
    }
    

  
  
• AfterBackup
  An event generated after backup
  
  • Declaration
    AfterBackup(Comp, Task, File, Error)
  • Parameters
    Comp - a string of characters that specifies the computer name
    Task - a string of characters that specifies the backup task name
    File - a string of characters that specifies the path and target file name (ZIP archive)
    Error - a number that specifies the backup result. This parameter may have the following values.
    • 0 – backup successfully completed
    • different than 0 – backup error
  • Example
    Saving the list of files contained in a backup copy (ZIP archive) when using 7-Zip. 7-Zip is run from the command shell (CMD) to forward the standard output stream from the screen to the file.

    function AfterBackup(Comp, Task, File, Error) {
      if (Error == 0)
        SScript.Run('cmd /c 7z l "' + File +'" >"' + File + '.txt"');
    }
    

  
  
• BeforeReplication
  An event generated before replication
  
  • Declaration
    BeforeReplication(Comp, Task, RepType, DestPath)
  • Parameters
    
  • Comp – a string of characters that specifies the computer name. An empty string means a replication for all computers
    Task - a string of characters that specifies the backup task name. An empty string means a replication of all backup tasks for a given computer
    RepType - a number that specifies the replication type. This parameter may have the following values.
    • 1 – replication into a disc medium
    • 2 - replication into an optical medium
    • 3 - replication into a tape medium
    DestPath - a string of characters that specifies the access path to the target directory (1) or the device name (2,3)
  • Example
    Change a medium in a tape drive using RSM command

    function BeforeReplication(Comp, Task, RepType, DestPath) {
      if (RepType == 3) //MTD
        SScript.Run('RSM MOUNT ' +
          '/PF"MEDIA_NAME" /CF"CHANGER_NAME" /OREADWRITE');
    }
    

  
  
• AfterReplication
  An event generated after replication
  • Declaration
    AfterReplication(Comp, Task, RepType, DestPath)
  • Parameters
    Comp – a string of characters that specifies the computer name. An empty string means a replication for all computers
    Task - a string of characters that specifies the backup task name. An empty string means a replication of all backup tasks for a given computer
    RepType - a number that specifies the replication type. This parameter may have the following values.
    • 1 – replication into a disc medium
    • 2 - replication into an optical medium
    • 3 - replication into a tape medium
    DestPath - a string of characters that specifies the access path to the target directory (1) or the device name (2,3)
  • Example
    Eject medium from a tape medium using RSM command

    function AfterReplication(Comp, Task, RepType, DestPath) {
      if (RepType == 3) //MTD
        SScript.Run('RSM eject /pf"MEDIA_NAME" /astart');
    }
    

  
  
• OnReplicationError
  An event generated after an error has occurred during replication
  
  • Declaration
    OnReplicationError(Comp, Task, RepType, DestPath, Error)
  • Parameters
    Comp – a string of characters that specifies the computer name. An empty string means a replication for all computers
    Task - a string of characters that specifies the backup task name. An empty string means a replication of all backup tasks for a given computer
    RepType - a number that specifies the replication type. This parameter may have the following values.
    • 1 – replication into a disc medium
    • 2 - replication into an optical medium
    • 3 - replication into a tape medium
    DestPath - a string of characters that specifies the access path to the target directory (1) or the device name (2,3) This parameter can have values of system error codes. Example:
    • 11 - (ERROR_BAD_FORMAT) a medium has not been formatted
    • 1100 - (ERROR_END_OF_MEDIA) no space on the medium
    • 1112 - (ERROR_NO_MEDIA_IN_DRIVE) no medium in drive
    A full list of error codes for Windows is available on page: System Error Codes
  • Overview
    If an error has been handled, the true (1) value must be returned. In that case, the last replication will be retried. If the same error occurs when the operation is retried, replication will be interrupted (OnReplicationError event will not be generated again). If the false (0) value is returned, replication will be interrupted.
  • Example
    Format the tape if it has not been formatted or if it is full

    function OnReplicationError(Comp, Task, RepType, DestPath, Error) {
      if (Error == 11 | Error == 1100) {  //BAD FORMAT or END OF MEDIA
        SScript.TapeFormat(false, 'NEW_TAPE_NAME');
        return true;
      }
    }
    

FBS Server (or more precisely: a thread that generated the event) is suspended until the script operation is completed. Script running duration is limited by default to 3 minutes. When this limit is exceeded, the script is interrupted and FBS Server is resumed. (The running time limit can be redefined within the script using SScript's Timeout property)



SScript (server script) is an object integrated in FBS Server. It is a global object, created automatically, available from any location within the script. SScript is an equivalent of WScript integrated in Windows Script Host. It provides access to several useful methods and properties which are described in detail below.

• Echo
  The method saves a given text in the Event Log
  
  • Definition
    Echo(EventText)
  • Parameters
    EventText - a string of characters to specify an event text
  • Example
    Information is saved in the Event Log

      SScript.Echo('Text');
    

  
  
• Log
  The method saves a given text in the Event Log and marks the entry as information, warning or error
  
  • Definition
    Log(EventType, EventText)
  • Parameters
    EventType – a number to specify the event type. This parameter may have the following values.
    • 0 - information
    • 1 - warning
    • 2 - error
    EventText - a string of characters to specify an event text
  • Example
    Information is saved in the Event Log

      SScript.Log(1, 'Text');
    

  
  
• TapeFormat
  The method formats a tape medium in FBTF
  
  • Definition
    TapeFormat(Full, MediaLabel)
  • Parameters
    Full – a logical value to specify the formatting type. This parameter may have the following values.
    • 0 (false) – fast formatting
    • 1 (true) – full formatting
    MediaLabel – a string of characters to specify the media label
  • Example
    Fast tape formatting

      SScript.TapeFormat(false, 'NEW_TAPE_LABEL');
    

  
  
• Sleep
  It suspends script operation for a given time
  
  • Definition
    Sleep(intTime)
  • Parameters
    intTime – an Integer number to specify a period expressed in milliseconds during which a script is to be suspended.
  • Example
    Script operation suspended for two seconds

      SScript.Sleep(2000);
    

  
  
• Run
  It runs a given program
  
  • Definition
    Run(Command, WindowStyle, WaitOnReturn)
  • Parameters
    Command – a string of characters to specify the command line to be executed. It may contain a full access path or just the program name. The program name may be followed by additional characters, which will be sent to the program as parameters. If the path is not specified, the program must be located in a path stored in PATH environmental system variable. WindowStyle – an Integer number to specify the way in which to display the window of the program being run. This parameter may have the following values.
    • 0 (SW_HIDE) - hidden
    • 1 (SW_NORMAL) - default
    • 2 (SW_SHOWMINIMIZED) - minimized
    • 3 (SW_SHOWMAXIMIZED) - maximized
    WaitOnReturn – a logical value to specify script behavior after starting the program. This parameter may have the following values.
    • 0 (false) – starts the program and continues script operation
    • 1 (true) - starts the program and waits until its shutdown before it continues to run the script
  • Example
    A program is run in the maximized mode without waiting until an operation is finished

      SScript.Run('notepad.exe', 3, false);
    

  
  
• Timeout
  It specifies the maximum script completion time
  
  • Definition
    Timeout
  • Value of the properties
    It retrieves or sets the maximum script completion time expressed in milliseconds. The default is 180000 ms. If the limit is exceeded, an exception will be generated and script execution will be stopped.
  • Example
    Script completion time limit extended to 30 minutes

      SScript.Timeout = 30 * 60 * 1000;
    

  
  
• StdOut
  It returns the contents of a standard output stream
  • Definition
    StdOut
  • Value of the properties
    A string of characters containing data of a console program’s standard output stream
  • Example
    A file copied using copy command and a standard output stream entered in the Event Log

      SScript.Run('cmd /c copy c:\\Log.txt D:\\', 0, true);
      SScript.Echo(SScript.StdOut);
    

Additional automation objects
SScript is the only object integrated in FBS Server. However, any automation objects (OLE) can be used in Remote Commands. Access to other objects is made available in a manner specific to each script language. By example, for JScript language, you need to call ActiveXObject; for VBScript - CreateObject. Here follows a list of the most common used automation objects.

• FileSystemObject
  A group of objects for managing discs, directories and files
  • Automation server name: Scripting
  • Class name: FileSystemObject
  
  
• WshShell
  An object used to run programs, manage the system register, create shortcuts, etc.
  • Automation server name: WScript
  • Class name: Shell
  
  
• WshNetwork
  An object used to map network discs and printers, connect network resources and to read the computer name, domain name and user name
  • Automation server name: WScript
  • Class name: Network

Useful information:

• List of error codes
• JScript language details
• VBScript language details

See also: Remote Commands



Settings - Network Resources

In the Network Resources tab, define all UNC paths, mapped network disks and FTP server disks to be used by FBS Server as local hard disks. It is only necessary to add network resources when Main Backup Location, Target Replication Directory or administrative alert save path indicate a network location. To allow FBS Server to use network connections that are created directly in the operating system, such connections must also be added to the Network Resources list.

Fig. 7.5 FBS Server - Network resources.

• Connect – use this to connect the selected network resource
• Disconnect – use this to disconnect the selected network resource
• Add – use this to add a new network resource to the list and open a network resources setup dialog
  • Map a network disk – adding a resource available in LAN to the list. When connected, a resource is mapped to a local disk letter
  • Map FTP server disk – adding an FTP server resource to the list. When connected, a resource is mapped to a local disk letter
  • Add a network share – adding a network resource available through UNC path. To establish connection, use the username and password provided
• Modify – use this to open a network resources setup dialog
• Delete – use this to disconnect and remove from the list a selected network resource

Network resources are connected automatically when FBS Server is trying to access a given network resource – before backup, replication, before sending an administrative alert or by opening a dialog for selecting the destination directory. If a connection attempt is unsuccessful, the current operation that requires access to a given resource will be interrupted, and a relevant error will be entered in the Event Log. The minimum interval for reattempting to connect is 60 seconds. This limit is not used for manual connection (Connect button).

DRIVE MAPPING - A local system account on which the FBSWorker is installed by default does not have access privileges to network resources. Therefore it is necessary to switch the FBSWorker service to an account which has such privileges (e.g. an administrator account) or to set relevant privileges for the Local system account.

• going to the Services console (Control panel -> Administrative tools -> Services)
• running NET START, NET STOP commands using the FBSServer parameter
• running the FBSServer.exe using the /START or /STOP parameter

User manual for the Ferro Backup System™ - Worker

;FERRO Software Ferro Backup System - Worker
;Config file
;02-02-2007


[CONNECTION]
;Description: name or IP address of a computer running FBS Server
;Comments: empty string means the host name is assigned to a local host (127.0.0.1)
HOST=localhost



;Description: TCP port, used to connect to the server
;Range: 1 - -65535
;Default: 4531
;Comments: currently this must be set to 4531.
PORT=4531



;Description: interval between subsequent server reconnect attempts
;Unit: millsecond [ms], Range: 0 (no delay) - 16777216
;Default: 4000
RECONNECTINTERVAL=4000

• CONNECTION - HOST
  This is where the name/IP address of the backup server is stored (of the computer on which the FBS Server is launched), as entered by the user during program installation. If during the use of the System the FBS Server is moved to another computer or if that computer’s name or IP address changes, the user can change the server location in this field to the correct one. Changing this field manually will have the same effect as launching the installer and reentering the name/IP address during the installation of the FBS Worker.
  
  
• CONNECTION - PORT
  Number of the TCP port used to connect to the server.
  
  
• CONNECTION - VIRTUALNAME
  Alternative name of the computer under which it will be available on the backup server. FBSServer uses names (rather than IP addresses) to identify workstations. If the local network is divided into two or more subnetworks with duplicate workstation names, only one workstation will be connected to the backup server; no subsequent workstations of the same name will be available in the FBS Server control console. In order to resolve this issue change the default name on computers with duplicate names: VIRTUALNAME=NEW_NAME
  
  Information. The computer name should not be longer than 15 characters.

• going to the Services console (Control panel -> Administrative tools -> Services)
• running NET START, NET STOP commands using the FBSWorker parameter
• running the FBSWorker.exe using the /START or /STOP parameter

• check if the FBS Worker is running in the Windows task manager (the FBSWorker.exe process)
• check that the HOST entry is correct in the FBSWorker.ini file
• check (for example using the PING command) that the computer on which the FBS Server is installed is available
• check that the TCP 4531 port is not blocked by any firewall software.