Fortinet black logo

Administration Guide

Configuring report profiles and generating reports

Configuring report profiles and generating reports

A report profile is a group of settings with the report name, subject, schedule, and other information that the FortiMail unit uses when it generates reports. The reports show the information in tabular and graphical format.

Statistics in the reports are generated from log data. Log retention must allow enough time for the report to be generated before the log file is deleted. See Configuring logging.

This section contains the following topics:

Configuring domain-level mail statistics reports

If you have the feature license for it, you can generate reports that focus on email processing for each protected domain.

To configure the report profile

  1. Purchase the feature license and enable the feature. See Domain mail statistics.

    By default, its corresponding areas of the GUI are hidden and disabled.

  2. Go to Log & Report > Report Setting > Domain Mail Statistics.

  3. To enable the report, select Generate report.
  4. If the report should include statistics about all protected domains, enable All domains.

    Otherwise disable it. Text areas appear. In Available domains, select the names of protected domains, and then click >> to move it to Selected domains.

  5. In Schedule, select the how frequently the FortiMail unit will generate the report. Also configure At hour with the time of day when the report will be generated, and, if you selected a weekly report, which days of the week.

    Time periods included in the report are everything in the schedule interval.

    Note

    Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night.

  6. Click Apply.
  7. If you want to generate a report immediately (on demand; the report is also generated later, according to the schedule), click Generate Now. (This button is not available if Generate report is disabled.)

    Otherwise you can wait for the schedule to trigger the report, and then view it. See Viewing reports.

Configuring system-level mail statistics reports

To configure the report profile

  1. Go to Log & Report > Report Setting > Mail Statistics.

    GUI item

    Description

    Generate

    (button)

    Select a report profile and then click this button to generate a report immediately, on demand. See Viewing reports.

    Report Name

    Displays the name of the report profile.

    Recipient Domain

    Displays the name of the recipient domain.

    Sender Domain

    Displays the name of the sender domain.

    Schedule

    Displays the frequency with which the FortiMail unit generates a scheduled report.

    If the report is generated on demand, Not Scheduled appears in this column.

  2. Click New to add a profile, or double-click a profile to modify it.
  3. Configure the following settings:

    GUI item

    Description

    Report name

    Enter a name for the report. Do not include spaces.

    Comment

    Optional. Enter a description or comment.

    Time period

    Select the time range of log messages from which to generate the report.

  4. Expand and configure the following sections:

  5. Click Create or OK.

Query Selection

When configuring a report profile, you can select one or more queries or query groups that define the subject matter of the report.

Each query group contains multiple individual queries, each of which correspond to a chart that will appear in the generated report. You can select all queries within the group by marking the check box of the query group, or you can expand the query group and individually select each query to include.

For example:

  • If you want the report to include charts about spam, select both the Spam by Sender and Spam by Recipient query groups.
  • If you want the report to specifically include only a chart about top virus senders by date, expand the query group Virus by Sender and select only the individual query Top Virus Sender By Date.

GUI item

Description

Mail Filtering Statistics

Select to include high-level categories, such as mail, spam, non-spam, and virus.

Mail High Level

Select to include all top level and summary information for all queries, such as Top Client IP By Date.

Mail Statistics

Select to include information on daily, hourly or weekly email message statistics, such as Mail Stat Messages By Day.

Mail by Recipient

Select to include information on email messages by each recipient, such as Top Recipient By Date.

Mail by Sender

Select to include information on email messages by each sender, such as Top Sender By Date.

Spam by Recipient

Select to include information on spam by each recipient, such as Top Spam Recipient By Date.

Spam by Sender

Select to include information on spam by each sender, such as Top Spam Sender By Date.

Statistics

Select to include information on generalized email message statistics (less granular than Mail Statistics).

Total Summary

Select to include summary information, such as Total Sent And Received.

Virus by Sender

Select to include information on infected email messages by each sender, such as Top Virus Sender By Date.

Virus by Recipient

Select to include information on infected email messages by each recipient, such as Top Virus Recipient By Date.

Schedule

When configuring a report profile, you can select when the report will generate. Alternatively, you can leave it unscheduled.

Note

Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night. Alternatively, you can generate them on demand, only when necessary.

Expand the Schedule section, then in the Schedule dropdown, select either:

GUI item

Description

Not Scheduled

Select if you do not want the FortiMail unit to generate the report automatically according to a schedule. The report is only generated when you manually click Generate to generate it on demand.

Daily

Select to generate the report each day. Also configure At hour.

These days

Select to generate the report on specific days of each week, then select those days. Also configure At hour.

