Reports
Reports is a standard configuration interface for reports within Unified Assurance. This is also where Administrators can change report configuration information.
Refer to the Standard Configuration Interface guide for details on interacting with the grid and form.
This user interface calls REST methods from api/report/reports.
The UI path for this interface is Configuration -> Reports -> Reports.
Form Fields
-
Name - The title to identify the report at a glance.
-
Append Date Time - A flag to indicate if the date and time should be added to the report name.
-
Profile - The generic configuration profile to use for the report.
-
Dashboard - Basis for the report output.
-
Dashboard Parameters - The variables the portal needs in order to render properly such as DeviceID or MetricID.
-
Email Recipients - Email addresses the report notification should be sent to when the report is run.
-
Footer - Determine what extra information is added to the end of the report. None indicates no information. Basic will add the date, time, and user the report was run as. Enhanced adds any parameters that were used to create the report to the Basic footer.
-
Render Timeout - The number of seconds to allow the report to render before capturing the results for the report.
-
Status - The state of the report.
-
Run as
-
User Group - The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.
-
User - The Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.
-
-
User Owner - The user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user.
-
Group Owner - The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.
-
Viewers - The user groups that will also have access to the report.
-
Presets - Several common times that reports are needed have been set as presets. These can be used to automatically fill in the fields below, or a custom time can be configured.
-
Minutes - The minutes when the report will be run. Valid entries are "*" which means every minute, numbers between 0 and 59 to run at that minute, or "*/
" can be used to indicate "Every number of minutes". Refer to the Configuring Scheduled Report Times section for additional information. -
Hours - The hours when the report will be run. Valid entries are "*" which means every hour, numbers between 0 and 23 to run at that hour, or "*/
" can be used to indicate "Every number of hours". Refer to the Configuring Scheduled Report Times section for additional information. -
Days - The day of the month when the report will be run. Valid entries are "*" which means every day, numbers between 1 and 31 to run on that day of the month, or "*/
" can be used to indicate "Every number of days". Refer to the Configuring Scheduled Report Times section for additional information. -
Months - The month when the report will be run. Valid entries are "*" which means every month, numbers between 1 and 12 to run at that minute, or "*/
" can be used to indicate "Every number of months". Refer to the Configuring Scheduled Report Times section for additional information. -
WeekDays - The day of the week when the report will be run. Valid entries are "*" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or "*/
" can be used to indicate "Every number of days". Refer to the Configuring Scheduled Report Times section for additional information.
Configuring Scheduled Report Times
Reports use a cron-like syntax to determine when the report is run. The scheduled time definition has a field for Minutes, Hours, Days, Months, and Days of Week. Each of these fields can be set to one or more literal value in a comma-separated list, or "*" which is interpreted as Every. The report runs when the current time elements match the report's scheduled time elements.
At its simplest, with every time period set to "*" (every), the report will be run every minute, because the current time will always match the report's scheduled time.
However, imagine every time period is set to "*" (every) except Minutes, which are set only to 30. In this case, the current time will match the scheduled time and the application will be run once every hour, at x:30.
It is possible to be overly complex, creating time criteria that very seldom match. Imagine a report with time criteria set to Minutes="*", Hours="*", Days=26, Months=1, and WeekDay=1. That report will not run until January 26, 2026 which is the next time since 2015 that January 26th will be on a Monday.
Best Practice
- Create the report directly from the dashboard via the dashboard tools in the header. This will automatically fill-in as many fields as possible.