1. Understanding Reports

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

Reports are components like modules, each user having access to the Gallery and all administrators can create their own report with the available widgets and only administrators could add them to the Gallery. Once added to the Gallery, reports could be used in creation of roles or used by other administrators.

When the user creates a report, he automatically subscribes to this report. It means that he will receive it by email at the configured date.

When added to a role, if the report is mandatory, then users having this role subscribes to the report and can not unsubscribe to it. When it is not mandatory, the report is available in the Gallery and when the user add it to its Portal he subscribes to it.

All users have a special module called Reports, it is mandatory and can not be removed. This module contains two dashboards with one widget on each

• My reports gives access to the widget of Management of user reports

• Archives gives access to the widget of Archives of user reports

  
  

Administrators have an additional widget in the Administration module. This widget permits to manage reports in the Gallery.

2. Manage User reports

Each user has access to this widget. It is located in the Reports module in My reports dashboard.

It permits to see all subscribed reports and manage them. For users having the right, new personal report could be created from this widget.

In the above capture, there is three reports.

• The first one has been added from the Gallery. This information is given by the Role column, the name of the role including this report is displayed. It can be unlocked which transform it in a personal report, as it has been created by the user.

• The second one has been created by the user itself, the role display the keyword personal and he can edit it or remove it. When a report is removed then it will be not sent anymore

• The third one is mandatory for this user. The role is displayed in bold, it means that he can not unlock it. It means also that it can not be unsubscribed

For every reports, it is possible to download or send a preview. This is called a preview since each report has a scope and until the scope is not completed then the data are not reliable. For example, if a monthly report is download the 10th of the month then data represented correspond to the first 10 days but not to the whole month.

2.1. Create

To create a new report the user should have the right to access the Gallery.

1. Click on the icon

2. Enter a Name

3. Select the period covered by the report. It means that data in the report will correspond to a fixed time window, if month is selected then the report will contains data for January, February etc.. The report is always generated at the end of the period

4. Select when the report should be sent. It depends on the period but has no influence on the data. A weekly report is always generated on Sunday, if the send date is Saturday then received report will contain data from the previous week.

   • Day: no configuration, report is sent each day
   • Week: select the day of the week the report will be sent
   • Month: select the day of the month OR a relative day in the month
   • Quarter: select the day in the first month of the quarter OR a relative day in the four first weeks of the quarter
   • Year: select the day of the year.

   
   

The second step permits to construct the content. The left part is the table of contents and the right part is the configuration panel.

To add new element, use the add menu.

• 
  

• chapter is the highest level available. It will be added after the current chapter or create a new one if no chapter exists
• section is the second level available. It will be added at the end of the current chapter
• widget is added at the end of the selected level
• import content from module permits to use elements of an existing module as report content. In this case, sections of module become the chapters and the dashboard are the sections

A section could be added without an existing chapter and a widget does not need a section or a chapter. But if one of them exist then it will be added as content of the level.

It is not necessary to add element in the correct order, they can be organized using the move up and down arrows. Movement will be applied on the selected element.

• chapter and section will move their entire content
• chapter can move only before of after an existing chapter
• section can move before of after existing section in a chapter, but it can also be moved out of chapter to add it in another one
• widget can move everywhere, it permits to change the parent of widget. By moving in the correct place the structure could be modified.

Example of movements.

• 
  

• Create the Night and P2P sections

• Move Applications with nightly activity under the Night section and same for P2P

• Now widgets are related to the section and not to the chapterMove Activity chapter to place it above the first chapter

Elements could be removed by clicking on the . Chapter and sections could be removed alone or with their content.

If the chapter is removed alone then its content will be attached to the previous chapter

If the section is removed alone then its content will be attached to the previous section or to its parent if there is no section

2.1.1. Configuration

When an element is selected, its configuration options are displayed on the right. For chapter and sections, the only configuration is the name of the element.

For widgets, the configuration depends on the type of widget and its configuration. By default the configuration of widgets aims to reduce information displayed in the report.

• Activity

  
  At least the overall chart or the inventory table should be displayed.

  • Display overall trend include or not the main trend chart

  • Display table include or not the main table

  • Display all tuples when a breakdown is configured, display all combinations or restrict to overall

  • Display all keywords when results are grouped by a category, display all keywords or only the overall

  • Sort sort the table by keywords (or tuples if no keywords) or by the overall value

  
  

• Inventory

  
  At least the overall chart or the inventory table should be displayed.

  • Display overall trend include or not the main trend chart

  • Display inventory table include or not the main table

  • Display all tuples when the widget uses some fields to sum the results, display all combinations or restrict to overall

  • Display all keywords when results are grouped by a category, display all keywords or only the overall

  • Display group as permits to select if keywords should be displayed as columns or as rows (available only if both tuples and keywords are all displayed)

  • Sort permits to sort the table by tuples (or keywords, depends on display) or by the overall value

  • Display in percent display values in ratio of a reference, options are the same as available in the widget

  • Attach details join a csv file of the details for the overall cell

  
  

• Issues

  
  At least the overall chart or the inventory table should be displayed.

  • Display overall issues include or not the main trend chart

  • Display issues include or not each issue

  • Display only overall keyword when results are grouped by a category, display all keywords or only the overall

  • Attach details join a csv file of the details for each issue

  
  

• List

  • Attach details join a csv file of the table displayed in report

  
  

• Service

  • Display impacted users as select if values should be displayed in absolute value or in ratio of total number of users of the service

  • Overall include or not the main trend chart

  • Display nodes of my level when results are grouped by hierarchies, display or not the nodes corresponding to the view domain of the user or the whole subtree corresponding to the view domain

  
  

• Software metering

  • Sort by one of the column of table, choices are level name (when grouped by hierarchies), number of installations, purchased licenses, compliance and number of underused

  • Attach details join a csv file of the installed sources for each software

  
  

• SLA

  
  There is no configuration for this widget

• Note

  
  There is no configuration for this widget

2.2. Other actions

• Unlock is available for non mandatory reports added from the Gallery. It permits to unsubscribe by removing the report

• Edit the configuration of the report

• Remove a report unlocked will remove the local copy and unsubscribe to the report. For a local module it implies that the report will not exist anymore

• Send a preview of the report to the email address of the user. Attached details are included in the email.

• Download a preview of the report. Only the PDF file is downloaded.

Note that send and download gives preview of the report. It means that the period covered by the report is not complete and data can be different than final result.

3. Manage Gallery reports

This widget is available for administrators. It permits to manage reports available in the Gallery.

3.1. Add a widget to the Gallery

• Click on the add button
• Select the local report in the list
• (Optional) replace the name
• Select or create a category
• Enter a description
• Click on OK

  
  

3.2. Other actions

• Edit an existing report or replace it by another local report

• Remove from the Gallery. It could have an impact on other users, if they have subscribed to it then they will not receive it anymore

• Send and Download are similar than in user reports management. It gives access to preview of the report

4. Reports archives

The reports archives widget gives access to all reports generated, sent or not for the user. Filters are available to reduce the list to a particular period or gives all references for a particular report.

For each report

• Send the report and the details to the email address of the user. In archives there are only completed period, it means that the data are valid for the given period

• Download the report and if available the details. Each icon correspond to a part of the report, the PDF and the details

5. 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>" }'