How to Create Backup Plug-In

Note: XML-based plug-ins are temporarily unavailable in the latest version, Handy Backup 7.9.5 (released on 26 October, 2017). We are planning to add this feature in several weeks - and if you need it right now, we recommend that you use version 6.9.7 instead.

Download version 6.9.7


Handy Backup provides advanced users with a great opportunity to create backup add-ons:

  1. Write an XML-based add-on for Handy Backup (see instructions below)
  2. Send it to support@handybackup.net
  3. Get a free copy of Handy Backup in return!

About Handy Backup Add-ons

Each Handy Backup add-on is a well-formed XML document containing a list of data and methods required for application backup for PC.

  • XML file must comply with the XML 1.0 specification: http://www.w3.org/TR/xml
  • The structure must include two essential parts: Prolog and the root element. The root element looks like <root></root> and must contain a Description and a list of Backup elements.

We welcome you to create add-ons of your own. If you send us your plug-in, you will be given a free Handy Backup copy and your add-on will be available for download on Handy Backup websites. This allows you to make the data backup process of often used applications easier.


Creating Handy Backup Add-ons

You can find detailed instructions on creating add-ons below.

Prolog

Prolog is a mandatory part of XML document that contains general information about the document. In our case it can be the next line: <?xml version="1.0" encoding="utf-8"?>.

Description element

This element contains information about this specific plug-in. All information is written as text data in its child elements. The following child elements are available:

Example #1

Backup element

This element contains the information about the data, which this plug-in backups. There may be several elements. It is obligatory to indicate the attribute id, which identifies the element unambiguously, even if there is only 1 Backup element.

Available child elements:

  • Path - It contains the information for determining full path to the folder, where the application which we backup is installed. This path may be used with the help of the expression "$PATH$" within the limits of the element. There may be several Path elements; the real application path is determined by the first correct element. Available child elements within the Path element include:
  • File - Contains the path to the file, which must be backed up.
  • Folder - Contains the path to the folder, which must be backed up. All the subdirectories of the stated directory are always backed up.
  • Registry - Contains the path to the registry key, which must be backed up. The subkeys of the stated key are always backed up.

For indicating paths to folders use standard Windows Environmental Variables.

The list of some of them you can see here.

An example of ACDSee data backup plug-in

To check the work of created plug-in, it is necessary to add it to the folder ProgramFiles/Novosoft/HandyBackup/Xmlplugins, create and perform a new task.

Search algorithms

3 algorithms of the path search on the given parameters in the element “Path” are realized. The type of an algorithm is given by the element “Type”. The possible values 1,2,3:

  1. There is a key search in the path of the Registry "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\<KeyPath>". If the key is found, we look for the variable <KeyValue> in this key. If there is the variable, we read it. There must be the path to the folder where the program is located. We look for the file <FileName> on this path. If this file exists, it means this is the needed path. Hence, the search is unzipped.
  2. There is a search of the key, containing the information about the file extension associated with the program, in the path of the Registry "HKEY_CLASSES_ROOT\<KeyPath>". If the key is found, we look for the variable <KeyValue> in this key. If there is the variable, we read it. There must be the path to the folder, where it is the program, in the following format: <the path to the folder>, <identifier>. We look for file <FileName> on this path. If this file exists, it means that this is the needed path. Hence, the search is unzipped.
  3. There is a key search in the path of the Registry "<KeyPath>". If the key is found, we look for the variable <KeyValue> in this key. If there is the variable, we read it. There must be the path to the folder, where it is the program. We look for the file <FileName> on this path. If this file exists, it means this is the needed path. Hence, the search is unzipped. If the value <IncludeSub>=TRUE, then, if the search fails, there is the search of values of all keys included in <KeyPath>.

Windows Environmental Variables

Variables for the description of path to system folders Windows:

Send your plug-in to registered@handybackup.net. We will advertise it on our web site and send you a FREE Handy Backup registration number!

Contact Us

support@handybackup.net

sales@handybackup.net

What to Back Up

My Documents Backup - one click backup of the My documents folder including pics, videos, music, text files

Website Backup - most reliable solution to protect your business web representation

Disk Image Backup - back up your hard drive by creating a hard drive image and saving it to the storage medium

MySQL Backup - simple, comprehensive backup of the MySQL database tables

Where to Back Up

Backup USB - back up your data to any USB connected device such as USB flash key

Backup to FTP - transfer your backups to remote FTP server for more data security

How to Back Up

Synchronizing files and folders - one click synchronization of files and folders across multiple locations including remote FTP servers

Who uses our backup software?