Labview Datafinder Toolkit
Labview Datafinder Toolkit
DataFinder Toolkit
LabVIEW DataFinder Toolkit
June 2011
375141B-01
Support
Worldwide Offices
Visit ni.com/niglobal to access the branch office Web sites, which provide up-to-date contact information,
support phone numbers, email addresses, and current events.
For further support information, refer to the Technical Support and Professional Services appendix. To comment
on National Instruments documentation, refer to the National Instruments Web site at ni.com/info and enter
the info code feedback.
Copyright
Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical, including photocopying,
recording, storing in an information retrieval system, or translating, in whole or in part, without the prior written consent of National
Instruments Corporation.
The DataFinder component in this product includes CLucene software which use is governed by the Apache License, Version 2.0.
This software includes Stingray software developed by the Rogue Wave Software division of Quovadx, Inc.
Copyright © 1995–2006, Quovadx, Inc. All rights reserved.
For components used in USI (Xerces C++, ICU, HDF5, b64 library, Stingray, and STLport), the following copyright stipulations apply. For a listing
of the conditions and disclaimers, refer to the USICopyrights.chm.
Xerces C++. This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
Copyright 1999 The Apache Software Foundation. All rights reserved.
ICU. Copyright 1995–2009 International Business Machines Corporation and others. All rights reserved.
HDF5. NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities
Copyright 1998, 1999, 2000, 2001, 2003, by the Board of Trustees of the University of Illinois. All rights reserved.
b64 library. Copyright (c) 2004–2006, Matthew Wilson and Synesis Software. All Rights Reserved.
Stingray. This software includes Stingray software developed by the Rogue Wave Software division of Quovadx, Inc.
Copyright 1995–2006, Quovadx, Inc. All Rights Reserved.
STLport. Copyright 1999–2003 Boris Fomitchev.
National Instruments respects the intellectual property of others, and we ask our users to do the same. NI software is protected by copyright and other
intellectual property laws. Where NI software may be used to reproduce software or other materials belonging to others, you may use NI software only
to reproduce materials that you may reproduce in accordance with the terms of any applicable license or other legal restriction.
Trademarks
LabVIEW, National Instruments, NI, ni.com, the National Instruments corporate logo, the Eagle logo, and DIAdem are trademarks of National
Instruments Corporation. Refer to the Trademark Information at ni.com/trademarks for other National Instruments trademarks.
Other product and company names mentioned herein are trademarks or trade names of their respective companies.
Members of the National Instruments Alliance Partner Program are business entities independent from National Instruments and have no
agency, partnership, or joint-venture relationship with National Instruments.
Patents
For patents covering National Instruments products/technology, refer to the appropriate location: Help»Patents in your software,
the patents.txt file on your media, or the National Instruments Patent Notice at ni.com/patents.
Chapter 1
Introduction
DataFinder .....................................................................................................................1-1
Desktop DataFinder and Remote DataFinder..................................................1-1
Configuring DataFinder...................................................................................1-2
Text Search and Extended Query ....................................................................1-2
Evaluating Search Results ...............................................................................1-3
The DataFinder Toolkit Palette......................................................................................1-3
Chapter 2
Running a Search
Running a Text Search...................................................................................................2-1
Executing an Extended Query .......................................................................................2-2
Displaying the Search Results as Waveforms ...............................................................2-3
Displaying Property Values ...........................................................................................2-4
Chapter 3
Connecting Other LabVIEW Components
Processing a Text Search with the TDM Streaming VIs ...............................................3-1
Processing Results of a Text Search with the Read From Measurement
File Express VI ...........................................................................................................3-2
Processing Results of an Extended Query with the Storage VIs ...................................3-3
Appendix A
Technical Support and Professional Services
Index
You can use this manual to familiarize yourself with the NI LabVIEW
DataFinder Toolkit features and how to use them.
The first chapter describes what DataFinder is and what DataFinder is used
for. You learn how to configure DataFinder and when to run a text search
or execute an extended query. The chapter also describes the functionality
of each of the VIs in the Toolkit Palette.
The second chapter describes step by step how to run text searches and
execute extended queries and how to evaluate and to graphically display
search results.
The third chapter describes how to use the LabVIEW DataFinder Toolkit in
combination with other LabVIEW VIs.
Conventions
The following conventions are used in this manual:
<> Angles brackets indicate a key you press to perform a function, for
example, <Ctrl> for the control key.
» The » symbol leads you through nested menu items and dialog box options
to a final action. The sequence Settings»Global Options»DataPlugins
instructs you to open the Settings menu, select the Global Options item,
and then select the DataPlugins item.
bold Bold text denotes items that you must select or click in the software, such
as menu items and dialog box options. Parameters are also bolded.
monospace Text in this font denotes text or characters that you enter from the keyboard,
such as dialog box entries and filenames. This font is also used for the
names of drives, paths, folders, filenames, and filename extensions.
Related Documentation
For more detailed information on the NI LabVIEW DataFinder Toolkit,
refer to the following documentation:
• NI LabVIEW DataFinder Toolkit Help files, which you open by
selecting Help»Search the LabVIEW Help and navigating to
Toolkits»DataFinder in the Help tree, or by pressing <F1> in a
Toolkit dialog box.
• NI DataFinder Server Edition: Search Engine for Technical Data
A DataFinder server is a search engine that you install on a server. The
DataFinder server browses specified folders on computers in a
network for files that contain technical data. The DataFinder server
indexes data files to provide the clients with the data properties. The
DataFinder server indexes files for which DataPlugins are registered in
the Server Manager.
You can define several DataFinder servers in the Server Manager to
provide different data for different work groups. Clients, such as
LabVIEW and DIAdem, communicate with the DataFinder servers to
query the indexed data and to load search results.
DataFinder
DataFinder is a search engine you can use to find specific data in large
amounts of various file formats, similar to Internet search engines.
DataFinder searches for files in the search areas you specify. Search areas
are file system folders that are on your local computer or on network drives.
DataPlugins enable the DataFinder to index many different file formats and
to search these files. All file formats indexed by DataFinder apply to the
TDM data model and contain descriptive information on three different
levels—root, group, and channel. The TDM root object, also referred to as
a file, can contain several groups, and each group can contain several
channels. You can work with the TDM data model-defined set of properties
at each of the three levels or insert your own custom properties.
The remote DataFinder contains the information for the connection to the
other computer. NI DataFinder Server Edition enables you to configure a
DataFinder and to make this DataFinder available to multiple clients on the
network. In the DataFinder Server Edition configuration you can assign
access rights to search areas for the individual clients.
Configuring DataFinder
You can configure “My DataFinder” interactively. To do so, right-click the
My DataFinder tray icon on the task bar and select Configure from the
context menu. DataFinder then opens a configuration dialog box.
On the Search Areas tab in the configuration dialog box you specify the
search areas where “My DataFinder” searches for data files. For
DataFinder to search for data in these search areas, the indexer must first
index this data. You configure the indexing settings on the Indexer tab. You
specify, for example, when files are indexed and the timeout for indexing a
file. Click the DataPlugins tab of the configuration dialog box to specify
which filename extensions DataFinder recognizes when searching for data.
You can import and export the DataFinder configuration. To do so, click
Import or Export in the DataFinder configuration dialog box. You can also
configure DataFinder programmatically with the VIs Invoke Node and
Property Node from the DataFinder API, which is in the DataFinder
Toolkit palette.
The extended query searches for specific values of properties stored on the
file, group, or channel level. You use the extended query if you want to
search for specific files, groups, or channels. You can, for example, use the
serial number, the test specification, and the test status to find all the tests
that have been executed for a specific unit under test. You use the Create
Query VI to generate the query conditions for an extended query. To
execute the search, wire the query output of Create Query VI to the
Execute Query VI.
In the extended query, you can use the Merge Queries VI to combine query
conditions with the logical operators AND and OR.
Search Text: Searches for text. Use the text search if you only have parts
of the information you are searching for, or if you do not know whether the
information you are searching for is stored on the file, group, or channel
level.
Create Query: Generates a query condition. You can search for text, paths,
numeric values, and time/date values. Use the Merge Queries VI to
combine multiple query conditions with each other. Use the Execute
Query VI to execute the query condition.
Execute Query: Executes a query. Use the VIs Create Query and Merge
Queries to define the query conditions.
Get Property Values: Extracts the values of one or more properties of the
search result references returned by the VIs Search Text and Execute
Query.
Get Indexed Properties: Determines the list of all indexed properties you
can use to execute a query.
Figure 2-3. Displaying the Search Results with the Results To Waveforms VI
4. In the block diagram, connect the result references out output of the
Execute Query VI, to the result references input of the Get Property
Values VI.
5. Right-click the property input of the Get Property Values VI and
select Create»Control.
6. Right-click the property values output of the Get Property Values
VI and select Create»Indicator.
7. Switch to the front panel.
8. In the property name input field, enter the name of a property, for
example, description.
9. Click the Run button. LabVIEW now displays the values in the
property values indicator.
Note If you use a DataPlugin built with the LabVIEW DataPlugin SDK, please ensure that
the LabVIEW versions match. This means that the DataPlugin’s LabVIEW version must
be the same as the DataFinder Toolkit version.
Figure 3-1. Processing a Text Search with the TDM Streaming VIs
Figure 3-3. Processing Results of an Extended Query with the Storage VIs
C I
Close Reference VI, 1-3 Indexer, 1-2
Configuration Invoke Node, 1-2
DataFinder, 1-2
Connecting, 1-1
Create Query VI, 1-2, 2-2 K
KnowledgeBase, A-1
D
DataFinder L
Configuration, 1-2 Logical Operators, 1-2
DataPlugins, 1-1
Export, 1-2
Import, 1-2 M
Indexer, 1-1 Merge Queries VI, 1-2
Network, 1-1 My DataFinder, 1-1
Remote, 1-1
Search areas, 1-1
DataFinder Server Edition, 1-1 N
DataFinder Toolkit NI support and services, A-1
Overview, 1-1
Palette, 1-3
Desktop DataFinder, 1-1 O
Open DataFinder VI, 1-3
E Operators, 1-2
Q
Query conditions
Connectives, 1-2
R
Read from Measurement File Express VI, 3-2
Remote DataFinder, 1-1
Results To Waveforms VI, 1-3, 2-3
S
Search results
Display as waveforms, 1-3, 2-3
Evaluation, 1-3
Search Text VI, 1-2, 2-1
Storage VIs, 3-3
T
TDM Streaming VIs, 3-1
Text search, 1-2
Run, 2-1
W
Web resources, A-1