Raw Data (version 24)
The Raw Data function returns the raw data for a set of tags. The raw data is a series of TVQs (timestamp, value, quality). If the data changes, a new TVQ is generated. If the tags were polled for updates every one second, but the value only changed every 2 minutes, there would be a TVQ every 2 minutes and not every second. When getting data from multiple tags, the timestamp sequence for each tag will be different.
Input Range
A reference to a range of cells containing a list of tag names typically generated by the Tag List function. This range is automatically set to the cells that are pre-selected when the button for this function is selected. The range can be adjusted by editing the range or selecting a new range of cells then clicking the Set button. Adjusting the input range will automatically update the output location.
Start Date
The Start Date can be an absolute date (11/21/2022), a relative time (NOW-5h), or a cell reference ('Sheet6'!$G$12). The absolute date can be typed in or the Calendar control may be used by pressing the down arrow at the end of the text box. If a relative time is specified, then the Start Time does not need to be used. To set a cell reference, select the desired cell and press the Set button.
Start Time
Used in conjunction with an absolute start date, Start Time can be an absolute time (10:15:00 AM) or a cell reference ('Sheet6'!$G$12). To set a cell reference, press the Set button with the desired cell selected.
End Date
The End Date can be an absolute date (8/9/2016), a relative time (Day-1d), or a cell reference ('Sheet6'!$G$12). The end date and time should be later than the start date and time. The absolute date can be typed in or the Calendar control may be used by pressing the down arrow at the end of the text box. If a relative time is specified, then the End Time does not need to be used. To set a cell reference, select the desired cell and press the Set button.
End Time
Used in conjunction with an absolute end date, End Time can be an absolute time (7:30:00 PM) or a cell reference ('Sheet6'!$G$12). The end date and time should be later than the start date and time. To set a cell reference, press the Set button with the desired cell selected.
Sort Order
The data can be returned with timestamps in ascending or descending order.
Show Headers
This option will display a heading for each Display Field included in the output.
Display Fields
If the Display Field name is checked, that field will be included in the output results. The order of the display field names determines the order in which they are outputted. To rearrange the order, click a field and then press the up/down buttons along the right side. You can also drag-and-drop fields to rearrange them.
- TimeStamp as Text - timestamps are returned as as formatted string down to one second resolution (10/4/2018 12:00:00 AM).
- TimeStamp as Number - timestamps are returned as an Excel DateTime number (needs to have Excel formatting applied to make it readable).
- Value if Good - The TVQ value if the quality is good, otherwise blank.
- Value - The TVQ value, regardless of quality.
- Data Type - The TVQ value data type.
- Decimal Quality - The TVQ quality in decimal format (i.e. 192, 0, 64, 32768).
- Hex Quality - The TVQ quality in hexadecimal format (i.e. C0, 0, 40, 8000).
- Readable Quality - The TVQ quality - in a readable format - of the different bit meanings (i.e. Good, Bad, Uncertain, No Data).
- Annotation Entered - If an annotation is present at this time, the TimeStamp the annotation was entered by the user.
- Annotation Message - If an annotation is present at this time, the annotation message.
- Annotation By - If an annotation is present at this time, the person who entered the annotation.
If any of the Annotation fields are checked and none of the TVQ fields (value and quality), then the output will just contain the annotations and will not display timestamps of the TVQs.
Output Vertically
This option transposes the output columns and rows. If checked, tag information will be displayed vertically giving each tag one or more rows depending on how many Display Fields have been selected.
Output Location
This is the location where the output will be written to. It is the cell in the upper left corner of the result. The number of cells needed for the result will depend on the input parameters. The number of columns and rows returned is dependent on the number of tags and display fields. The default output location cell is set to the cell just below the left most cell of the input range (if the input range is horizontal) or just to the right of the top most cell of the input range (if the input range is vertical.)
When using input parameters referencing other cells, if the input cell changes it will automatically update the resulting data.
The Input Pane can be closed at any time by clicking on the X in the upper right corner. To re-open the Pane, click on the Canary Ribbon "Raw Data" button. If the cell containing an existing Canary function has the focus and the user selects the corresponding function button from the Canary Ribbon, the input controls in the Pane will be set according to the parameters of the Canary function.