Accessing a Device, Feature, or Unit Definition to Use as a Template

NI InsightCM™ SDK 3.3 Help

Edition Date: December 2018

Part Number: 375191F-01

»View Product Info
Download Help (Windows Only)

Parent Topic: Customizing a Device Type Definition

A device definition is made up of several types of components, including module definitions and channel definitions. To get components of an existing device definition that you can customize or copy, export the component definitions from NI InsightCM Server.

Note  Before you begin, ensure that NI InsightCM Server services are running.
  1. Launch the NI InsightCM Console application (InsightCMConsole.exe) in the command line. This console is installed at <InstallDir>:\Program Files\National Instruments\InsightCM Server.
  2. Execute one of the following commands in the NI InsightCM Console:
    Task Command Example
    Export a specific component definition as a JSON file exportdefinition -t [type] -n [name] -o [output filepath] InsightCMConsole.exe exportdefinition -t device -n CMS-9068 -o "d:\temp\9068.json"
    View all definitions of a particular type listdefinitions -t [type] InsightCMConsole.exe listdefinitions -t channel
  3. Ensure you enter a unique ID for the exported definition instead of reusing the NI-defined ID. Otherwise, the new definition will overwrite the existing one when you import the new definition. For example, in channel definitions, enter a unique value for the ChannelType JSON object. In module definitions, enter a unique value for the Name object.
  4. If you are modifying an NI-developed device definition, delete the FirmwareGuid and BootstrapGuid name-value pairs in the Capabilities object shown in the following example:


    "DeviceType": "CMS-9068",

    "Capabilities": [


    CapabilityName": "SysCfgDeployer",

    "Properties": {

    "FirmwareGuid": "{F4DE796F-D708-47C6-9A47-E097E595CC62}",

    "BootstrapGuid": "{21AC4CC9-3EEB-4AFE-9F51-C71D575186DC}"





Valid Component Types

The -t option identifies the type of definition component you want to import. The following arguments are valid:

Argument Description Detailed Help for this Component
channel Properties users can assign to channels, as well as configuration tabs, layout groups, validation rules, and UX rules. Channel Type Definitions
device Serves as the master definition that calls or defines several other types of definitions, including device properties, channel types, and hardware definitions. Device Type Definitions
instance Defines properties of a feature that you can apply to a particular asset type. Instances allow you to define properties that apply to features when assigned to one asset type but not to other asset types that you associate with a different instance of the feature. For example, you can create an instance of a feature in which the feature is required to be calculated for assets of one type and a separate instance in which the feature is not required. Instance Definitions for Features
metric Defines the name and configurable properties of feature and spectral bands that display in the InsightCM web application. Feature Definitions
module Defines properties of a specific hardware module. Module Type Definitions
unit Defines the units of measurement in which a particular channel type can acquire data. Unit Definitions

Specifying a Component Name

To specify the argument of the -n option, enter the ID appropriate for that component type. For example, in channel definitions, the value of the ChannelType JSON object serves as the ID. In module definitions, the value of the Name object is the ID.

Related Information

Importing Device, Feature, and Unit Definitions into NI InsightCM Server


Not Helpful