Write Traces to Spreadsheet File VI
- Updated2024-11-20
- 6 minute(s) read
Stores the data from a set of historical trends into a spreadsheet file.

Inputs/Outputs
formatting information
—
formatting information contains inputs that determine the format of the spreadsheet. Refer to the Details section for information about formatting the spreadsheet.
trace information
—
trace information contains timestamp and sample interval information about the trace(s).
database URL
—
database URL specifies the computer name and the database name where the Citadel database resides. Enter the database URL in the format \\computer\database. For example, if you have a copy of the LabVIEW Datalogging and Supervisory Control (DSC) Module and Citadel service installed on a computer named datalogger and the name of the database on that computer is data, you can access the data on datalogger from another computer by using the path \\datalogger\data. If you provide a database name only, this VI searches for the database on the local computer. If you do not wire database URL, this VI resolves the database URL from the Shared Variable Engine (SVE). If the SVE resolution fails, this VI reads data from the database associated with the default DSC Module process.
trace names
—
trace names specifies the list of historical traces for which you want to read historical data. You can specify either Shared Variable references or existing traces for this parameter. The DSC Module uses these trace names as column headers when you convert this information into spreadsheet format.
output file path
—
output file path is the full path to the spreadsheet file to be created.
error in (no error)
—
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout (30 s)
—
timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 30. A timeout value of less than or equal to 0 indicates no timeout, which means this VI waits indefinitely until this VI receives data from the Citadel database. This VI ignores this value if you set show status bar to TRUE.
show status bar (T)
—
show status bar enables a progress bar during the operation if show status bar is TRUE.
database URL out
—
database URL out returns the computer name and the database name that specify where the Citadel database resides. The format is \\computer\database.
output file path out
—
output file path out returns the full path to the spreadsheet file. If a value is a data break, this output returns a data point whose data is NaN and whose timestamp you can ignore.
error out
—
error out contains error information. This output provides standard error out functionality. |
Write Traces to Spreadsheet File Details
This VI creates a column header that labels the date, time, and trace names. The default delimiter is the tab character. You can designate a different value, such as a comma by using the formatting information parameter to change the character used to separate columns.
You can apply the following variables to the entire export file to customize the spreadsheet. Enter these variables in the header text, footer text, or row format parameters.
| Variable | Description |
|---|---|
| creationDate | Date that exported file is created. |
| creationTime | Time that exported file is created. |
| delimiter | The delimiter is specified by the delimiter parameter. |
| endDate | End date specified by the stop timestamp parameter value in the formatting information control. |
| endTime | End time specified by the stop timestamp parameter value in the formatting information control. |
| interpType | Reports the type of interpolation. |
| name[N] | N = [0..numTraces). Name of trace N. Traces are indexed by number, starting with 0, in the order they appear in the trace names parameter. The fourth trace, for instance, would be represented by name[3]. |
| numTraces | Number of traces in the trace names parameter. |
| repeat(N,X,Y,"S") | Use this variable to repeat other variables so that the format template can be used with trace views that have different numbers of traces. |
| rows | Number of total rows of data exported. |
| startDate | Start date specified in the start timestamp parameter value in the formatting information control. |
| startTime | Start time specified in the start timestamp parameter value in the formatting information control. |
| timeInterval | Interpolation time interval specified in the sample interval control. |
You can apply the following variables to the row format parameter to customize the rows of the spreadsheet.
| Variable | Description |
|---|---|
| date | Date of current row. |
| formatValue({value[N]}, "flags|width|precision|padding") | Export format of a numeric variable. |
| quality[N] | Quality of trace N. 0 = good quality and other numeric values indicate bad quality. |
| row | Row number. |
| signals[N] | Type signal for trace N.
0 = asynchronous 1 = synchronous |
| time | Time of current row. |
| value[N] | N = [0..numTraces]. Value of the N trace in the current row. |
formatting information
—
header text
—
delimiter
—
sample interval
—
start timestamp
—
database URL
—
trace names
—
error in (no error)
—
timeout (30 s)
—
show status bar (T)
—
database URL out
—
error out
—