Reports
Reports is a standard configuration interface for reports within Oracle Communications Unified Assurance. This is also where administrators can change report configuration information.
For information about interacting with the grid and form, see Standard Configuration Interface in Unified Assurance Concepts.
This user interface calls REST methods from the api/report/reports endpoints. See REST API for Unified Assurance Core for details.
To open this interface, from the main navigation menu, select Configuration, then Reports, and then Reports.
Form Fields
-
Name: The title to identify the report at a glance.
-
Append Date Time: Whether or not to append the date and time to the report name.
-
Profile: The generic configuration profile to use for the report.
-
Dashboard: The dashboard to base the report output on.
-
Dashboard Parameters: The variables the dashboard needs in order to render properly, such as DeviceID or MetricID.
-
Email Recipients: The email addresses the report notification should be sent to when the report is run.
-
Footer: The type of extra information added to the end of the report. Options are:
-
None: No information.
-
Basic: Adds the date, time, and user the report was run as.
-
Enhanced: Adds the basic footer, and parameters that were used to create the report.
-
-
Render Timeout: The number of seconds to allow the report to render before capturing the results for the report.
Note:
For All Metrics Overview dashboards, to ensure that data cells include metric values, add ExcludeMetricValues=0 to Dashboard Parameters.
-
Email Recipients - Email addresses the report notification should be sent to when the report is run.
-
Run as: The user or group to run the report.
-
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 the associated report 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.
-
Schedule: When you select the time fields, menus appear where you can select values. You can alternatively enter the values manually. The menus and field values are updated to match each other as you change them. See Configuring Scheduled Report Times for more information and examples of how the time fields interact.
-
Presets: Includes several common times that reports are needed. Selecting these automatically fills in the time fields.
-
Minutes: The minutes when the report will run. Valid values are:
-
*: Run every minute.
-
A list of comma-separated numbers from 0 to 59: Run at the specified minutes.
-
*/N: Run every N minutes, where N is a number from 0 to 59. For example, set it to */5 to run every five minutes.
-
-
Hours: The hours when the report will run. Valid values are:
-
*: Run every hour.
-
A list of comma-separated numbers from 0 to 23: Run at the specified hours.
-
*/N: Run every N hours, where N is a number from 0 to 23.
-
-
Days: The day of the month when the report will run. Valid values are:
-
*: Run every day.
-
A list of comma-separated numbers from 1 to 31: Run on the specified days.
-
*/N: Run every N days, where N is a number from 1 to 31.
-
-
Months: The month when the report will run. Valid values are:
-
*: Run every month.
-
A list of comma-separated numbers from 1 to 12: Run on the specified months.
-
*/N: Run every N months, where N is a number from 1 to 12.
-
-
WeekDays: The day of the week when the report will run. Valid values are:
-
*: Run every day of the week.
-
A list of comma-separated numbers from 0 to 7: Run on the specified days of the week. Use 0 or 7 for Sunday, 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, and 6 for Saturday.
-
*/N: Run every N days of the week, where N is a number from 0 to 7.
-
-
For details about User Owner, Group Owner and Viewers, see Configuring Ownership and Viewer Access in Unified Assurance Security Guide.
Configuring Scheduled Report Times
Reports use a cron-like syntax to determine when the report is run. The scheduled time definition has fields for minutes, hours, days, months, and days of the week. You can set each of these fields to one or more literal values 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.
For example:
-
Set all time periods to * (every). The report runs every minute, because the current time will always match the report's scheduled time.
-
Set Minutes to 30 and all other time period to * (every). The current time will match the scheduled time once every hour, at thirty minutes past the hour. The report runs once every hour, at 1:30, 2:30, 3:30, and so on.
-
Set Minutes to 59, Hours to 23, Days to 7, and Months and WeekDays to *. The report runs at 23:59 on the 7th of every month, regardless of the day of the week the 7th falls on.
-
Avoid creating overly-complex schedules with time criteria that very seldom match. For example, by setting Minutes to *, Hours to *, Days to 26, Months to 1, and WeekDay to 1, the report will only run when January 26 falls on a Monday. This means it would have run on January 26, 2015, and then not again until January 26, 2026.