Customize the Regulatory Compliance page

AFA provides the ability to customize the Regulatory Compliance page for each AFA report in the CLI. The CLI supports the following actions:

• Adding or removing compliance reports.
• Creating custom reports by modifying existing reports.
• Setting the default compliance report that appears in the HOME and CHANGES pages.

For descriptions of all built-in regulatory compliance reports, see Supported regulatory compliance reports.

Add, remove or customize compliance reports

Do the following:

1. Open a terminal and log in using the username "afa" and the related password.

2. Create a new directory /home/afa/.fa/compliance_reports/. This is the override directory.

3. Copy /usr/share/fa/data/compliance_reports/compliance_reports.xml to /home/afa/.fa/compliance_reports/.

4. To create a custom report by modifying an existing report (and add it to the regulatory compliance page), do the following:

5. Create new templates for the report, by doing the following:

   1. Find the report template(s) you want to modify in the override directory.

      Report templates follow the following naming convention:

      • For individual device reports: compliance_rep_templ_reportname.html
      • For group device reports: compliance_rep_templ_group_reportname.html
      • For matrix device reports: compliance_rep_templ_matrix_reportname.html

      where reportname is the name of the compliance report.

   2. Copy the report templates you want to modify, and save the copy (in the override directory). Use the above naming convention, with a new name for your new report.

   3. Modify your template copies as you desire.

   4. Save the files.

6. Open /home/afa/.fa/compliance_reports/compliance_reports.xml.

Add a new report tag as a sub-tag to the compliance_reports tag. The following table describes the report tag attributes:

Attribute	Description
id	Internal key necessary for report creation.
title	Title of the report. This title will appear as a link on the Regulatory Compliance page of the device report. The link leads to the compliance report.
template_file	HTML template file for a single device. This template will be used to create a single device compliance report.
template_file_group	HTML template file for a device group. This template will be used to create a device group compliance report.
template_matrix	HTML template file for a device matrix. This template will be used to create a device matrix compliance report.
active	Indicates whether the report is generated when a device is analyzed. This attribute can take the following values: yes. Include the report on the Regulatory Compliance page of the device report. no. Exclude the report.
sub_title	The sub-title for the report. This appears below the title of the report.