Backup Agent provides an alternative method for implementing the Continuous Operations function provided with Zen.

This documentation provides a guide for getting started with and using Backup Agent. It provides information for users who install and run Backup Agent. This manual is also useful for programmers and system administrators responsible for performing live backups of Zen databases.

Topics include installation requirements and instructions, usage, and reference material for incorporating the Backup Agent into your application. Answers to common questions following an installation are also included.

In this section you will find the following topics:

Backup Agent provides a quick and simple method for you to set and manage Continuous Operations on your Zen database files. Setting and managing Continuous Operations is a critical piece when backing up your Zen databases. Backup Agent automatically handles setting and managing Continuous Operations on your open files so that your data is still available from your application during your backup. Once the backup procedure is complete, stopping Backup Agent automatically takes the files out of Continuous Operations and rolls in all the changes captured during the backup.

Backup Agent works seamlessly with many of the most popular backup applications on the market today.

Backup Agent automatically manages files that are opened during a backup for you, unlike the Continuous Operations feature in the Zen utilities, which requires that you to enter a list of specific file names.

Lastly, once you have installed Backup Agent with Zen and implemented the agent to work with your specific backup routine, you are ready to start backing up your Zen databases. There are no special configuration settings required.

Backup Agent is an optional product included with the current versions of Zen Enterprise Server and Cloud Server.

By default, Backup Agent is not installed. You must install it from the media after you install the database engine. Select Backup Agent in the installation selection dialog.

No separate key for Backup Agent is required if the product is installed on the same machine as Zen Enterprise Server or Cloud Server. You are not prompted for a key if the system is running either of these Zen products.

If you are using Backup Agent as a separate product, note that it supports installation on only one machine. You may install an evaluation version of Backup Agent without a key. At the end of the evaluation period, Backup Agent returns an error message when it attempts to start.

If you initially installed an evaluation version, you may later apply a permanent key using License Administrator. For more information on using the License Administrator, see Zen User’s Guide. On Windows or in a Workgroup engine installation, you may also administer keys through the command line utility clilcadm. For details about clilcadm, see Zen User’s Guide.

This topic discusses the components that make up Backup Agent. The two utility components along with the Software Developer Kit (SDK) give you three ways to easily incorporate the agent into your backup routine, depending on your business needs.

The command line interface (CLI) utility (pvbackup.exe) is one access method Backup Agent offers. For implementation with any of the popular backup products on the market, simply add the executable commands in pre- and postcommand settings. With this implementation, your backup software automatically starts the agent before backing up and stops it after the backup finishes. Using this method ensures that your regularly scheduled backups include consistent and reliable Zen data.

Another access method for Backup Agent is the graphical user interface utility pvbackupgui.exe, which is available from the Start menu or Start screen or from within Zen Control Center. In this interface you can start and stop the agent at the touch of a button – without having to recall commands or parameters required for the command line interface. Using this method allows you the flexibility to perform backups as needed of your Zen data quickly and almost effortlessly.

The GUI utility is available only on Windows platforms.

The Controller component of Backup Agent consists of a DLL that provides a common interface for the agent utilities. The Controller handles all communications with the Event Handler.

The Durable File List (dfl.txt) is located in the program’s data path and is generated by Backup Agent. The default data path is set at installation as <Zen Application Data directory>\PBA\Data. This file contains a list of all the files in Continuous Operations at any given time. When a file goes into Continuous Operations, it is automatically added to the list. Similarly, when a file is taken out of Continuous Operations, it is then removed from the list.

The Exclude File List (efl.txt) is located in <Zen Application Data directory>\PBA\Data. You can exclude files from being placed into Continuous Operations by Backup Agent by listing them in the exclude file list.

The Event Handler is the workhorse inside Backup Agent. The primary purpose of this component is to intercept files as they are opened so that they can be placed in Continuous Operations. Backup Agent works in conjunction with the database engine and the Controller to handle all the operations, or events, requested through the Backup Agent interfaces. As the name implies, the Event Handler handles all the events going on inside Backup Agent.

The Include File List (ifl.txt) is located in <Zen Application Data directory>\PBA\Data. You can include files to be placed into Continuous Operations by Backup Agent by listing them in the include file list.

Files in this list will be placed into Continuous Operations as soon as Backup Agent is turned on, whether or not the files are currently opened by the Zen engine.

Backup Agent maintains a file called baevent.log that reports informational and warning messages from the event handler. On Windows platforms, this file is located in <Zen Application Data directory>\PBA\Logs. On Linux and macOS, it is in /usr/local/actianzen/pba/logs. The locations are set at installation and are not configurable.

The maximum size for the log file is preset to 50 MB and cannot be changed. When this limit is reached, the file is automatically renamed for archival purposes, using a naming convention of baevent.1, baevent.2, and so on. Backup Agent maintains a maximum of five archived log files.

Under Windows, Backup Agent includes an application programming interface (API) so that developers can embed Backup Agent directly into a software application. The API, along with the necessary header and library files, compose the SDK. Integrating Backup Agent directly into your application using the SDK provides the highest level of backup data assurance.

We recommend that you view the readme file readme_ba.htm before installing Backup Agent. This file contains important information that may not have been included in the product documentation but may be essential to your installation and use of the product.

The readme file is located at the root on the installation CD.

You may also refer to the readme file after installation. On Windows platforms, you can access the file from the installation location. On Linux and macOS platforms, the file is located in the /usr/local/actianzen/pba/doc/ directory.

Finally, the latest copy of the release notes is posted at the Actian website.

The following things are required to use Backup Agent: