Quickstart

To install and start a PTV xServer on your local machine please check the system requirements and then proceed with the following steps.

Prerequisites & Preparation

Server Delivery Package

PTV xServer software comes bundled in a compressed archive.

  1. Simply extract the content to a designated folder.

  2. Make sure that the current user is granted read, write and execute permission for the whole folder. Therefore, we suggest not to use C:\Program Files for Windows.

License

A PTV xServer requires a valid license to start and use certain features.

Java Installation

A PTV xServer requires a 64-bit Java 17 installation. 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 (cf. Default Environment Settings).

License Configuration

License Configuration Used License Method
Neither a license file nor a floating license server is specified.

The PTV xServer looks for a license file xserver.lic in the root directory.

Only a license file is configured. The PTV xServer uses the configured license file.
Only a floating license is configured. The PTV xServer uses the configured floating license server.
A license file and a floating license server are configured.

PTV xServer uses the license file. If the license file is not present or invalid, the floating license server is used as a fallback.

Configure a License File

Related file: conf/xserver.conf

To configure a license file with a different name or location, add a section license with the entry licenseFilePath to the configuration file conf/xserver.conf. For example:

core {
	license {
		licenseFilePath = "YOUR_LICENSE_FILE.lic"
	}
}

If you will use another directory

If you need a new license file, please contact your PTV sales representative.

Configure a Floating License Server

Related file: conf/xserver.conf

To configure a floating license server add a section license with the entry floatingLicenseServerAddress to the configuration file conf/xserver.conf. As shown in the following example:

core {
	license {
		floatingLicenseServerAddress = "198.51.100.1:16090"
	}
}

Adjust the IP for your server but keep the default port 16090.

Determine your local Hardware ID

For a productive license is usually your local hardware id required. In case you already have a test license available, you can simply take it from the configuration page of the dashboard. Without a valid test license, please determine your local hardware id by calling the batch file displayHardwareId.sh from the console (command prompt) and then send the created text file localHardwareId.txt to PTV.

Batch Files

PTV xServer comes with a set of batch files that can be used to run the servers either from a console (command prompt) or as a service.

Smoke Testing

After installing the server and deploying the license file, make sure your installation is correct:

  1. Start the server from the console. Wait for the message that reads "server started in ... ms".

  2. Start a browser and open http://localhost:port. The default port is 50000; the port used is also listed at the very beginning of the console output. You should now see the Dashboard.

  3. Open the Raw Request Runner in the section Administration. Select a sample request from the request selector and send the request. You should see the response message as well as the HTTP status code, which should be a 200.

  4. Go to the console you started the server from and shut down the server with CTRL-C.

Next Steps

PTV xServer can be configured in many ways and lots of additional geographical content can be installed. Please refer to the other chapters in the Administrator's Guide to learn more about your options.