Reporting - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help
Product
Building Automation Systems > Graphics and Interfaces > Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active

What is Reporting?

With the Reporting feature, you can create equipment and spaces reports on the Metasys objects listed in the search results of an Advanced Search.
Note: Objects can be mapped or unmapped.

Starting at Metasys Release 12.0, you can also run Base reports to query a single engine, multiple engines, or the entire site for alarm (objects that are currently in alarm), offline, disabled, operator override, supervisory override, trouble, and out of service conditions. Additionally, starting at Metasys Release 12.0.50, you can use Base reports to query the site director for user account information.

What is the layout of the Reporting feature?

The following figures and tables describe the layout of the Reporting feature.

Figure 1. Reporting feature with Base reports selected
Table 1. Reporting feature callouts
Number Name Description
1 Reports Access your reports through this primary Reporting feature tab.
2 Base Access Base reports through this secondary Reporting feature tab. Run base reports for network items to query a single engine, multiple engines, or the entire site for alarm (objects that are currently in alarm), offline, disabled, operator override, supervisory override, trouble, and out of service conditions. Run the User Account base report to query the site director for user account information.
3 Saved From Search Access the reports that were saved from the search results through this secondary Reporting feature tab. This tab displays only if you have the Schedule Reports permission. Refer to Figure 1 for example content in the Saved From Search tab.
Table 2. Base reports callouts
Number Name
4 Select Report Type
5 Run Report On
6 Report results heading
7 Offline devices notification
8 Report detail columns
Figure 2. Saved From Search reports
Table 3. Saved From Search reports callouts
Number Name Description
1 Report Name Shows the name of the report.
2 Created By Shows the creator of the report.
Note: This column only appears for administrators who can see all scheduled reports at a site. Non-administrator users can only see their own reports in this window.
3 Created On Shows when the report was created.
4 Last Modified By Shows the person who last modified the report.
Note: Administrator and non-administrator users can see who modified a report.
5 Last Run Shows the last time when the report was sent. The Last Run time can deviate from the scheduled time, as the report generation can take some time. If an error occurs during report generation or delivery, an execution error message appears in this column.
6 Next Run

Shows the time for the next run.

Note: When you have non-scheduled reports, — appears in this column. When the report is disabled, this column shows Disabled.
7 Repeat

Shows how often the report is repeated.

Note: When you have non-scheduled reports, — appears in this column.
8 Actions You can edit reports, enable or disable reports, re-run a report with the previously selected delivery option, or delete your scheduled reports here.

What do the icons in the Saved From Search tab represent?

The following table describes the icons that you see in the Saved From Search tab.

Table 4. Saved From Search tab icons
Icon Icon name Description
Edit Edit a report.
Enable/Disable switch Click on the switch to enable or disable an individual report.
Re-run Re-run a report with the previously selected delivery option.
Delete Delete a report.

What are the prerequisites for scheduling a report?

You can access the Schedule Report feature only, if you have the Schedule Reports system privilege. You can assign this system privilege to users in the User Management feature. For more information about assigning a system privilege see How do I edit a user? What are my edit options? in User Management.

Before you can schedule a report, configure your email settings in the Remote Notifications feature of Metasys UI. See How do I change the settings in the Remote Notifications feature? in Remote Notifications for more information. Only Simple Mail Transfer Protocol (SMTP) type email settings are supported. POP Before SMTP type email settings are not supported for the Schedule Report feature.

Note: If the file size of the generated report exceeds the email server limit, which is by default 20MB, the report generation is successful, but the email delivery of the Scheduled Report may fail.

How do I create a report?

  1. Select the Advanced Search results that you want to include in the report.
  2. Click ACTIONS.
  3. Select Create Report. The Create Report window opens.
  4. Select the report type, date range, and format you require from the respective drop-down menus.
  5. From the Repeat drop-down menu, select how often and when you want to receive the report, and select an end for the report schedule.
  6. In the Delivery section, choose Download immediately. See How can I schedule a report? for more information about sending a report by email or to a network location.
  7. Enter a name in the Report Name field.
    Note: The Report Name field accepts up to 100 characters. All alphanumeric and special characters are allowed, except the following /,\, ?, :, *, ?, ", <, >, |.
  8. Click CREATE.

How can I schedule a report?

You can schedule reports through Advanced Search to receive reports regularly by email or on your network drive, without logging into the system each time to create the report.

To schedule a report, complete the following steps:

  1. Select the Advanced Search results that you want to include in the report.
  2. Click ACTIONS.
  3. Select Create Report. The Create Report window opens.
  4. Select the Report Type, Date Range, and Format. Then choose your preferred delivery method.
  5. From the Repeat drop-down menu select how often and when you want to receive the report, and then select an end for the report schedule.
  6. Click Download immediately or Send to. When you select Send to, you have two options:
    • If you select Email Address, enter the email address to which you want to send the report.
      Note: You can enter a maximum of 10 email addresses. Type the email addresses in the Email Address field, and separate the addresses with a comma or semicolon.
    • If you select Network Location, enter the network path on which you want to save the report. Use the following format: \\server_name\shared_folder_name. You can get the network path from the shared folder's properties. Then click TEST CONNECTION to test if the location is accessible to the feature. See also How do I make a network location accessible to the Reporting feature?
      Note: The Metasys server and the network path on which you want to save the report have to be on the same domain network.
  7. Enter a name in the Report Name field.
    Note: The Report Name field accepts up to 100 characters. All alphanumeric and special characters are allowed, except the following /,\, ?, :, *, ?, ", <, >, |.
  8. To save the selected report options as a template, select the Save as Report Template check box and enter a name in the Report Name field.
  9. Click CREATE.

