diff --git a/poscreators/middleware-doc/instore-app/Setup-guide/images/PairDevice.png b/poscreators/middleware-doc/instore-app/Setup-guide/images/PairDevice.png index 53aa112..62011e6 100644 Binary files a/poscreators/middleware-doc/instore-app/Setup-guide/images/PairDevice.png and b/poscreators/middleware-doc/instore-app/Setup-guide/images/PairDevice.png differ diff --git a/poscreators/middleware-doc/instore-app/Setup-guide/setup.md b/poscreators/middleware-doc/instore-app/Setup-guide/setup.md index b95a4a6..4e2d0d4 100644 --- a/poscreators/middleware-doc/instore-app/Setup-guide/setup.md +++ b/poscreators/middleware-doc/instore-app/Setup-guide/setup.md @@ -5,117 +5,90 @@ title: Getting Started # Getting Started -This guide explains how to install the Fiskaltrust app and connect it to your cash register. -Please follow the steps below in the given order. +To install the fiskaltrust InStore App and connect it to your cash register, complete the following steps. -**1. Install the app** +## Step 1: Install the app -Please check our [installation guides](../installation-guides/installation-guides.md) for details. +Refer to the [installation guides](../installation-guides/installation-guides.md) for detailed intructions. -**2. Start the App and Grant Permissions** +## Step2: Start the app and grant permissions -- Once installed, launch the app. -- If prompted, enable the option **"Display over other apps"** (this allows the app to stay in the foreground while you work in other apps). - - _Tip:_ If this option is disabled, a prompt will appear asking you to enable it. - Please confirm this setting. +* Once installed, launch the app. +* If prompted, enable the **Display over other apps** option (this allows the app to stay in the foreground while you work in other apps).
![DisplayOverApps](./images/DisplayOverApps.png) -![DisplayOverApps](./images/DisplayOverApps.png) +:::tip -**3. Access the Fiskaltrust Portal** +If this option is disabled, a prompt appears asking you to enable it. Confirm the setting. -- If you want to **test** your setup in the **Sandbox environment** , open the **Fiskaltrust Sandbox Portal** for your country in your web browser: - - [**Open Fiskaltrust Sandbox Portal**](https://portal-sandbox.fiskaltrust.at/) -- If you’re ready to go live in **production** , make sure to use the **production link** for your country: - - [**Open Fiskaltrust Production Portal**](https://portal.fiskaltrust.at/Account/Login?returnUrl=%2fCashBox#/) +::: -Make sure to select the correct country within the portal to match your region. +## Step 3: Access the fiskaltrust Portal -**4. Select Your Cashbox** +* If you want to test your setup in the Sandbox environment, open the fiskaltrust [Sandbox Portal](https://portal-sandbox.fiskaltrust.at/) for your country in your web browser. +* If you’re ready to go live in Production, use the [Production Portal](https://portal.fiskaltrust.at/Account/Login?returnUrl=%2fCashBox#/) for your country. -- Once in the portal, select your **Cashbox**. This is the virtual cash register you will connect to the app. - -![Cashbox](./images/Cashbox.png) - -**5. Copy the PAIR CODE** +Make sure to select the correct country in the portal to match your region. -- In the Cashbox overview, you will find your **PAIR CODE**. This code is used to pair your app with the Cashbox. - - **Example PAIR CODE:** 8639 - Copy this code. - -![PIN for InStore App](./images/PINforInstoreApp.png) +## Step 4: Select your Cashbox -**6. Enter the PAIR CODE in the App** - -- Now, open the Fiskaltrust app on your device and paste the previously copied **PAIR CODE** into the designated field. -- Click **"Pair"** to connect the app with your Cashbox. +In the portal, navigate to **Configuration** > **CashBox** and select your Cashbox. This is the virtual cash register you will connect to the app. -![PairDevice](./images/PairDevice.png) - ---- - -**You Are Ready to Go!** - - -Once the pairing is successful, your app is now connected to your Cashbox, and you can -start using it. If you need further assistance, please do not hesitate to contact us. - ---- - +![Cashbox](./images/Cashbox.png) -If you have any questions or encounter issues during installation, please first check the -FAQ section for possible solutions. If you still need assistance, feel free to reach out to -our support team. +## Step 5: Copy the PIN for InStore App ---- +In the CashBox overview, you will find your **PIN for InStore App**. This PIN is used to pair your app with the Cashbox. Example pairing PIN: 8639. Copy this code. -**Fiskaltrust Team** +![PIN for InStore App](./images/PINforInstoreApp.png) -[Support Website](https://www.fiskaltrust.at/support) +## Step 6: Enter the PIN code in the app ---- +* Open the InStore App on your device and enter the previously copied pairing PIN into the designated field. +* Click **Pair** to connect the app to your CashBox.
![PairDevice](./images/PairDevice.png) +Once the pairing is successful, your app is connected to your CashBox and ready to use. +If you have any questions or encounter issues during installation, first check the following FAQ section for possible solutions. If you still need assistance, contact our support team at support@fiskaltrust.eu. -**Frequently Asked Questions (FAQ)** +## Frequently Asked Questions (FAQ) **Q: The printer is not showing up. What should I do?** -- **A:** Please ensure that **Bluetooth** is enabled on your device. The app requires +- **A:** Ensure that **Bluetooth** is enabled on your device. The app requires Bluetooth to connect to the printer. You can check the Bluetooth settings in your - device’s settings menu. + device's settings menu. **Q: How can I reconnect the app to my Cashbox?** -- **A:** If the connection between the app and the Cashbox is lost, simply open the - Fiskaltrust Portal again, copy the **PAIR CODE** , and re-enter it in the app. This will +- **A:** If the connection between the app and the Cashbox is lost, open the + fiskaltrust Portal again, copy the **pairing PIN** , and re-enter it in the app. This will re-establish the connection. -**Q: The app isn't opening after installation. What do I do?** +**Q: The app isn't opening after installation. What should I do?** - **A:** Make sure that your device has sufficient storage and that all necessary - permissions (e.g., storage access, Bluetooth access) are granted. Try restarting + permissions (e.g., storage access and Bluetooth access) are granted. Try restarting your device and reinstalling the app if necessary. **Q: I received an error message when pairing. What does it mean?** -- **A:** This could indicate an issue with the PAIR CODE. Please double-check the - PAIR CODE you entered to ensure it is correct. You can also try copying and - pasting the code again from the Fiskaltrust Portal. +- **A:** This may indicate an issue with the pairing PIN. Double-check the + code you entered. You can also try copying it again from the fiskaltrust Portal. -**Q: How can I update the Fiskaltrust app?** +**Q: How can I update the fiskaltrust InStore App?** -- **A:** To ensure you have the latest version of the app, revisit the **download page** - and download the newest version. The app will automatically update when a new +- **A:** To ensure you have the latest version, revisit the download page + and install the newest version. The app will automatically update when a new version is available. **Q: Can I use the app without an internet connection?** - **A:** The app requires an internet connection for initial setup and communication - with the Fiskaltrust portal. However, once set up, the app can function offline for - day-to-day use, provided it was previously paired with the Cashbox. + with the fiskaltrust Portal. However, once set up, the app can function offline for + day-to-day use, provided it has been previously paired with the CashBox. **Q: The app is not responding or freezing. What should I do?** -- **A:** If the app freezes or becomes unresponsive, try restarting the app or your +- **A:** If the app freezes or becomes unresponsive, try restarting the app on your device. If the issue persists, check for available updates or reinstall the app to - ensure it's running the latest version. + ensure you are running the latest version. diff --git a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_implementation_overview.png b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_implementation_overview.png index b7ae9b7..d4d2c09 100644 Binary files a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_implementation_overview.png and b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_implementation_overview.png differ diff --git a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.jpg b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.jpg deleted file mode 100644 index a9ff47b..0000000 Binary files a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.jpg and /dev/null differ diff --git a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.png b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.png new file mode 100644 index 0000000..1b9d626 Binary files /dev/null and b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_pair_device.png differ diff --git a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_show_receipt.png b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_show_receipt.png index 12b31dd..476058f 100644 Binary files a/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_show_receipt.png and b/poscreators/middleware-doc/instore-app/introduction/images/InStore_App_show_receipt.png differ diff --git a/poscreators/middleware-doc/instore-app/introduction/images/fiskaltrust.Portal_pairing_pin.png b/poscreators/middleware-doc/instore-app/introduction/images/fiskaltrust.Portal_pairing_pin.png index 37aa846..4eb0f6f 100644 Binary files a/poscreators/middleware-doc/instore-app/introduction/images/fiskaltrust.Portal_pairing_pin.png and b/poscreators/middleware-doc/instore-app/introduction/images/fiskaltrust.Portal_pairing_pin.png differ diff --git a/poscreators/middleware-doc/instore-app/introduction/introduction.md b/poscreators/middleware-doc/instore-app/introduction/introduction.md index 79c421b..0fc3c12 100644 --- a/poscreators/middleware-doc/instore-app/introduction/introduction.md +++ b/poscreators/middleware-doc/instore-app/introduction/introduction.md @@ -5,112 +5,123 @@ title: Introduction # Introduction -The fiskaltrust InStore app can be used on a touch-enabled devices with an integrated thermal printer. The fiskaltrust InStore App can listen to receipt issuing of multiple CashBoxes filtered by provided terminal-identification by each CashBox. Each time a related CashBox issues a receipt, the fiskaltrust InStore App pops up on the consumer facing touch screen and shows the following elements: +The fiskaltrust InStore App can be used on touch-enabled devices with an integrated thermal printer. The fiskaltrust InStore App can listen to receipt issuing of multiple CashBoxes, filtered by provided terminal-identification by each CashBox. Each time a related CashBox issues a receipt, the fiskaltrust InStore App appears on the consumer-facing touchscreen and shows the following elements: -* Number, moment of creation and total amount of the receipt -* QR-Code with the https-receipt-link to hand over receipt to the consumer -* Accept button to manually acknowledge received receipt -* Print button with a countdown to print receipt +* The receipt number, creation time, and total amount. +* A QR code containing the HTTPS receipt link for the consumer to access the receipt. +* An OK button to manually acknowledge receipt. +* A Print button with a countdown timer to print receipt. +* A Send per Mail button to send the receipt via email. +* A Send per SMS button to send the receipt via SMS. -When the QR-Code is scanned and the https-receipt-link is used to download the https-receipt-document, then in the background there is an acknowledgement logged for receiving the receipt by the consumer and the current receipt display is closed. +When the QR code is scanned and the HTTPS receipt link is used to download the receipt, an acknowledgement of receipt by the consumer is logged in the background, and the current receipt display is closed. -When the accept button is pressed by the consumer, then a manual acknowledgement for receiving the receipt is logged and the current receipt display is closed. +When the OK button is tapped by the consumer, a manual acknowledgement of receipt is logged, and the current receipt display is closed. -When the print button is pressed by the consumer, or when the timeout/countdown is exceeded, then a paper receipt is printed and printing is logged for analytics. The current receipt display is closed after successful printing. +When the Print button is tapped by the consumer, or when the countdown expires, a paper receipt is printed and the event is logged for analytics. The current receipt display is closed after successful printing. -Setting up the InStore App requires no implementation into the Point of Sale software. +When the Send per Mail button is tapped by the consumer, a screen is displayed prompting the consumer to enter their email address. -Since all operations within the app (Including QR-Code scanning, accepting and printing) are meticulously logged in the fiskaltrust.Portal, the InStore App attains complete compliance with Austria's obligation to issue receipts ("Belegausgabepflicht") and the obligation to accept receipts ("Belegannahmepflicht"), as well as Germany's obligation to issue receipts ("Belegausgabepflicht"). Furthermore, the app ensures that the receipt will always be issued to the consumer. +When the Send per SMS button is tapped by the consumer, a screen is displayed prompting the consumer to enter their phone number. -fiskaltrust appointed Dr. Markus Knasmüller from BMD to create an external assessment about the conformity of the digital receipt in Austria. The final assessment can be requested here: https://forms.office.com/e/0PcMDYWC2B +Setting up the InStore App requires no implementation into the point-of-sale software. -## Receiving receipts with InStore App +Since all operations within the app (including QR code scanning, accepting, and printing) are fully logged in the fiskaltrust.Portal, the InStore App ensures compliance with Austria's obligation to issue receipts ("Belegausgabepflicht") and to accept receipts ("Belegannahmepflicht"), as well as Germany's obligation to issue receipts ("Belegausgabepflicht"). Furthermore, the app ensures that the receipt is always issued to the consumer. -This sequence diagram describes the process of generating a digital receipt with the InStore App. The participants in the process are the merchant, fiskaltrust, consumer and the InStore App. +fiskaltrust appointed Dr. Markus Knasmüller from BMD to create an external assessment of the conformity of digital receipt in Austria. The final assessment can be requested via the [request form](https://forms.office.com/e/0PcMDYWC2B). + +## Receiving Digital Receipts with InStore App + +The following diagram describes the process of generating a digital receipt with the InStore App. The participants in the process are the merchant, fiskaltrust, the consumer and the InStore App. ![InStore App_sequence](../introduction/images/sequenze_diagramm_instore_app.png) -The InStore App offers three options: scan QR-Code to receive digital receipt on mobile phone, accept button to manually acknowledge received receipt and print receipt on thermal paper. +The InStore App offers five options: scanning the QR code to receive the digital receipt on a mobile phone, tapping the OK button to manually acknowledge receipt, printing the receipt on thermal paper, sending the receipt via email, or sending it via SMS. + +In-store, the merchant collects items and processes the payment or checkout. The merchant then sends a sign message to fiskaltrust for fiscalization purposes. + +- **Scan QR code:** The InStore App continuously listens to the fiskaltrust receipt backend for incoming receipt push events. When an HTTPS receipt link is received, it displays a QR code on the device screen. The consumer scans the QR code with their mobile phone and receives the HTTPS receipt link. The InStore app sends a log to the fiskaltrust backend indicating that the receipt was scanned by the consumer. The fiskaltrust backend renders the receipt, and the QR code display on the InStore App device is closed. The consumer can now accesses the HTML receipt document and provide feedback regarding the receipt. -In store, the merchant collects items and processes the payment or checkout. Then the merchant sends a sign message to fiskaltrust for fiscalization purposes. +- **Acknowledge:** The consumer manually acknowledges receipt by tapping the OK button in the InStore App. The InStore app sends a log to the fiskaltrust backend indicating that the receipt was acknowledged manually. The InStore app receives a response from the fiskaltrust backend to close the display. -**Scan QR-Code:** The InStore App constantly listening to the fiskaltrust receipt backend, if there is an receipt push command. Once the InStore App received an https receipt link, the QR-Code gets visualized on the InStore App device. The consumer scans the QR-Code with his mobile phone. He receives the https receipt link, the InStore App sends an log that the receipt got scanned by consumer. The fiskaltrust backend renders the receipt, the QR-Code display on the InStore App device closes. The consumer can now accesses the HTML receipt document. The consumer can then provide feedback regarding the receipt. +- **Print receipt:** Consumers can manually initiate paper receipt printing on the InStore App device by tapping the Print button. Additionally, if there is no user interaction, a paper receipt is automatically printed after a default countdown of 15 seconds. Once the receipt is printed, the display closes and the print command is logged. -**Acknowledge:** The consumer manually accepts the he received the receipt, by pressing the accept button on the InStore App. The InStore App send to fiskaltrust backend and log, that the receipt got acknowledged manually. The InStore App gets a response from fiskaltrust, to close the display. +- **Send receipt via email:** Consumers can choose to receive the digital receipt via email by tapping the Send per Mail button on the InStore App device. A screen will then be displayed where the consumer can enter their email address. -**Print receipt:** Consumers can manually initiate paper receipt printing on the InStore App device by clicking the print button. Additionally, in the absence of user interaction, a paper receipt will be automatically printed after a default countdown of 15 seconds. Once the receipt is printed, the display will close and the print command will be logged. +- **Send receipt via SMS:** Consumers can choose to receive the digital receipt via SMS by tapping the Send per SMS button on the InStore App device. A screen will then be displayed where the consumer can enter their phone number. -## InStore App visualization -
+## Displaying Receipts in the InStore App ![InStore_App_show_receipt](./images/InStore_App_show_receipt.png) | Number | Description | |--------|-------------| -| 1 | Receipt number (ft5C43F#357749), date and receipt amount | -| 2 | QR-Code to https digital receipt document | -| 3 | `Accept button` | -| 4 | `Print button` | +| 1 | Receipt number (ft77#117), date, time, and total amount | +| 2 | QR code to access the digital receipt document | +| 3 | `OK` button to confirm and close the receipt view | +| 4 | `Print` button to print the receipt | +| 5 | `Send per Mail` button to send the receipt via email | +| 6 | `Send per SMS` button to send the receipt via SMS | -## Configuration +## Configuring InStore App -This high level overview shows you the steps on how to implement and configure the InStore App into your Point of Sales software. - -
+This high-level overview shows the steps required to implement and configure the InStore App in your point-of-sale software. ![InStore_App_implementation_overview](./images/InStore_App_implementation_overview.png) -## Configure master data +## Configuring Master Data For more information about the configuration steps for the master data, see [Digital Receipt Introduction](https://docs.fiskaltrust.cloud/docs/posdealers/buy-resell/products/digital-receipt#introduction). -# Implementation +## Implementing InStore App -fiskaltrust provides for the InStore App two implemenation methods. The first approach is via the POS API Helper, which is recommended for testing/sandbox environments and for small installations. Configuring the POS API Helper within the fiskaltrust.Portal requires no implementation effort in your Point of Sale software. +fiskaltrust provides two implementation methods for the InStore App. The first approach is via the POS API Helper, which is recommended for testing/sandbox environments as well as for small installations. Configuring the POS API Helper within the fiskaltrust.Portal requires no implementation effort in your point-of-sale software. -The POS API is the latest addition to the digital receipt ecosystem. The POS API is a superset of the Middleware's "original" IPOS interface, and uses the same models for /sign, /journal and /echo. The core features of this API provides a variety of different functionalities for Point of Sales software and is the central entry point to the fiskaltrust.Middleware. For the InStore App the /print endpoint is required, to digitally print digital receipts. +The POS API is the latest addition to the digital receipt ecosystem. It is a superset of the Middleware's original IPOS interface and uses the same models for `/sign`, `/journal`, and `/echo`. The core features of this API provides a variety of functionalities for point-of-sale software and serve as the central entry point to the fiskaltrust.Middleware. For the InStore App, the `/print` endpoint is required to digitally print digital receipts. -This means that existing implementations can very easily be reused by adjusting them to the asynchronous flow. The IPOS interface will continue to be fully supported by the Middleware. +This means that existing implementations can be easily reused by adapting them to the asynchronous flow. The IPOS interface will continue to be fully supported by the Middleware. -As most operations especially /print requests may take an extended amount of time, this API is designed in a completely asynchronous way. After sending a request to the /print endpoint, the InStore App immediately visualizes the QR-Code. Please note: The /sign operation does not necessary needs to be implemented for the InStore App. +As most operations, especially `/print` requests, may take an extended amount of time, this API is designed to be fully asynchronous. After sending a request to the `/print` endpoint, the InStore App immediately displays the QR code. Note that the `/sign` operation does not necessarily need to be implemented for the InStore App. -A general sample of this process flow is illustrated in the picture below: +A general sample of this process flow is illustrated as follows: ![Screenshot 2023-11-07 152951](https://github.com/fiskaltrust/interface-doc/assets/124153755/bd976d8c-3119-47b1-852d-abb678aea01d) :::warning -The fiskaltrust InStore App requires a permanent and stable connection to the internet. +The fiskaltrust InStore App requires a permanent and stable internet connection. ::: ## Availability -The production API can be reached at https://pos-api.fiskaltrust.cloud as for all fiskaltrust services, the sandbox instance should be used for development and testing: https://pos-api-sandbox.fiskaltrust.cloud. +The production API is available at https://pos-api.fiskaltrust.cloud as for all fiskaltrust services, the sandbox instance should be used for development and testing and is available at https://pos-api-sandbox.fiskaltrust.cloud. -The exact same endpoints will also be added to the on-premise Launcher (natively in version 2.0, and via additional Helper packages for the versions below). +The same endpoints will also be added to the on-premise Launcher (natively in version 2.0, and via additional Helper packages for earlier versions). :::info -- **Sign** endpoint is only available in Austria with the Cloud CashBox -- **Print** Endpoint is available in Austria and Germany +- **Sign** endpoint is only available in Austria with the Cloud CashBox. +- **Print** endpoint is available in Austria and Germany. ::: ## Authentication -Authentication is handled via the headers CashBoxID and Accesstoken, which are mandatory for each request. Those values can be obtained by creating a CashBox in the one of the country-specific fiskaltrust.Portal. +Authentication is handled via the `CashBoxID` and `Accesstoken` headers, which are mandatory for each request. These values can be obtained by creating a CashBox in the one of the country-specific fiskaltrust.Portal. + +## Operation Flow (Digital Receipt) -## Operation flow (digital receipt) +Typically, a complete receipt flow when using digital receipt (sign, print, and response) looks as follows: -Typically, a full receipt flow when using digital receipt (sign, print and response) would look like this: +1. Call the `/sign` endpoint and wait asynchronously for the result. +2. If signing is successful, call the `/print` endpoint. The InStore App then displays the QR code to the digital receipt. -1. Call the /sign endpoint and asynchronously wait for the result -2. If the signing was successful, call the /print endpoint and the InStore App will visualize the QR-Code to the digital receipt +## Asynchronously Sign a Receipt According to Local Regulations (Sign Endpoint) -## Asynchronously sign a receipt according to local regulations (Sign endpoint) +This method can be used to sign different types of receipts in accordance with local fiscalization regulations. After signing the receipt according to fiscal law, the method asynchronously returns the data that will be displayed on the digital receipt. -This method can be used to sign different types of receipts according to the local fiscalization regulations. After signing the receipt according to the fiscal law, this method asynchronously returns the data that will be visualized on the digital receipt. The format of the receipt request is documented in the Middleware API docs, and the exact behavior of the method is determined by the cases sent within the properties (e.g. ftReceiptCase, ftChargeItemCase and ftPayItemCase). +The format of the receipt request is documented in the Middleware API documentation. The exact behavior of the method is determined by the cases sent within the properties (for example, `ftReceiptCase`, `ftChargeItemCase`, and `ftPayItemCase`). **POST:** @@ -207,7 +218,7 @@ accesstoken (required): string 401 - Unauthorized (No or wrong Accesstoken or CashBoxID in header) -## Asynchronously create a digital receipt (Print endpoint) +## Asynchronously Create a Digital Receipt (Print Endpoint) This method is used to "print" a digital receipt, based on the receipt request and response pair from signing a receipt via the sign endpoint. The asynchronously created response contains the URL to the digital receipt. @@ -377,59 +388,58 @@ accesstoken (required): string 401 – Unauthorized (No or wrong Accesstoken or CashBoxID in header) -## Configure POS API Helper +## Configuring POS API Helper + +The POS API Helper is available in all countries. This Helper is responsible for uploading data from the local Queue to the digital receipt endpoint. It is configured in the fiskaltrust.Portal and assigned to each CashBox that uses digital receipts. The POS API Helper enables direct upload of digital receipts. + +To proceed with the configuration, log in to your fiskaltrust.Portal account first. -The POS API Helper is available in all countries. This Helper is responsible for uploading data from the local Queue to the digital receipt endpoint. This Helper is configured in the fiskaltrust.Portal and assigned to each CashBox that uses digital receipts. The POS API Helper changes to an direct upload behavior of the digital receipts. +### Queue -To proceed with the configuration, login to your fiskaltrust.Portal account first. +To configure the Queue, complete the following steps: -### Queue +1. Navigate to **Configuration** > **Queue**. +2. Click the **Configure Queue** icon. +3. Copy the URLs to your local machine (required for CashBox configuration later). +4. For all countries: change port to the next free port (+1). If no suffix exists after the port, add the suffix `/name_queue` to the URL ("name" can be freely chosen). If a suffix already exists, add the suffix `_queue` to the URL. +5. For Germany and France only: change the gRPC port to the next free port. If the port is free, no need to go to the next free port. Then add the suffix `/name_queue` to the URL ("name" can be freely chosen). +6. Save the changes. -| Step | Description | -| ------------- | ------------- | -| 1 | Navigate to the configuration section and go to Queue | -| 2 | Configure Queue | -| 3 | Copy the URLs to your local machine (Required for CashBox configuration later) | -| 4 | For all countries: Change port to the next free port (+1) and
a. if no suffix exists after the port: add the suffix "/name_queue" to the URL ("name" can be freely chosen)
b. if suffix already exists: add the suffix "_queue" to the URL | -| 5 | Germany & France only: Change grpc port to the next free port (if port is free no need to go up to the next free port) and add the suffix "/name_queue" to the URL ("name" can be freely chosen) | -| 6 | Save changes | +### Helper -### Helper +To configure the Helper, complete the following steps: -| Step | Description | -| ------------- | ------------- | -| 1 | Navigate to Helper | -| 2 | Create new helper | -| 3 | Add description | -| 4 | Select package name "fiskaltrust.service.helper.posapi" | -| 5 | Select latest package version | -| 6 | Select the outlet of CashBox | -| 7 | Save configuration | -| 8 | Klick configure helper | -| 9 | All Counties: Insert the previously saved Queue URLs to the Helper URLs and add the suffix "/name" to the URL (analogue to the naming in queue configuration). Germany & France only: Add also GRPC URL with next free port and add the suffix "/name" to the URL (analogue to the naming in queue configuration). | -| 10 | Save configuration and close | +1. Navigate to **Configuration** > **Helper**. +2. Create a new helper by clicking the **+Add** button. +3. Add a description. +4. Select the package name "fiskaltrust.service.helper.posapi". +5. Select the latest package version. +6. Select the outlet of the CashBox. +7. Save the configuration. +8. Configure the helper by clicking the **Configuration** icon. +9. For all countries: insert the previously saved queue URLs into the helper URLs and add the suffix `/name` to the URL (analogous to the naming used in the queue configuration). +10. For Germany and France only: also add the gRPC URL with the next free port and add the suffix `/name` to the URL (analogous to the naming used in the queue configuration). +11. Save configuration and close. -### CashBox +### CashBox -| Step | Description | -| ------------- | ------------- | -| 1 | Navigate to CashBox | -| 2 | Select your CashBox and click edit by list | -| 3 | Navigate to Helpers | -| 4 | Activate the POS API Helper | -| 5 | Save configuration | -| 6 | Klick rebuild configuration | +To configure the CashBox, complete the following steps: -### Restart +1. Navigate to **Configuration** > **CashBox**. +2. Select your CashBox and click the **Edit** icon. +3. Navigate to **Helpers**. +4. Activate the POS API Helper. +5. Save the configuration. +6. Click the **Rebuild configuration** icon for your CashBox. -Restart the fiskaltrust.Middleware to apply the changes. +After completing the POS API Helper configuration, restart the fiskaltrust.Middleware to apply the changes. -## Pair InStore App +## Pairing InStore App -After installing the InStore App on your Android device, establishing a connection with your preferred CashBox is essential. Here's how: +After installing the InStore App on your Android device, establish a connection with your preferred CashBox by completing the following steps: -| Step | Description | -| ------------- | ------------- | -| 1 | Log in to your fiskaltrust.Portal account and proceed to the CashBox you want to pair with the InStore App. | -| 2 | Extend the overview of the CashBox. Klick `unhide` to generate a new, temporary pairing pin.
![fiskaltrust.Portal_pairing_pin](./images/fiskaltrust.Portal_pairing_pin.png) The pairing pin is valid for five minutes. After the pin expired, you need to generate a new pin, by clicking `unhide` to generate a new pin. | -| 3 | ![InStore_App_pairing_pin](./images/InStore_App_pair_device.jpg)
Enter the four-digit pin into your InStore App, confirm the connection by clicking `Pair`. You can pair multiple InStore App installations with one CashBox. To open the paring to CashBox mask or to pair with a different CashBox, press the touchscreen one second. | +1. Log in to your fiskaltrust.Portal account and navigate to **Configuration** > **CashBox**. +2. Select the CashBox that you want to pair with the InStore App. +3. Expand the CashBox overview. +4. On **PIN for InStore App**, click the refresh button to generate a new temporary pairing PIN. The pairing PIN is valid for five minutes. After it expires, you must generate a new PIN by clicking the refresh button again.
![fiskaltrust.Portal_pairing_pin](./images/fiskaltrust.Portal_pairing_pin.png) +5. Enter the four-digit PIN into your InStore App and confirm the connection by clicking **Pair**. You can pair multiple InStore App installations with one CashBox. To open the pairing-to-CashBox screen or pair with a different CashBox, press and hold the touchscreen for one second.
![InStore_App_pairing_pin](./images/InStore_App_pair_device.png)