Skip to content

updated availible settings #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaximilianFT wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updated availible settings #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 74 additions & 35 deletions poscreators/middleware-doc/instore-app/available-settings/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,21 @@ slug: /poscreators/middleware-doc/instore-app/available-settings
title: Available Settings
---

# Available Settings - InStore App (v1.3.0)
# Available Settings - InStore App (v1.3.1)

:::info Important

All settings and options described here apply **only** to version **1.3.0** of the InStore App.
All settings and options described here apply **only** to version **1.3.1** of the InStore App.
If you are using an older version, some settings may differ or may not be available at all.

:::

:::info Visibility of settings

Many settings are shown or hidden depending on context — the selected **Operation Mode**, whether a real (non-virtual) printer is selected, and the selected payment provider. Some options only appear in internal **sandbox/development** builds. Where this is the case, it is noted below.

:::

---

## Main settings
Expand All @@ -24,6 +30,12 @@ Defines which features are available in the UI. Some options and sections appear
- Pull **down** on the QR code screen to show the receipt.
- Pull **up** to reveal action buttons.

:::info Note

Selecting **Merchant** mode automatically enables **Enable running in Background** (see below).

:::

### Terminal ID Filter
Filters receipts and data for a specific terminal within the CashBox.
For advanced multi-terminal options, see [Multiterminal Settings](https://docs.fiskaltrust.eu/docs/poscreators/middleware-doc/instore-app/multiterminal-settings)
Expand All @@ -37,7 +49,7 @@ When enabled it results in the following behaviour:

:::info Note

This setting is **mandatory for Android 15+**.
This setting is **mandatory for Android 15+**. It is only shown on Android (it is hidden on Windows).

:::

Expand All @@ -47,12 +59,6 @@ If enabled, local device settings override the backend configuration.

If disabled, the app follows centrally managed (backend) settings.

:::info Note

Currently, this setting can only be configured by internal staff via the backend. Customers do not yet have the ability to change this setting themselves.

:::

Once the setting is disabled and the app is restarted, the configuration stored in the backend will be loaded into the app.

This configuration can be applied:
Expand All @@ -63,27 +69,32 @@ This configuration can be applied:

## Printer settings

Tapping **Printer** opens a sub-page where you can select a printer and configure print options.
Tapping **Printer** opens a picker where you can select a printer; the remaining print options appear once a real printer is selected.

:::info Note

Some options depend on the selected Operation Mode.
Some options depend on the selected Operation Mode and on the selected printer type.

:::

#### Printer
Shows all available printers (USB, Bluetooth, or ESC POS Network printing). Select the one you want to use.
Shows all available printers (USB, Bluetooth, or **ESC POS Network printing**). Select the one you want to use. Some payment terminals also expose an integrated printer (e.g. the Shift4 Commerce Engine printer or a SmartPOS integrated printer), which appears here when that payment provider is active.

**ESC POS Network printing** is available as a default option and can be configured.
**ESC POS Network printing** is available as a default option and can be configured via the **IP Address** and **IP Port** fields (see below).

#### Print Delay
Defines the delay before an issued receipt will get printed automatically if the guest/customer is not receiving the receipt in another way like scanning the QR code with their phone, just accepting it by pressing OK or another method.

Default: 30s.
**Available only in Consumer mode.**
Adjust the value with the **–/+** stepper in **5‑second steps**. The range is **0–100 s**; a value of **0** is shown as **"Off"** and disables the automatic timed print.

Default: 30 s.
**Available only in Consumer mode and only when a real printer is selected.**

#### Paper width
Set the receipt width: **48 mm**, **72 mm**, or **80 mm**.
Set the receipt width: **48 mm**, **72 mm**, or **80 mm**. *(Shown only when a real printer is selected.)*

#### IP Address / IP Port
Shown only when **ESC POS Network printing** is selected. Enter the printer's network **IP Address** and **IP Port** (default port **9100**).

#### Print Demo
Executes a simple "demo" test print to check basic printer functionality.
Expand All @@ -95,53 +106,81 @@ Executes a simple "demo" test print to check basic printer functionality.
Tapping **Payment Method** opens a sub-page where you select and configure a payment provider.

#### Payment Method
Select the payment provider to use on this device (e.g., **Hobex ECR**, **Hobex POSit**, **Softpay.io**, **WPI SoftPay**, **Viva Wallet**, **GP tom**, **GP Pay**, **Shift4**).
Select the payment provider to use on this device. The list shown in the picker depends on the device and build, and may include:

- **HobexECR**
- **Hobex POSit**
- **Softpay.io**
- **Worldline/PayOne SmartPOS** or **Worldline/PayOne TOM** (depending on the device type)
- **Viva Wallet SoftPay**
- **GPTom SoftPay**
- **GPPay**
- **Shift4 / S4**

After selection, provider‑specific options appear as needed.

##### Hobex ECR (example of provider‑specific fields)
- **Hobex ECR TerminalId** – The terminal ID assigned by Hobex.
- **Hobex ECR Password** – The password for ECR integration.
- **Hobex ECR Host** – Hostname or IP of the ECR endpoint.
- **Hobex ECR Port** – TCP port of the ECR endpoint.
- **Test Communication** – Checks connectivity with the configured ECR endpoint before going live.
##### Use Sandbox app *(internal / sandbox builds only)*
For **Softpay.io**, **Hobex POSit**, and **GPTom**, sandbox/development builds show a **Use Sandbox app** switch. When enabled, the provider's sandbox app is used instead of the production app. This switch is not present in production builds.

##### HobexECR (example of provider‑specific fields)
- **Terminal ID** – The terminal ID assigned by Hobex.
- **Password** – The password for ECR integration (tap the eye icon to reveal/hide it).
- **Host** – Hostname or IP of the ECR endpoint (default `localhost`).
- **Port** – TCP port of the ECR endpoint (default `9990`).

##### Shift4

- **Auth Token** - The merchant auth token which will be provided by merchant's Lighthouse Transaction Manager Account Administrator. For further help please refer to Shift4 support.
- **CE Host** - The Commerce Engine Host address to connect to and process payment requests. If not otherwise provided by fiskaltrust support please use *127.0.0.1:8085*
- **Test Communication** - Checks connectivity with the configured Shift4 Commerce Engine host. Connection check has a timeout of 60s.
- **Auth Token** – The merchant auth token which will be provided by the merchant's Lighthouse Transaction Manager Account Administrator. The expected format is `12345678-ABCD-1234-ABCD1234567890EF` (uppercase hex); an inline message is shown if the format is invalid. For further help please refer to Shift4 support.
- **Commerce Engine Host** – The Commerce Engine host address to connect to and process payment requests. If not otherwise provided by fiskaltrust support please use *127.0.0.1:8085*.
- **Allow API Debugging** – Allows insecure certificates for troubleshooting. **Do not use in production.**

#### Test Communication
Shown for **HobexECR** and **Shift4**. Checks connectivity with the configured payment endpoint before going live. For Shift4 the check can take up to ~180 s.

---

## Other

The **Other** section of the Settings page contains two rows — **Advanced** and **About** — each opening its own sub-page.

### Advanced

Tapping **Advanced** opens a sub-page with the following actions:
Tapping **Advanced** opens a sub-page with the following options:

#### Enable webview URL
When enabled, the configured URL is shown on the home screen (the idle "no active session" view) instead of the default screen. Enter a valid `http://` or `https://` URL in the field that appears. While the toggle is on but the field is empty or the URL is invalid, the app keeps showing the default home screen and displays an inline warning.

#### Lock settings via PIN
When enabled, opening the **Settings** page requires a 6‑digit PIN. This prevents unwanted configuration changes (e.g. by waiters).

- When you enable the lock, the app shows the **fixed PIN once** so you can note it down — the PIN does not change.
- Disabling the lock also requires entering the PIN.
- After **5 wrong attempts within one hour**, PIN entry is locked for up to an hour.

#### Unpair CashBox
Disconnects the current CashBox to pair another one (e.g., when moving the device to a new store).

#### End App
Closes the app gracefully and persists configuration changes.
#### Quit App
Closes the app gracefully after a confirmation prompt and persists configuration changes.
It also stops the background service, so **Enable running in Background** is no longer active until the app is started again.
*Note:* Closing during an active process (e.g., printing) may interrupt that process, finish ongoing tasks first.
*Note:* Closing during an active process (e.g., printing) may interrupt that process — finish ongoing tasks first.

### About

Tapping **About** opens a sub-page showing device and app information. *(All fields are read‑only.)*

- **IP Address** – The current IP address of the device on your network. Use it when setting up network printing or firewall rules. Only appears when the device is connected via **LAN/WLAN**; hidden when using mobile data.
- **Device Type** – The device model/type (e.g., terminal vendor and model). Useful to identify hardware-specific behavior.
- **Device ID** – The unique identifier of this device. Quote this ID when contacting support or managing a fleet. If the value is truncated, tap it to show the full ID in a popup.
- **CashBox ID** – The CashBox the app is paired with. If the value is truncated, tap it to show the full ID in a popup.
- **Support contact** – Displays the fiskaltrust support email address.
- **Device ID** – The unique identifier of this device. Quote this ID when contacting support or managing a fleet. Tap it to show the full ID in a popup.
- **CashBox ID** – The CashBox the app is paired with (shows **"Not paired"** when no CashBox is paired). Tap it to show the full ID in a popup.
- **Support contact** – Displays the fiskaltrust support email address: **hello@fiskaltrust.eu**.
- **Version** – The currently installed app version.

---

## Best practices

- Keep **Use local configuration** **off** if you manage settings centrally — this prevents drift from backend policies.
- For **Hobex ECR**, use **Test Communication** before going live.
- For **Shift4**, use **Test Communication** before going live.
- Use **Test Communication** before going live for **HobexECR** and **Shift4**.
- Keep **Allow API Debugging** (Shift4) **off** in production — it is for troubleshooting only.
- When using **Lock settings via PIN**, note the PIN shown on activation and store it safely.
Loading