Custom report pages

AFA enables you to create custom pages in your reports.

In this topic:

Create a custom report page

You can create a custom report page that will be included as a separate tab in each new device, group, or matrix report.

To create a custom report page:

1. Create an XML file called custom_report.xml, containing all of the execution commands in the following format:

   <Custom_Report>

   <Report name="report_name">

   <device command="device_script_execution_command" output="device_output_file"></device>

   <group command="group_script_execution_command" output="group_output_file"></group>

   <matrix command="matrix_script_execution_command" output="group_output_file"></matrix>

   </Report>

   </Custom_Report>

   For more details, see Custom report configuration file parameters.

   The <device>, <group>, and <matrix> lines are optional. If you include the <device> line but do not include the <group> or <matrix> lines, the custom report page in the group or matrix report will display a concatenation of custom device pages.

2. Create a folder called custom_report, containing all of the scripts that must be executed.

3. Create a sub-folder called additional_files under the custom_report folder, containing additional files that are required for generating the custom report, for example data files, .css files, and so forth.

4. Add the file custom_report.xml and the folder custom_report (along with all its contents, including the subfolder additional_files) to a single .zip file.

5. Enter the following command:

   extract_custom_report -f zip_ file [-d domain_number] [-u user_name]

   For more details, see Extract custom report script flags.

   The extract_custom_report script extracts the .zip file.

The next time a report is generated, it will include the custom page.

Back to top

Custom report configuration file parameters

Parameter	Description
report_name	The name of the report page.
device_script_execution_command	The script execution command for the custom device report page, including input parameters. For example: sh device_script.sh
device_output_file	The name of the HTML output file for the custom device report page. For example: custom_device.html
group_script_execution_command	The script execution command for the custom group report page, including input parameters. For example: sh group_script.sh
group_output_file	The name of the HTML output file for the custom device report page. For example: custom_group.html
matrix_script_execution_command	The script execution command for the custom matrix report page, including input parameters. For example: sh matrix_script.sh
matrix_output_file	The name of the HTML output file for the custom device report page. For example: custom_matrix.html

Back to top

Extract custom report script flags

Flag	Description
-f zip_ file	The name of the .zip file. Note: The file must be located in the current directory.
-d domain_number	The number of the domain in the .fa directory, where the .zip file should be extracted. This flag is optional.
-u user_name	The user to use when installing the contents of the .zip file. This user will be granted permissions for the .zip file's contents. This flag is optional. If it is not included, the contents of the .zip file will be installed using the "afa" user.

Back to top