> For the complete documentation index, see [llms.txt](https://docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verifone.com/support-us/verifone-hq/vhq-device-search/search-by-hierarchy-group-or-additional-attributes/search-by-custom-attributes.md).

# Search by custom attributes

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

{% hint style="info" %}
**Use this when** you want to search or filter devices using your organization's own custom-defined attributes.
{% endhint %}

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

{% stepper %}
{% step %}

### Open Show/Hide Columns

Click the **Show/Hide Columns** option in the *Device Search* screen.
{% endstep %}

{% step %}

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

<figure><img src="https://verifone.cloud/sites/default/files/inline-images/1_194.JPG" alt="Show/Hide Columns window"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Confirm the selection

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

<figure><img src="https://verifone.cloud/sites/default/files/inline-images/2_135.JPG" alt="Confirm column selection"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Review the columns

The selected columns are displayed in the *Device Search* screen.

<figure><img src="https://verifone.cloud/sites/default/files/inline-images/3_102.JPG" alt="Custom attribute columns displayed"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

## Name your custom attributes

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

{% stepper %}
{% step %}

### Open System Configuration

Go to **Administration** > **Estate Administration** > **System Configuration**.
{% endstep %}

{% step %}

### Select the category

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

<figure><img src="https://verifone.cloud/sites/default/files/inline-images/image_79.png" alt="Device Custom Attribute Label category"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

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

<figure><img src="https://verifone.cloud/sites/default/files/inline-images/image_80.png" alt="Editing the custom attribute field name"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

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

{% hint style="warning" %}
You will need to work with Verifone to complete this configuration. Contact your Verifone representative to request this feature.
{% endhint %}

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.

<details>

<summary>Keywords</summary>

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

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verifone.com/support-us/verifone-hq/vhq-device-search/search-by-hierarchy-group-or-additional-attributes/search-by-custom-attributes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.