UI component reference
Title (title)
Show static text on the POS ui.
Properties
Style (style)
Properties
color: color
Caption (caption)
Properties
text: uiText
translations: uiTextTranslations
Button (button)
Run actions (macros) on tap.
Properties
Style (style)
Properties
color: color
Image (image)
A background image for the button.
Properties
file: file
Image record (image-record)
The ID of an image in the database to use as a background.
Properties
id
Caption (caption)
Properties
text: uiText
translations: uiTextTranslations
Macro (macro)
POS macros to execute when the button is tapped.
Properties
macros: textBlock
Presets
Item
Sell an item when the button is tapped. Item name will be used as caption and if the item has an image then that is used as background.
Properties
itemid
Tender
Pay with a tender when the button is tapped. The tender name will be used as caption.
Properties
tenderid
Cash
Pay a fixed amount with a tender when the button is tapped. The amount will be used as caption.
Properties
tenderid
amount
Menu:Open
Open the given menu when the button is tapped. The menu name is used for a caption.
Properties
menuid
Menu:Back
Go back one screen in the menu tree.
Menu:Home
Go to the home screen.
Void item
Void the selected item or items.
Void transaction
Void the current transaction.
Change quantity
Change the quantity of the currently selected sale line.
Change price
Change the unit price of the item in the currently selected sale line.
Training mode
Control training mode.
Properties
mode
Transaction journal (journal)
Show the current basket content, customer information, and coupon status.
Transaction total (simpletotal)
A single-number total display showing the current payment due.
Advanced transaction totals (advancedtotal)
A multi field total display showing the current payment due, taxes, and discounts.
Operator messages (operatormessages)
A field to display non-intrusive messaged for the operator. This also includes a pop-out input field so that the use of the Operator Input component is not required.
DEPRECATED - Operator input (operatorinput)
A component to allow entry of PLUs and other data from the operator. This functionality is now included in the Operator messages component.
Operator box (operatorbox)
Show the currently logged in operator and allow logoff or changing operators. Tapping this component logs off. Entering a different cashier ID and then tapping this component changes the operator.
Table and seat info (tableseat)
Shows the currently selected table (and seat) in a hospitality setting. Tap to change tables. Module: Hospitality
Restaurant table editor (tableeditor)
A floor-plan UI component to edit the table layout in a hospitality setting. Module: Hospitality
Restaurant table selector (tableselector)
A floor-plan UI component to select tables in a hospitality setting. Module: Hospitality
Restaurant seat selector (seatselector)
Module: Hospitality
Loyalty point information (loyaltypointinfo)
Shows the accumulated loyalty points of the current customer. Module: Loyalty
Keypad (keypad)
On-screen keypad.
Macro runner (macrorunner)
A text area allowing entry and execution of macros. Module: Development
Status bar (statusbar)
A status bar showing basic information such as POS number, time and date. This includes the Centara Button which toggles the quick menu.
Properties
Macro (macro)
An optional macro to run then the Centara Button is tapped. If this is not specified then the quickmenu layout will be opened.
Properties
macros: textBlock
Sublayout (sublayout)
Show a directly specified submenu. See the Menu component for role based menus.
Properties
Layout (layout)
The default layout to use if there are no conditional overrides in effect.
Properties
layout
Conditions (condition)
Conditionally override the displayed menu ID. If no conditions match then the default ID is used.
Properties
Conditional layout (conditional-layout)
Properties
condition
layout
Menu (menu)
Show a role specified submenu. See the Sublayout component for directly specified menus.
Properties
Role (role)
Properties
role
Coupon status (coupon-status)
Show the status of scanned coupons. Requires the Workstation.Coupons plugin Module: Loyalty
Coupon status (coupon-status)
Requires the Workstation.Loyalty plugin
Onscreen report UI (centara-operator-onscreenreport-ui)
Run a report query on the Centara Server and show the results on the POS screen. Requires the Workstation.OperatorOnScreenReport plugin
Properties
Report (report)
Properties
endpoint
Name of the endpoint
query-string
Parameters for the query.
Use POST request (usepost)
Stock search (stocksearch)
An item search component. This uses fuzzy matching and orders the results based on best-match score. It shows item ID, description, price, stock levels, anticipated order shipments and allows selling. It also allows viewing of the items' sales history. Requires the Workstation.Search plugin
Labels (labels)
Requires the Workstation.Search plugin
Properties
label (label)
Properties
caption
commands: textBlock
Style search (stylesearch)
An size-colour-style item search component. This uses fuzzy matching and orders the results based on best-match score. It shows item ID, attributes, description, price, stock levels, anticipated order shipments and allows selling. Items are grouped by master number. It also allows viewing of the items' sales history. Requires the Workstation.Search plugin
Labels (labels)
Requires the Workstation.Search plugin
Properties
label (label)
Properties
caption
commands: textBlock
Customer search (customersearch)
An customer search component. This uses fuzzy matching and orders the results based on best-match score. It shows customer ID, name, phone and e-mail. It also allows viewing of the customers' sales history. Requires the Workstation.Search plugin
Properties
email (email)
Properties
factor
no-fuzzyness: boolean
phone (phone)
Properties
factor
name (name)
Properties
factor
no-fuzzyness: boolean
id (id)
Properties
factor
history (sale-history)
Properties
mode
customercreate (enable-customercreate)
Transaction search (transactionsearch)
A search component for suspended or otherwise stored transactions. Requires the Workstation.Search plugin
Properties
Suspended category (category)
The name of the category to suspend / retrieve as. This is useful for filtering suspended transactions based on a category. By default the category name used is 'suspended'
Properties
name
Day limit (days)
This property can be used to override the default maximum number of days (2) that the search uses to load the initial list of transactions. All transactions that have been suspended within this number of days will be retrieved
Properties
limit
Transaction count limit (transaction)
This property can be used to override the default maximum number (30) of results that can be returned by the transaction search.
Properties
count-limit
Transaction lookup (transactionlookup)
A component to look up past transactions by ID. Requires the Workstation.TransactionLookup plugin
Properties
Show only return by receipt (show-only-return-by-receipt)
If set to true then only return by receipt screen will be shown
Properties
value: boolean
Transaction list (transactionlist)
A component that shows recent past transactions in a list. Requires the Workstation.TransactionLookup plugin
Transaction details (transactiondetails)
A component that shows the content of a single past transaction and allows reprints and returns. This component uses menu context data (TRNO) to get the transaction number. Requires the Workstation.TransactionLookup plugin
Return from transaction (transactionreturn)
A component that allows returning items from a single past transaction. This component uses menu context data (TRNO) to get the transaction number. Requires the Workstation.TransactionLookup plugin
Basket confirm (basket-confirmation)
A web-store order picking component.
Last updated
Was this helpful?