|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.|
|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|
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|
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.