diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 1ee87d4..385cf68 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,12 +1,13 @@
name: Build
on:
- pull_request_target:
+ pull_request:
types: [opened, synchronize, reopened]
jobs:
check-links:
runs-on: ubuntu-latest
+ needs: []
permissions:
pull-requests: write
contents: read
@@ -16,15 +17,33 @@ jobs:
ref: ${{ github.event.pull_request.head.sha }}
- uses: lycheeverse/lychee-action@v2
- id: lychee_markets
+ id: lychee
with:
args: ". --exclude '^file://.*'"
fail: true
build:
- uses: fiskaltrust/service-docs-ui/.github/workflows/build.yml@main
- needs: check-links
- with:
- docs_ref: ${{ github.event.pull_request.head.sha }}
- secrets:
- DOCS_REPOS_READ_TOKEN: ${{ secrets.DOCS_REPOS_READ_TOKEN }}
+ runs-on: windows-latest
+ needs: []
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ repository: fiskaltrust/service-docs-ui
+ token: ${{ secrets.DOCS_REPOS_READ_TOKEN }}
+ submodules: true
+
+ - name: Update submodules
+ run: git submodule update --recursive --remote
+
+ - name: Checkout docs to specific ref
+ working-directory: docs
+ run: |
+ git fetch origin ${{ github.event.pull_request.head.sha }}
+ git checkout ${{ github.event.pull_request.head.sha }}
+
+ - name: Restore packages
+ run: yarn install
+
+ - name: Build site
+ run: yarn build
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 0d0bf6f..b97fb10 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -14,4 +14,9 @@ jobs:
with:
token: ${{ secrets.DOCS_REPOS_DISPATCH_TOKEN }}
repository: fiskaltrust/service-docs-ui
- event-type: deploy-docs
+ event-type: update-docs
+ client-payload: |-
+ {
+ "sha": "${{ github.sha }}",
+ "repository": "${{ github.repository }}"
+ }
diff --git a/.lycheeignore b/.lycheeignore
index 7db1419..949dfe9 100644
--- a/.lycheeignore
+++ b/.lycheeignore
@@ -23,3 +23,4 @@ https://www.raspberrypi.com/products/raspberry-pi-2-model-b
https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000044983827#:~:text=La%20taxe%20est%20exigible%20%3A,%C3%A0%20concurrence%20du%20montant%20encaiss%C3%A9.
https://forms\.office\.com/e/.*
https?://fiskaltrust\.../
+https?://github\.com/fiskaltrust/service-docs-ui.*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3577fcc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# fiskaltrust Documentation Content
+
+This repository contains the documentation content for the [fiskaltrust documentation platform](https://docs.fiskaltrust.cloud). It is consumed as a Git submodule by [fiskaltrust/service-docs-ui](https://github.com/fiskaltrust/service-docs-ui), which uses [Docusaurus](https://docusaurus.io/) to build and deploy the site.
+
+## Documentation Structure
+
+The content is organized into audience-specific sections, each with its own sidebar navigation defined in a `toc.js` file.
+
+```
+.
+├── poscreators/ # Technical integration guides and middleware API docs for POS system developers
+├── posdealers/ # Business, onboarding and operational docs for POS resellers
+├── faq/ # General reference pages (terminology, customer roles)
+└── sidebars.js
+```
+
+### Sidebar Navigation
+
+The sidebar structure is defined manually via JavaScript files rather than auto-generated from the directory layout. The root `sidebars.js` imports the sidebar definitions from `poscreators/toc.js` and `posdealers/toc.js`.
+
+When you add, remove, or rename a page, you must update the corresponding `toc.js` file to reflect the change in the sidebar.
+
+### Writing Documentation Pages
+
+Each Markdown file should start with [Docusaurus front matter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter):
+
+```yaml
+---
+slug: /poscreators/my-new-page
+title: My New Page
+---
+```
+
+Use standard Markdown for content. Docusaurus also supports [MDX](https://docusaurus.io/docs/markdown-features) if you need React components.
+
+Place images in an `images/` directory next to the Markdown files that reference them and use relative paths.
+
+## Contributing
+
+1. Fork or branch this repository.
+2. Edit or add Markdown files in the appropriate section (`poscreators/`, `posdealers/`, or `faq/`).
+3. Update the sidebar in the relevant `toc.js` file if you added, removed, or renamed a page.
+4. Open a pull request against the `main` branch.
+
+Every page on the live site has an "Edit this document" link at the bottom that takes you directly to the source file on GitHub.
+
+> For instructions on previewing your changes locally in the context of the full site, see the [service-docs-ui README](https://github.com/fiskaltrust/service-docs-ui#readme).
+
+## CI/CD
+
+Pull requests are automatically validated with a link check ([lychee](https://github.com/lycheeverse/lychee-action)) and a full Docusaurus site build to catch broken links and build errors before merging.
+
+When a pull request is merged to `main`, the site is automatically rebuilt and deployed to https://docs.fiskaltrust.cloud.
+
+> For a full overview of how the workflows across all repositories fit together, see the [CI/CD Workflows section in the service-docs-ui README](https://github.com/fiskaltrust/service-docs-ui#cicd-workflows).
+
+## Link Checking Configuration
+
+Link checking is configured via two files:
+
+- `lychee.toml`: general settings (timeout, retry wait time).
+- `.lycheeignore`: URL patterns to exclude from checking (e.g. sandbox URLs, localhost, known false positives).
+
+If a new external URL is consistently flagged as a false positive, add a matching pattern to `.lycheeignore`.
diff --git a/poscreators/getting-started/get-started.md b/poscreators/getting-started/get-started.md
index 343cfe4..d6b0dc4 100644
--- a/poscreators/getting-started/get-started.md
+++ b/poscreators/getting-started/get-started.md
@@ -1,196 +1,28 @@
---
slug: /poscreators/get-started
-title: Get started for PosCreators
+title: Introduction
---
-# Getting Started Guide for PosCreators
+# Introduction
-## Overview
+This guide provides a technical overview of the integration and onboarding workflow for PosCreators. It outlines the key stages required to successfully integrate **fiskaltrust.Middleware** into a POS system and to progress to pilot installations.
-This guide describes on a high level the stages, which a PosCreator should achieve, to ensure a successful completion of the journey, from the integration of the fiskaltrust.Middleware into the POS-System, to a phase of pilot installations.
+Successful completion of these stages ensures a reliable and compliant deployment of fiskaltrust solutions in your POS environment.
-The success of this journey can be achieved through the completion of the following stages:
+## Integration Workflow
-
-
-
-## Useful resources
-
-Before proceeding with this guide, you may consider getting familiar with the content of the following useful resources:
-
-- [PosCreator technical onboarding video](onboarding-presentation.md)
-
-**Note:** you can find more useful resources in the [Further sources of information](#further-sources-of-information) section at the end of this document.
-
-## 1. fiskaltrust.Portal Registration
-
-### 1.1 Overview
-
-The fiskaltrust.Portal is a web application which offers features required to easily manage the functions necessary for the configuration and operation of your POS-Systems. The fiskaltrust.Portal is accessible via common Internet browsers, however, if your browser does not display some content correctly, or features are not available or not behaving as expected, try using the current version of Google Chrome.
-
-There are 2 instances of fiskaltrust.Portal:
-
-- Live - [https://portal.fiskaltrust.de](https://portal.fiskaltrust.de/)
-- Sandbox - [https://portal-sandbox.fiskaltrust.de](https://portal-sandbox.fiskaltrust.de/)
-
-**Important Notes:**
-
-- In order to receive the free support from fiskaltrust you must register in our live portal.
-- No tests should be performed on the Live portal!
-- The sandbox registration is needed for conducting all test activities and does not qualify for support!
-
-### 1.2 Registration steps
-
-The registration steps on both, the sandbox and the live portal, are identical. Simply complete the registration form, confirm your email, and sign the cooperation agreement.
-
-### 1.3 Company data and cooperation agreement
-
-As soon as you have registered in the portal, a form for selecting your role will be displayed. Select the option " PosCreator " and sign our cooperation agreement by entering your name in the input field. If you are also a PosDealer, please select that role as well.
-
-By registering in the live fiskaltrust.Portal and digitally signing our cooperation agreement, you are now entitled to access our free support for setup questions and onboarding. You can reach our Support Team at support@fiskaltrust.de.
-
-## 2. Middleware Integration
-
-There are several steps which must be followed to successfully integrate your solution with fiskaltrust.Middleware. Those steps include the CashBox Configuration, using the Middleware Launcher, and testing of the communication. Please check our [fiskaltrust.Middleware document](middleware-integration.md) for detailed information about this process.
-
-## 3. PosDealer Onboarding
-
-Once you were able to test the integration and successfully establish a communication with the fiskaltrust.Middleware by sending simple requests and receiving correct expected responses, you are now ready to start engaging your PosDealers into discussion about the details of the specific implementation of your POS-System, and agree on the suitable rollout scenarios.
-
-It is important to involve your PosDealers as early as possible, because they have to perform the following steps, among others, before they can roullout the fiskaltrust.Middleware to the PosOperators:
-1. Register in the fiskalttrust.Portal and there digitally sign a cooperation agreement with fiskaltrust.
-2. Depending on the circumstances, request and sign framework agreements for the purchase of products with fiskaltrust.
-3. Invite the PosOperators to the fiskaltrust.Portal so that they can sign the usage agreement for the fiskaltrust.Middleware.
-4. Request access rights to the PosOperator`s fiskaltrust.Account so that the PosDealer can redeem and activate the product entitlements purchased from fiskaltrust
-5. Request access rights to the PosOperator`s fiskaltrust.Account so that the PosDealer can configure the fiskaltrust.Middleware instance to be installed on behalf of the operator.
-6. For the correct DSFInV-K export the information of the POS-System needs to be connected by the PosDealer with the master data of the PosOperator.
-7. Technical planning and preparation for rollout together with the PosCreator.
-
-These steps can be very time consuming. Therefore, we strongly recommend that you **inform your PosDealers as early as possible and especially invite them to register in the fiskaltrust.Portal**.
-
-### 3.1 Invite PosDealer in fiskaltrust.Portal
-
-:::important
-
-The following steps explain how you, as PosCreator, register a PosSystem in the fiskaltrust.Portal. This registration includes a PossystemID, which ensures that all country-specific requirements are met, regardless of whether they are currently mandatory in your country or will become if you want to expand your offering to other markets. In addition, the fiskaltrust.Portal supports you with a simplified invitation process for your PosDealers.
-
-:::
-
-Log in to the fiskaltrust.Portal and select `PosSystems`, then `Add`.
-Enter the properties of your PosSystem and select `Create new`.
-Once the PosSystem is created, you will find it in the list of your available systems. You can add `Business areas` and `Properties` to each PosSystem. With `PosDealer`, you open the list of assigned PosDealers. To invite more, click on `Add`.
-
-
-For more detailed instructions, please open the drop-down window below.
+The integration process is divided into discrete stages, each with specific objectives and deliverables as follows:
-
- Management of PosSystems in Details
-
-:::caution if you are missing menu items, please check your active roles
-
-:::
-
-Depending on the active roles and contractual agreements,
-the fiskaltrust.Portal offers different items
-on the menu. Suppose the items described here are unavailable;
-check `Company` / `Overview` for the active roles.
-We recommend handling an account as PosCreator and as PosDealer separated.
-
-#### Creation of a PosSystem
-
-
-
-| steps | description |
-|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
-| |Log in to the fiskaltrust.Portal as a PosCreator, select `PosSystems` and `Add` to create new ones. |
-| |Enter data like `Name`, `Brand`, `Type` and `Software Major Version` of your new PosSystem. |
-| |Make your selection at `Cash type`. |
-| |With `Create new`, you will find the new PosSystem in the list of your available systems. |
-
-#### Editing of a PosSystem
-
-
-
-| steps | description |
-|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
-| |You can find the `PosSystemId` in the list but not change this value. |
-| |You can add `Business areas` (like trade or services) and `Properties` (like technical base or equipment) to each PosSystem. |
-| |With `PosDealer`, you open the list of assigned PosDealers; read below for further details. |
-| |You can change the data of the PosSystem with `Edit`. |
-
-#### Assignment of a PosSystem
-
-
-
-| steps | description |
-|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
-| |To check assigned PosSystem distributors, select `PosDealer`. |
-| |You find a list of all PosDealers assigned to your chosen PosSystem. Use the link of the `contact person` to send an E-Mail. |
-| |With `Remove assignment`, you cut the connection between the selected PosDealer and the actual PosSystem. |
-| |To assign or invite more PosDealers, select `Add`. |
-
-To add a PosDealer to a selected PosSystem, enter his E-Mail address and
-select `Search`. If the desired PosDealer is already registered in the
-fiskaltrust.Portal, you finalize the assignment of the selected PosSystem.
-Suppose no company with that E-Mail address is registered in the fiskaltrust.Portal,
-you must complete the business data and choose `Add / Invite`.
-This invitation will send an E-Mail and assign the company to your selected PosSystem. The E-Mail contains a link the recipient needs to use to complete the registration process.
-
-#### Request of a PosSystem as PosDealer
-
-:::caution if you are missing menu items, please check your active roles
-
-:::
-
-Depending on the active roles and contractual agreements,
-the fiskaltrust.Portal offers different items
-on the menu. Suppose the items described here are unavailable;
-check `Company` / `Overview` for the active roles.
-We recommend handling an account as PosCreator and as PosDealer separated.
-
-As a PosDealer, you get either the invitation by a PosCreator to receive the assignment of a PosSystem. Or you reach out to a PosCreator to request the assignment of your desired PosSystem. Please note that this requires that you, as a PosDealer, are registered in the fiskaltrust.Portal.
-
-
-
-| steps | description |
-|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
-| |Log in to the fiskaltrust.Portal as a PosDealer, select `PosSystems` and `Add` to start your request for new ones. |
-| |Enter data like `Name`, `Brand`, `Type` or `Manufacturer` of your desired PosSystem and press `Search`. |
-| |With `Request Assignment`, your request is sent to the PosCreator. |
-
-If the PosCreator accepts the assignment, the connection between the PosDealer`s account and the manufacturer's POS-System is established.
-
-
-
-### 3.2 Rollout Scenarios
-
-As the approach to the rollout highly depends on the implementation, the components, and the capabilities of your POS-System, you should select the appropriate rollout scenario and discuss it with your POS Dealers, to ensure their sufficient levels of knowledge and understanding required for the successful execution of the rollout process.
-
-The rollout has 2 separate areas, the [buy- and resell part](https://docs.fiskaltrust.cloud/docs/posdealers/buy-resell/overview), and [the technical rollout](https://docs.fiskaltrust.cloud/docs/posdealers/buy-resell/rollout-plans), which are both covered in the the PosDealer area of this documentation.
-
-The technical stage requires a close collaboration of the technical experts from both sides: yours and the POS Dealer`s. You will discuss the details of the implementation, agree on the approach for rollout automation and templating, and select the best strategy for the rollout based on the appropriate rollout scenario. We have documented examples of different [rollout scenarios](https://docs.fiskaltrust.cloud/docs/posdealers/technical-operations/rollout-scenarios) in our documentation portal.
-
-### 3.3 Rollout Automation
-
-You should help the POS Dealer to automate the rollout process as much as possible for example by preparing a configuration `Template` and discussing its details with the POS Dealer. A `Template`, which can be added in the fiskaltrust.Portal or executed via API, contains the details of a pre-configured CashBox with all its components. It is used to automatically create similar CashBoxes for the PosOperators. Such templates can be used among other fiskaltrust tools and features to automate, and therefore to significantly speed-up the rollout process. You can find the [details of the automation options and templating](https://docs.fiskaltrust.cloud/docs/posdealers/technical-operations/rollout-automation/templates) in our documentation portal.
-
-## 4. Complex Business Case Analysis
-
-Each industry may have several specific and complex business cases which require a special handling in terms of requests sent to the fiskaltrust.Middleware. If you require assistance establishing the proper handling of such complex business cases in the implementation of your POS-System, please write us an email to our PosCreator support mailbox at support@fiskaltrust.de, and one of our experts will be happy to assist you.
+
-## 5. Pilot Installation
+Before proceeding with this guide, review the following resources:
-Once the rollout strategy has been selected and the approach to automation of the rollout (e.g. templating) has been agreed, it`s time for you and the PosDealer to test it with selected PosOperator(s). Such pilot installation(s) should provide you with sufficient feedback, to allow early identification of problems and their possible resolutions, before handing over to the PosDealer for mass rollout to multiple PosOperators.
+### Video Tutorial
-## 6. Handover for Rollout
+A technical walkthrough covering the complete PosCreator onboarding process can be viewed as follows:
-Once all previous stages have been completed, all preparations are done, the communication with fiskaltrust.Middleware works, the rollout strategy has been agreed, and the pilot installation(s) have been successfully executed, you are now ready to handover for rollout to your PosDealers.
-The goal of this stage is about reaching an agreement with the PosDealers that they are ready to start the rollout to the PosOperators.
+
-## Further sources of information
+### Presentation Slides
-- German fiskaltrust website: [https://fiskaltrust.de](https://fiskaltrust.de/)
-- fiskaltrust.Docs: [https://docs.fiskaltrust.cloud](https://docs.fiskaltrust.cloud/)
-- Knowledge Base: Available in the _Help_ section in the Portal
-- fiskaltrust Github repositories: [https://github.com/fiskaltrust](https://github.com/fiskaltrust)
-- fiskaltrust videos: [Youtube Channel](https://www.youtube.com/channel/UCmMlqO4L3AzkEhh6WYA8BJg)
+Download the slides corresponding to the video tutorial [here](presentations/technical-onboarding-poscreators.pdf).
diff --git a/poscreators/getting-started/middleware-integration.md b/poscreators/getting-started/middleware-integration.md
index 9cfd010..c4829ac 100644
--- a/poscreators/getting-started/middleware-integration.md
+++ b/poscreators/getting-started/middleware-integration.md
@@ -1,11 +1,17 @@
---
slug: /poscreators/get-started/middleware-integration
-title: Middleware integration
+title: Integration Steps
---
-# Middleware Integration
+# Integration Steps
-This document describes the steps required to configure and test the integration of the ft.Middleware with your POS-System.
+There are several mandatory steps to successfully integrate your solution with **fiskaltrust.Middleware**. These steps include:
+
+- CashBox Configuration
+- Middleware Launcher usage
+- Middleware Communication testing
+
+The following steps describe how to configure and test the integration of **ft.Middleware** with your POS system.
## 1. CashBox Configuration
diff --git a/poscreators/getting-started/onboarding-posdealers.md b/poscreators/getting-started/onboarding-posdealers.md
new file mode 100644
index 0000000..e80e27e
--- /dev/null
+++ b/poscreators/getting-started/onboarding-posdealers.md
@@ -0,0 +1,150 @@
+---
+slug: /poscreators/get-started/onboarding-posdealers
+title: Onboarding PosDealers
+---
+
+# Onboarding PosDealers
+
+Once you were able to test the integration and successfully establish a communication with the fiskaltrust.Middleware by sending simple requests and receiving correct expected responses, you are now ready to start engaging your PosDealers into discussion about the details of the specific implementation of your POS-System, and agree on the suitable rollout scenarios.
+
+:::info Important
+
+Involve your PosDealers as early as possible, because they have to perform the following steps, among others, before they can roullout the fiskaltrust.Middleware to the PosOperators. For more details, open the drop-down window below.
+
+:::
+
+
+ Registration steps for PosDealers
+
+1. Register in the fiskalttrust.Portal and there digitally sign a cooperation agreement with fiskaltrust.
+2. Depending on the circumstances, request and sign framework agreements for the purchase of products with fiskaltrust.
+3. Invite the PosOperators to the fiskaltrust.Portal so that they can sign the usage agreement for the fiskaltrust.Middleware.
+4. Request access rights to the PosOperator`s fiskaltrust.Account so that the PosDealer can redeem and activate the product entitlements purchased from fiskaltrust
+5. Request access rights to the PosOperator`s fiskaltrust.Account so that the PosDealer can configure the fiskaltrust.Middleware instance to be installed on behalf of the operator.
+6. For the correct DSFInV-K export the information of the POS-System needs to be connected by the PosDealer with the master data of the PosOperator.
+7. Technical planning and preparation for rollout together with the PosCreator.
+
+These steps can be very time consuming. Therefore, we strongly recommend that you **inform your PosDealers as early as possible and especially invite them to register in the fiskaltrust.Portal**.
+
+
+
+## 1. Invite PosDealer in fiskaltrust.Portal
+
+:::important
+
+The following steps explain how you, as PosCreator, register a PosSystem in the fiskaltrust.Portal. This registration includes a PossystemID, which ensures that all country-specific requirements are met, regardless of whether they are currently mandatory in your country or will become if you want to expand your offering to other markets. In addition, the fiskaltrust.Portal supports you with a simplified invitation process for your PosDealers.
+
+:::
+
+Log in to the fiskaltrust.Portal and select `PosSystems`, then `Add`.
+Enter the properties of your PosSystem and select `Create new`.
+Once the PosSystem is created, you will find it in the list of your available systems. You can add `Business areas` and `Properties` to each PosSystem. With `PosDealer`, you open the list of assigned PosDealers. To invite more, click on `Add`.
+
+
+For more detailed instructions, please open the drop-down window below.
+
+
+ Management of PosSystems in Details
+
+:::caution
+
+if you are missing menu items, please check your active roles
+
+:::
+
+Depending on the active roles and contractual agreements,
+the fiskaltrust.Portal offers different items
+on the menu. Suppose the items described here are unavailable;
+check `Company` / `Overview` for the active roles.
+We recommend handling an account as PosCreator and as PosDealer separated.
+
+### Creation of a PosSystem
+
+
+
+| steps | description |
+|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
+| |Log in to the fiskaltrust.Portal as a PosCreator, select `PosSystems` and `Add` to create new ones. |
+| |Enter data like `Name`, `Brand`, `Type` and `Software Major Version` of your new PosSystem. |
+| |Make your selection at `Cash type`. |
+| |With `Create new`, you will find the new PosSystem in the list of your available systems. |
+
+### Editing of a PosSystem
+
+
+
+| steps | description |
+|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
+| |You can find the `PosSystemId` in the list but not change this value. |
+| |You can add `Business areas` (like trade or services) and `Properties` (like technical base or equipment) to each PosSystem. |
+| |With `PosDealer`, you open the list of assigned PosDealers; read below for further details. |
+| |You can change the data of the PosSystem with `Edit`. |
+
+### Assignment of a PosSystem
+
+
+
+| steps | description |
+|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
+| |To check assigned PosSystem distributors, select `PosDealer`. |
+| |You find a list of all PosDealers assigned to your chosen PosSystem. Use the link of the `contact person` to send an E-Mail. |
+| |With `Remove assignment`, you cut the connection between the selected PosDealer and the actual PosSystem. |
+| |To assign or invite more PosDealers, select `Add`. |
+
+To add a PosDealer to a selected PosSystem, enter his E-Mail address and
+select `Search`. If the desired PosDealer is already registered in the
+fiskaltrust.Portal, you finalize the assignment of the selected PosSystem.
+Suppose no company with that E-Mail address is registered in the fiskaltrust.Portal,
+you must complete the business data and choose `Add / Invite`.
+This invitation will send an E-Mail and assign the company to your selected PosSystem. The E-Mail contains a link the recipient needs to use to complete the registration process.
+
+### Request of a PosSystem as PosDealer
+
+:::caution if you are missing menu items, please check your active roles
+
+:::
+
+Depending on the active roles and contractual agreements,
+the fiskaltrust.Portal offers different items
+on the menu. Suppose the items described here are unavailable;
+check `Company` / `Overview` for the active roles.
+We recommend handling an account as PosCreator and as PosDealer separated.
+
+As a PosDealer, you get either the invitation by a PosCreator to receive the assignment of a PosSystem. Or you reach out to a PosCreator to request the assignment of your desired PosSystem. Please note that this requires that you, as a PosDealer, are registered in the fiskaltrust.Portal.
+
+
+
+| steps | description |
+|:----------------------:|-------------------------------------------------------------------------------------------------------------------------------------|
+| |Log in to the fiskaltrust.Portal as a PosDealer, select `PosSystems` and `Add` to start your request for new ones. |
+| |Enter data like `Name`, `Brand`, `Type` or `Manufacturer` of your desired PosSystem and press `Search`. |
+| |With `Request Assignment`, your request is sent to the PosCreator. |
+
+If the PosCreator accepts the assignment, the connection between the PosDealer`s account and the manufacturer's POS-System is established.
+
+
+
+## 2. Rollout Scenarios
+
+As the approach to the rollout highly depends on the implementation, the components, and the capabilities of your POS-System, you should select the appropriate rollout scenario and discuss it with your POS Dealers, to ensure their sufficient levels of knowledge and understanding required for the successful execution of the rollout process.
+
+The rollout has 2 separate areas, the [buy- and resell part](https://docs.fiskaltrust.cloud/docs/posdealers/buy-resell/overview), and [the technical rollout](https://docs.fiskaltrust.cloud/docs/posdealers/buy-resell/rollout-plans), which are both covered in the the PosDealer area of this documentation.
+
+The technical stage requires a close collaboration of the technical experts from both sides: yours and the POS Dealer`s. You will discuss the details of the implementation, agree on the approach for rollout automation and templating, and select the best strategy for the rollout based on the appropriate rollout scenario. We have documented examples of different [rollout scenarios](https://docs.fiskaltrust.cloud/docs/posdealers/technical-operations/rollout-scenarios) in our documentation portal.
+
+## 3. Rollout Automation
+
+You should help the POS Dealer to automate the rollout process as much as possible for example by preparing a configuration `Template` and discussing its details with the POS Dealer. A `Template`, which can be added in the fiskaltrust.Portal or executed via API, contains the details of a pre-configured CashBox with all its components. It is used to automatically create similar CashBoxes for the PosOperators. Such templates can be used among other fiskaltrust tools and features to automate, and therefore to significantly speed-up the rollout process. You can find the [details of the automation options and templating](https://docs.fiskaltrust.cloud/docs/posdealers/technical-operations/rollout-automation/templates) in our documentation portal.
+
+## 4. Complex Business Case Analysis
+
+Each industry may have several specific and complex business cases which require a special handling in terms of requests sent to the fiskaltrust.Middleware. If you require assistance establishing the proper handling of such complex business cases in the implementation of your POS-System, please write us an email to our PosCreator support mailbox at support@fiskaltrust.de, and one of our experts will be happy to assist you.
+
+## 5. Pilot Installation
+
+Once the rollout strategy has been selected and the approach to automation of the rollout (e.g. templating) has been agreed, it`s time for you and the PosDealer to test it with selected PosOperator(s). Such pilot installation(s) should provide you with sufficient feedback, to allow early identification of problems and their possible resolutions, before handing over to the PosDealer for mass rollout to multiple PosOperators.
+
+## 6. Handover for Rollout
+
+Once all previous stages have been completed, all preparations are done, the communication with fiskaltrust.Middleware works, the rollout strategy has been agreed, and the pilot installation(s) have been successfully executed, you are now ready to handover for rollout to your PosDealers.
+The goal of this stage is about reaching an agreement with the PosDealers that they are ready to start the rollout to the PosOperators.
diff --git a/poscreators/getting-started/portal-registration.md b/poscreators/getting-started/portal-registration.md
new file mode 100644
index 0000000..c742c44
--- /dev/null
+++ b/poscreators/getting-started/portal-registration.md
@@ -0,0 +1,35 @@
+---
+slug: /poscreators/get-started/portal-registration
+title: Portal Registration
+---
+
+# Portal Registration
+
+The **fiskaltrust.Portal** is a web-based application that provides all the features necessary to manage the configuration and operation of your POS systems.
+
+The Portal is compatible with standard Internet browsers. However, if certain content does not display correctly or specific features are unavailable or not functioning as expected, use the latest version of Google Chrome for optimal performance.
+
+There are two separate instances of the fiskaltrust.Portal:
+
+- Live: [https://portal.fiskaltrust.de](https://portal.fiskaltrust.de/) - Production environment
+- Sandbox: [https://portal-sandbox.fiskaltrust.de](https://portal-sandbox.fiskaltrust.de/) - Testing and development environment
+
+**Important Notes:**
+
+- **Live Portal Registration Required for Support:** To access free support from fiskaltrust, you must register in the Live Portal.
+- **Do Not Test in Live Portal:** All testing activities should be performed in the Sandbox Portal. No tests should be conducted in the Live Portal.
+- **Sandbox Portal Use:** Registration in the Sandbox Portal is required for all testing and development activities. Note that Sandbox registrations do not qualify for official support.
+
+## Registration Steps
+
+The registration steps are identical for both the Sandbox and Live Portals. To complete registration:
+
+1. Fill out the registration form with all required information.
+2. Confirm your email address.
+3. Sign the cooperation agreement to finalize the registration.
+
+## Company Data and Cooperation Agreement
+
+After completing portal registration, you will be prompted to select your role. Select the **PosCreator** option and sign the cooperation agreement by entering your name in the provided input field. If you also act as a PosDealer, select this role as well.
+
+By registering in the live **fiskaltrust.Portal** and digitally signing the cooperation agreement, you gain entitlement to free support for setup questions and onboarding. For assistance with setup or onboarding, contact our Support Team at support@fiskaltrust.de.
diff --git a/poscreators/middleware-doc/instore-app/installation-guides/installation-guides.md b/poscreators/middleware-doc/instore-app/installation-guides/installation-guides.md
index a03c41a..15b311e 100644
--- a/poscreators/middleware-doc/instore-app/installation-guides/installation-guides.md
+++ b/poscreators/middleware-doc/instore-app/installation-guides/installation-guides.md
@@ -12,10 +12,12 @@ The `fiskaltrust InStore App` can be installed directly via app download or via
- [Orderman SystemCenterNext (SCN)](Orderman/orderman-guide.md)
- [Sunmi Partner portal](Sunmi/sunmi-guide.md)
+Note: The Manual guide includes both the stable and preview download links.
+
## Also supported
For the following protals please refer to the partners documentation and support on how to install the `fiskaltrust InStore App`:
- [PAX Viva Wallet](https://vivawallet.whatspos.com)
- [PAX GP](https://www.whatspos.com)
-- [PAX Italia](https://paxitalia.whatspos.com)
+- [PAX Italia](https://paxitalia.whatspos.com)
\ No newline at end of file
diff --git a/poscreators/middleware-doc/instore-app/installation-guides/manual/manual-guide.md b/poscreators/middleware-doc/instore-app/installation-guides/manual/manual-guide.md
index ceab57c..f46e306 100644
--- a/poscreators/middleware-doc/instore-app/installation-guides/manual/manual-guide.md
+++ b/poscreators/middleware-doc/instore-app/installation-guides/manual/manual-guide.md
@@ -6,10 +6,11 @@ title: 'Manual Installation Guide'
## Download the App
- Open **Web Explorer** or any other web browser on your device.
-- Visit the following website to download the latest version of the Fiskaltrust InStore App:
-- [Download the App](https://link.fiskaltrust.eu/downloads/instoreapp/stable)
+- Visit the download page for the Fiskaltrust InStore App:
+ - [Stable version](https://link.fiskaltrust.eu/downloads/instoreapp/stable) - use in production and for release testing.
+ - [Preview version](https://link.fiskaltrust.eu/downloads/instoreapp/preview) - use during development or to test new, upcoming features.
## Install the App
- After the download is complete, open the downloaded file to start the installation.
-- Follow the on-screen instructions to complete the installation.
+- Follow the on-screen instructions to complete the installation.
\ No newline at end of file
diff --git a/poscreators/toc.js b/poscreators/toc.js
index 0296227..7aa0c2c 100644
--- a/poscreators/toc.js
+++ b/poscreators/toc.js
@@ -1,12 +1,25 @@
module.exports = [
{
type: "category",
- label: "Get started",
+ label: "Get Started",
items: [
- "poscreators/getting-started/get-started",
- "poscreators/getting-started/middleware-integration",
- "poscreators/getting-started/integration-checklist",
- "poscreators/getting-started/onboarding-presentation",
+ {
+ type: "category",
+ label: "Getting Started for PosCreators",
+ items: [
+ "poscreators/getting-started/get-started",
+ "poscreators/getting-started/portal-registration",
+ ],
+ },
+ {
+ type: "category",
+ label: "Middleware Integration",
+ items: [
+ "poscreators/getting-started/middleware-integration",
+ "poscreators/getting-started/integration-checklist",
+ ],
+ },
+ "poscreators/getting-started/onboarding-posdealers",
],
},
{
@@ -408,4 +421,9 @@ module.exports = [
},
],
},
+ {
+ type: "link",
+ label: "Development Kit",
+ href: "https://github.com/fiskaltrust/possystemapi-devkit/blob/main/README.MD",
+ },
];