Provisioning workstation & handheld configs
Purpose: Create and edit the configuration each device pulls down, the Merchant ID, the reader, the tip presets, mobile terminal, routing, and the rest.
When to use this: Setting up a new workstation or handheld, or changing how an existing one behaves. After you save here, the device picks up the change on its next reload (workstation: Reload Workstation Config; handheld: Reload in Device Settings).
Three values break things if they're wrong. Read these before anything else:
- Workstation Name: wrong value and the workstation service won't start.
- Secure Device: wrong value and handhelds stop working.
- Com mode: wrong value and payments stop.
Open the workstations list
In the portal, open Workstations. There are two sections: Workstations and Handhelds. Tap Create Workstation to add one, or open an existing one to Edit, Duplicate, or Delete it.
[INSERT SCREENSHOT: portal Workstations list showing the Workstations and Handhelds sections]
The three values that break things
Workstation Name = the machine's hostname
The workstation service finds its config by the PC's Windows hostname. The portal field that has to match it is Workstation Name.
If Workstation Name doesn't exactly equal the machine's Windows device name, the service can't find its config and won't start. The portal gives no warning, so set this carefully.
To find the PC's hostname: on the workstation, press Windows + R, type cmd, press Enter, and run hostname. Put that exact value in Workstation Name. See Workstation · Install & reinstall.
Secure Device
Secure Device tells the device which card reader it's driving. It's a free-text field, there's no dropdown, so the value has to be exactly right for the reader model.
A wrong Secure Device value stops handhelds (and counter readers) from working. Copy the exact value for the model from the Secure Device reference. For example, a Verifone P400 is EMV_P400_DATACAP_E2E; a PAX A920 Pro is EMV_A920PRO_DATACAP_E2E.
Com mode
COM Mode tells the workstation how the reader is connected. The valid values are USB or NET.
A wrong COM Mode stops payments. Use USB for a USB-connected reader. Use NET for a network reader, which then needs a Pin Pad Address (for example 127.0.0.1) and a Pin Pad Port (for example 1235).
The other fields
- Merchant ID: the account this device settles to.
- Workstation Type: Workstation or Handheld. Handheld type exposes extras like Enable Auto Rotation and a Minimal Receipt option.
- Enable Mobile Terminal: turns on using a handheld as this workstation's reader; set the Mobile Terminal IP (for example
192.168.1.52) and Port (3036). See Setting up Mobile Terminal. - Tip Percentages: the suggested tip presets (for example
[18,20,25]), plus On Screen Gratuity and Gratuity Suggestions. - CAPS IP: the address of the site's central server (for example
192.168.15.155). - Cert Mode: CERT or PROD.
- Deployment ID, logo and color, and the offline limits round out the form.
Alternative Routes (multi-MID)
For a site that runs more than one merchant account on one workstation, add Alternative Routes, each pairs a Merchant ID with the Host IP it should use (for example 192.168.1.10). This is how RVC routing is configured.
Handheld configs
Handhelds appear under the Handhelds section. The Secure Device and Com mode rules above apply the same way, a handheld with the wrong Secure Device value won't take payments.
Verify
After saving:
- On a workstation, open
http://localhost:3036/api/dashand press Reload Workstation Config; check Service Stats reflects the change. - On a handheld, open Device Settings and tap Reload.
- Run a small test sale to confirm the reader works.
