Customizing PDF Report Output

To have a custom look and feel for your PDF Report, you need to create a Custom PDF Report Template. A Template can be created at various levels:

  • For each Report in RESOURCES > Reports
  • For each Report folder in RESOURCES > Reports
  • For each Report Bundle defined in RESOURCES > Reports > Report Bundles

When you run a report under RESOURCES > Reports, then FortiSIEM will choose the appropriate PDF Report Template in the following order:

  1. If a specific template is defined for the selected report, then that template would be chosen.
  2. If a template in the previous step is not found, then the template for the folder to which the Report belongs would be chosen.
  3. If no matching template is found in Steps 1 and 2, then the system-defined template for the root folder RESOURCES > Reports would be chosen - this is system-defined.

If you load and run a report in RESOURCES > Reports from the ANALYTICS page and then manually export the Report in PDF format:

  • If you choose the Defined option, then FortiSIEM will use the rules above to find the matching template.
  • If you choose the New option, then you can define a new Report format for this report instance only.

Note: For Service Provider deployments, the PDF Report templates can only be defined at the Super/Global level and applies for all customers.

The following sections provide information about:

Creating a PDF report template

A PDF Report template can be created as follows:

  • For a specific Report under RESOURCES > Reports:

    1. Go to RESOURCES > Reports.
    2. Select the Report from the right pane.
    3. Click More > Report Design.

  • For a Report folder under RESOURCES > Reports (including the root group):

    1. Go to RESOURCES > Reports.
    2. Choose any Report folder from the left pane.
    3. Click More > Report Design.

  • For a Report Bundle under RESOURCES > Report > Report Bundles (excluding the root group):

    1. Go to RESOURCES > Reports > Report Bundles.
    2. Select any system-defined report bundle under this group.
    3. Click More > Report Design.

Designing a PDF report template

You can design or modify the following template sections using the settings under Report Design:

Cover Page

The default Cover Page template includes the current Organization, Start Time, End Time, Generated Time and Device Time Zone as Default Text. These settings can be deleted or rearranged but not modified. You can also add text content and attachments to the Cover Page.

Adding text to cover page

  1. Click on the Cover Page bar to expand the section.
  2. Click Add and select Text from the drop-down to add text content in the cover page.
  3. Add the text in the Content field.
  4. Enable HTML if the text should be displayed in HTML format.
  5. Click Save to apply the changes.

Adding attachments to cover page

  1. Click on the Cover Page bar to expand the section.
  2. Click Add and select Attachment from the drop-down to add any PDF or PNG attachments in the cover page.
  3. Click Upload to add the attachment.
  4. Enter the required Width and Height of the attachment or else enable Auto Resize to adjust the size of the attachment to the PDF borders.
  5. Click Save to apply the changes.

    Use the Edit, Delete, Move Up or Move Down icons to the right of the Text field to modify, delete or re-arrange the order of text respectively.

Table of Contents - Sections and Subsections

This sections allows you to add new Sections and Sub Sections to the Table of Contents. You can also add text content, attachments, event reports and CMDB reports here.

Adding sections and subsections

  1. Click on the Table of Contents bar to expand the section.
  2. Click Add and select Section to add a new section.
  3. To add a subsection, select the required Section and click Add > Sub Section.
  4. Click the new section bar to expand.
  5. Enter a Title for the section.
  6. Click Preview to view the changes before saving.
  7. Click Save to apply the changes.

Adding text to a section or subsection

  1. Click on the required section or subsection bar to expand the section.
  2. Click Add and select Text from the drop-down to add text information in the cover page.
  3. Add the text in the Content field.
  4. Enable HTML if the text should be displayed in HTML format.
  5. Click Save to apply the changes.

Adding attachments to a section or subsection

  1. Click on the required section or subsection bar to expand the section.
  2. Click Add and select Attachment from the drop-down to add any PDF or PNG attachments.
  3. Click Upload to add the attachment.
  4. Enter the required Width and Height of the attachment or else enable Auto Resize to adjust the size of the attachment to the PDF borders.
  5. Click Save to apply the changes.

Adding an Event Report to a section or subsection

  1. Click on the required section or subsection bar to expand the section.
  2. Click Add and select Event Report from the drop-down.
  3. Select the Event Report from the drop-down.
  4. To display the event type, enable Show Event Type.
  5. When you define a custom template for Report Bundles (excluding the root group), you can select any Event Reports from the Select Event Report drop-down.

    Note the following:
    - For Report folders (including the root group), the Select Event Report setting is not available.
    - For a single Report, the Event Report is automatically selected under Select Event Report setting and you cannot modify this.

  6. Configure the display format:
    1. Select the report Format from the drop-down: Donut Chart, Bar Chart, Trend Line Chart, Trend Area Chart, Trend Bar Chart or Table.
    2. Select the Attribute.
    3. Enter the Title for the chart.
    4. Select or enter the number of Items to display.
    5. Enter the Height of the chart or table.
    6. To add more formats, click + under Row and use the Move arrows to re-order the list.
    7. Click Save.
  7. Click Save to apply the changes.

Adding a CMDB Report to a section or subsection

Note: You can add CMDB Reports only to a Report Bundle template.

  1. Click on the required section or subsection bar to expand the section.
  2. Click Add and select CMDB Report from the drop-down.
  3. Click the Edit icon to select the CMDB Report from the drop-down. You can also use the search bar to find a specific CMDB report.
  4. Click Select to confirm the selection.
  5. Select the number of Items to display.
  6. Click Save to apply the changes.