Hotkey Setup

Hotkey Setup

🌐 Backend — EQuipWebRetail ModeSales Setup

Sales Setup — 4.6 Hotkey Setup

Use Hotkey Setup to customize the touchscreen buttons on your POS. Arrange your most popular items as big, colorful buttons so cashiers can tap them quickly instead of searching — perfect for fast-paced environments like cafes and food courts. Hotkeys provide quick-access buttons for products, categories, departments, and collections on the POS screen. The layout is organized into button groups (folders) with child buttons, each customizable with colors, images, and linked references.

When to use this: When you want to customize the touchscreen buttons on your POS terminal.

Prerequisites

  • Products or Categories must exist for hotkey assignment

Hotkey List

📝 General Description

The Hotkey list shows all configured hotkey layouts. Each layout is assigned to a specific POS terminal and defines the button grid that cashiers use during sales transactions.

Hotkey Setup List

⚙️ Configuration Guide & UI Elements

  • 🔴 1. Add New
    • Element Type: Button (Green)
    • Function: Opens the Hotkey Layout Builder to create a new layout.
  • 🔴 2. Point of Sale Filter
    • Element Type: Dropdown
    • Function: Filter hotkey layouts by the assigned POS terminal.
  • 🔴 3. Filter Icon (🔽)
    • Element Type: Funnel button
    • Function: Opens the advanced filter panel.

📊 Column Descriptions

ColumnDescriptionExample
Point of SaleThe POS terminal this layout is assigned to (clickable)POS-001, Main Counter
Hotkey NameName of the layoutDefault Layout, F&B Menu
Applicable FromStart date for when this layout is active27 Nov 2015 02:07 PM
Applicable ToEnd date for when this layout expires03 Nov 2115 02:07 PM
DeletedHidden/deleted status☐ / ☑

Hotkey Layout Builder

Click + Add New or click a Point of Sale link to open the visual layout editor:

Layout Configuration

FieldTypeRequiredDescription
POSDropdownYesAssign this layout to a specific POS terminal.
Hotkey NameTextYesName of the hotkey layout (e.g., "Main Counter Layout").

Button Grid (6×4 Layout)

