Calculations & Operations Columns

The Report Studio is still under development and has not officially been released. Be warned that code may change such that reports you create with this pre-release trial version might need to be updated in order to continue working after your next VTScada update.

Until the official release, documentation for the Report Studio will open in response to the F1 key but will not be shown in the menu system. To view a table of contents for the complete chapter, navigate to The Report Studio

The Report Studio Calculations data set will perform operations using other data sets in your report, constants or parameters. There are three categories: consolidation, summarization and basic operations. The properties panel will change as you go, adding and removing fields depending on the options you have selected.

To configure your Calculations data set, you may first need to configure other data sets, such as a tag query data set, to bring in values to reference and you may need to add or manage report parameters. As data sets and parameters are added to your report, they become options in your Calculations data cell properties.

About Operations

What are the options and what do they do?

Consolidation →

Consolidation is a means to combine multiple columns into a single column. This works on a per row basis.

Think of a Tag Query data set that returns 4 tags. It displays four columns of data. Each Consolidation-type calculation adds an additional column with a value consolidated from those 4 values.

There are several consolidation types:

Total - The sum of all the values in the row
Minimum - The lowest of all the values in the row
Maximum - The highest of all the values in the row
Average - All the values in the row added together and divided by the number of values.
Median - The middle value of all the values sorted by size.
Range - The highest value minus the smallest value in the row.
Standard Deviation - How much the values of the set deviate from the average.
Count - Counts how many columns with valid entries are in the set.

This example includes one of each of the available consolidation types. A row of equipment values from a Tag Query are highlighted in yellow. Because I added 8 calculations, there are eight additional columns displaying values calculated from the four pump values of the same row.

Summarization ↓

Summarization is a means to combine a column of data into a single value to display in additional columns. This operation works on a per column basis.

Think of a Tag Query data set that returns 4 tags. It displays four columns of data. Summarization takes all the values from a whole column and applies a calculation. The result is displayed in four columns (one output column per input column) with the value repeated for each cell .

This example includes one summarization calculation. There are four additional columns. One column for each Tag Query value. The result of the calculation repeats in every row of the column.

Generally, a summarization calculation data set is used as input to another calculation.
You can display it in a report (as in this example) but you may find a summary row more suitable for report display purposes.]

There are several summarization types:

Total - The sum of all the values in the column
Minimum - The lowest of all the values in the column
Maximum - The highest of all the values in the column
Average - All the values in the column added together and divided by the number of values.
Median - The middle value of all the values sorted by size.
Range - The highest value minus the smallest value in the column.
Standard Deviation - How much the values of the set deviate from the average.
Count - Counts how many rows (with valid entries) are in the column.

Basic Operations

Math functions you may want to apply to data in your report. For example, use a calculation data set to add a column to show a percentage or a unit conversion.

In this report, calculation data sets are used to convert imperial values to metric.

Possible operations include:

Add - Add a value with another value ( + )
Subtract - Subtract a value with another value ( - )
Multiply - Multiple a value with another value ( * )
Divide - Divide a value by another value ( / )
Modulus - Divide one value with another and return the remainder. ( % )
Exponent - Raise the first value to the power of the second. ( Pow )

Setup for Calculation configuration

Calculation drop lists are populated with data sets and parameters that are already configured in your report. It is recommended that you start with the other columns to be displayed in your report, data sets that query values to be used in your calculations, and add parameters if you want to include parameterized calculations in your report.

Creating a Calculation data set

To create a Calculation Data Set you have two options:

Add a column to the table component. Click the [+] that appears in the new Data Cell Properties pane.
Click the [+] on the bottom-left below the Data Set Manager.

Either of these options will present you with a New Data Set dialog. Choose a name and select "Calculation" as the type.

This is how the cell properties appear by default. As fields are configured, relevant settings will become available.

Calculation Data Cell Properties

Delete the column

Click the trash can icon in the header of the Data Cell Properties panel. Note that deleting the column removes it from the table but does not remove the Data Set definition.

Create or Select a Data Set

For every column you want to add to your report, you'll be making a Data Set. Data Sets may not always appear in reports. You can maintain a collection to easily swap values in and out of reports or reference Data Sets using other Data Sets.

You're likely to accumulate a lot of them, so it is a best practice to give them a descriptive name.

