Resources for Writing Your Own DataPlugin

Publish Date: Sep 08, 2017 | 0 Ratings | 0.00 out of 5 | Print

Overview



Here are some resouces that should help you start writing your own DataPlugin. If you would like someone from NI to assist you with creating a dataplugin, send a sample data file to dataplugins@ni.com

Table of Contents

  1. Programmer's Reference Guide
  2. Example Exercises
  3. Registering DataPlugins
  4. Additional Resources

1. Programmer's Reference Guide

The programmer's reference guide describes the object-oriented script interface for DataPlugins. The topics provide information about all objects, collections, methods, properties, and events, and examples that demonstrate how to use the interface. The reference guide is available in English and German. 

DataPlugins Programmer's Reference Guide

This zip file contains a CHM file, which are compiles HTML help files for Windows. After extracting the zip file, you usually just have to double-click the files to open them. If you open a CHM file and get an empty site or a message "Action canceled", "This page cannot be displayed", then try the following: 

  • Make sure you are not running a CHM file that has been saved to a network drive. Save the .CHM file to the local computer and the file should appear correctly.
  • Manually unblock the link.  Right-click the CHM file, and go to the Properties.  In the Attributes section of the General Properties tab, click the Unblock button.  This should allow those links to be displayed.

Back to Top

2. Example Exercises

The following examples show how you create DataPlugins for loading or registering your own file formats in the DIAdem Data Portal. 

Example 1: Reading in a Text File with Meta Information

This example shows how to

    • create a DataPlugin and use the DataPlugin in the DataFinder
    • provide information about the text file
    • read in text
    • create properties and assign values to the properties
    • generate channels with automatically calculated values

Example 2: Reading in an ASCII File with Meta Information and Channel Data

This example shows how to

    • use a StringBlock to read in text channels
    • provide information about formatting a time channel
    • display a message when an error occurs

Example 3: Reading in a Binary File with Four Channels

This example shows how to

  • read in binary channel values
  • create a channel group
  • create a channel
  • export the DataPlugin


Example 4: Reading in a Text File and Handling Errors

This example shows how to

    • read in a time channel
    • read in and edit single values
    • display error messages
    • process invalid values

Example 5: Excel File with Meta Information and Channel Data

This example shows how to

    • read in general information on the workbook
    • use a CellBlock to read in data of a worksheet

Back to Top

3. Registering DataPlugins

Once you've created your DataPlugin, you must register it before DIAdem can interpret your files. To do this, you can follow the steps outlined in this help document

Back to Top

4. Additional Resources

DIAdem Homepage

DataPlugins: Supported Data Formats

DIAdem Hands-On Exercises

Back to Top

Bookmark & Share


Ratings

Rate this document

Answered Your Question?
Yes No

Submit