im printissue
prints a PTC RV&S issue
Synopsis
im printissue [--outputFile=value] [--asOf=[<date>:label:<label>]] [--[no]showAttachments] [--[no]showChangePackages] [--[no]showFields] [--[no]showLabels] [--[no]showBranches] [--[no]showHistory] [--[no]showHistoryAscending] [--[no]showHistoryWithIndirectEdits] [--[no]showRelationships] [--[no]showTimeEntries] [--[no]showHistoryWithComputedField] [--[no]showTestResults] [--query=[user:]query] [--queryDefinition=query] [--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]] issue id...
Description
im printissue prints HTML output of the selected PTC RV&S issue to your console.
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 print an issue as of a historical date or label. For example, to print an issue as of a specific date, type
im printissue --asOf="January 8, 2007 10:00:00 AM EST" 123
If a value is not provided the issue is printed as of the server's current time. This field is optional.
• --outputFile=value
specifies the path to the file you want the issue data to be printed to. If the specified file already exists, you are asked to confirm an overwrite.
• --[no]showAttachments
specifies whether to display attachments when printing the selected issue. The default is to display attachments.
|
This option controls the visibility of the built in attachment field only. Custom attachment fields are always visible.
|
• --[no]showBranches
specifies whether to show branches of issues when printing the selected issue. Branches will be printed if the issue has at least one branch.
• --[no]showChangePackages
specifies whether to display change packages when printing the selected issue. The default is to display change packages.
• --[no]showFields
specifies whether to display fields when printing the selected issue. The default is to display fields.
• --[no]showLabels
specifies whether to display labels when printing the selected issue. The default is to print labels if there is more than one.
• --[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 do display the issue history, the information displays in reverse chronological order (the most recent changes appear at the top); however, you can configure the chronological ordering of history information using the --[no]showHistoryAscending option.
• --[no]showHistoryAscending
specifies whether to display the issue history in ascending or descending chronological order. This option is used with 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]showRelationships
specifies whether to display relationships when printing the selected issue. The default is to display relationships.
|
This option controls the visibility of the built in relationship fields only. Custom relationship fields are always visible.
|
• --[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]showTestResults
specifies whether to display test results for the issue type, if the issue type has been given a test management role by your administrator. Test results record the outcome of a test session, test case, or test step.
• --query=[user:]query
specifies the query used to populate the issue selection. Includes the name of the user who the query belongs to and the query name, for example, mchang:ActiveDefects. You do not have to specify the user name, but you must specify the query name. This option is useful when multiple users have the same name for a query.
|
PTC RV&S initially assumes that text before the first colon (:) is a user name and text after it is a query name. If PTC RV&S fails to find a matching user name and query name, it searches for a query name matching the exact text. For example, if you type mchang:ActiveDefects, PTC RV&S searches for the Active Defects query created by mchang. If PTC RV&S cannot find the query or user, it searches for the mchang:ActiveDefects query created by any user.
|
• --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 you want to print. To specify multiple issues, use a space separated list, for example, im printissue 51 98 102. By default, attachments, fields, relationships, and change packages are also printed unless you specify otherwise. Overrides the --query option.
See Also