These dates

Select to generate the report on specific date of each month, then enter those date numbers. Separate multiple date numbers with a comma. For example, to generate a report on the 1st and 30th day of every month, enter 1,30.

Also configure At hour.

Recipient Domain and Sender Domain

When configuring a report profile, you must specify at least one protected domain that is in recipient and/or sender email addresses. The log messages that match those protected domains are used when generating the report.

  1. Expand the Recipient Domain and/or Sender Domain sections.
  2. Disable All domains.

    Options appear to select specific protected domains.

  3. In the Available domains area, select one or more protected domains that you want to include in the report, and then click >> to move them to the Selected domains area.

    Optionally, in External domain, you can also enter a domain name that is not a protected domain, and then click >> to move it to Selected domains.

    To remove a domain from a report, select it in the Selected domains area, and then click <<.

Conditions

When configuring a report profile, you can choose to report only on logged email messages that match adirectionality: incoming, outgoing, or both.

  1. Expand the Conditions section.
  2. In Direction, select the direction of email relative to protected domains: either Incoming, Outgoing, or All.
  3. In Destination, select how you want to define the destination address of the email: either User Defined or IP Group. Then select the name of an IP group, or enter the IP address and network mask.

Email Notification

When configuring a report profile, you can have the FortiMail unit email an attached copy of the generated report, in either HTML or PDF file format, to designated recipients.

  1. Expand the Email Notification section.
  2. In Report format, select the file format of the attachment for the generated report, either html or pdf.
  3. In the Email address field, enter an email address that will receive the report, and then click >> to add it to the list of recipients in All notification Email address.

    To remove a recipient address, select it and click <<.

Configuring mailbox statistics

The FortiMail unit can generate reports on the total number of active mailboxes during a particular time period, as specified in the report profile creation. Mailbox statistic reports can be configured based on schedule, domain, and email address notification. After configuration, to view historical active mailbox counts over the last 30 days and 12 months, go to FortiView > Mail Statistics > Active Mailbox.

To configure the report profile

  1. Purchase the feature license and enable the feature. See Mailbox accounting service.

    By default, the corresponding areas of the GUI are hidden and disabled.

  2. Go to Log & Report > Report Setting > Mailbox Statistics.

    GUI item

    Description

    Generate

    (button)

    Select a report profile, and then click this button to generate a report immediately, on demand. See Viewing reports.

    Report Name

    Displays the name of the report profiles.

    Domain

    Displays the protected domain name(s).

    Schedule

    Displays the frequency with which the FortiMail unit generates a scheduled report. If the report is designed for manual generation, Not Scheduled appears in this column.

  3. Click New to add a profile or double-click a profile to modify it.
  4. Configure the following settings:

    GUI item

    Description

    Report name

    Enter a name for the report. Do not include spaces.

    Time period

    Select the time range of log messages from which to generate the report.

    Include mailbox list

    Enable this option to include information about the active mailboxes for each protected domain and the last time that email was delivered to them.

  5. Expand and configure the following sections:

  6. Click Create or OK.

Schedule

When configuring a report profile, you can select when the report will generate. Alternatively, you can leave it unscheduled.

Note

Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night. Alternatively, you can generate them on demand, only when necessary.

Expand the Schedule section, then in the Schedule dropdown, select either:

GUI item

Description

Not Scheduled

Select if you do not want the FortiMail unit to generate the report automatically according to a schedule. The report is only generated when you manually click Generate to generate it on demand.

Daily

Select to generate the report each day. Also configure At hour.

Weekly

Select to generate the report on specific days of each week, then select those days. Also configure At hour.

Monthly

Select to generate the report on specific date of each month, then enter those date numbers. Separate multiple date numbers with a comma. For example, to generate a report on the 1stand 30th day of every month, enter 1,30.

Also configure At hour.

Domain

When configuring a report profile, you must specify at least one protected domain whose log messages are used when generating the report.

  1. Expand the Domain section.
  2. Disable All domains.

    Options appear to select specific protected domains.

  3. In the Available domains area, select one or more protected domains that you want to include in the report, and then click >> to move them to the Selected domains area.

    To remove a domain from a report, select it in the Selected domains area, and then click <<.

Email Notification

When configuring a report profile, you can have the FortiMail unit email an attached copy of the generated report to designated recipients.

  1. Expand the Email Notification section.
  2. In the Email address field, enter an email address that will receive the report, and then click >> to add it to the list of recipients in All notification Email address.

    To remove a recipient address, select it and click <<.

Configuring report profiles and generating reports

