Attachments

doc/3.2.1/Working With Portal/Reports

1. Understanding Reports

A reports is a document in PDF format, which is sent periodically by e-mail (scheduled) or immediately downloaded (manual), and contains the output of several widgets.

1.1. Scheduled reports

Composing a scheduled report is as simple as:

  • selecting one or more modules,
  • selecting a frequency (monthly, weekly or daily)
  • specifying one or more recipients.

1.1.1. Managing reports

In the administration tab, the Reports page allows to manage all scheduled reports:

  • report-admin.png

Existing report can be:

  • report-edit.png edited,

  • report-dup.png duplicated,

  • report-sendnow.png sent immediately,

  • report-download.png downloaded.

1.1.2. Editing reports

When creating a new report, or editing or duplicating an existing one, the report configurations can be specified by means of this wizard:

  • report-wiz.png

1.2. Manual reports

A report for one module or dashboard can be immediately downloaded within the Portal without the need of having the "Administrator" role. To do it, go to the module you'd like to export and click on the PDF icon located at the bottom-left of the window (cf screenshot below); you can then choose to export the whole module or just the selected dashboard.

  • manual_reports.png

2. SMTP Configuration

The SMTP configuration for the Portal is available in the Web Console.

It can be also configured from a shell session via ssh on the Portal server:

  1. cd /var/nexthink/portal
  2. To test, type the following command with, appropriate values in lieu of the <>'s:

    ./rsquery/emailConfig.py -s '{ \
    "mail.from": "<FROM-EMAIL>", \
    "mail.password": "<PASSWORD>", \
    "mail.smtp.auth": true, \
    "mail.smtp.host": "<HOST>", \
    "mail.smtp.port": 25, \
    "mail.smtp.starttls.enable": true, \
    "mail.user": "<USER>" }' \
    -t <TEST-EMAIL-RECIPIENT>
    Notes:
    • If the SMTP server requires no account, specify an empty string for <USER> and <PASSWORD>.

    • This will not save the parameters, but only use them for the test.
  3. Check if you received an e-mail to <TEST-EMAIL-RECIPIENT>, and repeat step 2 until it works.

  4. To save the parameters, type the following command, with appropriate values in lieu of the <>'s:

    ./rsquery/emailConfig.py -s '{ \
    "mail.from": "<FROM-EMAIL>", \
    "mail.password": "<PASSWORD>", \
    "mail.smtp.auth": true, \
    "mail.smtp.host": "<HOST>", \
    "mail.smtp.port": 25, \
    "mail.smtp.starttls.enable": true, \
    "mail.user": "<USER>" }'