Working with Report Design Templates

FortiSIEM gives you the flexibility of designing custom templates for each of your reports. When you select RESOURCES > Reports, notice that the table of reports includes a Report Design Template column. This column identifies the template to be used when generating and exporting a report. By default, all reports are assigned the same template. The default template name has the format organization_name scope Reports Template. For example, Global System Reports Template would be a report for the Global organization with System scope.

The Global System Reports Template can be edited when you log in as Super/Global. In this case, an Edit icon will appear next to Global System Reports Template after you modify the report design 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, FortiSIEM will choose the appropriate Report Template in the following order:

1. If a specific template is defined for the selected report, then that template will be chosen.
2. If a template in the previous step is not found, then the template for the folder to which the Report belongs will 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 will be chosen. System-defined templates cannot be edited.

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 Report templates can only be defined at the Super/Global level and applies for all customers.
• If a report is part of two folders and each folder has its own template defined, then the template of the current folder being viewed will be used.

The following sections provide information about:

• Creating a Report Template
• Designing a Report Template

Creating a Report Template

A Report template for PDF can be created as follows:

1. Go to RESOURCES > Reports and select one of the subcategories from the left pane.
2. Select the desired row from the table.
3. (Optional) Select the Sync checkbox in the row to synchronize the report with the Report Server.
4. Open the More drop-down list and select Report Design. The Report Design page opens.
5. Notice that the Name given to the report template is in the form organization_name scope report_name Template. You can edit this name if you want.
6. Follow the instructions in Designing a Report Template to design the cover page and add sections, objects, attachments, and so on, to the report.
7. Click Save.

   The name of the new template will be displayed in the Report Design Template column of the table. Notice that an edit icon appears next to the name of the template.

Creating Report Templates for a Report Folder or Resource Bundle

To create a report template for a Resource folder, choose any Report folder from the left pane. The steps to create the template are similar to Creating a Report Template.

To create a report template for a Report Bundle, complete these steps:

1. Select any system-defined or user-defined report bundle in this group.
2. Select all of the reports in the table.
3. Click More > Report Design.

Notice that the Name of the template for a Report Bundle cannot be edited.

Modifying an Existing Report Template

1. Click the edit icon next to the name of the existing report design template. The Report Design page opens.
2. Make the desired changes to the template design.
3. Click Save.

Designing a Report Template

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

• Overview
• Cover Page
• Report - Sections and Objects

Overview

Report Designer allows you to build a report out the following objects, the Cover Page, Table of Contents, Pages (Sections), and Objects.

• Visual PDF Report Designer Interface
• Adding an Object
• Deleting an Object
• Orientation
• Using the Text Editor when Adding Text to an Object

Visual PDF Report Designer Interface

The main interface consists of the Template Name field, that allows you to rename your report template, an Organization drop-down list to select the organization that the report template belongs to, an Orientation drop-down list to choose a Portrait or Landscape generated PDF report, and a horizontal control bar that has the following buttons.

• New Page - Clicking this adds a new page (Section) to your report template structure. A page can contain any number of elements, which include text, images, charts, and report tables.

• Discard Changes - Clicking this removes all prior work done before you saved (Save appears at the bottom of the interface).

• Layout - Allows you to make size and positional adjustments to an element as well as being able to adjust the margins of an element that is selected. To make a positional adjustment, select the Section or Object, and click an arrow (up, down, left, right) to change its position to where you want to move it. To adjust a margin, select the appropriate margin box and enter the new pixel value.
  Note: Only valid position options will be displayed, for example a Page/Section can only be moved up or down, and cannot be positioned left or right, so lef t and right options will not appear if a Page/Section is selected.

• Cover - When selected, a cover will be included with your PDF report. If unselected, no cover page is included with the report.

• TOC - When selected, a table of contents (TOC) will be included with your PDF report. If unselected, no TOC is included with the report.

The buttons that are available depend on how you entered the Visual PDF Report Designer.

If you entered the Visual PDF Report Designer via Resources, the following options are available:

At the upper right of the page:

• Organization: Select the organization the report is for.

• Orientation: Select between Portrait or Landscape.

At the bottom of the page:

• Save - Click to save your changes.
  Note: This will overwrite the default template stored for a Report or Report Bundle.

• Cancel - Click to cancel out of the Visual PDF Report Designer.

• Preview - Click to see a preview of the how the exported data will appear in PDF.

