im createreport
creates a new PTC RV&S report
Synopsis
im createreport[--query=[user:]query] [--reportTemplate=value] [--reportTemplateFile=value] [--recipeParam=value] [--recipeParams=value] [--recipeParamsFile=value] [--shareWith=u=user1[:modify],user2[:modify],...;g=group1[:modify],group2[:modify],...] [--name=value] [--description=value] [--sharedAdmin] [--hostname=value] [--port=value] [--password=value] [--user=value] [(-?|--usage)] [(-F file|--selectionFile=file)][(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=value] [--forceConfirm=[yes|no]]
Description
PTC RV&S allows you to create, edit, and generate various reports on the data in your projects. You can share your report with selected user groups, or you can keep it private. Only a user who created a report can modify it, delete it, and decide which user groups can see the report. Reports can be printed, displayed on screen, or exported as an HTML file for viewing on the Web.
For example,
im createreport --name="Docs Daily Status" --query="Docs Items Worked On This Week" --reportTemplateFile=c:/Program Files/PTC RV&S/PTC RV&SServer10/data/reports/recipes/One column.html
creates a new report based on a query and template.
For more information on reports, see the PTC RV&S Help Center.
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 PTC 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 PTC RV&S Help Center, or contact your administrator.
• Symbolic dates in rules and queries are evaluated on the PTC RV&S Client's time zone.
• Relevance and editability rules are evaluated on the PTC 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 PTC 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 PTC RV&S Client's time zone and perform calculations in the PTC 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 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.
• --reportTemplatevalue
specifies the report template on which the report is based. For information on the report template format, see the PTC RV&S Help Center.
• --reportTemplateFile=value
specifies the file name that contains a report template. For information on the report template file format, see the PTC RV&S Help Center.
• --recipeParam=valuespecifies 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.
• --sharedAdmin
specifies the report as a system provided object (objects within the PTC RV&S object model that support solution definition and management, as well as workflow migration). For more information, see your administrator.
 |
Once a user object is converted to a system provided object, you cannot revert it to a user object again.
|
• --name=value specifies the name of the report. This field is mandatory. Names may be a maximum of 100 characters, and cannot contain square brackets.
• --description=value specifies a description for the report.
See Also
• Miscellaneous: options