Self-Diagnosis
To ensure that a sedex-Client installation is configured correctly and works successfully, the sedex-Client offers a function for self-diagnosis and an installation check. This test function can be executed manually by the participant at any time using a new shell script e.g. when encountering problems.
This stand-alone installation-check script allows checking a sedex-Client installation without having to start the client. In this way, a new installation can be checked at an early stage without unintentionally processing sedex messages.
What is checkedπ
Among other things, the following aspects are checked:
- Correctness of the configuration files
- Validity of the certificates
- Reachability of the sedex servers via the network connection
How to run the installation checkπ
Note: Check stopped installations
To prevent a running sedex-Client and the installation-check from interfering with each other, it is recommended to stop the sedex-Client before running the installation-check.
Classic OS-based Installationsπ
The installation check can be started using a shell script:
- Open a command line (terminal) on your system.
-
Navigate to the directory where the sedex-Client is located:
Replacecd <sedex-home><sedex-home>with the actual path to the installation directory. -
Execute the following command to perform the installation check:
.\bin\check-installation.bat
./bin/check-installation.sh
Docker-Based Installationsπ
The installation check can be started by executing a script inside the container:
$ docker run \
--rm \
--mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
--mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
sedexch/sedex-client:container-1.2 check-installation.sh
$ docker run \
--rm \
--mount type=bind,source=/home/data/sedex-interface-1-1234-1,destination=/sedex-interface/ \
--mount type=bind,source=/home/data/sedex-data-1-1234-1,destination=/sedex-data/ \
sedexch/sedex-client:container-1.2 check-installation.sh
How to analyse the resultπ
The following screenshot shows the result of an installation check for a properly functioning installation:
``` command Checking sedex-client installation in opt/sedex-client on 11.09.2025 15:19:08
Checking sedex-client-configuration.properties ........................... OK Checking sedex-certificate-configuration.xml ............................. OK Checking connection to sedex without a client certificate ................ OK Checking connection to sedex using the newest client certificate ......... OK Checking installed certificates .......................................... OK Checking newest certificate .............................................. OK Checking sedex-incoming-message-interface-rules.conf ..................... OK Checking sedex-wsproxy-user-configuration.properties ..................... OK Checking File Access ..................................................... OK
- Success: sedex Client installation check completed with no errors *
```
In this example, each check was confirmed with an OK. If an error is detected at an individual checkpoint, this indicates a potential problem in that aspect. Additional notes then help to understand and resolve the problem.
The output content is also written to the log file <sedex-home>/logs/controller/controller-technical.log. This means that the details of an installation-check can also be accessed again at a later point in time.