Skip to content

Update InStore App settings docs for v1.3.0 #24

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

Update InStore App settings docs for v1.3.0 #24

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
110 changes: 54 additions & 56 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,48 +3,18 @@ slug: /poscreators/middleware-doc/instore-app/available-settings
title: Available Settings
---

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

:::info Important

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

:::

## DeviceId
Shows the unique identifier of this device. Quote this ID when contacting support or managing a fleet. *(Read‑only.)*

## DeviceType
Displays the device model/type (e.g., terminal vendor and model). Useful to identify hardware-specific behavior. *(Read‑only.)*

## IP Address
Shows the current IP address of the device on your network. Use it when setting up network printing or firewall rules. *(Read‑only.)*

:::info Note

This setting only appears when the device is connected via **LAN/WLAN**. When using **mobile data**, the IP Address field is hidden.

:::

---

## Base settings

### CashBoxId
The CashBox the app is paired with. It links the app to the correct fiscal/payment configuration.

### 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.
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.

### 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)
## Main settings

### Operation Mode
Defines which features are available in the UI. Some options and sections appear or hide based on this selection:
Expand All @@ -54,6 +24,22 @@ 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.

### 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)

### Enable running in Background
Runs the app as an **Android foreground service** also displaying a notification in the Android status bar (when notifications are enabled in Android settings) that shows "InStore App is running in the background". The service takes care that the app is run at all times.

When enabled it results in the following behaviour:
- Even if the InStore App is not in foreground (e.g., the user is working with the POS app on the same device), it continues to run in the background.
- The InStore App **auto‑starts after device boot** so no manual start is required after boot. This means even without ever starting the InStore App manually it will start in the background automatically and can process actions (like trigger payments or show receipts).

:::info Note

This setting is **mandatory for Android 15+**.

:::

### Use local configuration

Expand All @@ -67,39 +53,28 @@ Currently, this setting can only be configured by internal staff via the backend

:::


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:
- **Per device**: A specific configuration for each individual device.
- **Per cashbox**: A shared configuration for all devices connected to a particular cashbox.


---

## App settings

### Enable running in Background
Runs the app as an **Android foreground service** also displaying a notification in the Android status bar (when notifications are enabled in Android settings) that shows "InStore App is running in the background". The service takes care that the app is run at all times.

When enabled it results in the following behaviour:
- Even if the InStore App is not in foreground (e.g., the user is working with the POS app on the same device), it continues to run in the background.
- The InStore App **auto‑starts after device boot** so no manual start is required after boot. This means even without ever starting the InStore App manually it will start in the background automatically and can process actions (like trigger payments or show receipts).

---

## Printer settings

Tapping **Printer** opens a sub-page where you can select a printer and configure print options.

:::info Note

Some options depend on the selected mode.
Some options depend on the selected Operation Mode.

:::

#### Printers
#### Printer
Shows all available printers (USB, Bluetooth, or ESC POS Network printing). Select the one you want to use.

**ESC POS Network printing** is available as a new default option and can be configured.
**ESC POS Network printing** is available as a default option and can be configured.

#### 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.
Expand All @@ -108,7 +83,7 @@ Default: 30s.
**Available only in Consumer mode.**

#### Paper width
Set the receipt width: **48 mm**, **72 mm**, or **80 mm**.
Set the receipt width: **48 mm**, **72 mm**, or **80 mm**.

#### Print Demo
Executes a simple "demo" test print to check basic printer functionality.
Expand All @@ -117,13 +92,9 @@ Executes a simple "demo" test print to check basic printer functionality.

## Payment settings

:::info Note

The UI first asks you to pick a **Payment** method. Depending on the method, additional fields can appear.
Tapping **Payment Method** opens a sub-page where you select and configure a payment provider.

:::

#### Payment
#### 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**).
After selection, provider‑specific options appear as needed.

Expand All @@ -142,6 +113,33 @@ After selection, provider‑specific options appear as needed.

---

## Other

### Advanced

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

#### 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.
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.

### 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.
- **Version** – The currently installed app version.

---

## Best practices

- Keep **Use local configuration** **off** if you manage settings centrally — this prevents drift from backend policies.
Expand Down
Loading