Skip to main content

How To Configure Mobile Client Application on Android

Introduction

This guide describes the Mobile Client Configuration process in the Enactor Retail System from an operational perspective. Client Configuration Sets contain device-specific configuration data, such as identity information, that is required by some device types at install time. For most devices, such as Fixed POS, this data is installed to the device during installation.

However, some devices, such as Mobile POS, require more convenient and reliable means. The preferred method is for the device to connect to a web service to download the configuration directly from the central configuration repository at install time. By entering a Registration Serial Number obtained against a device, a Mobile POS is enabled to access the service, identify itself, and receive the device-specific configuration download stored in the Client Configuration Set. The Client Configuration Set identifies a specific Operating System, Device Type, and an Option Set. Option Sets are configuration entities used to define extension properties of an entity.

The purpose of this guide is to demonstrate the steps to configure the Enactor Mobile POS client application on an Android device.


Overview

This guide covers the configuration for the following:

  1. Attribute / Option Sets - Allows maintaining the available settings used to configure Mobile POS devices.
  2. Client Configuration Sets - Allows setting device-specific configurations that bind an operating system, device type and option set together.
  3. Devices - Devices are mapped to the appropriate client configuration set and assigned a registration serial number.
  4. Mobile POS App Functionality - Starting the app on the mobile device and registering it using a serial number.

Prior Training / Experience

You should be familiar with the following:

  • Estate Manager configuration
  • Data broadcasting

Configuration Steps

Attribute / Option Set

Option Sets are used to create user-configurable data entry fields. The purpose and function of the option set is defined by the Option Set Type. Example Client Configuration sets for Android devices are already provided. These can be maintained and added as required. The configured options provide the properties required for the mobile device (Android) when installing a new device.

Navigate to Attribute / Option Set Maintenance using the path: Configuration > Merchandise > Attribute / Option Sets

The following guide uses ANDROID_POS_CONFIG_OPTIONS as the use case.

Select Edit on the Android POS Config Options entry.

Attribute / Option Set Maintenance list showing ANDROID_POS_CONFIG_OPTIONS highlighted with Client Configuration type and All region.

The Attribute / Option Set Maintenance list displays all configured option sets. Select Edit on the ANDROID_POS_CONFIG_OPTIONS row to modify the Android POS properties.

Edit Attribute / Option Set screen for ANDROID_POS_CONFIG_OPTIONS showing a full property tree of Android POS configuration options.

The Edit Attribute / Option Set screen shows all properties defined in the Android POS Config Options set. Select Add at the bottom if new properties are required.
note

Data types can be added as Boolean checkboxes, String drop-down, text, or numeric fields.

Properties are added to the ordered list and are available for individual selection. Properties with associated value sets are displayed with an expand/collapse option to show or hide the values. While the Option Set is selected, further properties may be added. When individual properties are selected, options are available to Edit, Remove, or Change the position of the property in the list.

Edit Choice Option screen showing the Logger Level property on the General tab with ID loggerLevel, and the Values tab listing five log levels: Information, Error, Warning, Debug, and Verbose.

The Edit Choice Option screen allows editing individual properties. The General tab defines the property identity and the Values tab lists the available choices for drop-down fields such as Logger Level.

Bottom section of the option set property tree showing Logger Level expanded with its five values and action buttons Edit, Remove, Move Up, and Move Down.

When a property is selected, use Edit, Remove, Move Up, or Move Down to manage its position and configuration in the list.

Client Configuration Set

The Client Configuration Set identifies a specific Operating System, Device Type, and an Option Set. Create a new client configuration using the Client Configuration Option Set created above.

Navigate to Client Configuration Set Maintenance using the path: Administration > Devices > Client Configuration Sets

Client Configuration Set Maintenance list showing four entries including Android - 0001 - Hertford and IOS - 0001 - Hertford, both Mobile POS type.

The Client Configuration Set Maintenance list shows all configured sets. Select Create a new Configuration Set to add a new entry, or Edit an existing one.

