Configuration
  • 17 Dec 2024
  • 6 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Configuration

  • Dark
    Light
  • PDF

Article summary

Configuration of Mobile POS

The following article outlines all configuration parameters available for Mobile POS. The configuration determines what functionality is available or not inside the app, as well as the look and feel of the app.

All configuration can be set common for all stores or seperate for each store. The lowest level configuration set will be applied. For example, if something is configured on common level and then the same configuration is changed on the store level, it is the store level configuration which will apply for the given store.

The configuration can be changed inside EG Chain, provided your user has access. It is important to remember, that when a configuration is changed, the user must click Activate in order for the change to take affect.

In addition to the configuration listed below, Mobile POS also depends on configuration of the cash register in the POS API. This is configured in POS Configuration. The POS Configuration is responsible for configuring business logic related to the cash register itself, the cart handling and receipt details. An example of such business logic is for instance, defining what currency is used in the sale. How to configure a cash register will be documented under EG Retail Platform.

Important to remember during configuration of the solution:

  1. When changing the POS Configuration, for the changes to trigger after activation, a reload of POS API is required. Commonly known as a swap.

  2. When changing Mobile POS Configuration, changed configuration is reloaded upon logging into the app. So logging out and logging back in again is sufficient to trigger the changes.

  3. When configuring automatic login to Softpay, meaning the mapping of store’s from EG’ solution to the stores in Softpay’s solution, a reload of the Mobile POS backend is required. Commonly known as swap.


Available Configuration Parameters

AutoLogoutWhenIdle

The number of minutes before user is automatically logged out of the application when the application is running in the background on the device. Values is set in number of minutes.

Maximum possible value is 48 hours, which equals to 2880 minutes. If the value set is higher than 2880, user will still be logged out after 2880 minutes of inactivity.

AutoLogoutWhenInReceiptTimeout

The number of minutes before user is automatically logged out of the application when the application is running in the background on the device during an active sale. Values is set in number of minutes.

Maximum possible value is 48 hours, which equals to 2880 minutes. If the value set is higher than 2880, user will still be logged out after 2880 minutes of inactivity.

AvailablePrinters

If the value is set to blank, print button inside the app will not be visible, nor will the peripherals option which allows you to connect to printer. The values set in this configuration defines available printer types for the given store. Currently, the only supported printer type is Epson.

CartOrdering

Possible values: LatestOnBottom/LatestOnTop. This defines the order in which items are added to sale. E.g. If LatestOnTop is set, all items added to a sale will be added to the top.

CreateMemberEnabled

Defines whether to show "create member" button or not. Possible values: true or false. E.g. If set to false, the create member button is not visible.
When set to true, user will also be given an option to update/save member information when changing/adding email for digital receipt.

CreditCustomerIntegration

Defines whether customer functionality is available in the app. Possible values: true or false. If value is set to false, it will not be possible to search for customer, add customer or perform credit sale.

CustomerOrderEnabled

Defines whether the app will show the option which allows the user to sell an item that is not in stock of the given store by placing an order. Possible values: true or false.

DefaultItemView

Defines the default item view for sales view and search view. Possible values: Compressed, image or expanded.

DigitalReceiptOptions

This parameter allows user to configure which digital receipt options are available for the user after payment is completed. Available options: Email, QR, SMS.

DispatchRule

The DispatchRuleID for customers using weborder functionality. Set the DispatchRuleID as value if weborder functionality is to be used. This is a requirement if CustomerOrderEnabled is set to true.

DummyCustomerWhenQuantityOver1

The value should contain either an empty value or a customer number. If customer number is set, this customer will be added to the sale automatically when navigating to payment if quantity of any item exceeds 1. This will not occurr if customer has already been added to sale.

EnabledPaymentProviders

Defines available payment methods. E.g. Softpay, Vipps, Coopay, Swish, Instabank, Mobile Pay, Klarna, Giftcard.

EnabledGiftcards

Defines whether gift card functionality should be shown in Mobile POS. Possible values: true/false. If set to true, it is possible to sell, check balance and pay with gift cards from EG Giftcard module.

ExternalStoreNumberInReceipt

During online return, perform an additional lookup of storenumber against the externalstorenumber. Set to true when storenumber is external storenumber on receipt.

FetchDeliveryAlternativesFromDispatch

Possible values: true/false. If set to true, when creating a weborder, delivery alternatives are fetched from DispatchService. If set to false, delivery alternatives are fetched from FreightChargeItem in POS Configuration.

HideLoginType

Possible values: Cashier. Hide a login type when logging into the app.

ImageEANRegex

Regex used for lookup of images using URL to 3rd party. Generally used for items with many sizes and colours.

ImageURLTemplate

Value can contain a URL which Mobile POS will use to lookup images for items. If blank, Mobile POS will not try to find images.

LoyaltyIntegrationProvider

This parameter defines what the master source for loyalty system should be used. Possible values: memberservice and POSCustomerService. If any other source than EG Loyalty is used, the value should be set to POSCustomerService.

MemberRegistrationFields

This parameter determines which fields are visible and/or mandatory when creating a member from Mobile POS.

MemberServiceSiteName

Set the sitename for the given loyalty program the store is a part of. Only required when using EG Loyalty.

MemberTermsURL

Value can contain a URL which user is directed to when clicking on "member terms" inside the app.

RequiredForCreditSale

When performing a credit sale, user can be prompted to fill in Reference number, Reference text and/or Social security number. This parameter defines which of these 3 fields should be shown and which fields should be mandatory.

ReUseCartItemIfPossible

When adding 2 of the same item, this determines if the item is split into separate rows or not. If set to true, many of the same item is added as 1 row, if false, each scan creates separate lines.

SalesBoardSource

Possible values: PLUList/PLUBoard/Empty. This defines from where items for sales board are fetched.

SoftpayMainLogin

Encrypted username for logging into Softpay on devices with GMS. Used for automatic login to Softpay.

SoftpayMainPassword

Encrypted password for logging into Softpay on devices with GMS. Used for automatic login to Softpay.

SoftpayBackupLogin

Encrypted username for logging into Softpay on devices without GMS. Used for automatic login to Softpay.

SoftpayBackupPassword

Encrypted password for logging into Softpay on devices without GMS. Used for automatic login to Softpay.

StartingPage

Defines the default starting page when using Mobile POS. Possible values: salesview or salesboard.

ThumbnailImageURLTemplate

Value can contain a URL which Mobile POS will use to lookup images for items to show as thumbnails. If blank, Mobile POS will not try to find images.

UseModelItemFunctionality

Possible values: true/false. If set to true (default value), user will have size and colour selector for model items. If set to false, model item functionality will be removed from the app.

WebshopURL

Define a URL which will look up items in the webshop based on item identifier.


Was this article helpful?

ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence