DataBackup.report

Package: WA2L/SimpleBackup 1.0.67
Section: File Formats (4)
Updated: 08 February 2021
Index Return to Main Contents

 

NAME

DataBackup.report - report file customization for DataBackup

 

SYNOPSIS

WA2LSimpleBackup/lib/DataBackup.report.html

WA2LSimpleBackup/lib/DataBackup.report.LANG.html

WA2LSimpleBackup/lib/DataBackup.report.css

WA2LSimpleBackup/lib/DataBackup.report.js

 

AVAILABILITY

WA2L/SimpleBackup

 

DESCRIPTION

The HTML- and CSS-files are used to define the look of the DataBackup report. The JS-file is used to implement dynamic functionality into the report.

The style- and JavaScript files are included directly into the generated DataBackup.BACKUPNAME.html report to ensure that the style definition and dynamic functionality takes effect independent of the report file location.

With the REPORTHTML and REPORTCSS setting in the DataBackup.cfg or DataBackup.BACKUPNAME.cfg config file it is possible to define a report look different from the default as defined in the lib/DataBackup.report.html and lib/DataBackup.report.css files.

With the REPORTJS setting in the DataBackup.cfg or DataBackup.BACKUPNAME.cfg config file it is possible to define a report functionality different from the default as defined in the lib/DataBackup.report.js file.

 

FILEFORMAT

The HTML file format complies to the definitions of HTML files with some additional formatting rules explained below.

The style file format complies to the definitions of the cascading style sheets (CSS) but has to match to the HTML file.

The JavaScript file format complies to the definitions of JavaScript programs (js) but has to match to the HTML file.

 

OPTIONS

Below the definitions special to the DataBackup report are explained.

 

REPORT STRUCTURE

This is the slightly simplified general structure of the HTML report template file.

The table columns of all backups with the name BACKUPNAME are inserted into the file between the html tags <tbody> and </tbody> in the order: Date, GBytes, Files, MBytes, GBytes Graph, Free GBytes, Logfile, Log Essentials. If you want to hide some of the columns, do this using the { display: none; } CSS directive.

The logfile contents of var/log/DataBackup.TIMESTAMP.BACKUPNAME.log is inserted between the <pre class="logfile"> and </pre class="logfile"> html tags.

The logfile essentials report contents of var/rpt/DataBackup.TIMESTAMP.BACKUPNAME.LogEssentials.txt is inserted between the <pre class="essentials"> and </pre class="essentials"> html tags.

The DataBackup configuration file etc/DataBackup.cfg contents is inserted between the <pre class="config_prg"> and </pre class="config_prg"> html tags.

The backup configuration file etc/DataBackup.BACKUPNAME.cfg configuration file contents is inserted between the <pre class="config_bkp"> and </pre class="config_bkp"> html tags.

<html>
  <head>
    <style>
    </style>
    <script>
    </script>
  </head>
  <body>
    <ul>
      <li>
        <table>
          <thead>
            <tr>
              <th>Date</th>
              <th>GBytes</th>
              <th>Files</th>
              <th>MBytes</th>
              <th>GBytes Graph</th>
              <th>Free GBytes</th>
              <th>Logfile</th>
              <th>Log Essentials</th>
            </tr>
          </thead>
          <tbody>
          </tbody>
          <tfoot>
            <tr>
              <td></td>
              <td></td>
              <td></td>
              <td></td>
              <td></td>
              <td></td>
              <td></td>
              <td></td>
            </tr>
          </tfoot>
        </table>
      </li>
      <li>
        <pre class="logfile">
        </pre class="logfile">
      </li>
      <li>
        <pre class="essentials">
        </pre class="essentials">
      </li>
      <li>
        <pre class="config_prg">
        </pre class="config_prg">
      </li>
      <li>
        <pre class="config_bkp">
        </pre class="config_bkp">
      <li>
    </ul>
  </body>
</html>

 

TAGS WITH SPECIAL TREATMENT

<style> ... </style>
the CSS file is inserted between this two tags.

<script> ... </script>
the JS (JavaScript) file is inserted between this two tags.

