im runchart

CLI Reference > Workflows and Documents Commands > im runchart

im runchart

runs a PTC RV&S chart

Synopsis

Description

im runchart runs a PTC RV&S chart, generating chart data. For more information on charts, refer to the PTC RV&S Help Center.

For example,

im runchart --gui jriley:"Release 2 Features By Priority"

displays the Release 2 Features By Priority chart created by jriley.

Note the following:

• All charts 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 see your administrator.

• For the best performance, avoid generating trend or issue fields trend charts using short intervals over long time spans.

• Displayed date fields do not change based on the time zone that a user is operating in; however, displayed date/time fields and time entries vary based on the time zone that a user is operating in.

Options

This command takes the universal options available to im commands, as well as some general options. See the options reference page for descriptions.

• --fieldFilter=field=[value,value,...]

specifies project filter values to apply to the chart.

If you are running a distribution chart that is based on a query with a project filter, the project filter values you specify here are combined with the query filter. In some cases, this could result in no data being returned. For example, if a chart is based on a query with an embedded project filter value of Cosmo1, and you specify a project filter value of Cosmo2, no data is returned.

overrides the graph style defined for the chart.

• --chartFootnote=value

Overrides the chart footnote with the specified value.

• --chartTitle=value

Overrides the chart title with the specified value.

• --description=value

Overrides the chart description with the specified value.

• --[no]displayDescription=value

Overrides the chart display description with the specified value. When you specify --nodisplayDescription, the chart description is not displayed.

--imageHeight=value

specifies the height of the image, in pixels; value must be a whole number. This option does not apply to table style charts.

• --imageWidth=value

specifies the width of the image, in pixels; value must be a whole number. This option does not apply to table style charts.

• --outputFile=value

specifies the name of the file you want the chart data to be saved in.

Table style charts are saved in comma separated values (csv) format. All other styles of charts are saved in PNG format.

• --[no|confirm]overwriteOutputFile

specifies whether to overwrite if the file specified in the --outputFile option already exists.

• --query=[user:]query

specifies a query to override the chart query.

• --queryDefinition=query

specifies a string to define the query constraints to override the chart query. For details of the query format, see the im createquery reference page.

To reference the original query in the new query so that any changes to the original query are reflected in the new query, define <subquery> as subquery[OriginalQuery]

• [user:]chart

specifies the name of the chart to run, and the user who created it. If you are running a chart you created, you do not have to specify the user name, but you must specify the chart name.

PTC RV&S initially assumes that text before the colon (:) is a user name and text after it is a chart name. If PTC RV&S fails to find a matching user name and chart name, it searches for a chart name matching the exact text. For example, if you type jhoyt:CosmosDefects, PTC RV&S searches for the CosmosDefects chart created by jhoyt. If PTC RV&S cannot find the chart and/or user, it searches for the jhoyt:CosmosDefects chart created by any user.