Skip to main content

Reporting - How to configure and view a Report

  • Updated

Overview

Before a Report can be viewed, it must be configured first. The scope of Report configuration includes specifying general report properties and defining a layout for a Report.

Workflow to configure and view a Report

 
# Step Description Screenshot

1

Add a New Report:

1.1

Add a New Report from scratch

  1. Go to Reporting > Overview

  2. Click on ‘Add New’
1.1.png

2

Configure Report Properties

2.1

Specify a Customer

a Report will fetch the data of the selected Customer
2.1.png

2.2

Specify Report Name

user-defined Report Name
2.2.png

2.3

Add Datasources for a Report

2.3.1

Click on ‘Add Datasource’

 

 

2.3.1.png

Adding a Data Source

2.3.2

Specify the Data Source Type

Specify one of the following Data Sources to pull data by a Report:

  1. Alarm History - the history of alarms for the Points specified

  2. Audit Logs -  the history of changes for any resource (only for Table widget)

  3. Current Value - the current (last known) Value of a Point

  4. Point History - historical Point Values

  5. Tags - Site/Equipment/Point Tags
2.3.2.png

2.3.3

Alarm History Data Source-specific settings

Specify filters to pull Alarm History data by a Report:

  1. Sites - a required field. A Report will pull alarms related to the selected Site’s Points.

  2. Equipment - an optional field. a Report will pull alarms related to the selected Equipment’s Points.

  3. Points - a Report will pull alarms related to the selected Points

  4. Dates - a time range to pull alarms that is counted from the moment a Report is received.

 2.3.3.png

2.3.4

Audit Logs Data Source-specific settings

Specify filters to pull Audit Logs data by a Report:

  1. Audit Log Resource - app chapter to get log records

  2. Audit Log Action - optional field. A Report will pull logs with the selected action.

  3. Sites - a required field. A Report will pull logs related to the selected Site’s Points.

  4. Equipment - an optional field. a Report will pull logs related to the selected Equipment’s Points.

  5. Points - a Report will pull logs related to the selected Points

  6. Dates - a time range to pull logs that is counted from the moment a Report is received.

 2.3.4.png

2.3.5

Current Value Data Source-specific settings

Specify Site>Equipment>Point path to pull Current Value of the specific Point(s) by a Report:

  1. Sites - a required field. The sites containing Equipment to which Point(s) of interest are related

  2. Equipment - a required field. The equipment to which Point(s) of interest are related

  3. Points - a required field. Point(s) of interest which Current Values have to be pulled by a Report.

 2.3.5.png

2.3.6

Point History Data Source-specific settings

Specify Site>Equipment>Point path and a Time Frame to pull Historical Value of the specific Point(s) by a Report:

  1. Sites - a required field. The sites containing Equipment to which Point(s) of interest are related

  2. Equipment - a required field. The equipment to which Point(s) of interest are related

  3. Points - a required field. Point(s) of interest which Current Values have to be pulled by a Report.

  4. Dates - a time range to pull historical point data that is counted from the moment a Report is received.

  5. Interpolate - if enabled, estimates values between known historical point data to fill gaps in that data if there’re any

  6. Interpolate Frequency (in seconds) - a frequency to apply Interpolate function

 2.3.6.png

2.3.7

Tags Data Source-specific settings

Specify entities to pull its Tags values by a Report:

  1. Tags for - specify an Entity type to pull its Tags values by a Report

  2. Sites - a required field. The sites containing Equipment to which Tag(s) of interest are related

  3. Equipment - a required field. The equipment to which Tag(s) of interest are related

  4. Points - a required field. The points to which Tag(s) of interest are related

 2.3.7.png

2.4

Specify Report Delivery Preferences

2.4.1

Frequency

Specify the frequency of Report delivery:

  1. Hourly

  2. Daily

  3. Weekly (requires additional property to be specified - Day of Week)

  4. Monthly (requires additional property to be specified - Day of Month from 1 to 31)

  5. Yearly (requires additional property to be specified - Month)

2.4.1.png 

2.4.2

Time

Specify Time to send a Report in AM/PM format

2.4.2.png

2.4.3

Timezone

Specify the required Timezone

2.4.3.png

2.4.4

Recipients

Specify either Turntide Account’s First Name + Last Name whose email will be used to send a Report OR custom email address. Multiple recipients can be specified.
2.4.4.png 

2.5

Save a Report

2.5.1

Save Report configuration made

Click on ‘Save’
2.5.1.png

2.6

Define Report Layout

2.6.1

Go to Report Builder

  1. Select the created Report

  2. Click on ‘Edit’
2.6.1.png

 

2.6.2

Add, arrange and configure Widgets

  1. Add Widgets on the Canvas

  2. Place widgets at the required positions

  3. Select a Widget

  4. Go to ‘Properties’ Tab

  5. Make the necessary adjustments
2.6.2.png

 

2.6.3

(Optional) Preview Report to evaluate look&feel of the Report

  1. Click on ‘Preview’

  2. Evaluate look&feel of the Report

  3. Click on ‘Close Preview’
2.6.2__1_.png2.6.3__2_.png

2.6.4

(Optional) Debug a Report to evaluate data-related aspects, find out the root-cause of potential issues with the data

  1. Click on ‘Debug’

  2. Click on a Widget

  3. Inspect data

  4. Click on ‘Close Preview'
2.6.4_1_.png
2.6.4_2_.png
2.6.4_3_.png

 

2.6.5

Save Report Layout

Click on ‘Save’

 2.6.5.png

2.7

View a Report

2.7.1

View a Report

  1. Ensure that the time to send the Report has come (see step #2.4 Specify Report Delivery Preferences)

  2. Go to the Report Recipient’s Mailbox specified at step #2.4.3 Recipients

  3. View a Report

    1. Report Preview

    2. Attachments

      1. PDF version of the Report

      2. CSV File with Report data

 2.7.1.png

Related articles