im viewissue
displays the issue information of one or more PTC RV&S issues
Synopsis
im viewissue [--asOf=[<date>|label:<label>] [--[no]showAttachments] [--[no]showAttachmentDetails] [--[no]showAnnotations] [--[no]showBranches] [--[no]showLabels] [--[no]showLock] [--[no]showChangePackages] [--[no]showHistory] [--[no]showHistoryAscending] [--[no]showHistoryWithIndirectEdits] [--[no]showRelationships] [--[no]showWorkflow] [--[no]showTimeEntries] [--[no]showHistoryWithComputedField] [--[no]showRichContent] [--[no]showXHTML] [--[no]showTestResults] [--[no]substituteParams] [--[no]showSourceTraceDetails] [--[no]showSourceLinkDetails] [--[no]showDecorators] [--height=value] [--width=value] [-x value] [-y value] [--hostname=value] [--port=value] [--password=value] [--user=value] [(-?|--usage)] [(-g|--gui)] [(-F value|--selectionFile=value)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=value] [--forceConfirm=[yes|no]] [--[no]showIncomingExternalReferences] issue id...
Description
im viewissue displays the issue information of one or more PTC RV&S issues.
For example,
im viewissue --showTimeEntries --showAnnotations --asOf="January 8, 2007 10:00:00 AM EST" 123
displays information for issue 123, including time entries and annotations, as of January 8, 2007.
Note the following:
• Displayed date fields do not change based on the time zone that a user is operating in; however, displayed date/time fields vary based on the time zone that a user is operating in.
• Relevance and editability rules are evaluated on the PTC RV&S Client's time zone.
• Computed expressions return dates/times in the PTC RV&S Client’s time zone and perform calculations in the PTC RV&S Server's time zone where appropriate.
When you use the -g or --gui option, PTC 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 PTC 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.
• --asOf=<date>|label:<label>
allows you to view an issue as of a historical date or label. If a value is not provided the issue displays as of the server's current time. This field is optional.
 |
If you specify a WEST or IST time zone, the time is not displayed correctly in the issue history. Instead, use the time zone GMT+/-hours:minutes.
|
• --[no]showAttachments
specifies whether to display attachment file names. The default is to show attachments.
|
|
This option controls the visibility of the built in attachment field only. Custom attachment fields are always visible.
|
• --[no]showAttachmentDetails
specifies whether to display the following attachment details: added user, added date, summary and Mime type, and name and size of attachment. The default is not to display attachment details.
• --[no]showAnnotations
specifies whether to display annotations or a audit record for an issue. The default is not to show annotations.One line per annotation in the following format
Annotations:
Operation by: John Smith on Thu Aug 10 08:59:35 EDT 2006
Add Label: mylabel against time Thu Aug 10 08:59:35 EDT 2006
Operation by: John Smith on Thu Aug 10 08:59:35 EDT 2006
Add Label: mylabel against time Thu Aug 10 08:59:35 EDT 2006
• --[no]showBranches
specifies whether to show branch issue numbers if branches exist. A separate line indicates if an issue was branched from a parent. If the branch was performed against an --asOf time the annotation indicates the target --asOf time. The default is not to show branches.
• --[no]showHistory
specifies whether to display a read-only log of all changes to the issue. The default is to not show the history. If you display the issue history, the information displays in chronological order (the most recent changes appear at the bottom) by default; however, you can configure the chronological ordering of history information using the --[no]showHistoryAscending option.
|
|
Depending on the settings applied by your PTC RV&S administrator, the item's history may not be visible. If showHistory is disabled, an error message displays when you use the --showHistory option.
|
• --[no]showHistoryAscending
specifies whether to display the issue history in ascending or descending chronological order. In the GUI, the issue history displays in descending order by default. In the CLI and API, the issue history displays in ascending order by default. This option requires the --[no]showHistory option.
• --[no]showHistoryWithIndirectEdits
specifies whether to include indirect edits in the item's history. An indirect edit is an edit made to the backing field of a field value attribute (FVA) field. When --showHistoryWithIndirectEdits is specified, the results of such edits are shown in the item's history. When this option is not specified or --noshowHistoryWithIndirectEdits is specified, the results of such edits are not included.
• --[no]showLabels
specifies whether to display the labels created on an issue against a specific date and time. The default is not to show labels.
• --[no]showLock
specifies whether to display the document locking information about an issue. The default is not to show locking information.
• --[no]showChangePackages
specifies whether to display change package information. For more information on using change packages, refer to the PTC RV&S Help Center. The default is to show change packages.
• --[no]showRelationships
specifies whether to display related issue IDs from the Forward and Backward relationship fields. The default is to show these fields.
|
|
This option controls the visibility of the related issue IDs from the built in relationship fields only. Related issue IDs from custom relationship fields are always visible.
|
• --[no]showWorkflow
specifies whether to display the workflow for the issue type, if your administrator has enabled it. This option can only be specified with -g or --gui. Viewing the Workflow panel is useful for determining where you can progress in the workflow. The Workflow panel displays the complete workflow for the issue type, unvisited states, visited states, the current state, other state transitions, and phases, as indicated by the Legend.
• --[no]showTimeEntries
specifies whether to display time entries for the issue type, if enabled by your administrator. Time entries indicate time spent working on an issue. Time entries display the entry date, user, source, duration, and notes. Time entries are sorted in descending order of entry date.
• --[no]showHistoryWithComputedField
specifies whether to display the changes to computed fields in the issue history. By default, computed fields are not displayed in the issue history.
• --[no]showRichContent
specifies whether to display rich text information. The data displays in raw rich text, with HTML elements and attributes. You can display rich text for the issue as of now, for the issue as of a historical date or label (using the --asOf option), or for the log of changes made to the item (using the --showHistory option).
|
|
This option is intended only for use with the CLI or API and does not work when used with the-g option. By default, the data displays in plain text.
|
• --[no]showXHTML
specifies whether to display rich text field data in XHMTL format. Use with the --[no]showRichContent option. The --[no]showXHTML option is intended for use in triggers, scripts, or custom integrations. Special characters are included in the CLI output, but not the API output (API output is entity protected, for example < is converted to <).
• --[no]showTestResults
specifies whether to display test results for the issue, if enabled by your administrator for the issue type. The data displays as a list of test result IDs in the following format: test session ID : test case ID.
• --[no]substituteParams
specifies whether to replace parameter references in text fields with a parameter value. For more information on how parameter values are determined, see the PTC RV&S Help Center.
• --[no]showSourceTraceDetails
specifies whether to display source trace details for any source link fields, with trace enabled, on the issue. By default, source link fields with trace enabled display the file name, revision and line range (start and end) for each trace. If details are displayed, the following information is displayed for each trace: member, revision, line range, trace name, server, project, variant (developent path), created date, modified date, suspect trace (true or false), and follow tip (true or false). Details are separated by a tab.
Follow tip indicates that the trace always points to the head revision of the source file.
• --[no]showSourceLinkDetails
specifies whether to display source link details for any source link fields on the issue. By default, source link fields display the file name, revision and line range (start and end) for each link.
• --[no]showDecorators
specifies whether to display the ! decorator to indicate a computed field in a versioned item contains an ambiguous computation. By default, the --showDecorators option is specified.
• --[no]showIncomingExternalReferences
specifies whether to show incoming external references (IERs) that are related to a requirement. This option is only valid if one or more IER fields have been created.
• issue id...
specifies the ID of the issue you want to view. Use a space separated list to specify more than one issue ID, for example, 240 241 242.
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.
See Also
• Miscellaneous: options