To create a new Client Configuration Set, select Create a new Configuration Set on the Client Configuration Set Maintenance page.


Client Configuration Set - General Tab

The General tab captures the basic identity information of the Client Configuration Set.

Edit Client Configuration Set on the General tab. Description is Android - 0001 - Hertford, Operating System is Android, Device Type is Mobile POS.

Set the identity of the Client Configuration Set on the General tab. Select Android as the Operating System and Mobile POS as the Device Type.

Set the appropriate values on the General tab as follows:

ConfigurationDescription
DescriptionEnter a user-friendly identifier for the Client Configuration Set (alphanumeric, maximum 40 characters). You may enter the store ID for easy identification.
Operating SystemSelect Android from the dropdown list of configured operating systems.
Device TypeSelect Mobile POS from the dropdown list of configured device types.

Client Configuration Set - Properties Tab

The Properties tab captures all properties defined in the Property Set from Attribute / Option Set maintenance.

Edit Client Configuration Set on the Properties tab showing server connection settings with Host Name 20.49.195.64, Port 39901, and Theme NextGen1024x768.

The Properties tab displays all configurable fields from the selected property set. Set the server connection, theme, and process set values as required for the target device.

Set the appropriate values on the Properties tab as follows:

Common Settings

Properties listed under common settings are the mandatory properties that should be set by the user.

Server Connection Properties
EntryExample ValueDescription
Property SetAndroid POS Config OptionsSelect the desired Property Set from the dropdown list of predefined Option Sets.
Host Name20.49.195.64Enter the hostname or IP address of the PDP server the client will connect to.
Port39901Enter the port of the PDP server the client will connect to.
Use SSLTick to indicate the device should use SSL when connecting.
Start Process IDPos/ThinClientStartUpIdentifies the Application Process that will implement data exports using this export type.
ThemeNextGen1024x768Set the POS application view theme from the available theme options (Standard, NextGen, or Gold).
Parent ThemeNextGenSet the parent theme in line with the Theme, Process Set, and Parent Process Set.
Process SetNextGenSet the process set in line with the Theme, Parent Theme, and Parent Process Set.
Parent Process SetNextGenSet the parent process set in line with the Theme, Process Set, and Parent Theme.
View Type IDHTMLPosPDPThis is applicable only for users of HTML (React) POS.
User Interface Properties
EntryDescription
Disable System KeyboardTick to disable the system keyboard. This is mostly applicable for HTML (React) POS users to avoid overlapping of physical and system keyboards.
Screen OrientationSelect the desired screen orientation from the dropdown list: Portrait, Landscape, Reverse Portrait, Reverse Landscape, Sensor Portrait, or Sensor Landscape.

Additional Settings

Additional settings may be applied as required.

Registration Properties
EntryDescription
Registration URLEnter the registration URL the client will use to retrieve configuration data.
Security Properties
EntryDescription
Settings PasswordSet a password required to access the settings of the application.
Show Settings ButtonTick to make the Settings button visible in the reconnection dialog.
Hide Close ButtonTick to hide the Close button in the reconnection dialog.
User Interface Properties
EntryDescription
Default Splash Screen SizeSet a numeric value to define the default splash screen size.
Splash Screen Text ColourSet a value to define the splash screen text colour.
Splash Screen URLEnter a URL for a background image to appear on the splash screen.
Append Theme To Splash Screen URLTick if the background image should be appended to the theme.
Hardware AccelerationTick to enhance hardware performance when using the app.
Override Back ButtonTick to enable back button override.
Font SizeEnter a numeric value to define the font size.
Font Scale MultiplierEnter a numeric value to define the font scale multiplier.
Font Scale AdditionEnter a numeric value to define the font scale addition.
Allow Message PlaybackTick to enable message playback.
Network Properties
EntryDescription
Automatic ResumeTick to enable automatic resume.
Automatic RecoveryTick to enable automatic recovery.
Keep Alive Frequency (ms)Enter a numeric value for the milliseconds between keep-alive messages. Set to zero to disable keep-alive.
Show Network MonitorTick to make the network monitor visible.
Caching Properties
EntryDescription
Save ResourceTick to save resources in the document directory.
Clear Saved ResourcesTick to delete saved resources in the document directory every time the app restarts.
Developer Options
EntryDescription
Save MessagesTick to save messages into local storage.
Development ModeTick to run the application in development mode.
Logging Properties
EntryDescription
Logger LevelSelect the log level from the dropdown list: Information, Error, Warning, Debug, or Verbose. This defines the minimum severity for messages to be logged.
ADB LoggerTick to send log messages to ADB.
ADB MetricsTick to send metrics to ADB.
File LoggerTick to enable logging to a file.
File Logger FilenameEnter the name of the log file.
Log File Size (MBs)Enter a numeric value for the maximum log file size. A new file is created when the size is exceeded.
Log File BackupsEnter a numeric value for the number of backup log files to keep.

