si viewprojectmetrics
displays all the metrics for a specified project checkpoint
Synopsis
si viewprojectmetrics [--fields=field1[:width1],field2[:width2]...] [--metrics=value] [(-P project|--project=project)] [(-S sandbox|--sandbox=sandbox)] [--[no]failOnAmbiguousProject] [--projectRevision=rev] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]]
Description
si viewprojectmetrics displays all the metrics for the specified project checkpoint. For example:
si viewprojectmetrics --project=c:/Aurora_Program/bin/Libra/project.pj --projectRevision=1.2
You can track metrics for top-level Windchill RV&S projects and calculate them through event triggers. Calculated metrics can be viewed for a Windchill RV&S configuration management project or through a computed field on a Windchill RV&S Workflows and Documents project issue. Metrics provide information on a project as of a specific checkpoint.
Windchill RV&S provides some standard physical metrics that you can use. You can also create your own metrics using a third party tool. The --projectRevision option is mandatory. Metrics can only be viewed for a build project..
|
|
Metrics are only supported for database type repositories.
|
Options
This command takes the universal options available to all
si commands, as well as some general options. See the
options reference page for descriptions.
• --metrics=value
specifies the metrics to display information for. The value is a comma-delimited list of metric names, for example, lines,functions,bytes. If you do not specify a value, all metrics are displayed.
Each metric is displayed on a line by itself, displaying the fields specified by --fields If no fields are specified, all fields are displayed except for description.
• --fields=field1[:width1],field2[:width2]...
allows you to select fields to be printed, specified in the format field1[:width1],field2[:width2].... Specifying the column [:width] (in pixels) for each field is optional - widths are only available with the -g or --gui options. Under the CLI the fields are separated with a space.
The fields available for printing can be one or more of the following:
◦ average
displays the average for the metric.
◦ count
displays the number of issues that this metric is tracked for.
◦ metric
displays the name of the metric.
◦ description
displays the description of the metric.
◦ value
displays the value of the metric.
Diagnostics
See the
diagnostics reference page for possible exit status values.
Preferences
Using
si setprefs or
si viewprefs, you are able to set or view the preference keys for this command.
See Also
• Commands:
• Miscellaneous:
