Documentation

Configuration


Configuring Default Currency

eQuate supports multiple currency symbols. If your desired currency symbol is not listed, there is an option to enter a custom currency symbol.

 

Supported Currency Symbols
  • Baht (THB) ฿
  • Balboa (PAB) B/.
  • Bolivares Fuertes (VEF) Bs
  • Cordobas (NIO) C$
  • Denars (MKD) ден
  • Dinars (RSD) Дин.
  • Dollars (GYD) $
  • Dollars (HKD) $
  • Dollars (JMD) J$
  • Dollars (LRD) $
  • Dollars (NAD) $
  • Dollars (NZD) $
  • Dollars (SBD) $
  • Dollars (SGD) $
  • Dollars (SRD) $
  • Dollars (TTD) TT$
  • Dollars (TVD) $
  • Dong (VND) ₫
  • Forint (HUF) Ft
  • Guarani (PYG) Gs
  • Guilders (ANG) ƒ
  • Hryvnia (UAH) ₴
  • Kips (LAK) ₭
  • Krone (NOK) kr
  • Kronor (SEK) kr
  • Kronur (ISK) kr
  • Lati (LVL) Ls
  • Lempiras (HNL) L
  • Lira (TRY) TL
  • Liras (TRL) £
  • Litai (LTL) Lt
  • Meticais (MZN) MT
  • Nairas (NGN) ₦
  • New Dollars (TWD) NT$
  • New Lei (RON) lei
  • New Shekels (ILS) ₪
  • Nuevos Soles (PEN) S/.
  • Pesos (MXN) $
  • Pesos (PHP) Php
  • Pesos (UYU) $U
  • Pounds (GGP) £
  • Pounds (IMP) £
  • Pounds (JEP) £
  • Pounds (LBP) £
  • Pounds (SHP) £
  • Pounds (SYP) £
  • Rand (ZAR) R
  • Rials (IRR) ﷼
  • Rials (OMR) ﷼
  • Rials (QAR) ﷼
  • Rials (YER) ﷼
  • Ringgits (MYR) RM
  • Riyals (SAR) ﷼
  • Rubles (RUB) руб
  • Rupees (INR) Rp
  • Rupees (LKR) ₨
  • Rupees (MUR) ₨
  • Rupees (NPR) ₨
  • Rupees (PKR) ₨
  • Rupees (SCR) ₨
  • Rupiahs (IDR) Rp
  • Shillings (SOS) S
  • Soms (KGS) лв
  • Sums (UZS) лв
  • Switzerland Francs (CHF) CHF
  • Tenge (KZT) лв
  • Tugriks (MNT) ₮
  • Won (KPW) ₩
  • Won (KRW) ₩
  • Yen (JPY) ¥
  • Zimbabwe Dollars (ZWD) Z$
  • Zlotych (PLN) zł
Changing Default Currency
  1. Login to eQuate Back Office
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select Locale (see Figure A)
  4. Find "System Currency" and change to your preferred currency.
  5. Press Save Changes to complete your change.
Figure A

Change the default currency by locating "System Currency" under "Locale" in Settings & Modules.

Configuring Monitor & Customer Display Screen

This guide assumes all of your hardware components have been installed and in working order. If you need assistance with setting up your device drivers, please contact your IT support person, or hardware manufacturer.

 

Monitor Setup

 

Touch Screen Monitors

  1. A minimum resolution of 1024 x 768 pixels is recommended.
  2. We recommend using mouse emulation and single click (no sound) mouse pointer options for the Touch Screen settings.

 

Regular Monitors

  1. Minimum resolution is 1024 x 768 pixels.

 

Customer Display Screen Setup

Currently not supported - to be supported in a future release.

 

Helpful Links
  1. ELO - www.elotouch.com

Configuring Bar Code & Swipe Readers

This guide assumes all of your hardware components are installed and in working order. If you need assistance with setting up your device drivers, please contact your IT support person, or hardware manufacturer.

 

Bar Code Scanner Setup

  1. Barcode Readers should be setup by default.

Keyboard Emulation type devices are the only current supported devices. Generally, almost all USB hardware manufacturered after 2011 is keyboard emulated.

 

Card Reader Setup

  1. Card Readers should be setup by default.

Keyboard Emulation type devices are the only current supported devices. Generally, almost all USB hardware manufacturered after 2011 is keyboard emulated.

 

Helpful Links
  1. Honeywell - www.honeywellaidc.com
  2. ID Tech - www.idtechproducts.com

Configuring Printer & Cash Drawer Settings

