Installation

Setup Java

Extract files

  • Unzip floreant pos zip file
  • Give write permission to the database folder & go to floreantpos folder.

Launch Application

  • Go to the folder and start the application from command line

java -jar floreantpos.jar

  • In windows and Mac double click on floreantpos.jar and it will start the application
screenshot

This document was written for Floreant POS build 452 released in 2015. There are many similarities between them. More detail instruction for build 1551+ will be shared shortly.


Configure Database

Use one of the following options.

Embedded database

By default it will run with embedded Derby database. The database name is posdb. You may need to recreate database. If you want to test create database with sample data.

Database server

Floreant POS ships with a database server inside Database folder. To start the database server go to database/derby-server/ and click on start-server.bat or start-server.sh

Accessing Back Office

Default password for Administrator is “1111”. Restaurant owner can change it and also change length of password. Each store employee should be given a unique password to log in.

Figure 1: Store Details

Store details

Store details are exactly what you will see in Receipts and Reports. They should not be changed unless its must. Keep length of Restaurant name, Address line 1, 2 & 3 less than 12 character so that they print nicely in small printers.

Service charge

If you charge % of service charge use this field, otherwise leave it blank.

Default Gratuity

Enter a tips % over the total amount due if you have a fixed number, otherwise leave it blank.

Vat no

Some countries require to print Tax/Vat no in receipts. One Trick way is to use Unused Address field or Ticket footer. If your price like UK are calculated including VAT check respective field in next tab button.

Currency

Add local currencies such as EURO, BRG or ARS. Enter exchange rate based on main currency. Tolerance will allow to adjust very small differences.

currrency


Terminal number

In default setting Floreant runs as standalone single terminal. Usually system generates unique 4 digit terminal number. If you decide to have different terminal number at initial setup that should not be changed later on.

Default Password Length

Login Password must be protected and secured for each store employee. Default password length can be changed to 6, 8 or 10.

To Protect the Terminal and all its data from unauthorized use of employees Database Configuration button should be disabled from login screen. If database recreated by mistake it can erase all existing data.

Auto log off

By default in every 60 seconds of inactivity  Floreant terminal will logs out. This is useful where many people shares the terminal. You can change the time period or disable totally.

terminal

Translated Name

At the menu item setup using translated name for other languages than English, this button need to be checked to activate the Translated Name.

Kiosk Mode

Kiosk mode means full screen protected mode where a regular server cannot access Operating system. You may assign certain user to see shutdown button. You must  check if a administrator has shutdown mode before you have enabled this.

Group by Categories in Kitchen Receipt

Items can be viewed by sections under their menu categories instead of the sequence the order was originally taken. This may help the cook to get more organized.

Enable Multi-currency

For using any other currencies other than US$, Multi-currency functions need to be enabled.

Allow to Delete Printed Ticket Items

The tickets that have been settled and printed can not be removed from the record by default, this feature gives the option to remove those tickets.


location

Terminal Location

This is the store address where the POS terminal resides in. This might be needed for Home Delivery orders to find delivery distance.

Button Style

In case you are using higher resolution display or small touch devices you can change button height and font size. Dragging the bar to the right will increase the button and text size.

Report printers

You can setup a regular printer used for Printing back office reports, choose the Printer Type as Report and add a desktop printer.

Receipt Printer

A small printer attached to each terminal for printing payment receipts.

Kitchen & Bar Printers

Kitchen Printers will print food orders that are sent to kitchen. Bar printers will print Bar Items that are set up in the menu item entry. Unlimited kitchen printers combined with packing or bar printers can be added in one single printer group.

printer

Printer Groups

Unlimited kitchen printers combined with packing or bar printers can be added in one single printer group. After food or bar orders are taken those will print in all printers that are assigned under the Printer Group. Each food or bar item needs to assign the Printer Group to activate it at menu item entry.

One Printer Group may consist of only one printer such as Bar, Prep or Grill.

Kitchen Display

Yellow or Red flags to the Kitchen Display System can alert the cook for the elapsed time of the order been taken. The timers for Yellow or Red can be changed.

Card payment setup

Magnetic swipe card reader

We have integrated Authorize.Net , a reputed PCI Pre-approved payment gateway. In case you have own Merchant, let us know. We may integrate any similar Merchant API.  You may test with Sandbox account and then have a Merchant ID of Authorize.net from here

Manual Entry of Card information

In case your card reader is not able to read Card, Cashier can manually type user name, card type, card number and expiry date.

External Card reader device

In case you have separate terminal to read credit card you just enter Ref#  and complete transaction.

Sandbox

 

VAT/Tax Included Sales Price mode

  • If you turn this on prices will include Vat/Tax.

Multiple Tax

You can create list of taxes and add in individual items.

 

Card Merchants

Floreant POS supports magnetic swipe card and has support for PCI Pre approved credit card API. Currently it supports list of credit card gateway and any standard credit card gateway can be supported.

