For the complete documentation index, see llms.txt. This page is also available as Markdown.
Support

CSV import file reference

Field reference for the CSV device import file format used in VHQ.

What is the CSV import format?

You can add, modify, or delete one or more devices using .csv files. The device model naming convention must follow the Verifone Style Guideline.

Sample Import Device .CSV
Sample Import Device .CSV

CSV field reference

Tags
Required / Optional
Description

REM Version = 1.1

Version information of the file.

REM Bulk Device

Header information.

Device operations

Mandatory

First field of each line should start with an operation tag of ADD, MODIFY, ADD_MODIFY, or DELETE, indicating the operation to be performed. Each record is processed based on this tag. • ADD: Adds a device record. If the record already exists, the insert fails and is reported as an error. • MODIFY: Modifies an existing record. If the record isn't present, no row is modified, and it's reported as an error. • ADD_MODIFY: If the device record is present, it's modified; otherwise, a new record is inserted. If either MODIFY or ADD fails, it's reported as an error. • DELETE: Deletes an existing record. Note: If an invalid value is specified for this field, or no value is specified, the default is assumed to be ADD. The value is not case-sensitive, so ADD is the same as Add. If no value is specified and it's followed by a comma, the value is assumed to be ADD.

Serial Number

Mandatory

Serial number of the device being created or modified. Maximum length 255 characters. The actual device serial number is in the nnn-nnn-nnn format; the import tool does not validate this format.

Hierarchy

Optional

Complete path to the hierarchy from the root node, indicating where the device should be located. The path uses ">>" as the separator. Example: MyCompany>>MyRegion>>MyState>>MyCity>>MyStore. If the operation is ADD, ADD_MODIFY, or MODIFY, a value must be specified, or VHQ will place the device at the root node.

Model Name

Mandatory

Indicates the device model.

Group

Optional

Associates a device to an already existing group in VHQ. A group is a collection of terminals not categorized by a hierarchy level — terminals in a group can be within a hierarchy or across hierarchies, such as a group of stores based on common attributes.

Device ID

Optional

Device or terminal identifier used to reference the device — not the internal unique device identifier.

Device import results for .CSV file

The device import result file returns the results or status of the imported devices.

Last updated

Was this helpful?