Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

FilterDeviceModelByGroup VI

NI InsightCM™ SDK Help

Edition Date: July 2017

Part Number: 375191C-01

»View Product Info
Download Help (Windows Only)

Owning Palette: Group Helpers VIs

Requires: NI InsightCM SDK

Returns a copy of the device model with only the channels that belong to a specific data group, including channels that belong to multiple data groups.

device model contains the following components that define how the device is configured in the InsightCM web application. Use the Get Device Model VI to return this cluster from the configuration file on the device.
Device contains the following elements that describe the device.
Id specifies the GUID used to correlate an element reference in one configuration file with a definition in another file.
Name is the device name that you want to appear throughout the InsightCM web application.
DeviceType is the name of a device type that NI InsightCM Server supports, such as CMS-9068.
HardwareName is the hostname of the device, which is in the format of NI-cRIO-ModelNumberSerialNumber by default.
IpAddress is the IP address assigned to the device. If you do not enter a value, NI InsightCM Server adds the device as an offline device, and you can bring the device online later by manually entering its IP address on the Device Configuration page.
HardwareInfo contains the following elements that identify the controller and module models that one or more devices on the NewDevices worksheet contain.
HardwareKey specifies one of the following values that describes the role of the hardware component within devices: Controller, Slot 1, ..., Slot N, where N is the highest slot number in the device chassis.
HardwareValue is the model name of the hardware component described by HardwareKey. If this row represents an empty module slot, leave this cell empty.
ApplicationType specifies the type of software application that runs on the device.
ApplicationVersion specifies which version of the software application is running on the device.
EquipmentIds specifies the GUIDs of device equipment.
ConfigurationVersion is the timestamp of the last device configuration.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
DataGroups contains the following elements that define a data group.
Name specifies the data group name that you want to appear throughout the InsightCM web application.
OperatingStates contains the following elements that define operating states.
Name specifies the operating state name that you want to appear throughout the InsightCM web application.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
Triggers contains the following elements that make up operating state triggers.
Type specifies the operating state trigger type. For example, Gate, Delta EU, or Advanced.
Expression is the definition of the conditions that cause the device to trigger an operating state.
Conditions contains the following elements that make up the operating state trigger conditions.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
EquipmentIds specifies the GUIDs of device equipment.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
EquipmentIds specifies the GUIDs of device equipment.
Channels contains the following elements that describe channels.
Id specifies the GUID used to correlate an element reference in one configuration file with a definition in another file.
DeviceId specifies the GUID used to correlate an element reference in one configuration file with a definition in another file.
Name specifies the human-readable channel source name.
ChannelType specifies the channel types that the InsightCM web application displays in the pull-down menu.
HardwareKey specifies one of the following values that describes the role of the hardware component within devices: Controller, Slot 1, ..., Slot N, where N is the highest slot number in the device chassis.
HardwareChannel specifies the physical location of the channel on the device.
DataGroup specifies the name of the data group to which the device belongs.
Keywords specifies an array of strings that classify the channel.
equipment Ids returns the GUIDs of the equipment-layout nodes to which the channel is assigned. You can unbundle these values from the device model that the Get Device Model VI returns.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
Metrics contains the following elements that make up a metric definition.
Id specifies the GUID used to correlate an element reference in one configuration file with a definition in another file.
MetricDefinitionInstanceId is a GUID used to correlate the element reference in the configuration file with the metric definition in another file.
Properties is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
Tags contains the following elements that define internal storage containers where devices and NI InsightCM Server read and write values.
Id specifies the GUID used to correlate an element reference in one configuration file with a definition in another file.
Path specifies the path to the item formatted as a string.
Name specifies the unique name, delimited by vertical bars (pipes), that identifies the tag.
DataType specifies the data type of the tag.
Props is an array in which each element is a key-value pair that represents a property.
Key specifies the ID of the property field you want to define.
Value specifies the user-defined value that corresponds to the Key.
Keywords specifies an array of strings that classifies the tag.
group specifies the name of the data group for which to filter the input data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
device model (channels filtered by group) contains the following components that define how the device is configured in the InsightCM web application. Use the Get Device Model VI to return this cluster from the configuration file on the device.
Device contains the following elements that describe the device.
Id returns the GUID used to correlate an element reference in one configuration file with a definition in another file.
Name is the device name that appears throughout the InsightCM web application.
DeviceType is the name of a device type that NI InsightCM Server supports, such as CMS-9068.
HardwareName is the hostname of the device, which is in the format of NI-cRIO-ModelNumberSerialNumber by default.
IpAddress is the IP address assigned to the device.
HardwareInfo contains the following elements that identify the controller and module models that one or more devices on the NewDevices worksheet contain.
HardwareKey returns one of the following values that describes the role of the hardware component within devices: Controller, Slot 1, ..., Slot N, where N is the highest slot number in the device chassis.
HardwareValue is the model name of the hardware component described by HardwareKey. If this row represents an empty module slot, this cell is empty.
ApplicationType returns the type of software application that runs on the device.
ApplicationVersion returns whichever version of the software application is running on the device.
EquipmentIds returns the GUIDs of device equipment.
ConfigurationVersion is the timestamp of the last device configuration.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
DataGroups contains the following elements that define a data group.
Name returns the data group name that appears throughout the InsightCM web application.
OperatingStates contains the following elements that define operating states.
Name returns the operating state name that appears throughout the InsightCM web application.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
Triggers contains the following elements that make up operating state triggers.
Type returns the operating state trigger type. For example, Gate, Delta EU, or Advanced.
Expression is the definition of the conditions that cause the device to trigger an operating state.
Conditions contains the following elements that make up the operating state trigger conditions.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
EquipmentIds returns the GUIDs of device equipment.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
EquipmentIds returns the GUIDs of device equipment.
Channels contains the following elements that describe channels.
Id returns the GUID used to correlate an element reference in one configuration file with a definition in another file.
DeviceId returns the GUID used to correlate an element reference in one configuration file with a definition in another file.
Name returns the human-readable channel source name.
ChannelType returns the channel types of the channels that the InsightCM web application displays in the pull-down menu.
HardwareKey returns one of the following values that describes the role of the hardware component within devices: Controller, Slot 1, ..., Slot N, where N is the highest slot number in the device chassis.
HardwareChannel returns the physical location of the channel on the device.
DataGroup returns the name of the data group to which the device belongs.
Keywords returns an array of strings that classify the channel.
equipment Ids returns the GUIDs of the equipment-layout nodes to which the channel is assigned. You can unbundle these values from the device model that the Get Device Model VI returns.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
Metrics contains the following elements that make up a metric definition.
Id returns the GUID used to correlate an element reference in one configuration file with a definition in another file.
MetricDefinitionInstanceId is a GUID used to correlate the element reference in the configuration file with the metric definition in another file.
Properties returns an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field.
Value returns the user-defined value that corresponds to the Key.
Tags contains the following elements that define internal storage containers where devices and NI InsightCM Server read and write values.
Id returns the GUID used to correlate an element reference in one configuration file with a definition in another file.
Path returns the path to the item formatted as a string.
Name returns the unique name, delimited by vertical bars (pipes), that identifies the tag.
DataType returns the data type of the tag.
Props is an array in which each element is a key-value pair that represents a property.
Key returns the ID of the property field defined by the key-value pair.
Value returns the user-defined value that corresponds to the Key.
Keywords returns an array of strings that classify the tag.
error out contains error information. This output provides standard error out functionality.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit