beA Desk Installation Guide and Technical Documentation

1 Introduction

This document will guide you through the installation process of the STP beA Desk as well as the required components and prerequisites.

2 Important Notes

2.1 beA Message Server and LEXolution Service Bus

❗ Currently, only one beA Message Server can be operated on a single LEXolution Service Bus.

2.2 KSW Toolkit

💡 The STP beA Desk uses the KSW interface provided by BRAK for communication with the beA network. This is a Java component that communicates with the STP beA Desk via STP beA Connect. This component is automatically installed during setup.

❗ The STP beA Desk is limited to the functions and capabilities provided by the KSW interface for receiving and sending beA messages. Newer versions of the KSW interface will be integrated into future versions of the STP beA Desk.

❗ For each user who starts the STP beA Desk, a separate instance of STP beA Connect and thus the KSW interface is started. Make sure the KSW interface has enough memory available (typically about 500 MB per user; depending on message size, memory usage may temporarily exceed 3 GB per user). This is especially important when running on a terminal server, which should have enough RAM per user.

2.3 Document Signature / Signature Component

The STP beA Desk supports direct signing of documents within the application using signature components.

You can use the STP beA Desk Signer or, alternatively, the SecSigner component from the third-party provider SecCommerce.

2.3.1 SecCommerce SecSigner

The SecCommerce SecSigner is not included and must be downloaded and installed from the manufacturer's website.

If the user's signature card allows it, so-called batch signatures are possible. This means you can sign multiple documents in the STP beA Desk with a single PIN entry.

💡 In the current version of SecCommerce SecSigner, batch signatures are limited to a maximum of 30 documents.

💡 The SecCommerce SecSigner requires sufficient memory, as documents are loaded into memory during a batch signature process.

2.3.2 STP beA Desk Signer

The STP beA Desk Signer can be installed directly via the beA Desk setup.

💡 The STP beA Desk Signer supports remote signatures.

💡 The STP beA Desk Signer supports batch signatures.

💡 Integration into the beA Desk is done via direct communication with the host application.

2.4 Regular Backups

The STP beA Desk uses both a Microsoft SQL Server database and a blob storage in the file system for data storage. Make sure that both the SQL database and the blob storage directory are included in your regular backups and are backed up at the same time.

• Microsoft SQL Server database: This is the database set up for the STP beA Message Server.
• STP beA Message Server Blob Storage: If you kept the default installation path and did not change it, the files are located on the server at the following path:
  *%PROGRAMDATA%AGMessage Server

3 System Requirements

3.1 Software

The STP beA Desk and the STP beA Message Server are compatible with the following environments and components. Please note that only 64-bit versions are supported.

• Windows Server 2025
• Windows Server 2022
• Windows Server 2019
• MS SQL Server 2025 (Standard or Enterprise)
• MS SQL Server 2022 (Standard or Enterprise)
• MS SQL Server 2019 (Standard or Enterprise)
• Windows 11
• STP Common Services
• STP User Management

💡 For client operating systems, please note that Home or Starter editions are NOT supported.

💡 Make sure that the latest service packs and security updates are always installed for the software you use.

❗ Installations on operating systems or components not listed here are considered unsupported.

3.2 Additional Requirements

Before installing the STP beA Desk and the STP beA Message Server, the following prerequisites must be met:

• Installation/availability of central STP User Management
• Installation/availability of LEXolution Service BUS
• Installation/availability of an SQL Server
• Installation/availability of the currently supported STP Documents (DMS) version (required for document transfer from STP Documents and message archiving)
• Installation/availability of the currently supported STP Winsolvenz version (required for table transfer to the court)

4 STP beA Message Server

4.1 Installation

Run the installation file “STP beA Message Server Setup <VERSION>.exe” to start the installation process.

❗ The setup file should be started from a local drive. If you run the installation from a network drive, problems may occur.

❗ The setup must be run as administrator (right-click -> Run as administrator).

❗ Currently, only one beA Message Server can be operated on a single LEXolution.ServiceBus.

The welcome screen will then open. Click “Next”.

In the next window, you can choose whether to perform a “Complete” or “Custom” installation.
If you select “Custom”, you can choose and change the installation directory.
If you select “Complete”, the program will be installed by default in the recommended directory:

C:\Program Files\STP beA Message Server

If you select “Custom”, you can adjust the setup accordingly and decide whether the STP Update Server should be installed.

If an Update Server is already installed, the setup will only add the beA-relevant information.

If you chose the custom installation, you can change the installation path using the “Change” button.

