Search by additional attributes

This section discusses the additional default attributes available in the Device Search feature.

Use this when you need to search for device information that isn't covered by the default search criteria.

You have the ability to search devices by creating an additional attribute. This is often needed to search for relevant device information that is not in the default search criteria.

Available attributes

You can search for devices with the following attributes:

Attribute Name	Multi selection (Yes/No)
Agent Version	Yes
Application	Yes
Device ID	Yes
Device Status	No
GUI Manager Version	Yes
Hierarchy Path	Yes
IP Address	Yes
Last Heartbeat	No
Location Identifier	Yes
M-Level Part Number	Yes
MAC Address	Yes
Manufacture Date	No
Mode of Connectivity	No
Model	No
OS Version	Yes
POS Agent Version	Yes
POS IP Address	No
POS OS Version	Yes
Security Policy	Yes
Serial #	Yes
Sub Status	No
VSR Sponsor	Yes
VTP Encryption Status	No
Location ID	Yes

You cannot select the same attribute more than once.

Attribute operators and descriptions

Attribute Name	Operator Allowed	Multi selection (Yes/No)	Description
Agent Version	Contains, Equal To, Not Equal To	Yes	Version of ADKTMS Agent. Enter the control value to search for the device based on the Agent version.
Application	Contains, Equal To, Not Equal To	Yes	The application that is installed and running on the device. Enter the name and value to search for the application.
Device ID	Equal To, Like, Not Equal To	Yes	Also known as Terminal ID. Used with DeviceIDBackupSource to define the DeviceId sent to the server. Enter the control value to search based on device ID. For backward compatibility, this is TerminalId, not DeviceId.
Device Status	Equal To	No	Status of the device — Active, Inactive, Pending Hierarchy Assignment, Pending Registration. Select from the drop-down menu.
GUI Manager Version	Contains, Equal To, Not Equal To	Yes	GUI Manager version on the device. Enter the control value to search based on the GUI Manager version.
Hierarchy Path	Contains, Like	Yes	Device hierarchy path. Enter the control value to search based on hierarchy path.
IP Address	Contains, Equal To, Not Equal To	Yes	IP address of the device. Enter the control value to search based on the IP address.
Last Heartbeat	Between, Equal To, Greater Than	No	Last heartbeat received time. Enter the date.
Location Identifier	Equal To, Contains, Like	Yes	Exact location of the device. Enter the control value to search based on the location identifier.
M-Level Part Number	Equal To, Like, Not Equal To	Yes	Device hardware part number. Enter the control value to search based on the hardware part number.
MAC Address	Contains, Equal To, Not Equal To	Yes	MAC address of the device. Enter the control value to search based on the MAC address.
Manufacture Date	Between, Equal To, Greater Than	No	Device manufacture date. Enter the date.
Mode of Connectivity	Equal To, Not Equal To	No	Connectivity media (Dialup, Ethernet, GPRS, USB, Wi-Fi, and others). Select from the drop-down menu.
Model	Equal To	No	Model number of the device. Select from the drop-down menu.
OS Version	Contains, Equal To, Not Equal To	Yes	OS version of the device. Enter the control value to search based on the OS version.
POS Agent Version	Contains, Equal To, Not Equal To	Yes	POS Agent version. Enter the control value to search based on the POS Agent version.
POS IP Address	Contains, Equal To, Not Equal To	No	POS IP address. Enter the control value to search based on the POS IP address.
POS OS Version	Contains, Equal To, Not Equal To	Yes	OS version of the POS. Enter the control value to search based on the POS version.
Security Policy	Contains, Equal To, Not Equal To	Yes	Device security policy. Enter the control value to search based on the security policy.
Serial #	Contains, Equal To, Like	Yes	Serial number of the device. Enter the control value to search based on the serial number.
Sub Status	Equal To	No	Sub status of inactive devices — Swapped, No-Recent-Communication, Tablet Communication Issue. Select from the drop-down menu.
VSR Sponsor	Contains, Equal To, Not Equal To	Yes	App signer card name. Enter the control value to search based on the VSR Sponsor.
VTP Encryption Status	Equal To	No	VeriShield encryption status. Select from the drop-down menu.

Add an attribute to your search

1

Select an attribute

Select the attribute from the drop-down list in the Select Attributes section. Based on the selected attribute, the operator and value fields are displayed. VHQ allows multiple comma-separated text values for attributes that support all three operators: Contains, Equal to, and Not Equal To. Enter the appropriate value for the selected operator.

2

Add the attribute

Click Add Attribute. The Search Criteria section is displayed with the attribute added, and it's listed in the Device Search screen. You can add up to a maximum of 20 columns, including the 5 default columns (Serial Number, Device ID, Model, Device status, Last Heartbeat) plus the searched attribute columns. Since any number of attributes can be selected, the first 5 default columns will always be displayed.

3

Apply the filter

Click Apply Filter. The Device Search screen displays the search results.

Guidelines

• The Show/Hide columns option in the Device Search screen displays all device-level attributes, ordered by default attributes first, then the remaining. You can select up to 15 attributes to display as columns.

Tracking payment application versions

The Device Search screen displays the application version status using green, amber, or red color, giving a quick check on the version of the application residing on the device. Go to VHQ > Device Search to view the application version status.

The Device Profile screen displays the device health chart for the last 7 days, with the current health. The Software option provides the health metric of the payment application versions, also using a green, amber, or red light:

• Green — the payment application on the device is current.
• Amber — the payment application is one version old.
• Red — the payment application is two versions old.

To view the device health chart, go to VHQ > Device Profile > Support.

Keywords

Also called: additional attributes search, attribute filter. Search terms: add attribute, apply filter, show/hide columns, application version status.