From 04:00 PM CDT – 08:00 PM CDT (09:00 PM UTC – 01:00 AM UTC) Tuesday, April 16, ni.com will undergo system upgrades that may result in temporary service interruption.

We appreciate your patience as we improve our online experience.

Resources for Writing Your Own DataPlugin

Overview

This document will direct you to various resources to write your own DataPlugins.

Contents

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.

Example Exercises

DIAdem Help provides several examples to create DataPlugins for loading or registering your own file formats in the DIAdem Data Portal. The examples can be found in DIAdem Help: Examples.

Topics covered in the examples include:

  • Creating a DataPlugin and use the DataPlugin in the DataFinder.
  • Creating properties and assign values to the properties.
  • Generating channels with automatically calculated values.
  • Using a StringBlock to read in text channels
  • Formatting a time channel.
  • Displaying a message when an error occur.s
  • Reading binary channel values.
  • Creating channel groups.
  • …and others.

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

Additional Resources

Was this information helpful?

Yes

No