Create Transaction Logger Reports
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 Report Building (Report Studio)
The Transaction Data Set provides access to data relating to Transaction Logger tags. Transaction Logger tags are used to record a collection of historical values as a single transaction that is stored in the historian. Previously, this data was commonly accessed through ODBC connections.
Create a Data Set
In the Data Set Manager, click [ + ] , select the correct Type from the drop list and give your Data Set a name. You may cultivate a selection of Data Sets in a single report configuration so you should opt for a descriptive name.
Click OK and the Data Set Properties will open on the right-hand side.
If you navigate away and want to get back to this properties panel, click on the Data Set in the manager.
Transaction Data Set Properties
The Transaction Logger tag used for this demo has two child tags: Fill Volume and Truck incoming weight. |
Delete the Data Set The trash can located in the header of a Data Set Properties panel will delete the Data Set. If you delete a Data Set that is being used by components or other Data Sets, they will stop working until you revisit their properties and select a suitable replacement. Before deleting, double check the header: Are you deleting a Data Set? Or a Data Cell? Name The name of your Data Set is displayed in this field. To change the name, edit the field. Logger Use the tag selector to the right of this field to link the data set to a Transaction Logger tag. Click the tag button to the left of this field to change from tag selection to parameter selection. Custom parameters make it possible to define one report and adapt the output for many different contexts. |
Available Data Columns
Available Data Columns represent one or more columns that you can include in a report table. Some of the options are enabled by default. You can enable or disable as many of the available columns options as you need, as long as at least one is enabled.
Some column data comes from the Transaction Logger tag:
- Timestamp - The time when the value was recorded. A display format that includes milliseconds is recommended. Can be specified as a Timestamp or a String.
- TransactionID - The Transaction ID. Data Type must be String.
- TransactionLogger - The name of the transaction tag that did the transaction.
- All Remaining - Displays multiple columns representing all data recorded to the Historian from the Transaction Logger tag, such as the values of child tags present at the time of the transaction and all other data column values. Can be specified as Numeric, String or Timestamp.
The rest of the available data columns represent values from IO tags that are children of the Transaction Logger tag. For example, in the Data Set Properties image above, "Truck incoming weight" and "Fill Volume" happen to be Analog I/O and Calculations tags that are children to the Transaction logger. The available data column option "All Remaining" can be used as a catch-all that is helpful if you don't want to manually select all children.
Enable your data columns and then select each one in turn to configure the format per column:
- Header - The label to appear at the top of the columns. Use the droplist to reuse recent values. Open the Parameter Phrase dialog and configure a string or use parameter tokens to insert real values.
- Data Type - A unique property of a Transactions data set is the requirement to specify the Data Type. Data is retrieved from the historian rather than the current tag's history. There is no guarantee that a child tag that is now numeric wasn't previously string. This allows you to control the formatting for the data you expect to retreive.
- Format - Found in Timestamp. Specify the kind of timestamp you want to display.
- Precision - The number of decimal places to show after the decimal point. Tag-specified by default. Maximum of 9 (that would be, 0.000000000).
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.
Maximum Records
Optionally, set a maximum record limit for entries that appear within a report.
Using a Transaction data set in a report
Drag a table component onto the canvas, and select the default cell.
This cell defaults to a Time Data Set. The transaction data sets already have a timestamp data column and that makes this default redundant. So instead of adding a new cell, change this one.
Selecting the table cell will open Data Cell properties to the right. Change the Data Set to a Transaction type.
The Data Cell will inherit the parent Data Set configurations by default.
See the Data Columns included from the Data Set. Click to select each one and see how they are configured. You cannot change them while "Use data set defaults" is enabled.
Disabling "Use data set defaults"
To make variations for this cell, uncheck "Use data set defaults". Disabling data set defaults will enable all of the Data Columns configuration options for this cell only.
Select Data Columns to see their configuration options. Change headers, format, and summary suppression. Add, remove or rearrange the data columns.
These changes will only affect the selected Data Cell and will not alter the parent Data Set.