• Restore to Default - Removes custom templates that have been created, leaving only the default templates available.

If you entered the Visual PDF Report Designer via Analytics, the following options are available:

At the upper right of the page:

• Orientation: Select between Portrait or Landscape.

• Window Size icon: Toggle between full window or default window.

At the bottom of the page:

• Generate - Click to export the report.

• Cancel - Click to abandon the report.

Adding an Object

When you create a new Report Design, a default Cover Page and Table of Contents is automatically created.

To add a page, also known as a section, select an existing page and click the + icon, and select Add page above or Add page below. You can also click on the New Page button to add a new page/section.

To add an Object, select an existing Object where you wish to add an Object to, then click the + icon, and select the Object that you wish to add (Image, Text, Chart, Report Table, Legend, PDF).

Note: Only allowable objects will be available from the drop-down list. For example, a PDF are only available to create from the last page.

Deleting an Object

A report can have a maximum of one Cover Page and one Table of Contents. The Table of Contents is based off the section(s) that you create, or that already exist. To delete any existing object, select the object and then click the trash icon that appears in the upper right corner for that object.

Orientation

You can choose the page orientation that your report appears in by clicking on the Orientation drop-down list button and selecting Portrait or Landscape.

Using the Text Editor when Adding Text to an Object

When you choose to add text to a cover page, section, a text Object will appear. Click on the edit icon to open the text editor. Use the editor to add any text you wish to display with your report in the Text window. When done, click Save.The text editor also provides the following tools:

Icon	Description
Undo	Click to undo the last typing action.
Redo	Click to re-apply the last undo action.
Size	Click the drop-down list, and select a font size. To apply to existing text, select the text first, then click the icon and select a size.
Font Color	Click the icon and select a color. To apply to existing text, select the text first, then click the icon and select a color.
Bold	Click the icon to begin bolding text. To apply to existing text, select the text first, then click the icon.
Underline	Click the icon to begin underling text. To apply to existing text, select the text first, then click the icon.
Italic	Click the icon to begin italicizing text. To apply to existing text, select the text first, then click the icon.
Strikethrough	Click the icon to begin strikethrough text. To apply to existing text, select the text first, then click the icon.
Remove Format	Click the icon to remove any existing formatting information that is currently being applied. To apply to existing text, select the text first, then click the icon.
Align	Click the Align icon and select one of the following alignments: Align left - Aligns the text to start at the left side of the window. Align center - Aligns the text to appear in the center of the window. Align right - Aligns the text to end at the right side of the window. Align justify - Aligns text so it is both left and right aligned by inserting spaces between words.
Full Screen/Text Editor	Click to toggle between expanding to full screen and the standard text editor window.
Code view	Click to toggle between normal and code view.

Cover Page

The default Cover Page template includes the Report title, current Organization, Start Time, End Time, Generated Time, and Device Time Zone as Default Text. These sections can be deleted, rearranged, or have text content and images added to them. To modify an existing section, select it, then select the type from the Cover Type drop-down list.

• Adding Text to Cover Page
• Adding Images to Cover Page

Adding Text to Cover Page

1. Click the Cover Page bar to expand the section.
2. Click on any Object in the Cover page, click the + icon, and select Text from the drop-down list to add text content to the cover page.
3. Add the text in the Text window. For information on text tools, see Using the Text Editor when Adding Text to an Object.
4. Click Save to apply the changes.

Adding Images to Cover Page

1. Click the Cover Page bar to expand the section.
2. Click on any Object in the Cover page, click the + icon, and select Image from the drop-down list to add any JPG, PNG, or SVG image in the cover page.
3. Click Select File to add the image.
4. From the Scale drop-down list, select one of the following:
   • Not Scale - The image will not be resized.
   • Fit Width - The image will be resized to fit width.
   • Fit Height - The image will be resized to fit height.
   • Fill all - The image will be resized to fill the entire space available for it.
5. Click on the Left, Center, or Right Alignment icon to adjust the image alignment.
   

Note: 

1. To fill the width of a page, the image size must be set to 5000 x 5000.
2. Even when enlarged, the JPG, PNG, or SVG image will appear pixelated (it does not use vector graphics). the more you zoom the page, the worse the image will look.

Report - Sections and Objects

This section allows you to add new Sections (Pages) and Objects to your Report. You can also add text content, images, charts, report tables, or a PDF attachment here.

