<h4>The Clients Interface</h4>
<font size=+1>
-<p>The Clients interface will show a list of clients and allow the
-user to right click on a client item to popup a context sensitive menu. The list of
-clients is a tree structure and will show a number of attributes from the database
-for each client.
+<p>The Clients interface shows a list of configured client resources. This
+list of clients is a tree structure and shows a number of attributes from the
+database for each client.
-<p>The context sensitive menu will allow the user to perform commands in the
-console that may be run with the desired client having been identified. These
+<p>The user may right click on a client item to display a context sensitive menu
+of what actions can be performed on a client. This menu has
+options to allow the user to perform commands in the console. These
commands include requesting the status of the client, and pruning or purging
-jobs and files from the catalog.
+jobs and files from the catalog. There is also an option to open up a JobList
+interface with the control for clients already prepopulated with the selected
+client item.
<p>To understand pruning and purging, please read the Bacula documentation at
the following URL: http://www.bacula.org/rel-manual/Bacula_Console.html
<h4>The Filesets Interface</h4>
<font size=+1>
-<p>The Filesets interface will show a list of filesets and allow the
+<p>The Filesets interface shows a list of filesets and allow the
user to right click on a specific fileset to popup it's context sensitive menu.
-This interface is a tree structure and each item will display a number of
+This interface is a tree structure and each item displays a number of
attributes from the database for each fileset.
-<p>The context sensitive menu will allow the user to perform the command status
+<p>The context sensitive menu allows the user to perform the command status
fileset in the console. The user can also open up a new JobList window with the
Fileset dropdown pre-populated with the selected fileset.
<p>The bat is bconsole with extra communication capabilities and a set of
graphical user interfaces that utilize those capabilities. A bat programmer is
able to create interfaces that interact with the director in all ways that a user
-can, by executing commands. When a command is entered by an interface, bat
-will type in the command in the console. Often times the interface visible will
-change to the console so that the user can read the command as well as the
+can, by executing commands. When a command is entered by an interface, the bat
+types in the command in the console. Often times the interface visible is
+changed to the console so that the user can read the command as well as the
resulting output from the director. Bat can also perform requests of the
daemon, that the user would not normally do. These requests would include the ability to
-retrieve lists of various resources and to perform instruct the director
-to query director daemon's sql server. The director will then forward the
-query results to bat.
+retrieve lists of various resources and to instruct the director
+to query the sql server. The director then forwards the query results to bat.
</BODY>
</HTML>
<h4>The JobList Interface</h4>
<font size=+1>
-<p>The JobList interface will display a table of job id's which are instances of
-a job being run. The table will display data for each job stored in the
+<p>The JobList interface displays a table of jobid's which are instances of
+a job having been run. The table displays data for each job stored in the
daemons sql backend. The table currently includes the job name, the client name,
the job type, the job level, the number of files, the number of bytes, the status,
and a flag for the jobs files that have been purged or not, and the jobs
settings of the controls in the JobList interface.
<p>There are many options in the context sensitive popup that appear when the user
-right clicks on the job table.
+right clicks on an item in the job table.
<p>Listing console commands can be run to list the jobid, list the files on that jobid,
list the jobmedia for that jobid, and list the volumes used for that jobid. There is
<p>An interface to view the logs that have been stored in the database for the jobid
can be viewed by using the show log for job option.
If the database does not have a log, an popup explaining the modification that
-should be made to the bacula-dir.conf file appears. The change is to add
-catalog = all to the messages stanza of the messages resource that this job uses.
+may be made to the bacula-dir.conf file appears. The change is to add
+"catalog = all" to the messages stanza of the messages resource that this job uses.
<p>Restore from job opens up the Select Jobs interface. It opens prepopulated
with the correct data to open up a standard restore interface displaying the
filestructure backed up when the job ran. It displays only the files from this job
if you don't change the controls in the "Select jobs interface"
-<p>Restore from time populateis the Select Jobs interface with the endtime of the job
+<p>Restore from time populates the Select Jobs interface with the endtime of the job
populated in the Before Time entry box. This causes the daemon to use the Before
Time to select the appropriate job id's for the restore. This contains the most recent
full backup, the most recent differential backup done since the most recent full, and
<h4>The JobPlot Interface</h4>
<font size=+1>
-<p>The JobPlot interface will have all of the same selection widgets as the
-JobList interface. It will also have widgets that will affect the plot's
-display. These settings will be saved and used the next time the interface
+<p>The JobPlot interface has all of the same selection controls as the
+JobList interface. It also has controls that affects the plot's
+display. These settings are saved and used the next time the interface
is opened. The user can change the Graph type to one of sticks, lines, steps
or none. The user can also turn one or both of the plots off with the File
Data and the Byte Data check boxes. The symbol type for each plot's points
<h4>The Jobs Interface</h4>
<font size=+1>
-<p>The Jobs interface shows a table of job resources. The data displayed
+<p>The Jobs interface shows a tree of configured job resources. The data displayed
for each job in this list are the defaults for the job resource as defined in
the bacula-dir configuration file. When a job is run due to being scheduled,
-these defaults are the values that will be used. They are also the values
+these defaults are the values that are used. They are also the values
that are populated by default if the job is run manually.
<p>The context sensitive popup menu includes a number of options. There are
<p>The open joblist option is to open a new JobList interface and pre-populate
the job dropdown list with the jobs resource name.
-<p>The run job option is to open the run job interface prepopulating the job
-dropdown box with the selected job.
+<p>The run job option is to open the Run a Job interface prepopulating the job
+dropdown box with the selected job. With the job name in the job dropdown box
+of the Run a Job interface, the remainder of the controls are populated with
+the jobs defaults.
</BODY>
</HTML>
shows data that are the values in the database for each volume. With this
interface, the user can manage tape volumes and file volumes.
-<p>The context sensitive menu allows the user to open up other interfaces
-and to perform commands in the console that may be run with the desired media
-having been identified. These commands include deleting the volume, purging
-the jobs and files backed up on the volume from the catalog, and pruning the
-jobs and files on the catalog that meet the selection criterion configured in
+<p>When the user right clicks on a volume item, a context sensitve menu appears
+that shows the actions that can be performed on this volume. This menu allows
+the user to open up other interfaces and to perform commands in the console.
+There are command options that modify the catalog. These commands include
+deleting the volume, purging the jobs/files which have been written to the volume, and pruning the
+jobs/files that meet the pruning criterion configured in
bacula-dir.conf. There is also a command to reset the parameters on the volumes
based on the parameters of the pool resource.
-<p>Other interfaces can be opened up from the context sensitive menu. The user
-may open up a JobList interface. This interface is opened with the media
-drop down control preselected This shows jobs that have been written to the
-volume. The user can open up the Relabel a Volume dialog box. The user can also open
+<p>Other interfaces can be opened up from the context sensitive menu.
+The user can open up the Relabel a Volume dialog box. The user can also open
up the Edit a Volume interface which allows the user to modify all user
-editable data items for the volume.
+editable data items for the volume. Another interface that may be opened is
+the JobList. When created the media drop down control is preselected to the
+volume. It lists jobs which have been written to the volume.
</BODY>
</HTML>
<h2>The Two Restore Interfaces</h2>
-<p>Both restore interfaces accomplish the same 3 steps in different ways.
-Those steps are to select jobs to restore from, give the user the
-opportunity to select files and directories, then indicate details of
-the host and path to restore to and run the job.
+<p>Both interfaces accomplish the same three steps.
+The steps are to select jobs to restore from, give the user the
+opportunity to select files/directories, then indicate details such as
+the host and path to restore to and trigger the job to run.
<h2>The Standard Restore Interface</h2>
<p>Start the standard restore procedure by pressing the restore button
in the task bar. There are also two options in the joblist context sensitive
-menu to start a restore. They are restore from time or restore from job.
+menu to start a restore. They are Restore From Time or Restore From Job.
-<p>This interface is intended as a high performance restore option.
+<p>This restore method is intended as a high performance option.
It is a server side process. These interfaces assist the user in utilizing the
text based restore capabilities of the standard console. It interprets the text
to display the information in a way that simplifies the restore procedure.
<p>The Opening interface allows the user to choose selection criterion to
inform the server how to determine the set of backup job ids to use in the
-restore. This best possible set is be the most recent full backup, the most
+restore. This best possible set is he most recent full backup, the most
recent differential backup done since the most recent full, and all the
incremental backups done since the most recent full or differential. Then the
server uses this set of jobs to create a file structure that is the
the server by any other interface.
<p>The second interface allows the user to browse this file structure and
-choose the files and directories to restore. This is be done in an explorer
+choose the files and directories to restore. This is done in an explorer
type interface with a directory tree on the left. In the right pane of a
-splitter is be a table showing a list of files and directories that are the
+splitter is a table showing a list of files and directories that are the
contents of the directory selected in the left pane. The user can mark and
unmark either with the buttons on the top or by double clicking on the check
mark icon to toggle whether an item is selected or not. Double clicking an
process. The user can have an unlimited number of selection windows open at a
time for viewing the cataloged jobs, directories, files and versions.
-<p>This restore interface is <b>NOT</b> intended to preform major restores of directory
+<p>This restore interface is <b>NOT</b> intended to perform major restores of directory
structures with large numbers of directories and files. It should work, however
it is a chatty interface. This is due to the number of sql queries made of the server
which is proportional to the number of files and directories selected plus the number of
are available in the catalog to restore.
<p>The interface contains a horizontal splitter. The bottom pane contains
-some controlling widgets for the interface.
-The top pane contains a vertical splitter with 4 widgets for viewing the
-cataloged information. The left widget is for viewing and further sub selecting
+some controls for the interface.
+The top portion contains a vertical splitter with 4 panes for viewing the
+cataloged information. The left pane is for viewing and further sub selecting
of jobs. The second pane is for viewing the directory tree. The third is for
viewing a list of files in a directory that has been selected. Then
-lastly the fourth widget is for viewing a table of versions of a single file
-that has been selected from the file widget.
+lastly the fourth pane is for viewing a table of versions of a single file
+that has been selected from the file table.
<p>The version browser accomplishes the three restore steps differently.
<h4>The Storage Interface</h4>
<font size=+1>
-<p>The Storage interface shows a list of storage resoruces and allows the
-user to right click on a storage to popup a context sensitive menu. The list of
-configured storage device resources is a tree structure and shows the storage id
-and the auto changer flag.
+<p>The Storage interface shows a list of configured storage device resources.
+The list is a tree structure and shows the storage id and the auto changer flag.
-<p>The context sensitive menu allows the user to perform commands in the
-console that may be run with the desired storage having been identified. These
-commands include requesting the status of the storage, and to mount, unmount and
-release the media in the storage device.
+<p>The interface allows the user to right click on an item to popup a context
+sensitive menu of the actions that can be performed with that storage device.
+The actions allow performing commands in the console. The commands include
+requesting the status of the storage, and to mount, unmount or release the media
+in the storage device.
<p>If the autochanger flag is true, two additional options in the context
sensitive menu are found. These are options to run the command to update slots
projects / bacula / bacula / commitdiff