Skip to content

PTMService

Jump to bottom
Namikoye Lusweti (from Dev Box) edited this page Aug 26, 2025 · 8 revisions

PTMService

PTMService is a cross-platform, web-based application for managing and running Windows protocol test suites. It replaces the old, .NET Framework based Protocol Test Manager application. It is a standalone application and not bundled with the Protocol Test Framework.

Install

  • Download and install .NET 8.0 for your platform.

  • Download PTMService.zip/PTMService.tar.gz from the Releases page and extract the archive. At the time of this update the latest is v1.1.1.

  • Optionally, if you want to add a desktop icon shortcut for PTMService on Windows and install PTMService into a different directory, you may run the install.ps1 powershell script within the extracted directory:

powershell .\install.ps1

Running

We recommend running PTMService in-place. On Windows and macOS, you may need to set up .NET dev certificates first:

dotnet dev-certs https
dotnet dev-certs https --trust

Launch your shell in the extracted PTMService folder (by default is C:\PTMService) and run

dotnet PTMService.dll

to start the service.

If you created a desktop shortcut, double clicking on it will start the service automatically.

Open your browser (Internet Explorer 11 is not supported) and go to https://localhost:5000/, or the targeted port as specified in the run log, to access PTMService. Ignore any certificate errors that may occur.

Usage

  • Go to the Management tab. PTMService Management tab

  • Upload a test suite. You could either download released test suite zips from the Releases page or compile the test suite from source. When uploading the test suite, take note of the version number and ensure it is the version you are targeting.

  • Go to the Run TestSuite tab and select the test suite you just added. Select the test suite to run

  • Add a configuration for the test suite. A configuration contains the metadata required for a test run, e.g. hostnames, credentials, test cases selected, etc. Add a configuration

  • Edit the configuration. There are three ways to initialize a configuration: by auto-detection using PTMService itself, by manual configuration, or by loading a pre-existing profile.

  • Run the test suite using the configuration that you've just created.

Usage Continued

PTMService allows you to load, run and utilize multiple versions of the same or different test suites. To keep track of multiple versions, provide meaningful names and descriptions and compare against the version numbers. For scenarios where an existing environment is used to run a new version of the test suite, simply upload the new version as you did before using the management tab, provide a meaningful name and decription and select it as you run the test suite.

MultiTestSuite

When you're ready to run the test suite, simply select the version you are targeting and proceed accordingly. Version information is replicated on the Run TestSuite page while doing test suite selection.

MultiTestSuiteRun

Note

If PTMService does not show a newly uploaded test suite version, ensure you have uploaded it using the Management tab. Each upload is treated as a separate entry; provide a unique name and description to distinguish versions. PTMService does not automatically detect new test suite files placed in the directory—you must upload each version through the UI.

Clone this wiki locally