• Adding Sections
• Adding Objects
• Adding Text to a Section or Object
• Adding an Image to a Section or Object
• Adding a PDF to a Custom Report
• Adding a Chart
• Adding a Report Table
• Adding a Legend to a Section
• Adding a CMDB Report to a Section or Object

Adding Sections

Click the New Page button to add a section, or from an existing section, take the following step.

1. Select the Section, and click on the + icon at the top or bottom of the Section to respectively add a page above the Section, or below it. After clicking the + icon, select Add page above, or Add page below to add a new Section.

Adding Objects

To add an Object to a Section, select a Section or Object, and click on the + icon. From the drop-down list, select an object (Text, Image, Chart, Report Table, Legend).

Note: Only allowable objects will be available from the drop-down list. For example, a Report Table and Legend are only available from a Section, and are not available when selecting + from an Object.

Adding Text to a Section or Object

1. Click the required Section or Object.
2. Click on a + icon, and select Text from the drop-down list to add text information.
3. Click the Text Edit icon and add the text in the Text window. For information on text tools, see Using the Text Editor when Adding Text to an Object.
4. Click Save to apply the changes.

Adding an Image to a Section or Object

1. Click on the required Section or Object.
2. Click on a + icon, and select Image from the drop-down list to add any JPG, PNG, or SVG image.
3. Click Select File to add the image.
4. From the Scale drop-down list, select one of the following:
   • Not Scale - The image will not be resized.
   • Fit Width - The image will be resized to fit width.
   • Fit Height - The image will be resized to fit height.
   • Fill all - The image will be resized to fill the entire space available for it.
     
5. Click on the Left, Center, or Right Alignment icon to adjust the image alignment.

Note: 

1. To fill the width of a page, the image size must be set to 5000 x 5000.
2. Even when enlarged, the JPG, PNG, or SVG image will appear pixelated (it does not use vector graphics). the more you zoom the page, the worse the image will look.

Adding a PDF to a Custom Report

A PDF attachment can only be added to the last page (Section) of a Custom report. To add a PDF attachment, click on the bottom + icon from the bottom most Page (Section), and select PDF. Click Select File, and select the PDF file to attach.

Adding a Chart

1. Click on the required section or object bar to expand the section.
   
2. To add a Chart, select a section or object.
   
3. Click the + icon, and select Chart from the drop-down list.
4. In the Report Section window, take the following steps.
   1. In the Chart Name field, enter the name of the chart.
      Note: The chart name will named as the Display Attribute unless a Chart Name is provided.
   2. From the Format drop-down list, select the chart type. The list displays the available charts.
   3. From the Items field, enter the number of items to display.
      Note: If the item number is changed for one chart, all charts and Legend within that page will be also be updated with that change.
      
   4. From the Report drop-down list, select the report to use.
   5. From the Attribute drop-down list, select an attribute.

Adding a Report Table

1. Click on the required section or object bar to expand the section.
   
   
2. To add a Report Table, select a section or object.
   Note: The Report Table option is only available if no Report Table exists on the page.
3. Click the + icon, and select Report Table from the drop-down list.
4. Select the Report from the Report drop-down.
5. To display the event type, add a check to the Event Type checkbox.
6. To display a summary, add a check to the Summary checkbox.
7. When you define a custom template for Report Bundles (excluding the root group), you can select any Event Reports from the Report drop-down list.
   Note the following:
   
   - For Report folders (including the root group), the Report setting is not available.
   
   - For a single Report, the Event Report is automatically selected under the Report setting and you cannot modify this.

Adding a Legend to a Section

1. Click on the required section to expand the section.

2. Click on the + icon, and select Legend.
   

   Note: The Legend option is only available if no Legend exists on the current section.
   

Adding a CMDB Report to a Section or Object

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

1. Navigate to Resources > Reports > Report Bundles > <Report Bundle>.
   For <Report Bundle>, select a specific Report Bundle, for example Important PCI, Firewall Health, or Router Health.
   
2. In the left pane, click the Report Design icon.
3. Click on the required section or object bar to expand the section.
4. Click the + icon and select CMDB Report from the drop-down list.
5. Click the Edit icon, then from the Select CMDB Report window, select the CMDB Report from the drop-down list. You can also use the search bar to find a specific CMDB report.
6. Click Save to confirm the selection.
7. Select the number of Items to display.
8. Click Save to apply the changes.