Adding a New Report

 Content Previous Next

This section explains how to create a new report with the Report Manager (requires the Reporting extension installed). Press the 'Add report' button to launch the Report Manager.

 

▪Step 1: Report Structure

In this step report columns, their headings and order may be configured.

 

▪Selecting columns: check a tickbox opposite an appropriate column type for this column to be included into the report. Unchecked columns will not be displayed in the report. At least one column must be included in the report, otherwise it will be impossible to proceed to next step.

 

▪Column headers: if left blank, column headers in the report will be identical to appropriate column types. In the 'Column Header' field custom column headers may be specified. The header does not affect the content of the column. For example, changing kbytes to bytes will not cause information to be displayed in bytes.

 

'GROUP': a name of group the task belongs to. Group name may be configured in the Task Properties.

 

'TIMESTAMP': a time and date of an event recorded by AnyFileBackup.

 

'TASK': a task name that may be configured in the Task Scenario.

 

'TEXT': a message that is recorded into AnyFileBackup Event List.

 

'STATUS': a description of an event--an error or not.

 

▪Up/Down arrows: by moving columns up or down you specify its position in the report. The top position means that this column will be the first to the left in the report; the bottom position, respectively, means that it will the the last to the right.
▪Step 2: Conditions

In this step conditions for including or excluding events may be specified. In other words, it is possible to filter in/out AnyFileBackup events. This step may be skipped if all events are to be included in the report.

 

▪'Connector': a logical operator that defines whether conditions are treated separately or cumulatively. First condition does not have a connector.

 

'OR' means that if either of two conditions are satisfied, an event will be included into the report.

 

'AND' means that both conditions must be satisfied for an event to be included into the report. This connector creates a group of conditions (1 AND 2 AND 3) that is treated as a single condition (see the below example for details).

 

Example:

 

STATUS IS ERROR

 

OR GROUP IS NOT Samples

 

AND TASK IS Folder Back up

 

OR TEXT IS Failure

 

This means that there are three conditions:

 

Condition 1: STATUS IS ERROR

 

Condition 2: GROUP IS NOT Samples AND TASK IS Folder Back up (that is because 'AND' creates a single condition consisting of two parts)

 

Condition 3: TEXT IS Failure

 

▪'Field': a property that is checked by AnyFileBackup. The following properties are supported:

 

'GROUP': a name of group the task belongs to. Group name may be configured in the Task Properties;

 

'TASK': a task name that may be configured in the Task Scenario;

 

'TEXT': a message that is recorded into AnyFileBackup Event List;

 

'STATUS': a description of an event--an error or not, or both.

 

▪'Operator': an expression that defines the relation between the 'Field' and its 'Value'. The following operators are available:

 

'IS': an expression meaning that for an event to be included into the report, it must have its value in respective 'Field' be fully equal to a value defined in the 'Value';

 

'IS NOT': an expression meaning that for an event to be included into the report, it must not have its value in respective 'Field' be equal (either partly or fully) to a value defined in the 'Value';

 

'CONTAINS': an expression meaning that for an event to be included into the report, it must have its value in respective 'Field' be equal (either partly or fully) to a value defined in the 'Value'.

 

▪'Delete' button: deletes the current condition. To delete a condition in the middle of the list, all subsequent (located below it in the list) must be deleted.

 

▪'Add' button: adds a condition to the bottom of the list.

Step 3: Reports Date, Header, and Style

In this step general report settings may be configured.

 

▪'Report name': a name that is displayed in the report list of the Reports window.

 

▪'Report title': a title that is displayed at the top of the report.

 

▪'Report start date' and 'Report end date': these dates define the period which will be covered by the report. If left blank, they are defined as ${YESTERDAY} and ${TODAY} meaning that the report will cover up to 48 hours of AnyFileBackup activity from the date when the report is generated.

 

There are two ways to define report start and end dates: with a macro and by defining an exact date (or a combination of them). The below table summarizes all available options:

 

 

Start Date

End Date

Macro

${YESTERDAY}

${TODAY-[DAYS]}

${TODAY}

${YESTERDAY}

${TODAY-[DAYS]}

${TODAY}

Exact Date

Any calendar date

Any calendar date

 

Notes:

 

▪End date must always be greater or equal to the Start date, otherwise an empty report will be generated.

 

▪If the 'Start date' field is left blank, the ${YESTERDAY} macro will be inserted there.

 

▪If the 'End date' field is left blank, the ${TODAY} macro will be inserted there.

 

▪Macro: where the macro is ${TODAY-[DAYS]}, the [DAYS] is the number of days back from from the current date. For example, if today is 10th of April and the macro is ${TODAY-7} then the period covered by the report will be from and including 4th of April to and including 10th of April.

 

▪Exact date: a date in Windows short date format which normally looks like dd/MM/yyyy. You can select it by clicking on the 'Calendar' icon (proper format will be used automatically) or type it manually. Windows short date format can be viewed at: 'Control Panel' > 'Region and Language' > 'Format' tab (Windows Vista and 7) OR 'Control Panel' > 'Region' > 'Formats' tab (Windows 8 and 8.1)

 

 

▪'A file with the report style': A full path to a file in XSL format with styles that may be applied to the report. If left blank, a default style will be used.
 Content Previous Next