In general, it is recommended not to change the default paths.
This makes it easier to provide support if needed.

After selecting an installation path, confirm your selection with “OK” and click “Next >” in the following window.

Next, you will configure the parameters for operating the STP beA Message Server, including an input field for the beA Desk Signer ID.

If you chose the complete installation, this step will start with the following screen:

4.1.1 Connection String to SQL Database (SQL Server Connection Data)

The settings and database creation are performed automatically during the initial installation of the beA Message Server.

When starting, the beA Message Server checks if a database exists. If not, it will be created automatically.

For an update installation, any necessary changes will also be made automatically at first startup if the database schema has changed.

❗ Make sure the database is included in your regular backup process.

4.1.2 DB Server

Enter the name of the server where the database is hosted.

If the database is on the same server as the beA Message Server, enter the computer name of that server.

If the database is hosted on another server, enter the name of that server.

4.1.3 DB Database Name

This is the beA Desk database that will be installed as part of this process. The default entry recommended here is “STP_beA”.

4.1.4 DB User

This is the user who logs in to the database. Enter a user with full rights to the database. The user must be authorized to create the database schema as well as read, delete, and write data. Avoid using the SQL Server user “sa”.

4.1.5 DB Password

Enter the password set for the user to log in to the database.

4.1.6 REST/API Address for the STP beA Message Server

Under Computer Name, enter the name of the computer where the beA Message Server will be installed. Note: You do not need to enter “http://” before the computer name. Only enter the computer name.

Under “Port 1”, enter the HTTP port. Default is “8096”.

Under “Port 2”, enter the HTTPS port. Default is “8097”.

💡 You only need to change the ports if another service on your application server is already using these ports.

After entering all information, click “Next”.

In the next window, you can enter the data for the LEXolution Service Bus and central User Management.

4.1.7 LEXolution Service Bus (LSB)

Enter the hostname of the LSB. If it is on the same computer as the beA Message Server, enter the name of that computer.

Port: Enter the LSB port. The default value is “5672”.
Username: Enter the username. The default value is “stpuser”. This depends on which user the LSB was set up under.
Password: Enter the password for the specified LSB user.

4.1.8 Central User Management (STP User Management)

Configure the username and password so that the STP beA Message Server can communicate with the central STP User Management.

Username: Enter the username for central User Management.
Password: Enter the password for the central User Management user.

After entering your settings, click “Next” to go to the next form.

4.1.9 Blob Storage Directory (for File Storage)

All files (attachments from beA messages, documents, and other files) managed by the STP beA Message Server are stored in this directory and its subdirectories.

❗ Users should not make manual changes or adjustments to files in this directory or its subdirectories.

❗ Make sure this directory is included in your regular backup process.

4.1.10 STP Updater

If you are already using an STP Update Server, no changes should be made here.

4.1.11 beA Desk Signer ID

If you want to use the beA Desk Signer to sign attachments or documents, enter the ID provided to you here.

After entering and checking all values, confirm with “Next”.

A new window will open. Click “Install”.

💡 Currently, the setup does not yet check the connection data you entered for the database, LEXolution Service Bus, or STP User Management.
Please make sure in advance that the connection data is valid.

If all data was entered correctly, the software will be installed successfully.
In the next window, you can use the checkbox to display the log file.

Click “Finish” to complete the installation process.
The STP beA Message Server should now be available as a Windows service on the target system and should have started automatically.

You can check this in Windows Services:

❗ Important: For the beA Message Server to keep the Type 3 code lists for X-Justiz records up to date, it needs access to the domain https://www.xrepository.de.
This must be considered when configuring firewalls or proxy servers.

💡 For the STP beA Message Server to start successfully, the other STP services (STP User Management and LEXolution.Service Bus) must also be running.
Since services may start one after another during a server restart, the STP beA Message Server will wait for a certain period (about 1 minute) at startup until the other services are available.

📝 If a problem occurs at startup, you can find more details in the log files at:

%PROGRAMDATA%\STP AG\beA Message Server\Logs

These log files help STP Support better understand and resolve possible issues.

4.2 Operation with Multiple Documents (DMS) Servers

💡 Note: The following configuration is only necessary if you are using multiple Documents servers. If only one server is used, it will be detected automatically.

If multiple Documents servers are used on the same LEXolution.ServiceBus, make sure these servers are registered in the beA Message Server configuration with their respective “SystemId” and description. To do this, follow these steps:

Open the server configuration file in the installation path of the beA Message Server with a text editor. This file is usually located at:

