Omni Text Reports
The Omni Flow computer can generate several different types of text reports. Each of these reports can be read by this driver and sent to the OPC Client as a string value.
Text Report Types
There are a number of report types that can be retrieved from the Omni Flow Computer. They may be read using a "TR" tag. The report types are as follows.
Custom Report Templates
9001 Report Template-Snapshot / Interval
9002 Report Template-Batch
9003 Report Template-Daily
9004 Report Template-Prove
Previous Batch Reports
9101 Batch Report-Last
9102 Batch Report-Second from Last
...
9108 Batch Report-Eighth from last
Previous Prove Reports
9201 Prove Report-Last
9202 Prove Report-Second from last
...
9208 Prove Report-Eighth from last
Previous Daily Reports
9301 Previous Day's Report-Last
9302 Previous Day's Report-Second from last
...
9308 Previous Day's Report-Eighth from last
Last Snapshot Report
9401 Last Local Snapshot / Interval Report
Miscellaneous Report Buffer
9402 Miscellaneous Report Buffer
Preview Monthly Reports
9501 Previous Month's Report - Last
9502 Previous Month's Report - Second from last
...
9508 Previous Month's Report - Eighth from last
Text Report Address Syntax
|
Address
|
Range
|
Data Type
|
Access
|
|---|---|---|---|
|
TRn
TRn T (triggered read)
|
n = Report address (9001-9508)
|
String
|
Read/Write
|
Example
To read or write to the Snapshot Report Template (address 9001), create a tag with address "TR9001".
Note: Because it can take several seconds to read a Text Report, the "TR" tags should be kept inactive in the OPC client. Alternatively, triggered reads can be used instead. No other tags on the channel can be read or written to while the driver is reading or writing a Text Report.Triggered Text Report Reads
As noted above, it is recommended that the Text Report tag be kept inactive, even though it is not always possible. A triggered read capability has been added as an alternative, allowing the Text Report tag to remain active. It also controls when the actual device reads occur with an auxiliary trigger tag.
A triggered read may not begin immediately, depending on when in the Text Report tag's update cycle the trigger is set. After the read attempt has been completed, the driver clears the trigger state. The Text Report tag shows the value and data quality that resulted from the last triggered read attempt.
Text Report Read Trigger Address Syntax
Address | Range | Data Type | Access |
|---|---|---|---|
TRIG_TRn | n = Report address (9001-9508) | Boolean | Read/Write |
Example
To read the Last Batch Report (address 9101) on trigger, create two tags. The first is a Text Report tag with address "TR9101 T", and the second is a Text Report Read Trigger tag with address "TRIG_TR9101".
Note: The Text Report tag address looks like a normal Text Report address followed by a space and the letter "T" for "triggered read". This "T" must be present in the address for triggered reads to work.To trigger a read, set the trigger tag value to true (non-zero). After the read attempt has been completed, the driver sets the trigger value to false (0). If the read was successful, the Text Report tag's data quality is Good. If the read failed, the Text Report tag's data quality is Bad, and the value is the last value successfully read.
Saving Text Report Data To Disk
The driver has the ability to save Text Report data to disk. This feature is enabled by using Text Report Path tags. These tags are used to write file path strings to the driver's memory. Each report type has its own path buffer. After a successful Text Report read, the driver checks the associated path buffer. If a valid path is stored there, the driver saves the report data as ASCII text in that file. The file is created if needed. The file is overwritten on subsequent Text Report reads.
The path buffers are initialized to empty strings on server start up. The driver does not write Text Report data to file until a valid path is saved in the associated path buffer. Path data is not persistent. The path strings must be rewritten each time the server is restarted. The path values can be changed at any time, allowing users to save data to different files on each read if desired.
Path strings may be up to 255 characters long.
Text Report Path Address Syntax
Address | Range | Data Type | Access |
|---|---|---|---|
PATH_TRn | n = Report address (9001-9508) | String | Read/Write |
Example
To read the Last Batch Report (address 9101) and save the result to disk, create two tags. The first is a Text Report tag with address "TR9101", and the second is a path tag with address "PATH_TR9101".
To save the report data in a file called "LastBatch.txt" (which is to be created in the folder "C:\OmniData\BatchReports") set up the client so that the first thing that it does is write "C:\OmniData\BatchReports\LastBatch.txt" to the path tag. Once this is done, read the Text Report tag. If the path is not set before the first read of the Text Report, the driver is not able to save the data to disk.
Note: To disable this feature, write an empty string to the path tag.