Credit card Pre-Approval

As industry practice Credit card payments are pre-approved and they may not be submitted in real time. They are shown in “Authorize” button. Usually they are authroize everytime a drawer pull is done. Admin or special users can login and change tips.

Bar tab

We also support API required for supporting bars

Tips paid through credit card

Often tips are paid after user has paid the bill. This is done through Authorization button.

 

 

Configure user types

View all Open ticket will allow to see/manage tickets created by other users. If a user does not have permission he will find those buttons grayed. You may create as many custom user type as you wish.

 User details

Enter user name, phone and social security number.

User type

One user is assigned to one user type.

Cost per hour

Time attendance is generated using this hourly cost.

Secret code

4 digit unique code. You may change size of the secret code in adjacent tab.

Item Categories & Item Groups

  • Categories are important for arranging items in a structured fashion. However, they are not shown in receipts
  • Categories are useful for generating sales summary reports
  • Groups are secondary level for organizing.
  • Every Item can exist in one Category and subordinate group.

In order to maintain database integrity you have to create Menu items in the following sequence

  1. Create Category
  2. Create Groups
  3. Create Modifiers
  4. Create Modifier Groups
  5. Create Menu Item

Item Categories

 

Items

Discounted Rates are rates applied in

Adding Modifier in Item

  • Adding modifiers in Item. Minimum Quantity is what must be taken. Maximum Quantity is price included quantity.

 

Menu Items are single food defined in restaurant printed menu. Each Menu items are further extended with Modifiers

 Create shift

Name different shifts like “Morning, General or Happy meal”.

Set Item price by shifts

Optionally Mention discounted food price in specific shift.

Inventory

Floreant POS inventory is an optional feature provided through  OROCUBE Inventory  Plugin. Inventory products are basically raw materials and fuel for preparing foods.

Add Warehouse & Location

First step is to define ware house and location. Ware house may be main ware house or extensions and locations are shelf, refrigerators or places where raw materials are stored.

Add vendors

List vendors items are purchased frequently.

Add Products in inventory

Inventory forms allows adding products with initial balance. Products are also described by their packages. Use groups to link same products in different packages.

Stock In / Stock out

When products are purchased create new transaction with Transaction refernce# with quantity. In the same fashion when products are issues we need to make another transaction.

Recipe

Recipe is to estimate raw material consumption for each menu item. In menu you can optionally add Inventory items and their percentage.

 

Terminal Modes

Often a small cafe wants to replace Cash terminal with a Standalone POS, and their best choice is to run Floreant POS with embedded database. We call it Single mode, and such setup boots with Derby database . What you need is add hardware as necessary. We have seen Street food sellers using Floreant POS in Java supported tablets like  Dell Venue Pro and they used battery operated Receipt printer for the best experience. On the other hand large restaurants has to deploy a back office server and then connect many terminals over wifi or ethernet. Floreant ships with Derby Database server but we also have option for MySQL connection.

Single terminal Installation

  1. In windows 7 or 8 installing JDK will make Jar files clickable. So try double clicking on floreantpos.jar
  2. In case it does not start, setup Java environment andfrom command line write  java -jar floreantpos.jar

Multi terminal Installation

  1. Go to Terminal / Command prompt
  2. Type cd database/derby-server
  3. Type java -cp ./lib/derbynet.jar org.apache.derby.drda.NetworkServerControl start -h localhost -p 51527
    Instead of localhost try with ip address. If you run Bat file change port number to 51527

4. Start Floreant pos terminal by java -jar floreantpos.jar

5. In login screen click on “Configure Database” database server IP and Port should be same as the server.

 6. Create database schema and add sample data

Password & Length

Default password for Administrator is “1111”. Restaurant owner can change it and also change length of password.

Magnetic ID Card

USB Port based Magnetic card readers can be used to let user login with his own Magnetic ID Card. Some of our users also successfully used Motor Drivers License.

Login Screen for Floreant POS 1.4.56

Change Splash screen

Replace logo.png in config folder. Recommended size is 800×600.

 

Database Re-create

When you start Floreant POS boots up with embedded(single) database with own sample food menu. In case you mess up you may recreate the system with sample data or blank.

Back up & Restore

If you use Derby database, shutdown system and simply copy the database folder in a safe place. For mysql or any other database system follow their own procedure.

Update Database

When you need to upgrade next version of Floreant POS, you can copy old database folder and replace database folder of newer version. Update button will generate/change all the tables keeping the database intact.

 

Store details

Store details are exactly what you will see in Receipts and reports. They should not changed  unless its must. Keep length of Restaurant name, Address line 1, 2 & 3 less than 12 character so that they print nicely in small printers.

Currency

Change currency name and symbol. In case you see white box you should change system font that has those unicode symbol (available in 1.4 build 452 +).

Service charge

If you charge % of service charge use this field, otherwise leave it blank.

Vat no

