 |
timeout limits the time that the VI waits for data to be returned from the database. The default is 30 seconds.
A timeout value of less than or equal to 0 indicates no timeout, which means that the VI waits indefinitely until the data is returned.
|
 |
internal id is the unique identifier for a data run.
This unique identifier is generated automatically by the system. It is unique within the data set. This identifier allows you to distinguish among multiple data set runs that might have the same application–defined run id value.
|
 |
database URL is the computer name and the database name where the Citadel database resides.
Enter the database URL in the format \\computer\database_name. 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, the DSC Module searches for the database on the local computer. If you do not wire database URL, the VI reads data from the database associated with the default DSC Module process.
|
 |
data set information trace is the data set in the database for which the run(s) are sought.
|
 |
get all runs info? specifies to query each run for a list of traces and equipment. This parameter uses an additional amount of CPU resources when the value is TRUE. If the value is FALSE, this VI queries for a list of traces and equipment in the first run and uses the same query results for all consecutive runs. The default is FALSE.
|
 |
run id is the specific data run from which to extract data.
This value can be empty if you use the internal id input. If more than one data run has the same run id, this VI returns all matching data set runs. If both run id and internal id are specified, this VI uses the internal id.
|
 |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
 |
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
|
 |
code is the error or warning code. The default is 0.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
|
|
 |
matching data sets is complete information for all matching data runs found in the data set.
 |
run info is information that describes a specific data run.
 |
run id is the run identification value for the data run specified by the application.
|
 |
description is the description of the data run that is provided by the application.
|
 |
traces is the list of shared variables used in the data run. The shared variable data is stored in the historical database in a trace.
|
 |
equipment is the list of equipment used during the data run. This parameter has two values. The first value is the name of the piece of equipment and the second value is the description of the piece of equipment.
|
 |
user name is the name of the user logged into the system when the data run started.
|
 |
internal id is a unique identifier for a data run. This unique identifier is generated automatically by the system. It is unique within the data set. This identifier allows you to distinguish among multiple data set runs that might have the same run id value, which you can specify using the Read Data Set Run by ID VI.
|
 |
start time is the start time of the data run. This is the time at which the start condition was met.
|
 |
end time is the end time of the data run. This is the time at which the end condition was met.
|
|
|
 |
database URL out returns the computer name and the database name to specify where the Citadel database resides. The format is \\computer\database_name.
|
 |
first match data contains data for the traces that are part of the first data run whose run ID or internal ID matches the supplied run id or internal id.
 | Note Data for string shared variables is not returned. |
 |
historical trace is the historical trace for the input trace that is read from the historical database.
 |
timestamps is an array of the timestamps of the data points.
|
 |
data contains the data values of the data points.
|
|
|
 |
first match run id is the run ID value of the first matching data run.
|
 |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
 |
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
|
 |
code is the error or warning code.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
|
|
 |
all matches is data for all the data runs whose ID matched the run id parameter. If the internal id was used, this array contains only one element.
 |
run id is the run identification value for the data run specified by the application.
|
 |
historical traces is an array of the historical traces for the input traces that are read from the historical database.
 |
timestamps is an array of the timestamps of the data points.
|
 |
data contains the data values of the data points.
|
|
|