A report profile is a group of settings with the report name, subject, schedule, and other information that the FortiMail unit uses when it generates reports. The reports show the information in tabular and graphical format.

Statistics in the reports are generated from log data. Log retention must allow enough time for the report to be generated before the log file is deleted. See Configuring logging.

This section contains the following topics:

Configuring domain-level mail statistics reports

If you have the feature license for it, you can generate reports that focus on email processing for each protected domain.

To configure the report profile

  1. Purchase the feature license and enable the feature. See Domain mail statistics.

    By default, its corresponding areas of the GUI are hidden and disabled.

  2. Go to Log & Report > Report Setting > Domain Mail Statistics.

  3. To enable the report, select Generate report.
  4. If the report should include statistics about all protected domains, enable All domains.

    Otherwise disable it. Text areas appear. In Available domains, select the names of protected domains, and then click >> to move it to Selected domains.

  5. In Schedule, select the how frequently the FortiMail unit will generate the report. Also configure At hour with the time of day when the report will be generated, and, if you selected a weekly report, which days of the week.

    Time periods included in the report are everything in the schedule interval.

    Note

    Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night.

  6. Click Apply.
  7. If you want to generate a report immediately (on demand; the report is also generated later, according to the schedule), click Generate Now. (This button is not available if Generate report is disabled.)

    Otherwise you can wait for the schedule to trigger the report, and then view it. See Viewing reports.

Configuring system-level mail statistics reports

To configure the report profile

  1. Go to Log & Report > Report Setting > Mail Statistics.

    GUI item

    Description

    Generate

    (button)

    Select a report profile and then click this button to generate a report immediately, on demand. See Viewing reports.

    Report Name

    Displays the name of the report profile.

    Recipient Domain

    Displays the name of the recipient domain.

    Sender Domain

    Displays the name of the sender domain.

    Schedule

    Displays the frequency with which the FortiMail unit generates a scheduled report.

    If the report is generated on demand, Not Scheduled appears in this column.

  2. Click New to add a profile, or double-click a profile to modify it.
  3. Configure the following settings:

    GUI item

    Description

    Report name

    Enter a name for the report. Do not include spaces.

    Comment

    Optional. Enter a description or comment.

    Time period

    Select the time range of log messages from which to generate the report.

  4. Expand and configure the following sections:

  5. Click Create or OK.

Query Selection

When configuring a report profile, you can select one or more queries or query groups that define the subject matter of the report.

Each query group contains multiple individual queries, each of which correspond to a chart that will appear in the generated report. You can select all queries within the group by marking the check box of the query group, or you can expand the query group and individually select each query to include.

For example:

  • If you want the report to include charts about spam, select both the Spam by Sender and Spam by Recipient query groups.
  • If you want the report to specifically include only a chart about top virus senders by date, expand the query group Virus by Sender and select only the individual query Top Virus Sender By Date.

GUI item

Description

Mail Filtering Statistics

Select to include high-level categories, such as mail, spam, non-spam, and virus.

Mail High Level

Select to include all top level and summary information for all queries, such as Top Client IP By Date.

Mail Statistics

Select to include information on daily, hourly or weekly email message statistics, such as Mail Stat Messages By Day.

Mail by Recipient

Select to include information on email messages by each recipient, such as Top Recipient By Date.

Mail by Sender

Select to include information on email messages by each sender, such as Top Sender By Date.

Spam by Recipient

Select to include information on spam by each recipient, such as Top Spam Recipient By Date.

Spam by Sender

Select to include information on spam by each sender, such as Top Spam Sender By Date.

Statistics

Select to include information on generalized email message statistics (less granular than Mail Statistics).

Total Summary

Select to include summary information, such as Total Sent And Received.

Virus by Sender

Select to include information on infected email messages by each sender, such as Top Virus Sender By Date.

Virus by Recipient

Select to include information on infected email messages by each recipient, such as Top Virus Recipient By Date.

Schedule

When configuring a report profile, you can select when the report will generate. Alternatively, you can leave it unscheduled.

Note

Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night. Alternatively, you can generate them on demand, only when necessary.

Expand the Schedule section, then in the Schedule dropdown, select either:

GUI item

Description

Not Scheduled

Select if you do not want the FortiMail unit to generate the report automatically according to a schedule. The report is only generated when you manually click Generate to generate it on demand.

Daily

Select to generate the report each day. Also configure At hour.

These days

Select to generate the report on specific days of each week, then select those days. Also configure At hour.

These dates

Select to generate the report on specific date of each month, then enter those date numbers. Separate multiple date numbers with a comma. For example, to generate a report on the 1st and 30th day of every month, enter 1,30.

Also configure At hour.

Recipient Domain and Sender Domain

When configuring a report profile, you must specify at least one protected domain that is in recipient and/or sender email addresses. The log messages that match those protected domains are used when generating the report.

  1. Expand the Recipient Domain and/or Sender Domain sections.
  2. Disable All domains.

    Options appear to select specific protected domains.

  3. In the Available domains area, select one or more protected domains that you want to include in the report, and then click >> to move them to the Selected domains area.

    Optionally, in External domain, you can also enter a domain name that is not a protected domain, and then click >> to move it to Selected domains.

    To remove a domain from a report, select it in the Selected domains area, and then click <<.

Conditions

When configuring a report profile, you can choose to report only on logged email messages that match adirectionality: incoming, outgoing, or both.

  1. Expand the Conditions section.
  2. In Direction, select the direction of email relative to protected domains: either Incoming, Outgoing, or All.
  3. In Destination, select how you want to define the destination address of the email: either User Defined or IP Group. Then select the name of an IP group, or enter the IP address and network mask.

Email Notification

When configuring a report profile, you can have the FortiMail unit email an attached copy of the generated report, in either HTML or PDF file format, to designated recipients.

  1. Expand the Email Notification section.
  2. In Report format, select the file format of the attachment for the generated report, either html or pdf.
  3. In the Email address field, enter an email address that will receive the report, and then click >> to add it to the list of recipients in All notification Email address.

    To remove a recipient address, select it and click <<.

Configuring mailbox statistics

The FortiMail unit can generate reports on the total number of active mailboxes during a particular time period, as specified in the report profile creation. Mailbox statistic reports can be configured based on schedule, domain, and email address notification. After configuration, to view historical active mailbox counts over the last 30 days and 12 months, go to FortiView > Mail Statistics > Active Mailbox.

To configure the report profile

  1. Purchase the feature license and enable the feature. See Mailbox accounting service.

    By default, the corresponding areas of the GUI are hidden and disabled.

  2. Go to Log & Report > Report Setting > Mailbox Statistics.

    GUI item

    Description

    Generate

    (button)

    Select a report profile, and then click this button to generate a report immediately, on demand. See Viewing reports.

    Report Name

    Displays the name of the report profiles.

    Domain

    Displays the protected domain name(s).

    Schedule

    Displays the frequency with which the FortiMail unit generates a scheduled report. If the report is designed for manual generation, Not Scheduled appears in this column.

  3. Click New to add a profile or double-click a profile to modify it.
  4. Configure the following settings:

    GUI item

    Description

    Report name

    Enter a name for the report. Do not include spaces.

    Time period

    Select the time range of log messages from which to generate the report.

    Include mailbox list

    Enable this option to include information about the active mailboxes for each protected domain and the last time that email was delivered to them.

  5. Expand and configure the following sections:

  6. Click Create or OK.

Schedule

When configuring a report profile, you can select when the report will generate. Alternatively, you can leave it unscheduled.

Note

Generating reports can be resource intensive. To avoid slower email processing, you may want to schedule reports to generate them during times with low traffic volume, such as at night. Alternatively, you can generate them on demand, only when necessary.

Expand the Schedule section, then in the Schedule dropdown, select either:

GUI item

Description

Not Scheduled

Select if you do not want the FortiMail unit to generate the report automatically according to a schedule. The report is only generated when you manually click Generate to generate it on demand.

Daily

Select to generate the report each day. Also configure At hour.

Weekly

Select to generate the report on specific days of each week, then select those days. Also configure At hour.

Monthly

Select to generate the report on specific date of each month, then enter those date numbers. Separate multiple date numbers with a comma. For example, to generate a report on the 1stand 30th day of every month, enter 1,30.

Also configure At hour.

Domain

When configuring a report profile, you must specify at least one protected domain whose log messages are used when generating the report.

  1. Expand the Domain section.
  2. Disable All domains.

    Options appear to select specific protected domains.

  3. In the Available domains area, select one or more protected domains that you want to include in the report, and then click >> to move them to the Selected domains area.

    To remove a domain from a report, select it in the Selected domains area, and then click <<.

Email Notification

When configuring a report profile, you can have the FortiMail unit email an attached copy of the generated report to designated recipients.

  1. Expand the Email Notification section.
  2. In the Email address field, enter an email address that will receive the report, and then click >> to add it to the list of recipients in All notification Email address.

    To remove a recipient address, select it and click <<.