im relationships
displays all the relationships for one or more Windchill RV&S issues
Synopsis
im relationships [--asOf=[<date>label:<label>] [--fields=field[:width[:rich|plain]],field[:width[:rich|plain]],...] [--expandRelationshipDirection=[forward|backward|both]] [--expandRelationshipFields=field,field,...] [--[no]ApplyDisplayPattern] [--structureFieldIconDisplayField=field] [--structureFieldDisplayFormat=value] [--focusIssueID=value] [--expandLevel=value] [--[no]batchEdit][--nodeDisplayFields=value] [--[no]showFieldNodes] [--[no]showXHTML] [--query=[user:]query] [--queryDefinition=query] [--height=value] [--width=value] [-x value] [-y value] [--hostname=value] [--port=value] [--password=value] [--user=value] [(-g|--gui)] [(-?|--usage)] [(-F value|--selectionFile=value)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] [(-N|--no)] [(-Y|--yes)] [--cwd=value] [--forceConfirm=[yes|no]]issue id...[--[no]showEditPanel] [--[no]confirmSave] [--[no]showIssueView]
Description
The im relationships command displays a relationship tree. You can expand the tree to show the relationship fields for the root issue(s), and expand each relationship field to see the related issues in that field. You can control which relationship fields display in the view, and you can perform functions on the issues in the view.
For example,
im relationship --field=ID,type,state,summary 80713
displays the ID, type, state, and summary for all issues that issue 80713 has a relationship with.
|
|
This command is only supported with the -g or --gui option. When you use the -g or --gui option, Windchill RV&S displays an issue selection dialog box. If you browse for issues from the issue selection dialog box, any changes you make to the columns in the Issues View will not be applied to that view when it is accessed through the Windchill RV&S Client GUI.
|
Options
This command takes the universal options available to
im commands, as well as some general options. See the
options reference page for descriptions.
• --fields=field[:width[:rich|plain]],field[:width[:rich|plain]],...
allows you to select fields to be printed, 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.
• --[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.
|
• --focusIssueID=value
specifies the item ID to highlight in the tree pane when the segment displays. This color is defined in the View > Options dialog in the context of the Document view.
• --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 relationships as of a historical date or label. For example, to view relationships on an issue as of a specific date, type
im relationships --asOf="January 8, 2007 10:00:00 AM EST" 123
If a value is not provided the relationships display as of the server's current time. This field is optional.
• --structureFieldIconDisplayField=field
specifies the field from which the icon is taken. This is the icon that will be displayed for each node in the Outline pane.
• --expandLevel=value
specifies to expand the nodes to a specified level, for example, 1, 2, 3. The default is one.
• --[no]showXHTML
specifies to enable rich text fields to be displayed as XHTML.
• --structureFieldDisplayFormat=value
specifies the fields and style that should be displayed for the tree nodes.
defines an output format for user-formatted text. 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:
im relationships --structureFieldDisplayFormat="{ID},{Summary}"
• --[no]showFieldNodes
specifies whether or not to display field nodes.
• --query=[user:]query
specifies the query to use to populate the issue selection. If not specified, Windchill RV&S uses the most recently run query.
• --queryDefinition=query
specifies a string to define the query constraints for the query used to populate the issue selection. For the format of the query definition, see the
im createquery reference page.
• issue id...
specifies the ID of the issue(s) you want to view relationships for. Use spaces to specify more than one issue, for example 3423.
If document versioning is enabled, you can also specify versioned items. To type the ID of a versioned item, use the format Live Item ID-major.minor, for example, 184-1.2.
--[no]showEditPanel
specifies whether to show the embedded item edit pannel. This option can be used in conjunction with the --[no]showIssueView option. If conflicts arise, the--[no]showEditPanel option always wins.
--[no]showIssueView
specifies whether to show the embedded item view. This option can be used in conjunction with the --[no]showEditPanel option. If conflicts arise, the --[no]showEditPanel option always wins.
--[no]confirmSave
specifies whether to prompt you to confirm changes are to be saved. This turns on and off whether you a confirmation window oepns when you save in this view.
See Also
