Documentation Website

User Tools

Site Tools



User interface

Basic concepts

  • Departments
  • Terminals
  • Users & user roles
  • Work periods
  • Tickets & orders
  • The POS menu
    • Products & product categories
    • Menus
    • Recipes
    • Product modifiers

Quick-start: setting up a (very basic) POS configuration

Advanced concepts

Customizing your POS system


Mobile Client

SambaPOS License


General Concepts

Entity Custom Fields are useful to store static data of an entity. It can be a Customer's Phone Number, Waiter's SSN or an expiry date of a Promotion Card.

Entities have states. States toggles between some pre-defined values and are useful to track some operational data. For example; Tables can be Available or Occupied. If we create a Deliverer entity for ticket, the deliverer can be Away or Ready.

We can use Entity Screens to select / change entities. We have three types of Entity Screens.

  1. Entity Selection screens display entities as buttons. This is how the Tables screen is configured.
  2. Entity Search screens allow us to select entities, by searching them by their name, or custom field value. Customers screen is a Entity Search screen.
  3. Custom screens allow us to create custom entity selection screens. For example, you can prepare a custom table selection screen by using your floor plan. Items you can add into a Custom screen are called Widgets. You can position, resize or use the advanced settings for implementing custom work flows.

We can create a ticket by selecting an entity through the entity selection screen or assign entities after creating a ticket. Either way, we'll use entity screens.

Choosing / Changing Entities

While editing a ticket we'll see an Entity Selection button for each entity type mapped to the Ticket Type. That will appear with Entity's Type Name. So if we have a Table entity, that button will appear as Select Table, if there is no table selected for ticket. Or it will appear as Change Table if a table is already selected. When we click on Select / Change Table button the Table Selection Screen which will appear.

Properties for this screen are configured through related Entity Screen records. Entities appear as buttons as this is an Entity Selection screen and it displays Entity states with colours. So; table B19 is occupied. Other tables are available.

Two additional buttons will appear on top of screen. The arrow button returns ticket without a selection. The cross button removes table assignment from ticket. Users should have Can remove entity permission to be able to use that button.

How a ticket can exists without a table?

SambaPOS tracks tickets and tables differently. We can assign one or more tickets to a table or split a ticket to move part of a ticket, to a different table. So some tickets may exist without a table assignment (eg. delivery tickets, fast food tickets, etc.) Customer is another entity type just like tables, so the same thing applies for customers. A customer can have one or more tickets, or we can split tickets between customers. We can also create tickets without customers. If we create additional Waiter, or Deliverer entities, it will work just as tables or as customers work.

entities.txt · Last modified: 2019/04/19 03:22 by