Custom Data

You can collect custom data about a device and display it on the Device Details tab in the Device Information panel. Use the Custom Data dialog box to create, modify, or delete custom data items.

Warning: Custom data definitions can retrieve sensitive information. The database stores the information in plain text, accessible through the WebConsole. Configure your custom data definitions to avoid collecting sensitive data you cannot secure.

Note: For Windows Modern devices, see Custom Data (Windows Modern).


Override Settings Inherited from Parent Group '`device group name`'	Turn on to ignore settings inherited from parent device groups. This option is displayed only in nested device groups.
Apply changes to all child groups and devices	Turn on to cascade settings specified here to all nested devices and device groups.

Turn on Enable Custom Data Configuration.

Custom Data Configuration

The Custom Definitions section lists all the available custom data items.

Custom Data Configuration window

Beside the name of an existing definition, select More to Edit, set Permissions for, or Delete a custom data item.

To add a new custom data definition, select Add. The Definition Info form opens.

Custom Definitions

Use the Definition Info dialog to define new custom data items.

Definition Info window


Name	Enter the name you want to give this custom data item. This is the display name for the custom data item in the Device Information panel.
Build Type	Select a build type for the custom data from the list. Once you have selected a build type, the Definition Info section updates to show options specific to your selection. Here, you can define the expression used to extract the custom data from the device.
Data Type	The default setting is STRING. Set this field only when collecting custom data.
Description	Enter a brief note describing the nature and purpose of the custom data query.

Build Type: Text File

Display a line from a text file located on the device.


Text File	Enter the full path of the text file on the device.
Line Number	Enter the line number in the text file.

Example:

The following example returns the text from Line Number one of Text File testfile.txt.

Build Type: Registry

Display a key value from the device's registry.

Note: Supported values are REG_SZ and REG_DWORD.

Note: Not available on Android Plus or Linux devices.


Registry Hive	Enter the registry hive.
Key Path	Enter the path of the registry key with the value to display.
Value Name	Enter the name of the registry value to display.

Example:

The following example returns the registry value for Value Name under the specified Key Path in the named Registry Hive.

Build Type: INI File

Display the value associated with a given section and property name in an INI file on the device.


INI File Name	Enter the full path of the INI file on the device.
Section Name	Enter the name of the section with the property value to display.
Value Name	Enter the property name whose associated value is to display.

Example:

INI example

Build Type: XML File

Display the value obtained from an XML file on the device using an XPath expression.

Note: Only available for Android Plus devices.


XML File Name	Enter the full path of the XML file on the device.
XPath Expression	Enter the XPath expression used to obtain a value from the XML file.

Example:

XML example

Build Type: JSON File

Display the value obtained from a JSON file on the device using an XPath expression.

Note: Only available for Android Plus devices.


JSON File Name	Enter the full path of the JSON file on the device.
JSON Expression	Enter the JSON Path expression used to obtain a value from the JSON file.

Example: JSON file example

Build Type: Exit Code

Display the exit code returned by an executable program on the device.

Note: Not available on Android Plus or Linux devices.

CAUTION: Commands execute with administrator privileges on the underlying operating system.


Exit Code	Enter the full path of the executable program on the device whose exit code you want displayed.

Build Type: STDOUT

Display the first line of standard output from an executable program on the device.

Note: Not available on Android Plus devices.

CAUTION: Commands execute with administrator privileges on the underlying operating system.


STDOUT	Enter the full path of the executable program on the device to capture the first line of standard output it displays.

Build Type: Device APIs

The use of Device APIs is specific to Zebra printers. Device APIs perform activities like creating, retrieving, updating, or deleting a resource.

Note: Only available on Linux devices.

Build Type: Static

Display information about the device that is statically set. The device has the value assigned rather than pulling it from a device attribute.

Note: Not available on Android Plus or Linux devices.


Static	Enter a static value that provides information about the device. Example: OwnerName="X & Y Corporation, SalesDepartment"