tm resulteditor

CLI Reference > Workflows and Documents Commands > tm resulteditor

tm resulteditor

allows you to manage the results of a test session

Synopsis

tm resulteditor[--[no]applyDisplayPattern][--[no]showOutline[--[no]showDetails[--[no]splitVertical[--[no]displayOutline][--asOf=[<date>|label:<label>][--fields=field[:width[:rich|plain]],field[:width[:rich|plain]],...][--expandRelationshipDirection=[forward|backward|both]][--expandRelationshipFields=field,field,...][--[no]batch][--[no]showFieldNodes][--structureFieldDisplayFormat=field][--structureFieldIconDisplayField=value][--query=[user:]query][--[no]showXHTML][--expandLevel=value][--focusIssueID=value][--height=value][--width=value][-xvalue][-yvalue][--hostname=value][--port=value][--password=value][--user=value][(-g|--gui)][(-?|--usage)][(-Fvalue|--selectionFile=value)][--quiet][--settingsUI=[gui|default]][--status=[none|gui|default]][(-N|--no)][(-Y|--yes)][--cwd=value][--forceConfirm=[yes|no]]issue id...

Description

The tm resulteditor command displays an editor for working with test results for a test session. You can expand the tree to show test cases for the root issue(s) and enter or change the test result for the test cases.

For example,

tm resulteditor --splitVertical --fields=ID,summary 80713

displays the ID and summary for all test cases contained in test session 80713. The editor displays both the Outline and Details panes.

This command is only supported with the -g or --gui option.

If a test session contains versioned test items, use the Integrity Lifecycle Manager 12.0 client or a later client only. It is recommended that you upgrade clients older than 12.0 to the current version for using the Test Result Editor with versioned test items.

Options

This command takes the universal options available to tm commands, as well as some general options. See the options reference page for descriptions.

• --[no]applyDisplayPattern

specifies whether to apply a display pattern to numeric fields. Display patterns are configured by your administrator and allow you to quantify integer and floating point field values, for example, as currency or percentages. --applyDisplayPattern is enabled by default.

If you use scripts, PTC recommends using the --noapplyDisplayPattern option to avoid being impacted by administrative changes to display patterns.

• --[no]displayOutline

specifies whether to display the Outline, a tree-like relationship hierarchy stemming from the test session you used to launch the view.

• --[no]displayDetails

specifies whether to display the details of the test case selected in the Outline.

• --[no]splitVertical

specifies whether to split the test editor vertically, displaying the Outline on the left side and the test case details on the right side.

• --fields=field[:width[:rich|plain]],field[:width[:rich|plain]],...

allows you to select fields to be displayed in the test result editor, specified in the format field[:width],field[:width],.... Specifying the column [:width] (in pixels) for each field is optional.

For rich content fields, you can specify display patterns to display field values as rich content (:rich) or plain text (:plain). The rich content display pattern displays the underlying HTML elements and attributes in the rich content field. For example, --fields=Description::rich displays the Description field value with HTML elements and attributes. By default, rich content fields display plain text.

• --expandRelationshipDirection=[forward|backward|both]

specifies the type of relationship fields to display and expand: forward, backward, or both.

• --expandRelationshipFields=field,field,...

specifies the relationship fields to display and expand.

Note the following:

◦ Relationship fields include standard forward and backward relationship fields, as well as query backed relationship (QBR) and item backed picklist (IBPL) fields (considered as forward relationship fields).

◦ The --expandRelationshipDirection and --expandRelationshipFields options are mutually exclusive. If both options are specified, the im relationships command fails and displays an error message with the reason.

• --asOf=[<date>|label:<label>]

allows you to view test cases as of a historical date or label. For example, to view test cases in a test session as of a specific date, type

tm resulteditor --asOf="January 8, 2007 10:00:00 AM EST" 123

If no value is provided the test cases display as of the date in the test session field specified by your administrator, or as of the server's current time if no test session date is specified. This field is optional.

• --structureFieldDisplayFormat=value

specifies the fields and style that should be displayed for the tree nodes.

The default formatting is suitable for interpretation by most users; the various formatting options are provided for programmatic control.

--structureFieldDisplayFormat options use the same values as --fields, but similar to a JAVA MessageFormat string (that is, it requires { } to surround each field). For example:

tm resulteditor --structureFieldDisplayFormat="{ID},{Summary}"

• --structureFieldIconDisplayField=value

specifies the field from which the icon is taken. This will specify the icon that will be displayed for each node in the Outline pane.

• --[no]showXHTML

specifies whether rich text fields display in XHTML.

• --expandLevel=value

specifies to expand the nodes to a specified level, for example, 1, 2, 3. The default is 1.

• --focusIssueID=value

specifies the issue ID to focus on in the editor.

• --query=[user:]query

specifies the query to use to populate the issue selection. If not specified, PTC RV&S uses the most recently run query.

• issue id...

specifies the ID of the test session issue(s) you want to manage results for. Use spaces to specify more than one issue, for example 34 23.