C:\Program Files\STP AG\beA Message Server\appsettings.json

In the “DmsServerSettings” section, enter all Documents servers available in beA Desk as shown in the following example.

{
  "DmsServerSettings": {
    "Servers": [
      {
        "SystemId": "129ff2c1-b4c4-4665-b55f-8d2a39dee8f9",
        "Description": "DMS Server – Area A"
      },
      {
        "SystemId": "c96917d2-0483-4a64-b078-1098c2edcdfe",
        "Description": "DMS Server – Area B"
      }
    ]
  }
}

❗ Make sure that brackets and commas are placed correctly. An incorrect configuration can prevent the beA Message Server from starting.

After restarting the beA Message Server, the registered servers will be available for selection on the beA Desk login screen. Users can set the default Documents server for future logins using the checkbox.

4.3 Operation with multiple input management systems

Starting with beA Desk version 1.5, multiple input management tenants can be connected. Each input management tenant is assigned to exactly one Documents (DMS) server.

By selecting the Documents server in the beA Desk login window, the associated input management system is automatically selected. If beA messages are archived in the input management system during the beA Desk session, the target system is already selected and no further prompt will appear.

📝 If your existing system already has an input management system defined and you want to continue using it as a single system, you can skip this section.

The configuration of input management tenants is done in the configuration file of the beA Message Server:

Open the server configuration file in the installation path of the beA Message Server using a text editor. This file is usually located at:

C:FilesAGMessage Server.json

Enter the access data and the corresponding Documents servers in the "DmsToImMapping" section as shown in the example below.

{
  "DmsToImMapping": [
    {
      "DmsServerSystemId": "129ff2c1-b4c4-4665-b55f-8d2a39dee8f9",
      "ImUrl": "https://INPUT-MANAGEMENT-TENANT-1.stp-cloud.de/",
      "ImUser": "USER_1",
      "ImPassword": "PW_1",
      "SkipCertificateValidation": true
    },
    {
      "DmsServerSystemId": "c96917d2-0483-4a64-b078-1098c2edcdfe",
      "ImUrl": "https://INPUT-MANAGEMENT-TENANT-2.stp-cloud.de/",
      "ImUser": "USER_2",
      "ImPassword": "PW_2"
    }
  ]
}

```json
After expanding the configuration to two input management systems, the appsettings.json file should look like this:

{
  "ImSettings": {
    "ImUrl": "https://stp.../",
    "ImUser": "User",
    "ImPassword": "Pw_Im",
    "SkipCertificateValidation": false
  },
  "DmsServerSettings": {
    "Servers": [
      {
        "SystemId": "ID1",
        "Description": "DMS Server 1"
      },
      {
        "SystemId": "ID2",
        "Description": "DMS Server 2"
      }
    ]
  },
  "DmsToImMapping": [
    {
      "DmsServerSystemId": "ID1",
      "ImUrl": "https://INSERT-CUSTOMER-ABBREVIATION-HERE_1.cloud.de/",
      "ImUser": "USER_1",
      "ImPassword": "PW_1",
      "SkipCertificateValidation": true
    },
    {
      "DmsServerSystemId": "ID2",
      "ImUrl": "https://INSERT-CUSTOMER-ABBREVIATION-HERE_2.cloud.de/",
      "ImUser": "USER_2",
      "ImPassword": "PW_2",
      "SkipCertificateValidation": true
    }
  ]
}

❗ Make sure that brackets and commas are set correctly according to JSON syntax. An incorrect configuration can prevent the beA Message Server from starting.

💡 The "ImSettings" configuration is used if no mapping is found in "DmsToImMapping".

After restarting the beA Message Server, the configured input management tenants will be linked to the specified Documents systems and used based on the selected Documents server.

4.4 Options for accessing BRAK mailboxes

Starting with version 1.5, both inbox synchronization and the sending process have been improved. It is no longer technically required for beA Desk to move incoming and outgoing messages to the "STP beA Desk Inbox/Outbox" subfolders on the BRAK server after successful synchronization.

You can now configure on the beA Message Server whether messages should be moved or not.

📝 Do not move messages to subfolders:

One advantage of not moving synchronized inbox messages to subfolders is that alternative software products with beA integration can also read and process the inbox.

If beA Desk moves synchronized inbox messages from the root directory, other beA applications may not find these new messages.

📝 Move messages to subfolders:

If the above requirement does not apply, it is recommended that beA Desk moves messages after successful synchronization, as this improves the organization of synchronized messages on the BRAK server.

To configure whether incoming or outgoing messages should be moved to subfolders after successful synchronization, follow these steps:

Open the server configuration file in the installation path of the beA Message Server using a text editor. This file is usually located at:

C:FilesAGMessage Server.json

Make the desired changes in the "Preferences" section. Possible values are "true" (default) or "false".

{
  "Preferences": {
    "AfterSyncMoveBrakInboxMessagesToStpSubfolder": true,
    "AfterSyncMoveBrakSentMessagesToStpSubfolder": true
  }
}

4.5 Update

If a new version of the STP beA Message Server is available, run the updated installation file “STP beA Message Server Setup *.exe” to start the update process. Keep the parameters from the initial installation.

❗ Before updating, make sure you have backed up the database and file storage of the beA Message Server.

❗ The setup must be run as an administrator (right-click -> Run as administrator).

5 STP beA Desk 5.1 Installing beA Desk Signer or SecCommerce SecSigner

To sign documents within beA Desk, you can use either the beA Desk Signer from STP (from beA Desk version 1.4 FP1) or the SecCommerce SecSigner (third-party component).

Neither is included in the standard package and must be downloaded and installed before installing beA Desk.

5.1.1

Please follow the download and installation instructions at the following link: https://seccommerce.com/download-secsigner-secsign-id/

📝 The installation can be performed using the default settings. Usually, no changes to the settings are required. If you keep the default installation paths, you can also use the default settings during the beA Desk setup.

5.2 Preparing the installation on a Windows Terminal Server

If you want to install the beA Desk Client on a terminal server, you must set the terminal server to installation mode before starting the installation.

To do this, open a command prompt with administrator rights:

Right-click the Windows icon at the bottom left of the screen. Select “Command Prompt (Administrator)” from the list.

In the command window that opens, enter the following command and press Enter:

❗ Important: This step is generally recommended when installing new programs on terminal servers to ensure user-specific settings are copied to the respective user profiles.

5.3 beA Desk Client Installation – Special notes for different installation environments 5.3.1 Update beA Desk: Option 1 with Updater (not a terminal server)

Place the update file for beA Desk in the Updater repository of the STP beA Desk.

If you are using the STP Expert Signer, use the XML file with a name like UpdateManifest_1.4.139.0.xml [remove the version label “_1.4.139.0”].

If you are using the SecCommerce SecSigner, first manually uninstall the STP beA Signer on all systems. Then place the beA Desk setup file in the Updater repository and use the XML file UpdateManifest_1.x.xxx.0_no_beA_Signer.xml [remove the version label “1.x.xxx.0_no_beA_Signer”].

5.3.2 Option 2 Installation without Updater (local client installation / terminal server installation)

Installation on a terminal server / local PC with beA Signer:

Place the setup file for beA Desk on the computer, e.g., under c: (not on the desktop or a network drive). On the terminal server, open the command window as administrator and activate installation mode with:

change user /install

Right-click the setup file and run it as administrator to start the installation.

After installation, exit installation mode with:

change user /execute

This step is not required for PC/laptop installations.

Installation on a terminal server / local PC with SecCommerce SecSigner:

Check if the STP Expert Signer is installed, and uninstall it on all systems first.

Place the setup file on the computer, e.g., under c: (not on the desktop or a network drive). On the terminal server, open the command window as administrator and activate installation mode with:

change user /install

Right-click the setup file and select “Custom Installation.” In the following steps, uncheck “STP beA Signer.”

Start the setup and proceed as usual.

After installation, exit installation mode with:

change user /execute

This step is not required for PC/laptop installations.

5.4 Installation

Before installing beA Desk, the installation of the beA Message Server must be completed.

❗ It is recommended not to run setup files from a network drive. Installing directly from a network drive can cause issues.

Run the installation file “STP beA Desk Setup .exe” to start the installation process.

❗ The setup must be run as an administrator (right-click -> Run as administrator). This usually results in an installation for “all users.”

The welcome screen will appear. Click “Next.”

In the next window, you can choose whether to perform a “Complete” or “Custom” installation. If you select “Custom,” you can freely set and change the installation directory. If you select “Complete,” the program will be installed by default in the following directory:

C:beA Desk

If you choose the custom installation, you can change the installation path using the “Change” button. However, it is recommended to keep the default installation path.

💡 STP beA Desk also requires the installation of STP beA Connect, as this component is used for communication with the BRAK beA server via the KSW interface.

After selecting an installation path, confirm it with “OK” and then click “Next >” in the following window.

A new window will open where you need to enter the following values:

5.4.1 REST/API address of the beA Message Server

The URL must be entered in the following format:

Under Computer Name, enter the name of the computer where the beA Message Server is installed.

💡 You do not need to enter “http://” before the computer name.

Under Port, enter the HTTPS port. By default, this is port “8097.”

5.4.2 Installation path for SecCommerce SecSigner 32-bit / 64-bit

Here, enter the directory where SecSigner is installed on this client.

💡 If you did not change the installation path for SecCommerce SecSigner during setup, you can keep the default installation paths suggested by the installer. If you need to change the path, you can do so using the “Change” button.

After entering and checking all values, confirm with “Next >.”

In the next window, you can enter the data for the LEXolution Service Bus (LSB).

5.4.3 LEXolution Service Bus (LSB)

Enter the hostname of the LSB here. If it is on the same computer where you are installing the beA Message Server, enter the name of that computer.

Port: Enter the port of the LSB. By default, this is “5672.”

Username: Enter the username. By default, this is “stpuser.” This depends on which user account the LEXolution Service Bus (LSB) was configured under.

Password: Enter the password for the LSB user specified above.

Confirm your entries with “Next >.”

A new window will open. Click “Install.”

💡 Currently, the setup does not check the connection data you entered for the STP beA Message Server or the LEXolution Service Bus. Please make sure in advance that the connection data is correct.

If all data was entered correctly, the software will be installed successfully. In the next window, you can use the checkbox to display the log file.

💡 Don’t forget to set the mode back to “execute” after installation on a terminal server.

5.5 Update

If a new version of beA Desk is available, run the updated installation file “STP beA Desk Setup .exe” to start the update process. Keep the parameters from the initial installation.

❗ The setup must be run as an administrator (right-click -> Run as administrator).

❗ Before updating, make sure that no instance of beA Desk is running and no beA Connect Java process is active.

❗ Make sure there are no incomplete messages in the “Outbox” folder of any beA Desk mailbox before updating.

❗ It is recommended not to run setup files from a network drive. Installing directly from a network drive can cause issues.

💡 If beA Connect cannot start after the update, make sure that only the latest beaConnect-*.jar file is in the beA Connect program folder (usually C:FilesAGbeA DeskbeA Connect).

5.6 Role and group management

The beA Desk uses subgroups under the main group “beA” in the central STP User Management to assign users their functional roles within beA Desk.

When the STP beA Message Server starts, the following groups are automatically created if they do not already exist:

The subgroups of the main group “beA” also represent the users’ functional roles in beA Desk. Please add your users to the appropriate groups according to their professional roles.

beA Desk does not make any changes to the user roles or permission structure of your BRAK mailbox and its rights. The grouping is only for professional assignment and only affects the beA OfficeManager, where administrative rights within beA Desk are assigned.

5.6.1 Description of functional roles

Group beA-OfficeManager – Office Managers are authorized to set up mailboxes and assign permissions for mailboxes.

Group beA-Rechtanwalt – This group is authorized to create message drafts in mailboxes they have access to and, depending on the permissions granted by BRAK, to send and receive messages.

Group beA-Sachbearbeiter – This group is authorized to create message drafts in mailboxes they have access to and, depending on the permissions granted by BRAK, to send and receive messages.

Group beA-Sekretariat – This group is authorized to create message drafts in mailboxes they have access to and, depending on the permissions granted by BRAK, to send and receive messages.

❗ Whether a user can receive messages in the inbox or send messages after successfully logging in to STP beA Desk depends solely on logging in to the beA network and the permissions set by BRAK.

💡 Users can be added to groups in the central STP User Management while the STP beA Message Server is running. However, it may take up to 5 minutes for these changes to take effect in the beA Message Server and beA Desk.

5.7 First launch

Open beA Desk (an icon should be on the desktop) and log in with a user who has been assigned permissions in User Management.

With this step, the installation of beA Desk is successfully completed. You can now begin setting up mailboxes for individual users in the “beA-OfficeManager” role area via the “Settings” dialog.

With this step, the installation of beA Desk is successfully completed. You can now use the gear icon in the “Settings” dialog to create mailboxes for individual users in the “beA-OfficeManager” role.

6 Technical basics and components

The STP beA Desk and the STP beA Message Server communicate with each other as well as with other STP products, as shown in the following diagram.

For successful communication between the individual STP products and components, make sure that the relevant protocols and ports are enabled.