<tbody> ... </tbody>
the table body of all backup runs is inserted between this two tags.

<pre class="logfile"> ... </pre class="logfile">
the backup log file is inserted between this two tags.

<pre class="essentials"> ... </pre class="essentials">
the logfile essentials report file is inserted between this two tags.

<pre class="config_prg"> ... </pre class="config_prg">
the current DataBackup.cfg configuration file is inserted between this two tags.

<pre class="config_bkp"> ... </pre class="config_bkp">
the current DataBackup.BACKUPNAME.cfg file is inserted between this two tags.

 

VARIABLES

@BACKUPCONFIGFILE@
configuration file path and file name representing the backup with the name BACKUPNAME.

@BACKUPMODE@
backup mode.

@BACKUPNAME@
name of the backup.

@CHARSET@
characterset of the HTML file.

@DATE@
date of the backup run.

@TODAYMIL@
date in military format of today.

@NOW@
reverse date and time of today.

@DESCRIPTION@
description text of the backup.

@DESTINATION_BASEDIR@
destination base directory.

@DESTINATION_DRIVE@
destination drive letter.

@DESTINATION_DRIVENAME@
destination drive name.

@GBYTESMAX@
maximal destination GBytes of all backup runs.

@GBYTESMIN@
minimal destination GBytes of all backup runs.

@HOSTNAME@
computer name of the system where the backup is started.

@PROGNAME@
program name.

@TARGET_DRIVE@
target drive letter.

@TIME@
time of the backup run.

@TOTALBACKUPRUNS@
total number of backup runs.

@USER@
user name that started the backup.

@VERSION@
version number of the DataBackup command.

@YEAR@
year of the backup run.

 

FILES

The .nt files (lib/DataBackup.report.[language.]nt.html) are the non-tabbed (old) variants of the report. If the .nt files are used, it is needed to set the REPORTCSS setting to the lib/DataBackup.report.nt.css file.

lib/DataBackup.report.html
Default report definition for the DataBackup report.

Do not change this file if you like to change the report look, create an own .html file and set the REPORTHTML setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.de.[nt.]html
Report definition for the DataBackup report in German.

Do not change this file if you like to change the report look, create an own .html file and set the REPORTHTML setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.en.[nt.]html
Report definition for the DataBackup report in English.

Do not change this file if you like to change the report look, create an own .html file and set the REPORTHTML setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.es.[nt.]html
Report definition for the DataBackup report in Spanish.

Do not change this file if you like to change the report look, create an own .html file and set the REPORTHTML setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.ru.[nt.]html
Report definition for the DataBackup report in Russian.

Do not change this file if you like to change the report look, create an own .html file and set the REPORTHTML setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.[nt.]css
Default style definition for the DataBackup report.

Do not change this file if you like to change the report look, create an own .css file and set the REPORTCSS setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

lib/DataBackup.report.js
Default JavaScript declarations for the DataBackup report.

Do not change this file if you like to change the report functions, create an own .js file and set the REPORTJS setting in the related configuration file, otherwise your changes will be lost after an upgrade of WA2L/SimpleBackup.

etc/DataBackup.cfg
DataBackup configuration file.

etc/DataBackup.<BACKUPNAME>.cfg
backup definition file for the backup with the related name.

var/log/DataBackup.<TIMESTAMP>.<BACKUPNAME>.log
log file for backup with the name BACKUPNAME.

var/rpt/DataBackup.<TIMESTAMP>.<BACKUPNAME>.LogEssentials.txt
log essentials report for backup with the name BACKUPNAME.

var/report/DataBackup.<BACKUPNAME>.html
generated backup report for the backup with the related name.

 

EXAMPLES

-

 

SEE ALSO

simplebackupintro(1), databackup(1), databackup.cfg(4), databackup.config(4)

 

NOTES

-

 

BUGS

-

 

AUTHOR

databackup.report was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2021 Christian Walther

This is free software; see WA2LSimpleBackup/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
FILEFORMAT
OPTIONS
REPORT STRUCTURE
TAGS WITH SPECIAL TREATMENT
VARIABLES
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:29:45 GMT, September 14, 2024