Some countries require to print Tax/Vat no in receipts. One Trick way is to use Unused Address field or Ticket footer. If your price like UK are calculated including VAT check respective field in next tab button.

Capacity & Tables

Capacity and Tables are maximum number of guests and Tables respectively.

 Terminal number

In default setting Floreant runs as standalone single terminal. Usually system generates unique 4 digit terminal number. If you more from single to multiple terminal mode you have to assign unique id and they should not be change later on.

Kiosk Mode

Kiosk mode means full screen protected mode where a regular server cannot access Operating system. You may assign certain user to see shutdown button. You must  check if a administrator has shutdown mode before you have enable this.

Auto log off

By default in every 60 seconds of inactivity  Floreant terminal will logs out. This is useful where many people shares the terminal.

Select Order types

You may clean up interface by removing unnecessary order types from here. Uncheck what you hardly use.

Button Style

In case you are using higher resolution display or small touch devices you can change button height and font size.

Report printers

You can setup a regular printer used for Printing back office reports.

Receipt Printer

A small printers attached to each terminal for printing cash receipts.

Kitchen & Bar Printers

Routes kitchen and bar printers to predefined or default printers. Floreant POS supports unlimited number of kitchen / bar printers. Before using this you have to make a label for each kitchen/bar printers ( like “Prep”, “Grill”, “Chinese” etc) . You have to set one printer as default and in every food item you can set a printer. Kitchen printers must be set to  each terminals.

Floor Plan

Visual Floor plan is an optional features. It requires  FloorPlan or FloorPlan pro Plugin from OROCUBE site. Free version of the plugin may be obtained from without any charge.

Adding new table in Floor plan

First it needs to upload a restaurant map and then clicking on table location should add new table.

Card payment setup

Magnetic swipe card reader

We have integrated Authorize.Net , a reputed PCI Pre-approved payment gateway. In case you have own Merchant, let us know. We may integrate any similar Merchant API.  You may test with Sandbox account and then have a Merchant ID of Authorize.net from here

Manual Entry of Card information

In case your card reader is not able to read Card, Cashier can manually type user name, card type, card number and expiry date.

External Card reader device

In case you have separate terminal to read credit card you just enter Ref#  and complete transaction.

Sandbox

VAT/Tax Included Sales Price mode

  • If you turn this on prices will include Vat/Tax.

Multiple Tax

You can create list of taxes and add in individual items.

Card Merchants

Floreant POS supports magnetic swipe card and has support for PCI Pre approved credit card API. Currently it supports list of credit card gateway and any standard credit card gateway can be supported.

Credit card Pre-Approval

As industry practice Credit card payments are pre-approved and they may not be submitted in real time. They are shown in “Authorize” button. Usually they are authroize everytime a drawer pull is done. Admin or special users can login and change tips.

Bar tab

We also support API required for supporting bars

Tips paid through credit card

Often tips are paid after user has paid the bill. This is done through Authorization button.

Configure user types

View all Open ticket will allow to see/manage tickets created by other users. If a user does not have permission he will find those buttons grayed. You may create as many custom user type as you wish.

 User details

Enter user name, phone and social security number.

User type

One user is assigned to one user type.

Cost per hour

Time attendance is generated using this hourly cost.

Secret code

4 digit unique code. You may change size of the secret code in adjacent tab.

Item Categories & Item Groups

  • Categories are important for arranging items in a structured fashion. However, they are not shown in receipts
  • Categories are useful for generating sales summary reports
  • Groups are secondary level for organizing.
  • Every Item can exist in one Category and subordinate group.

In order to maintain database integrity you have to create Menu items in the following sequence

  1. Create Category
  2. Create Groups
  3. Create Modifiers
  4. Create Modifier Groups
  5. Create Menu Item

Item Categories

 

Items

Discounted Rates are rates applied in

Adding Modifier in Item

  • Adding modifiers in Item. Minimum Quantity is what must be taken. Maximum Quantity is price included quantity.

 

Menu Items are single food defined in restaurant printed menu. Each Menu items are further extended with Modifiers

 Create shift

Name different shifts like “Morning, General or Happy meal”.

Set Item price by shifts

Optionally Mention discounted food price in specific shift.

Inventory

Floreant POS inventory is an optional feature provided through  OROCUBE Inventory  Plugin. Inventory products are basically raw materials and fuel for preparing foods.

Add Warehouse & Location

First step is to define ware house and location. Ware house may be main ware house or extensions and locations are shelf, refrigerators or places where raw materials are stored.

Add vendors

List vendors items are purchased frequently.

Add Products in inventory

Inventory forms allows adding products with initial balance. Products are also described by their packages. Use groups to link same products in different packages.

Stock In / Stock out

When products are purchased create new transaction with Transaction refernce# with quantity. In the same fashion when products are issues we need to make another transaction.

Recipe

Recipe is to estimate raw material consumption for each menu item. In menu you can optionally add Inventory items and their percentage.