The hotkey editor displays an interactive 6 rows × 4 columns button grid per page.

  • Click an empty cell (+) to create a new button at that position.
  • Click an existing button to edit its properties.
  • Pagination: Buttons are organized into pages within groups. Use arrows to navigate pages ("Page X of Y").
  • Add Page: Adds a new blank page (only when the last page isn't empty).

Button Types

TypeDescription
ITEMLinks to a specific product. Tapping it adds the product to the cart.
CATEGORYLinks to a product category. Tapping it shows all items in that category.
DEPARTMENTLinks to a department. Tapping it shows all items in that department.
COLLECTIONLinks to a product collection.
FOLDERCreates a sub-group. Tapping it opens a nested page of buttons.
ALLITEMShows all products.
ALLCATEGORYShows all categories.
ALLDEPARTMENTShows all departments.
ITEMGROUPLinks to an item group.

Button Properties

PropertyTypeDescription
Button TypeDropdownSelect from the types listed above.
Reference NoLookupThe linked item/category/department/collection (via a search modal).
Display TextTextThe text label shown on the button.
WidthNumber (1–4)How many columns the button spans. Default: 1.
HeightNumber (1–6)How many rows the button spans. Default: 1.
Page NoNumberWhich page this button appears on.
X / Y PositionNumberGrid position (column/row).
PriorityNumberDisplay order priority.

Button Appearance

Color Tab

FieldDescription
Background ColorButton background color. Choose from a color picker or named presets (BLUE, BROWN, GOLD, etc.).
Font ColorButton text color. Auto-calculated for readability based on background brightness.

Image Tab

FieldDescription
Button ImageUpload a custom image (JPEG, PNG, JPG) for the button face.

How to Edit a hotkey layout.Groups[1].Value.ToUpper()otkey layout

If you need to change any details of an existing hotkey layout, follow these steps:

  1. Go to Hotkey Setup and find the hotkey layout you want to change.

  1. Click the layout name link to open the edit form. The form looks the same as the "Add New" form, but the fields are already filled in with the current values.

  1. Make your changes to any of the fields you need to update.

  2. Click Save to apply your changes.

Expected Result: The hotkey is saved and appears on POS after sync.

[!TIP] The edit form is identical to the "Add New" form. The only difference is that all fields are pre-filled with the existing data. Change what you need and click Save.

[!NOTE] Color and Image are mutually exclusive. Saving with the Color tab active clears any uploaded image. Saving with the Image tab active clears the color.

Group Navigation (Folders)

Hotkeys support hierarchical grouping via FOLDER-type buttons:

  • Open Group: Select a FOLDER button → click "OPEN GROUP" to drill into its child buttons.
  • Close Group: Click the caret-up (↑) button to navigate back to the parent level.
  • Breadcrumb Trail: Shown above the grid as > Group1 > SubGroup1.

Actions

ActionDescription
Add NewCreates a new hotkey layout
CopyDuplicates an existing hotkey layout to a new POS
Add ButtonClick empty cell (+) to create a button
Save ButtonSaves the selected button's properties
Delete ButtonRemoves the selected button (with confirmation)
Remove ImageClears the button image
Add PageAdds a new page to the current group
Save LayoutSaves the master record (name, POS assignment, dates)

Access & Permissions

RoleViewCreateEditDelete
AdminYesYesYesYes
SupervisorYesYesYesNo
CashierNo backend access

[!NOTE] Exact permissions depend on the Privileges Setup configured for each role. Contact your administrator if you cannot access this page.


How to Delete a Hotkey

  1. Navigate to Hotkey Setup from the sidebar menu.

2. Click the name or code link (blue text) of the record you want to delete. 3. In the edit form, scroll down to the bottom.

4. Click the Delete button (red button). 5. A confirmation dialog appears — click Yes to confirm deletion.

Expected Result: The record is soft-deleted — it is hidden from the active list and POS terminals but can be restored later using the "Show Deleted" filter.

[!WARNING] Records linked to active transactions or other modules cannot be deleted. The system will display an error if deletion is not allowed.


How to Add a New Hotkey

  1. Navigate to Hotkey Setup from the sidebar menu.

  1. Click the + Add New button (green button).

  2. Fill in the required fields in the form.

  1. Fill in any optional fields as needed.

  2. Click Save to create the new hotkey.

Expected Result: The new hotkey appears in the list and is available for use across the system.


FAQ

Q: Why is this payment mode not appearing on the POS? A: Check that the payment mode is marked as Active and assigned to the correct outlet. The POS also needs to sync.

Q: Can I edit a completed sales transaction? A: No. Completed transactions cannot be edited. You can void the transaction and create a new one if correction is needed.

Q: How do I set up a new tax rate without affecting past transactions? A: Create a new GST rate with a future Commence Date. The system will automatically apply the old rate to past transactions and the new rate from the effective date.


Troubleshooting

IssuePossible CauseSolution
Cannot save the recordRequired fields are empty or invalidCheck all fields marked with * and fill in valid data
Record not appearing in POSPOS terminal has not synced yetWait for the next sync cycle or manually trigger sync from Terminal Status
Cannot delete the recordRecord is being used by other modulesCheck if the record is linked to active transactions, products, or other settings
Changes not taking effectBrowser cache showing old dataRefresh the page (Ctrl+F5) or clear browser cache
"Duplicate" error on saveA record with the same name/code already existsSearch the list (including deleted records) for duplicates
Page not loadingSession expired or network issueLog out and log back in. Check your internet connection

  • Product Setup > Product List — products linked to pricing
  • Master Data > Outlet Setup — outlet-specific payment modes
  • Master Data > POS Setup — POS terminal configuration
  • Setting > Feature Setup — enable/disable sales features

Open Questions / Confirmation Needed

[!NOTE] The following items may vary depending on your system version and configuration:

  • Exact permission settings depend on your Privileges Setup configuration
  • Sync timing to POS terminals depends on network conditions and sync schedule
  • Some features may require additional licensing or module activation
  • Field behavior may differ between EQuip versions

If you encounter behavior not described in this manual, contact your system administrator or EQuip support team.

    • Related Articles

    • Category Setup

      ? Backend — EQuipWebRetail ModeProduct Setup Chapter 2: Product Setup — 2.3 Category Setup Use Category Setup to organize your products into groups — like "Beverages", "Snacks", or "Electronics". When your products are neatly categorized, your staff ...
    • Setup Module Overview

      ? Backend — EQuipWebRetail ModeChapter 1: Getting Started Backend Setup — Module Overview and Getting Started Guide The Setup Overview provides a quick-reference guide for initial system configuration. This page summarizes the recommended setup ...
    • Privileges Setup

      ? Backend — EQuipWebRetail ModeUser Setup Chapter 6: User Setup — 6.4 Privileges Setup Use Setup to manage and configure this feature in your EQuipWeb system. Privileges Setup is the master list of all permissions available in the system. Each ...
    • Company Setup

      ? Backend — EQuipWebRetail ModeMaster Data Setup Chapter 8: Master Data Setup — 8.9 Company Setup Use Company Setup (under Master Data) to enter your company's official business details — company name, registration number, address, and contact ...
    • Role Setup

      ? Backend — EQuipWebRetail ModeUser Setup Chapter 6: User Setup — 6.2 Role Setup Use Role Setup to create job roles for your team — like "Cashier", "Supervisor", "Manager", or "Admin". Each role determines what a user can see and do in the system. ...