How do I make a network location accessible to the Reporting feature?

  1. Create a folder on the network.
  2. Configure Sharing for the folder to share with Everyone.
  3. Set the Permission Level for Everyone to Read/Write.

What types of reports can I create?

In the Create Report window, you can select the following report types:
  • Activity: A time line report of all alarms and audits.
  • Alarm: A report by occurrence for all alarms in the requested time frame.
  • Audit: All audit entries from the requested time frame.
  • Trend: All historical data from the requested time frame.
  • Present Value: A report that shows the present values of the selected objects.

You can generate these reports in a .csv file format or in a .pdf file format. You can also use the Reporting feature to schedule and receive these reports regularly by email. See How can I schedule a report?

Note:
  • All reports are limited to a maximum of 10,000 records, with the following exceptions:
    Table 5. Report limitations
    Report type Limit
    Present Value 2,000 values
    Trend PDF 75,000 trend samples
    Note: 75,000 is the overall number of samples that can export to PDF. As each object can display 600 trend samples, the trend data from 125 objects is the maximum limit.
    Trend CSV 2,100,000 trend samples
    Note: Exceeding these limitations may result in a failure to create a report or lead to an incomplete report. Reduce the number of points or time frame requested to ensure that you run reports within their limitations.
  • The retrieval of data for the Trend reports varies, depending on the duration of the report. For raw data duration, data for the Trend reports is fetched from the network engines and from the JCIHistorian database. When viewing raw data, the Metasys UI supports the display of 105,000 samples per trend point. Raw data appears if the duration is less than or equal to seven days. For a duration greater than seven days, the trend chart displays average data.
  • If you are not authorized to access certain objects, the reports you generate do not display the data pertaining to these objects.
  • The reports, email notifications, and time formats are automatically localized, based on the locale of the user who created the report configuration. The recipients also receive the reports based on the locale of the user who created the report configuration.

What date range options do I have?

You can select a date range from the following options:

The examples are based on the assumption that today's date is September 28, 2017 and it is 17:00.
  • Yesterday: The report contains data from September 27 00:00 to September 27 23:59.
  • Today: The report contains data from September 28 00:00 to September 28 17:00.
  • Last 7 Days: The report contains data from September 22 00:00 to September 28 17:00.
  • Last Week: The report contains data from September 18 00:00 to September 24 23:59.
  • This Week: The report contains data from September 25 00:00 to September 28 17:00.
  • Last 30 Days: The report contains data from August 30 00:00 to September 28 17:00.
  • Last Month: The report contains data from August 01 00:00 to August 31 23:59.
  • This Month: The report contains data from September 01 00:00 to September 28 17:00.
  • Last Year: The report contains data from January 01, 2016 00:00 to December 31, 2016 23:59.
  • All Time: The report contains data available from the very beginning to September 28, 2017 17:00.This Year: The report contains data from January 01, 2017 00:00 to September 28, 2017 17:00.
  • Custom Range (To-From Date and Time): The report contains data from selected date range including time.
Note: The Metasys server time zone forms the basis for the time zone of the report.

What repeat options are available for reports?

  • Never: Report never repeats (default).
  • Daily: You provide the run time of the report through the time picker (default time 12:00 AM).
  • Weekly: You provide the day of the week and time of running the report (default value is the first day of the week and the default time is 00:00 or 12:00 AM).
  • Monthly: You provide the first day, last day, or any particular day of the month (it is the first day by default).
  • Yearly: You provide the month of the year (January by default) and the day of the month (it is the first day by default).

How do I localize a report?

You can localize the Reporting feature, so that the report data, time format, and email correspondence displays in your own language.

The locale of the Metasys user forms the basis for the generated reports. You can set the locale of the user when you create the user account in the Metasys system. For more information, refer to the Security Administrator System Technical Bulletin (LIT-1201528).

How can I check my reports?

  1. Open the User menu.
  2. Click Advanced Search & Reporting.
  3. Click the Reports tab.
  4. Click Saved From Search.

How can I edit a report?

Note: Metasys administrators may edit any report. Non-administrators may edit only the reports they created.
  1. Open the User menu.
  2. Click Advanced Search & Reporting.
  3. Click the Reports tab.
  4. Click the Saved From Search tab.
  5. Click the edit icon in the Actions column next to the report you want to edit.
  6. Select or clear the options in the Report Options tab.
    Note: You can edit all report options.
  7. Click the Selected Objects tab and click the edit icon to edit your selected objects.
  8. The Advanced Search page opens and you can change your previously selected filters and objects.
    Note: You cannot use the Actions menu in this view of the Advanced Search page to run Bulk Command, Bulk Modify or Create Report.
  9. Select Cancel or Save to cancel or apply the changes.
Note: There may be some impact on performance while you edit the selected objects in Advanced Search, as editing a large number of objects may cause a throttled process to happen on the Metasys UI API.

How can I re-run a report?

  1. Open the User menu.
  2. Click Advanced Search & Reporting.
  3. Click the Reports tab.
  4. Click the Saved From Search tab.
  5. Click the re-run icon in the Actions column next to the report you want to re-run.
  6. If required, change the email address and the report name in the Re-Run dialog window.
    Note: These changes only affect this particular re-run, and do not affect the report configuration in general.

How do I run a base report?

  1. Open the User menu.
  2. Click Advanced Search & Reporting.
  3. Click the Reports tab.
  4. Click the Base tab.
  5. Select the required report type from the Select Report Type list.
  6. For the User Account report type, select SITE DIRECTOR to run the report. For all other report types, to run the report on the entire site, select ENTIRE SITE. To run the report on one or more specific devices, select SPECIFIC DEVICE(S), select the required devices in the Select Device(s) window, and click RUN.
    Note: The report completion time is proportional to the number of devices selected.