How do I build a Time Series Chart report?

To build a Time Series Chart report

The Time Series Chart report builder allows you to build reports that include time series charts. These show you the history of metrics over the reporting period. You can set two different time periods for comparison purposes.

This report includes one chart on which you can plot a maximum of eight metrics. These metrics can be selected from:

• a single managed object using different attributes.
• eight different managed objects using the same attribute.
• multiple managed objects and attributes.

To build a Time Series Chart report:

1. In the Main Menu, click Reports. This will open the Reports page.
2. Click Report Builder in the bottom left of the browser. This will open the Report Builder page.
3. Click Time series chart. This will open the Report Builder - Single Chart page. There are two sections to building a Time Series Chart report:

1. Report options:

1. Enter a name for the report in the Name field.
2. Enter a title for the report in the Report title field.
3. Enter a title to be displayed on the chart in the Chart title field.
   Once you have selected an attribute or attributes (see 2. Adding attributes below), you can quickly select a placeholder name from the selected attribute(s) via the red text Click to insert attributes here.
   
   Use the Click to insert attributes here placeholder to quickly enter titles for charts without having to manually type them.
4. Click Report Options + for further options:
   1. Enter a URL for your report in the Report URL field. Every report is assigend a default URL when it is created. If you enter a new URL for an existing report, then a copy of that existing URL is made. Note, any new URL you enter must be unique - if you enter a URL that is already assigned to a report, then that existing report will be overwritten.
      • You can click Browse next to the Report URL field and select the directory or folder in which you want to save your report, or you can create a new folder in which to save it.
   2. Keep the Navigation Framework box checked if you want to include the navigation framework available for reports generated in HTML. The navigation framework allows users to scroll through reports, return to the reports listing, and generate the report in another format.
   3. Keep the Charts Legend box checked if you want to include the chart to have an accompanying legend.
   4. Keep the Row Count box checked if you want to include the report to have an accompanying row count in the header. Note, this does not apply to chart reports.
   5. Specify the page width of the HTML report in the Page Width field. By default, this is 612 pixels.
   6. Specify the margin widths in the Margins fields. The defaults are Left 30px, Right 18px, Top20px, Bottom 20px.
5. Check the Include Standard Header box to select the standard components to include in the report's header:
   • Report Period.
   • Prime Time.
   • Print Time.
   • Logo.
   • Description. Entuity recommends that you make use of the Description field to help others maintain the system at a later date.
6. Specify the default time frame for the chart in the Primary time frame fields. This represents the overall reporting period that the report covers.
7. Select and specify the secondary time frame for the chart when comparing metrics over different time frames in the Secondary time frame fields.
8. Specify the time within the overall reporting period for which the report is applicable in the Prime Timefields, e.g. between 09:00 and 17:00 each day.

2. Adding attributes

There are 3 ways in which to add attributes:

• via the Find Attributes window.
• via Import from Drop Box.
• dragging attributes in.

• via Find Attributes window:
  1. Click the entry in the Value field (to start with, this will be 'None').
     
     
     
     
  2. This will open the Timeseries Attribute Selection window.
     
     
     
     
  3. Click Find Attributes to open the Find Attributes window.
  4. Expand the Browse For Objects section, and select the device and/or attribute that you want to display in the chart.
     
     
     
     
• via Import from Drop Box:
  
  • Click Import from Drop Box in the top right of the browser window. This will populate the attribute fields with the contents of the currently selected Drop Box list.
    
    
    
    
• by dragging attributes in:
  • Drag in the attributes you want to include on the chart into the Drag Attributes Below To Add fields.
    
    
    
    
  • You can drag into the fields attributes from an another tab, another browser, or from the open Drop Box form. Any time series metric can be dragged in, from multiple different components, and of different types of attribute.
  • Click on the attribute's name in the Value column to access the Timeseries Attribute Selection window, from where you can quickly access further attributes from the device in question via the Find Attributes window, in the same way as described above. Selecting these attributes will automatically populate the next empty field.

Once you have selected your attributes, you can arrange the chart.

1. Use the up and down arrows on the left to change the attribute order.
   
   
   
   
2. Check the box in the Show column to show the attribute on the chart.
   
   
   
   
3. Select the format you want to use for the data by clicking on the entry in the Display Type column. A list of possible types will appear. The default is Auto.
   
   
   
   
4. Select the line color you want for this attribute on the chart in the Line Color column.
   
   
   
   
5. Specify the Y-axis for your chart in the Y-axis column.
   
   
   
   
6. Specify the chart height in pixels in the Chart Height field. The default is 240px.
   
   
   
   
7. Specify the chart style in the Chart Style dropdown field, either Line or Stacked Area.
   
   
   
   
8. Click Preview to preview the report or Publish to publish the report to the User Defined Reports folder. If you tick the Show Advanced Options box in the top right of the page, you will also have the option to Copy Report URL to your clipboard.

3. Share report with users in the user groups to which you belong

By default, this section is hidden and set to 'Default', which refers to your global permissioning default. However, you can specify whether other users in your user groups can have access.

IMPORTANT NOTE: users must be very careful when granting report access to other users. Please read this section before sharing reports.

1. Click Sharing Options+ (below Show Advanced Options in the top right of the page) to expand the Group Access window.
2. This window lists the user groups to which you belong. For each user group, specify the level of access the users in that group have to this report. By default, the report is visible only to you.
3. Select from one of the following options:
   • Default - global permissioning default.
   • No Access - users in this user group have no access to this report (unless they are members of another user group with permission).
   • View - members of the user group can view generated reports.
   • View and Run - members of the user group can run and view generated reports.
   • View, Run and Schedule - members of the user group can schedule, run and view generated reports.
   • View, Run, Schedule and Edit - members of the user group can schedule, run, view and edit generated reports.