Select Save.


Devices

Devices, each with a unique Device ID, are differentiated functionally by the software services offered based on Device Type and individually by the specific instance executing on a given Host Name. Each device is defined in association with a Device Type and a specific Client Configuration Set.

Navigate to Device Maintenance using the path: Administration > Devices > Devices

Using the search filter options, select the Location and set Type to Mobile POS.

Device Maintenance list filtered by Location UK Hertford Store and Type Mobile POS, showing four mobile POS devices.

Filter the Device Maintenance list by Location and Type set to Mobile POS to display the relevant devices. Select Edit on the device you need to configure.

Edit the Mobile POS device to which you need to add the registration.

Device Maintenance editing mpos4@0001.enactor on the Registration tab. Configuration Set is Android - 0001 - Hertford, Download Hostname is 20.49.195.64, and a Registration Serial Number has been generated.

On the Registration tab, select the Configuration Set that matches the device location. Enter the Download Hostname and Download Port, then click Generate to create a Registration Serial Number.

Set the appropriate values on the Registration tab as follows:

EntryExample ValueDescription
Configuration SetAndroid - 0001 - HertfordSelect the store configuration set from the dropdown list. This should match the location associated with the device.
Download Host Name20.49.195.54Enter the host address for the Retail EM services server.
Download Port39833Enter the download port for the Retail EM services server.
Registration Serial NumberClick Generate to create a registration serial number for configuring the app on the mobile device.
Expiry DateSet an expiry date for the registration serial number.

Select Save.


Mobile POS App Functionality

On first-time startup, the mobile app prompts you to select how you would like to configure the application.

Enactor Mobile POS Configure Application screen on first startup showing two options: Configure using a Serial Number and Configure using the settings.

On first startup, the app presents two configuration methods. Select Configure using a Serial Number to use the serial number generated in the Device Registration step.

Select Configure using a Serial Number and enter the serial number generated in the Device Registration step.

Enactor Mobile POS serial number entry screen with the registration serial number entered and Cancel and Submit buttons.

Enter the Registration Serial Number that was generated in the Device Maintenance screen, then select Submit to download the device configuration.

The device will now download the relevant configuration and the app will prompt for a logon.

Enactor Mobile POS logon screen showing User ID and Password fields with a numeric keypad, displayed after successful configuration download.

After the configuration download completes, the POS logon screen appears. Enter the User ID and Password using the on-screen keypad to sign in.

Broadcasting

If Option Set updates have been made that alter the Client Configuration Sets, broadcast the following entities to deliver the configuration changes to the POS:

  • Device
  • Option Set
  • Registration Serial Number
info

After making changes to Client Configuration Sets or Option Sets, you must broadcast the updated entities for the changes to take effect on the POS devices.


Document History

VersionStatusIssue DateAuthorReason for Issue
1.0Initial Draft14 March 2026Mark HarrisonReformatted to Enactor documentation standards