This guide assumes all of your hardware components are installed and in working order. If you need assistance with setting up your device drivers, please contact your IT support person, or hardware manufacturer. 

 

Printer

  1. In the Client - Navigate to Options, and then click on Printer Settings. (see Figure G)
  2. Set your desired preferences on this page.
  3. When you print for the first time, you will need to set the margins correctly:
    1. Navigate to your POS through the web browser (for Windows, go to http://localhost:8888/.
    2. Attempt to print a receipt from the Point Of Sale, at this time, a window should open and allow you to configure the browsers settings (which also changes the Point Of Sale settings). When complete, complete a test print, and exit Google Chrome.

 

Cash Drawer

  1. The cash drawer should be configured through your Printer settings. 
  2. In Windows, open up your Control Panel and find Printers.
  3. Right click on your Thermal printer, and go to Advanced Settings
  4. Look for "Open Cash Drawer Before Printing" and change to Enabled
  5. Click Apply

To use the Cash Drawer feature, you must have a supported Printer. The printer should support 5 pin (Printer to Cash Drawer) connection.

 

Helpful Links
  1. Star Micronics - www.starmicronics.com
  2. Dymo - www.dymo.com
  3. EPSON - www.epson.com

Configuring Login Screen

Operators can login using an I.D. number, and a PIN (if applicable). Enabling this feature will allow you to use Payroll functions, Chat functions, and Sales Tracking.

 

Enabling Operator Login Screen Globally
  1. Access "Settings & Modules" under Settings in the left menu of eQuate Back Office.
  2. Select "Terminals" in the left sub-menu.
  3. Find "Require Login" and change to either Enabled or Disabled (see Figure A below).
  4. Press "Save Changes" to finalize changes made.
  5. The terminal must synchronize before the changes are discovered (see Figure B below).
Figure A

Cash Out screen showing "Customer Entitlement" option which will display the customers total loyalty points.

Figure B

Adjust Loyalty points on the Customer Profile screen by going to More > Loyalty.

Enabling Operator Login Screen On A Specific Terminal
  1. Access "Profiles & Terminals" under Settings in the left menu of eQuate Back Office.
  2. Select "Terminals" in the top sub-menu.
  3. On the "Action" drop-down menu, select "Edit" (see Figure C below).
  4. On the left sub-menu, click "Settings".
  5. Find "Require Login" and change to either Enabled or Disabled, or use Global Settings (default) (see Figure D below).
  6. Press "Save Changes" to finalize changes made.
  7. The terminal must synchronize before the changes are discovered (see Figure E below).
Figure C

Adjust Loyalty points on the Customer Profile screen by going to More > Loyalty.

Figure D

Adjust Loyalty points on the Customer Profile screen by going to More > Loyalty.

Figure E

Login screen with system time and information buttons.

Connecting to PrestaShop

PrestaShop is an open source based shopping cart available for free. PrestaShop allows you to customize your website with a large choice of available templates in their marketplace. PrestaShop also has many addon's that are compatible with eQuate POS. 

 

Caution

Always make a back-up copy of your PrestaShop database before adding it to eQuate POS.

eQuate POS can connect to your PrestaShop database and synchronize orders, products, and customers with your in-store operation. Some functions that eQuate offers may not be available in PrestaShop. See below for the full list of supported features:

eQuate Feature PS 1.5 PS 1.6 PS 1.7
Attributes Yes Yes Yes
Customers Yes Yes Yes
Discounts Yes Yes Yes
Gift Cards Yes Yes Yes
Images Yes Yes Yes
Inventory Yes Yes Yes
Loyalty No No No
Multi Store Yes Yes No *
Orders Yes Yes Yes
Stock Adjustments Yes Yes Yes

* PrestaShop discontinued native Advanced Stock Management starting in version 1.7.x. You can add additional stores in eQuate POS, but only one can deduct from PrestaShop inventory. You can choose to share inventory between PrestaShop and a store, or you can also have them as seperate inventories.

 

Before You Begin

Before connecting eQuate POS to PrestaShop, you may need to make adjustments to your PrestaShop installation.

Database:

  • Always make a backup of your PrestaShop database before adding it to eQuate POS.
  • Remote SQL connections to your PrestaShop database is required.
    Some shared web hosting providers may require you to contact them to allow our server to connect through their firewall. If you have dedicated a server for your web hosting, you may need to allow access from our server if you have a firewall enabled. You can find your eQuate POS server hostname when you login to your eQuatePOS.com account.

 

Adding Prestashop to eQuate POS

Once you have backed up your Prestashop database, you can proceed to add the connection between Prestashop and eQuate POS from the Back Office.

 

Connecting to Prestashop
  1. Login to the Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Click "Add Online Store" button (see Figure A below).
  5. Enter the Prestashop SQL database details and press "Save Changes" (see Figure B).
  6. Configure the default settings for Prestashop and "Save Changes" (see Figure C).
  7. Allow some time for the data to synchronize. Depending on the size of your Prestashop database, this could take anywhere from 1 to 60 minutes.
  8. Refresh the page to check the status of the synchronization.
Figure A

Add your online store in the Back Office area. Select "New Online Store".

Figure B

Enter your Prestashop SQL details and press "Save Changes".

Figure C

Configure the connection between Prestashop & eQuate POS.

Disabling or Updating PrestaShop
  1. Login to the Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Select your online store and under the Actions column, select "Action", then "Edit" (see Figure D).
  5. You must ensure the database you are editing is the same database that was previously synchronized (see Figure E).
  6. Click "Save Changes" when complete.
Figure D

After saving your online store to eQuate POS, you will see "Pending" until the system has synchronized.

Figure E

To disable the synchronization, select "Edit" under Actions and set the status to Disabled and press "Save Changes".

Connecting to VirtueMart

VirtueMart is an open source based shopping cart available for Joomla. Joomla is a open source content management system (CMS) that allows you to create dynamic websites. 

 

Caution

Always make a back-up copy of your VirtueMart database before adding it to eQuate POS.

eQuate POS can connect to your VirtueMart database and synchronize orders, products, and customers with your in-store operation. Some functions that eQuate offers may not be available in VirtueMart. See below for the full list of supported features:

eQuate Feature VirtueMart 2 VirtueMart 3
Attributes No No
Customers Yes Yes
Discounts Yes Yes
Gift Cards Yes Yes
Images Yes Yes
Inventory Yes Yes
Loyalty No No
Multi Store No * No *
Orders Yes Yes
Stock Adjustments Yes Yes

* VirtueMart only supports one stock inventory database by default. You can add additional stores in eQuate POS, but only one can deduct from VirtueMart inventory. You can choose to share inventory between VirtueMart and a store, or you can also have them as seperate inventories.

 

Before You Begin

Before connecting eQuate POS to VirtueMart, you may need to make adjustments to your VirtueMart installation.

Database:

  • Always make a backup of your VirtueMart database before adding it to eQuate POS.
  • Remote SQL connections to your VirtueMart database is required.
    Some shared web hosting providers may require you to contact them to allow our server to connect through their firewall. If you have dedicated a server for your web hosting, you may need to allow access from our server if you have a firewall enabled. You can find your eQuate POS server hostname when you login to your eQuatePOS.com account.


Limitations:

  • eQuate only supports the default group of specific prices. The price for each product must contain at least one entry for "Available for all".
  • eQuate only supports one tax group. Default tax group is set by the default vendor (ID 1).
  • Only one warehouse is supported for online sales. Multiple stores can be added with seperate inventory buckets however.
  • Attributes & values are not supported by VirtueMart. However, parent & child products are supported.
  • Only supports the default currency set. Default currency is set by the default vendor (ID 1).
  • The "VM Standard Payment" plugin must be enabled in Joomla.

 

Adding VirtueMart to eQuate POS

Once you have backed up your VirtueMart database, you can proceed to add the connection between VirtueMart and eQuate POS from the Back Office.

 

Connecting to VirtueMart
  1. Login to the Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Click "Add Online Store" button (see Figure A below).
  5. Enter the VirtueMart SQL database details and press "Save Changes" (see Figure B).
  6. Configure the default settings for VirtueMart and "Save Changes" (see Figure C).
  7. Allow some time for the data to synchronize. Depending on the size of your VirtueMart database, this could take anywhere from 1 to 60 minutes.
  8. Refresh the page to check the status of the synchronization.
Figure A

Add your online store in the Back Office area. Select "New Online Store".

Figure B

Enter your VirtueMart SQL details and press "Save Changes".

Figure C

Configure the connection between VirtueMart & eQuate POS.

Disabling or Updating VirtueMart
  1. Login to the Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Select your online store and under the Actions column, select "Action", then "Edit" (see Figure D).
  5. You must ensure the database you are editing is the same database that was previously synchronized (see Figure E).
  6. Click "Save Changes" when complete.
Figure D

After saving your online store to eQuate POS, you will see "Pending" until the system has synchronized.

Figure E

To disable the synchronization, select "Edit" under Actions and set the status to Disabled and press "Save Changes".

Connecting to WooCommerce

WooCommerce is an open source based shopping cart available for free as an plugin for WordPress. WordPress allows you to customize your website with a large choice of available templates in their marketplace. WooCommerce also has many addon's that are compatible with eQuate POS. 

 

Caution

Always make a back-up copy of your WooCommerce database before adding it to eQuate POS.

eQuate POS can connect to your WooCommerce database and synchronize orders, products, and customers with your in-store operation. Some functions that eQuate offers may not be available in WooCommerce. See below for the full list of supported features:

eQuate Feature WooCommerce 5.x
Attributes Yes
Customers Yes
Discounts Yes
Gift Cards No
Images Yes
Inventory Yes
Loyalty No
Multi Store No
Orders Yes
Stock Adjustments Yes

 

Before You Begin

Before connecting eQuate POS to WooCommerce, you may need to make adjustments to your WooCommerce installation.

Database:

  • Always make a backup of your WooCommerce database before adding it to eQuate POS.


Limitations:

  • Only one warehouse is supported for online sales. Multiple stores can be added with seperate inventory buckets however.
  • Only supports the default currency set in WooCommerce.

 

Creating an API key in WooCommerce

Before you connect eQuate POS with WooCommerce, you will need to create an API key in WooCommerce's settings.

 

Generating an API Key
  1. Login to your WordPress administrator site. WooCommerce must already be installed to continue.
  2. On the left menu, select "WooCommerce", then select "Settings".
  3. Select "Advanced" on the top menu.
  4. Click "REST API" link on the top page menu (see Figure A below).
  5. Click "Create an API Key".
  6. Give the API Key a description, and select a user with sufficient Administrative privledges. Permissions must be set to Read/Write.
  7. Click "Generate API Key".
  8. On the next page, your Consumer Key and Consumer Secret will be displayed. Save these details for later when you add WooCommerce to eQuate POS.
Figure A

Within WordPress, generate your API key by going to WooCommerce > Settings > Advanced > REST API. 

Figure B

Provide the API key a Description and select an Adminstrative user and set the permissions to "Read/Write" and press "Generate API key".

Figure C

Take note of the Consumer Key and Consumer Secret which you will need while adding WooCommerce to eQuate POS.

 

Installing the eQuate POS WordPress plugin

After you have generated your WooCommerce API key, you must install the eQuate POS plugin. The plugin allows eQuate POS to communicate to your WooCommerce site.

 

Installing the eQuate POS plugin
  1. Download the eQuate POS WordPress plugin here.
  2. Login to your WordPress administrator site. WooCommerce must already be installed to continue.
  3. On the left menu, select "Plugins", then select "Add New".
  4. Select "Upload Plugin" on the top menu.
  5. Attach the eQuate POS WordPress plugin zip file you downloaded (see Figure D below).
  6. You will see that the plugin is now installed, but not activated. Click "Activate Plugin" to enable the plugin (see Figure E below).
Figure D

From your WordPress backend, click "Plugins", then "Add New". Click Upload Plugin and attach the eQuate POS WooCommerce plugin zip file you downloaded.

Figure E

After the plugin has been installed, locate it on the list of plugins and click "Activate".

 

Adding WooCommerce to eQuate POS

Once you have backed up your WooCommerce database, created an API key, and installed the eQuate POS WordPress plugin, you can proceed to the final step of adding the connection between WooCommerce and eQuate POS from the Back Office.

 

Connecting to WooCommerce
  1. Login to the eQuate POS Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Click "Add Online Store" button (see Figure F below).
  5. Enter the WooCommerce API details and press "Save Changes" (see Figure G below).
  6. Configure the default settings for WooCommerce and "Save Changes" (see Figure H below).
  7. Allow some time for the data to synchronize. Depending on the size of your WooCommerce database, this could take anywhere from 1 to 60 minutes.
  8. Refresh the page to check the status of the synchronization.
Figure F

Add your online store in the Back Office area. Select "New Online Store".

Figure G

Enter your WooCommerce API details and press "Save Changes".

Figure H

Configure the connection between WooCommerce & eQuate POS.

Disabling or Updating WooCommerce
  1. Login to the Back Office.
  2. On the left menu, select "Settings & Modules" under Settings.
  3. Select "Online Store" on the left top menu.
  4. Select your online store and under the Actions column, select "Action", then "Edit" (see Figure I below).
  5. You must ensure the database you are editing is the same database that was previously synchronized (see Figure J below).
  6. Click "Save Changes" when complete.
Figure I

After saving your online store to eQuate POS, you will see "Pending" until the system has synchronized.

Figure J

To disable the synchronization, select "Edit" under Actions and set the status to Disabled and press "Save Changes".