Configure device report page messages

You can configure AFA to send specific report pages to a user automatically, each time a report is generated for a certain device. AFA sends the specified user a single e-mail with the specified report pages attached as individually zipped PDF documents. The e-mail includes a list of the attached report pages, as well as a list of any report pages that could not be attached due to inadequate permissions or size limitations.

The device report page message mechanism uses PDFs that are exported from AFA.

For information about exporting AFA data to PDF files, see Export AFA screens to PDF.

Note: The specified user must have permission to view the device and the specified report pages. E-mails will not be sent to users that do not have permission to view the device. Report pages for which the user does not have permissions will not be included in the e-mail. No e-mail notification options need to be enabled in the user's settings in order for the user to receive these e-mail messages.

Note: By default, each e-mail can be sent with up to 10 MB of attachments, only. Once the size limit has been reached, additional report pages will not be attached.
It is possible to change the size limit, by opening /home/afa/.fa/config and adding the following line:
      MaximumReportZipFileSize=sizeLimit
Where sizeLimit is the desired size limit in MB.

Note: It is possible to generate report page PDFs (including those that cannot be sent to a user due to inadequate permissions or size limitations) for additional uses. For example, you could export the PDFs to a central repository in order to display them on an enterprise or MSSP portal. The desired usage should be implemented by a script that receives the path of the report's directory as a parameter, and which runs after generating report pages for all devices and users, but before removing all of the created files.
To configure AFA to use such a script, open /home/afa/.fa/config and add the following line:
      PostPublishReportParts=command
Where command is the command to run.

To automatically send device report pages to users:

  1. On the AFA server, under /home/afa/.fa, create a file called publish_def.xml.

  2. Add the following lines to this file:

    <ReportPartsPublish>     

    <DevicesDef>

    <Device name="deviceName">

    <User username="userName" parts="reportPages" />

    </Device>     

    </DevicesDef>

    </ReportPartsPublish>

    Where:

    • deviceName is the name of the device whose report pages should be sent. A list of all device names is available in the file /home/afa/.fa/firewall_data.xml.
    • userName is the username of the user who should receive the report pages. A list of all usernames is available in the file /home/afa/.fa/users_info.xml.
    • reportPages is a list of report page IDs separated by semicolons (;). A list of report pages and their IDs is available in the file /usr/share/fa/data/publish_parts.xml, where each report page is represented by a Part tag, and each page's ID number appears in the Part tag's id attribute.

    An example is available under /usr/share/fa/data.

    Note: Parts 1-14 are supported for group reports and single device reports. Parts 15 and up are only supported for single device reports.

  3. Save the file.

Back to top