Share via

ResultsUtil Command-Line Options

  • Article

Applies To: Windows 8, Windows 8.1, Windows Server 2012 R2

The ResultsUtil command is used when you want to store assessment results in a SQL Server database. By default the results are stored on the Windows® Assessment Services server in a results store. The ResultsUtil command is used to configure the Windows Assessment Services server (or an independent server) to store job results from the results share into a SQL database. It is also used to import existing results into a SQL database. After you install Windows Assessment Services on a server, use the ResultsUtil commands to initialize the results database on a SQL Server instance before you import individual results or configure Windows Assessment Services to post results to the database automatically.

Warning

Results that are stored in a SQL Server database do not include the Assessment Platform presentation layer and cannot be viewed in the Windows® Assessment Services - Client (Windows ASC). A custom reporting solution is required to view the results.

Remarks

Starting with Windows 8.1, you can now batch import a set of results into the database and delete the batch from the database. The tracking mechanism used to tag the results in an import batch is the batch ID. Batch importing (/B) lets you point to a folder with a set of results and import them with a single command. The output of this command provides a batch ID that can later be used to delete the batch if any importing errors occur—if there is a typo in the metadata, for example.

Note

The /tags option is no longer supported.

Note

When using a database connection string, either with the /db option or when saving to ResultsUtil.exe.config with the /FileSave option, you must specify RelaxResults as the initial catalog. See the table of options below for examples.

Metadata

Metadata is useful when comparing results or reporting on a collection of results. There are three types of metadata that can be used to align data imported into the database. See the corresponding entries in the full options table below for examples.

Type Option Description

Project

/p

A grouping that represents a set of machines

Test Pass

/t

A set of results created by a single test pass or on a specific build

Run Tag

/rt

The configuration used during the run of a test pass. For example, you may run before and after a driver update to measure the performance

System Requirements

The following are system requirements for running the ResultsUtil command:

  • Windows® Assessment Services

  • Windows Server® 2008 R2, Windows Server® 2012, or Windows Server 2012 R2

  • A full version of SQL Server 2008 R2 or later

Configuration Overview

ResultsUtil uses a configuration file that is stored in the same directory as the executable. The individual configuration options are described in the sections below. Sections of the configuration file that are not listed below are specific to SQL server and should be edited only by an experienced administrator.

ResultsUtil.exe Command-Line Options

To initialize the database, use the following syntax:

ResultsUtil /InitializeDatabase [/DB <database connection string>] [/User <database user name>] [/FileSave]

To import results, use the following syntax:

ResultsUtil.exe /I [/s <file path>] [/b <folder path>] [/a] [/db <database connection string>] [/user <database user name>] [/p <project name>] [/t <test pass name>] [/rt <run tag>] [/tags <user defined tags>]

To delete a batch of results that have been imported into the database, use the following syntax:

ResultsUtil /D /BID <result batch ID> [DB <database connection string>] [/User <database user name>]

The following table provides a description of how each option can be used. These options are not case sensitive.

Option Description

/InitializeDatabase

Installs the results database on the specified instance of SQL Server.

Connection strings can be used to configure connections to the database. If no command line options are provided, then the /InitializeDatabase command uses what is in the configuration file.

Note
The two configurations in the default file are not used and can be removed.

Example:

ResultsUtil /InitializeDatabase /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /filesave

/ImportResults

/I

Imports the specified results file into the results database.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /project MyProject /testpass Milestone1 /runtag Run1 /tags M1Results

/ConfigureWASserver

/C

Configures the specified instance of Windows Assessment Services to store results to the specified results database.

Example:

ResultsUtil /ConfigureWASserver /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /WasServer http://WASserver:8000/relax/service

/InputFile <filename>

/S

Identifies a results file to be imported into the results database. The full path to the results file must be specified.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml

/B

Bulk import results files from a folder. The batch ID can be used later to delete this data from the database.

Example:

ResultsUtil /ImportResults /B C:\WAS\Results\ /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /project MyProject /testpass Milestone1 /runtag Run1 /tags M1Results

/DB <database_connection_string>

A connection string that includes the instance of SQL Server and the database to be created.

Example:

ResultsUtil /InitializeDatabase /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /filesave

/User <user_name>

A user name for the SQL server connection.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName

/Project <project_name>

/P

Associates a project name with the data being imported or overwrites it if it already exists. For assessment results imported from a job that ran in the Windows® Assessment Console on a local computer, the project name does not exist. If the results were generated from a job that ran in a lab environment that uses Windows® Assessment Services, the project name already exists.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /project Project1

/TestPass <test_pass_name>

/T

Creates a test pass metadata tag or overwrites it if one already exists. The test pass metadata helps you organize results for a specific milestone or test cycle.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /project Project1 /testpass Milestone1

/RunTag <run_tag_name>

/RT

Creates run tag metadata or overwrites it if it already exists. Run tag metadata helps you identify a specific job run instance when you search for results.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /project MyProject /testpass Milestone1 /runtag Run1

/BID <result_batch_ID>

Specifies the batch ID of the results you want to delete.

Example:

ResultsUtil /D /BID <Result batch ID>

/Archive

/A

Archive results before importing them.

The archive path is specified by using the archivePath node in the configuration file. You must configure the archive path in order to archive files.

Example:

ResultsUtil /ImportResults /inputfile C:\WAS\Results\JobResultsComputerGUID.xml /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /project MyProject /testpass Milestone1 /runtag Run1 /tags M1Results /archive

/D

Delete a batch of results imported into the database.

Example:

ResultsUtil /D /BID <Result batch ID>

/FileSave

Saves the database configuration file, resultsutil.exe.config, to the same location as the ResultsUtil. The database configuration file is prepopulated with the database connections string and user name so that you don’t have to enter it every time that you import results.

Note

There is only one database configuration file. If you have multiple results databases the command-line options will take precedence over the configuration file.

Example:

ResultsUtil /InitializeDatabase /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /user MyName /filesave

/Quiet

Suppresses status messages.

Example:

ResultsUtil /ConfigureWASserver /db "Data Source=localhost\WAS_SQLSERVER;Initial Catalog=RelaxResults;Integrated Security=True" /User MyName /WasServer http://MyServer:8000/relax/service /Quiet

See Also

Concepts

Windows Assessment Services Technical Reference