VTSCommand tool

The VTSCommand tool is a command-line utility designed to export and save test results from the Vienna Test System (VTS) as .xstp archive files. In addition to archiving, the tool offers the following capabilities:

Result cleanup: Optionally deletes all archived test results.
Person cleanup: Optionally deletes person records from VTS if all associated test results have been successfully archived, if no test results exist, or if only unfinished tests are present.
Certificate management: Allows replacement of the service’s certificate with a different X.509 certificate to be used by VTS.

Preconditions

For the tool to work, the Universal plugin must be configured and running on port 9010. For more information about configuring the Universal Plugin, refer to the Universal Plugin Documentation.

Username and password in the configuration of the Universal plugin must stay empty for the VTSCommand tool to be able to connect to it.

Example of the section with the initial configuration of the Universal plugin in the appsettings.json

CODE

"Urls": "https://localhost:9010",
"UniversalPlugin": {
  "Enabled": "true",
  "DefaultTestBattery": "",
  "CertificateSearchKind": "FindBySubjectName",
  "CertificateSearchValue": "SchuhfriedSelfSignedCertificate",
  "UsernameToVisService": "",
  "PasswordToVisService": ""
},

Location of the tool

The tool is by default located in the folder C:\Program Files\SCHUHFRIED GmbH\Vienna Test System 8 Client\AdminClient\VTSCommand.exe

Note: This is the default installation path. If the Vienna Test System was installed to a different location, the actual path may vary accordingly.

Parameters

The following parameters define the specific actions the tool should perform.

Parameter		Description
Archiving functionality
CODE `-a`	Mandatory	Starts archiving functionality.
CODE `-m MandantName`	Mandatory	Specification of the multi-client where the operation will be performed.
CODE `-p Path`	Optional	Specifies the directory where the archive file will be saved. This location must be accessible to the service user under which the tool is running. If not specified, the archive will be saved by default to: CODE `%ProgramData%\Schuhfried\Archive`
CODE `-e`	Optional	Additionally performs CSV export of persons and creates .csv file.
CODE `-d`	Optional	Deletes exported results. Additionally if all results of a person are deleted, person gets deleted as well.
CODE `-w`	Optional	Includes persons without planned tests in the archiving process. If parameter `-e` is used, separate csv file containing persons without planned tests will be created. If parameter `-d` is used, persons who without planned tests will be deleted.
CODE `-u`	Optional	Includes persons with unfinished tests in the archiving process. If parameter `-e` is used, separate csv file containing persons with unfinished tests will be created. If parameter `-d` is used, persons with unfinished tests will be deleted. -u
CODE `-x minutes`	Optional	Specifies the maximum execution time in minutes. Once this time limit is reached, the export process will be stopped.
CODE `-o days`	Optional	Limits archived results to those older than the specified number of days.
NONE `-y`	Optional	If specified, the export will be anonymized. This applies to both the test results export and the optional CSV export of person data (using the `-e` option).
CODE `-h`	Optional	Help command
Configuration of X509 Certificate
CODE `-c`	Mandatory	(Re)configure X509 Certificate for VIS & VTS
CODE `-k`	Required if in combination with `-v`	Defines the certificate search kind. This is the field by which we will be finding the certificate in the Windows certificate store. Valid values are: `FindByThumbprint, FindBySubjectName, FindBySubjectDistinguishedName, FindByIssuerName, FindByIssuerDistinguishedName, FindBySerialNumber, FindByTimeValid, FindByTimeNotYetValid, FindByTimeExpired, FindByTemplateName, FindByApplicationPolicy, FindByCertificatePolicy, FindByExtension, FindByKeyUsage, FindBySubjectKeyIdentifier`
CODE `-v`	Required if in combination with `-k`	Value used to search for the certificate in the Windows certificate store. Example: Use certificate subject name if `-k FindBySubjectName` or certificate thumbprint if `-k FindByThumbprint`
CODE `-f`	Required if in combination with `-q`	Full path to the *.pfx file including filename
CODE `-q`	Required if in combination with `-f`	Password to the *.pfx file
CODE `-n`	Optional	If specified, the tool will not ask for user confirmation in the console

Using the tool for archiving

The VTSCommand tool supports both manual archiving and automated archiving, allowing flexible integration into your workflows. For automated use, the tool can be triggered by external schedulers such as Windows Task Scheduler, enabling daily or periodic execution for continuous archiving.

Archiving Options

You can configure the tool to:

Archive test results while keeping them in the system, or
Archive and delete test results from the system after archiving.

In addition to archiving, the tool supports:

Deleting persons with no test results (e.g., created but never used),
Deleting persons with unfinished tests (e.g., tests never started or abandoned),
Exporting persons to a .csv file.

An anonymization option is available for the entire archiving process, allowing sensitive personal data to be anonymized both in archived data and exports, if required.

Archiving Scope and Retention

You can specify a retention period to control which test results are archived or deleted. Only test results older than the defined number of days are processed; newer ones remain in the system.

Example commands for archiving

The following command exports test results in mandant W12345_001. File with extension .xstp will be created in default archiving folder %ProgramData%\Schuhfried\Archive

VTSCommand.exe -m W12345_001 -a

The following command will export and delete all test results and corresponding persons provided they do not have any other unfinished or planned tests.

VTSCommand.exe -m W12345_001 -a -d

The following command will delete all exported test results and corresponding persons if they do not have any other unfinished or planned tests. Persons in the database with unfinished tests or no test results yet will also be deleted.

VTSCommand.exe -m W12345_001 -a -d -w -u

The following command will export and delete all test results older than 60 days. Corresponding persons will be also deleted provided they do not have any other unfinished or planned tests. If the export takes more than 8 hours, it will be stopped automatically.

VTSCommand.exe -m W12345_001 -a -d -o 60 -x 480

Using the tool for the configuration of X509 Certificate

The VTSCommand tool can be used to (re)configure which X.509 certificate is used by the VTS for the following purposes:

Hosting TLS services (VIS & VTS)
Encrypting generated reports

There are two ways to (re)configure the X.509 certificate for VIS and VTS:

By referencing an existing certificate installed in the Local Machine Personal certificate store
By providing the path and password to a *.pfx file that contains the certificate and its private key (the certificate will then be installed in the Local Machine Personal certificate store)

Note: The tool must be run with administrator privileges; otherwise, the operation will fail.

Example commands for certificate configuration

The following command finds a certificate by thumbprint in the computer/my certificate store and configures it to be used by VIS & VTS.

VTSCommand.exe -c -k FindByThumbPrint -v 2e6ded878a02917790863e9436dc8878a4140a50

The following command installs a certificate from the given pfx file into computer/my certificate store and configures it for the use by VIS & VTS. It skips the (Yes/no) user approval in the console.

VTSCommand.exe -c -n -f c:\users\admin\desktop\mycert.pfx -q mypassword1234