Click the [+] button to create a new Data Set or use the droplist to select an existing Calculation Data Set

To Rename, Copy or Delete a Data Set, access it's properties via the Data Set Manager.

Step A - When choosing Consolidate or Summarize

Operation - A drop list for specifying consolidate, summarize, or a basic math operation. If you choose "consolidate" or "summarize" the next two fields will be "Data" and either "Consolidation" or "Summary". As a quick reminder, consolidate works on a per row basis, and summarize works on a per column basis.

Data - A drop list of options populated by the Data Columns configured in other Data Sets within the report. As you add additional steps, the results of previous steps also become available as options.

Consolidation/Summary - Select the type. Total, Minimum, Maximum, Average, Median, Range, Standard Deviation, Count.

Step A - When choosing a basic math operation

Operation - Basic math operations include add, subtract, multiply, divide, modulus and exponent.

Selecting a math operation changes the latter two fields:

This configuration gives us Step A = Data 1 + Data 2.

Data 1/Data 2 - Change the input type by clicking the arrow next to the disc icon. Choose from Data Set, Constant or Parameter.

Click the plus button [ + ] under the step to add another step. Use the arrow buttons to change the order of the Steps. As you add additional steps, former step results become available as Data options. In Step C, for example, in the Data Set type droplist, you would see the available Data Sets and also Step A, Step B as options. The result of Step C will not be available to Step A.

Configure Column Settings

A column is added to "Data Columns" for each step you configure and displays in your report left-to-right in the same order they appear in the Data Columns list top-to-bottom. Use the arrows to change the order or use [ x ] to remove Steps that you do not wish to display in your report. Steps that are listed in Data Columns will become available in the Data drop lists of other Calculations data sets.

You cannot move a step above a step that references it. If you have steps A, B, C, D and use the result of B as an input in C, you will not be able to move C above B.

Summary Suppression

Summary Suppression is used when you have added a summary row to the table but the value doesn't make sense for this data set. For example, summing daily high temperature is not a helpful metric.

Another example of where you might use summary suppression is a pump report that includes a data column for flow characteristics, and a column for pump run time. The first Data Set might be summarized with a Range. The second might be summarized with a total. In this case, you would add two summary rows to your report and suppress them in the opposing data sets.

Using Calculations for multi-step math operations

Use a Calculation Data Set to perform basic math operations to convert units. In this example, we have an I/O and Calculations tag that reads the temperature in imperial units and we want to convert to metric units for a report.

With this Data Set configured, the result of Step B will also become available as an input option in other Calculation Data Sets.

Combining Operation and Data types

Let's say you have a report of the flow activity for a couple of pumps and you'd like to add an extra column displaying their combined output as a percentage of flow capacity.

The output might look something like this:

A basic table entitled "Flow Metrics 2026-01-23". It has four columns, Time, Pump 1, Pump 2, and % of Flow Capacity. There is a summary row displaying averages.

You have already configured:

The title from a text component
A formatted table component, with a configured Time per Record
A Time column, showing the time of each entry.
Using a Tag Query data set, you've included both pumps in your report.
The flow capacity is adjustable, so you've added and linked a tag-type parameter.
A summary row to show averages.

All you have left to do, is add an additional column and add and configure a Calculation data set.

Here is a complete example:

Pictured here is a report canvas with a table component. The final column is highlit and it's data cell properties are visible. They are descibred as follows:

Step A

For the first step, we want to get the total per row. The Operation for Step A is Consolidate. The previously configured Tag Query data set "Pump Flow.Average" is available in the Data droplist, and the Consolidation type will be "Total".

Step B

Next we want to determine what fraction of flow capacity was taken up at each time entry. This is a basic math operation, Divide. Data 1 is a Data Set type so we can select the result of the first step, and that is divided by whatever value is stored in our parameter "FlowCapacity".

Step C

Finally, to display the fraction as a percent, we need to multiply it by 100. Step C is another basic math operation, Multiply. Data 1 is a Data Set type so we can select the result of Step B and Data 2 is a Constant type with the numeric entry, "100".

Data Columns

We don't want to display Step A or Step B in my report, so we have used the [ x ] button under Data Columns to remove those Steps. With Step C highlighted, we can configure the header and increase the precision to show decimal places.