im editreport
edits an existing Windchill RV&S report
Synopsis
im editreport [--query=[user:]query] [--reportTemplate=value] [--reportTemplateFile=value] [--recipeParam=value] [--recipeParams=value] [--recipeParamsFile=value] [--shareWith=u=user1[:modify],user2[:modify],...;g=group1[:modify],group2[:modify],...] [--[no]confirmSharedAdmin] [--name=value] [--description=value] [--sharedAdmin] [--hostname=value] [--port=value] [--password=value] [--user=value] [(-?|--usage)] [(-F value|--selectionFile=value)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=value] [--forceConfirm=[yes|no]] [username:]report
Description
im editreport edits the properties of a Windchill RV&S report. You may only edit one report at a time, and only reports created by you are available for editing. For more information on reports, refer to the Windchill RV&S Help Center.
For example,
im editreport --name="Docs Weekly Status Release 2.0" "Docs Weekly Status"
edits the Docs Weekly Status report to change its name to Docs Weekly Status Release 2.0.
Note the following:
• Reports can do more than just display field information. You can also perform arithmetic calculations between numeric fields, displaying the values in the report. For example, you can add up column totals or count the number of issues in a specific state. To perform these calculations, you create a computed expression. For more information on the syntax, operators, functions, and operations applicable to computed expressions, see your administrator or the Windchill RV&S Help Center.
• You cannot create or edit a query while creating a report.
• A report can be edited by the user who created it. Principals (users and groups) that a report is shared to can edit it if they have edit permissions assigned to them by the report creator. A report can only be deleted by the user who created it or by the administrator.
• Because reports are based on queries, reports are subject to visibility rules set by your administrator. Visibility rules restrict access to specific information based on project and/or issue type. For more information, see the Windchill RV&S Help Center, or contact your administrator.
• Symbolic dates in rules and queries are evaluated on the Windchill RV&S Client’s time zone.
• Relevance and editability rules are evaluated on the Windchill RV&S Client’s time zone.
• Creating deeply nested reports with a large number of inter-related issues can create extremely large reports and/or cause the Windchill RV&S Server to stop responding. When creating a report, take into consideration that the average number of links per issue and the number of levels in the report multiply the size of the report.
• Computed expressions return dates/times in the Windchill RV&S Client’s time zone and perform calculations in the Windchill RV&S Server’s time zone where appropriate.
• Although the electronic signature fields Signed By and Signature Comment are only visible in an issue’s history (if enabled by your administrator), you can report on the historical values by specifying the fields in the report.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --query=
[user:]query
specifies the name of the query that defines the selection criteria for the report, and the user who created the query.
• --reportTemplate=value
specifies the report template on which the report is based. For information on the report template format, see the Windchill RV&S Help Center.
|
|
This option can only be used with template-based reports, and is not supported for recipe-based reports.
|
• --reportTemplateFile=value
specifies the file name that contains a report template. For information on the report template file format, see the Windchill RV&S Help Center.
|
|
This option can only be used with template-based reports, and is not supported for recipe-based reports.
|
• --recipeParam=value
specifies a single parameter key:value pair.
The report parameters (or attributes) determine what is displayed to users when creating and editing reports in the Report Wizard.
The available list of report recipe parameters and attributes can be viewed for each report type using the
im viewreport and
im reports commands. For more detailed information, see the knowledge base in the Support section of the PTC Web site (
http://www.ptc.com).
• --recipeParams=value
specifies a semicolon separated list of report recipe parameters or attributes in key:value pairs.
• --recipeParamsFile=value
specifies the file that contains the recipe parameters in the report.
• --shareWith=u=user1[:modify],user2[:modify],...;g=group1[:modify],group2[:modify],...
specifies the users and groups that can use and modify the report. Your administrator defines users and groups.
• --[no]confirmSharedAdmin
specifies whether to confirm the conversion of the report to a system provided object.
• --name=value
• specifies the new name of the report. Names may be a maximum of 100 characters and cannot contain square brackets.
• --description=value
specifies a description for the report.
• --sharedAdmin
specifies the report as a system provided object (objects within the Windchill RV&S object model that support solution definition and management, as well as workflow migration). For more information, see your administrator.
Important: Once a user object is converted to a system provided object, you cannot revert it to a user object again.
• [username:]report
specifies the report to edit and the user who created it. If you are editing a report you created, you do not have to specify the user name, but you must specify the report name. You can only edit reports that you created unless you are an administrator.
|
|
Windchill RV&S initially assumes that text before the colon (:) is a user name and text after it is a report name. If Windchill RV&S fails to find a matching user name and report name, it searches for a report name matching the exact text. For example, if you type jhoyt:CosmosDefects, Windchill RV&S searches for the CosmosDefects report created by jhoyt. If Windchill RV&S cannot find the report and/or user, it searches for the jhoyt:CosmosDefects report created by any user.
|
See Also
