Search by custom attributes

This section discusses how to create a custom search attribute in the Device Search feature.

Use this when you want to search or filter devices using your organization's own custom-defined attributes.

Custom attributes are user-defined attributes. VHQ allows you to add up to five custom attributes. You can customize the name/label and assign values on a per-device basis, which can later be used in the Search Results section for filtering.

Display custom attribute columns

1

Open Show/Hide Columns

Click the Show/Hide Columns option in the Device Search screen.

2

Select the columns

Select the columns from the Show/Hide Columns window. You are only allowed to select 15 columns. The last five checkboxes will always indicate the custom attributes defined by the VHQ administrator (DeviceID, PTID, CustomAttribute3, CustomAttribute4, CustomAttribute5), regardless of the defined field name.

3

Confirm the selection

Select the custom attribute or any other attribute and click OK.

4

Review the columns

The selected columns are displayed in the Device Search screen.

Name your custom attributes

You can define these custom attributes with a proper field name.

1

Open System Configuration

Go to Administration > Estate Administration > System Configuration.

2

Select the category

From the Category drop-down list, select Device Custom Attribute Label.

3

Edit the field name

Click the edit icon, enter the field name, and save. The field value can be viewed in the Show/Hide columns window.

Configuring custom identifiers and location ID

To configure custom identifiers and location ID on the VHQ server, you must:

1. Configure the application(s) on the device to send custom parameters to the VHQ Agent, so that they can be sent to the VHQ server.
2. Configure the VHQ server to display one of the custom parameters as the Location ID value.
3. Configure the names of the Custom Identifiers in the VHQ database, such as Store ID and Lane ID.

You will need to work with Verifone to complete this configuration. Contact your Verifone representative to request this feature.

Once the necessary changes are made on the VHQ server, VHQ will collect the device profile information from the device and display the custom identifiers and location identifier value. The device can be rebooted, or the Get device profile diagnostic action can be performed, to get the latest device profile details from the device.

Keywords

Also called: custom attributes, custom identifiers, device custom attribute label. Search terms: show/hide columns, location ID, custom fields.