Troubleshooting

Symptom	Possible Causes	Solution
The server does not start or exits immediately	Missing or insufficient license	Check if the PTV xServer has a valid license. A corresponding message should be in the log file `logs/xserver.log`. The PTV xServer can be configured either with a license file or a floating license server that provides the license. If the floating license server cannot be reached by the PTV xServer an according message is logged and the server is shut down. If your license expires while the PTV xServer is running, it is shut down. On restart, a corresponding error message is logged.
The server does not start or exits immediately	Missing or unsupported Java version	Java not found To check if Java is installed and configured, first try to start the server. If Java cannot be found, the file `wrapper.log` contains a message similar to the following: ERROR \| wrapper \| 2022/12/01 14:30:35 \| Unable to execute Java command. The system cannot find the file specified. (0x2) Please check that you have Java 17 installed. Furthermore the environment variable `JAVA_HOME` has to point to the location of the Java installation (the directory containing the bin directory). If you do not want to change the value of the `JAVA_HOME` variable, you can use the environment variable `XSERVER2_JAVA_HOME`. You should note that if neither the environment variable `JAVA_HOME` nor the environment variable `XSERVER2_JAVA_HOME` is defined, the `wrapper.log` contains an additional warning similar to the following: WARN \| wrapper \| 2022/12/01 14:30:35 \| The 'JAVA_HOME' environment variable was referenced but has not been defined. Unsupported Java version To check if the version of the configured Java installation is supported, first try to start the server. If the Java version is unsupported, the file `wrapper.log` contains a message similar to the following: FATAL \| wrapper \| 2022/12/01 15:37:36 \| The version of Java specified by wrapper.java.command (18.0.2) FATAL \| wrapper \| 2022/12/01 15:37:36 \| is greater than the maximum allowed (1.17). Please check that you have Java 17 installed. Furthermore the environment variable `JAVA_HOME` has to point to the location of the Java installation. If you do not want to change the value of the `JAVA_HOME` variable, you can use the environment variable `XSERVER2_JAVA_HOME`.
The server repeatedly starts over backend modules	Corrupted configuration	See the configuration section for details on legal values.
The server repeatedly starts over backend modules	Missing data	Are the configured data paths correct? Note that paths must use posix-separators (forward-slashes '/') to separate directories. Some modules might want trailing '/' characters at the end of the path.
(Microsoft^© Windows): PTV xServer does not start as service but logs a timeout error	Startup time exceeds default timeout setting of 30sec	Add or change the registry entry ServicePipeTimeout to a higher value such as 180000 to allow all processes to initialize. See also Microsoft Support Page.
(Linux): I am reported a CVE regarding the folder `/tmp/boost_interprocess`	This folder lacks the sticky bit	Add the sticky bit to that folder by executing `chmod +t /tmp/boost_interprocess`. Note that this is a folder which may also be used by other application, side-effects might be possible.
A PTV xServer service returns an exception	Hint: The exceptions contain more detailed information about the cause. Besides the message text each exception contains a fault object which provides specific data about the exception. For example, if the request contains a field with an invalid value, the fault provides information that tells which field it is. See the exception namespace for an overview of the existing exceptions.
A PTV xServer service returns an exception	A route locationA route location is the position of an object to be routed to or from, which contains additional information on how to link this position to the road network and whether or or not this position is actually reached. Route locations are used as the input for route calculation and optimization throughout PTV xServer. is not reachable.	In such a case the exception contains a WaypointNotLinkableFault or a RouteNotFoundFault. For example, if the routeA route corresponds to a path of a vehicle through the underlying transport network. The main attributes of a route are the distance and the time that the vehicle travels along the path. location of an xRoute waypointA waypoints is a geographic location used to specify start, destination and possible stopovers for a route. is far away from any road the fault tells which waypoint A waypoint is a geographic location used to specify start, destination and possible stopovers for a route. cannot be linked to the road network. See the use case Unreachable Route Location for more details.

Common Error Codes

Code Type	Code	Meaning
General Error Codes These error codes indicate a general exception during server startup and may be a symptom of an installation problem.	0	OK - no error occurred
	99	Licensing exception
Module Process Error Codes	50	Module was not able to start - please check the module configuration file for invalid data configuration.
	52	Module Timeout - the module did not receive a ping from the server for a certain amount of time and will therefore shut down.
	54	Module could not be initialized, the xServer will shut down. This is typically the case if there is a problem in the module-specific configuration such as a typing error in the data path.
Server Process Error Codes	102	Unable to open the alive port. Either there is a port misconfiguration or the port is already in use on your system.
Server Process Error Codes	103	Illegal/invalid server config. The configuration file `xserver.conf` contains invalid settings or is not accessible.