im copydashboard

CLI Reference > Workflows and Documents Commands > im copydashboard

im copydashboard

copies a PTC RV&S dashboard

Synopsis

im copydashboard [--shareWith=u=user1[:modify],user2[:modify],...; g=group1[:modify],group2[:modify],...] [--description=value] [--name=value ] [--fieldFilterConstraint=field:[Open[:value,value,...] | [Fixed[:value,value,...] | [Restricted[:value,value,...][:value,value,...]] [--layout=value] [--layoutFile=file] [--sharedAdmin] [--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]] [user:]dashboard

Description

im copydashboard copies the properties of a PTC RV&S dashboard to a new dashboard. For more information on dashboards, refer to the PTC RV&S Help Center.

For example,

im copydashboard --name="Release 2.0 Defect Trends" --fieldFilterConstraint=project:Fixed:/"Release 2.0" jriley:"Release 1.0 Defect Trends"

copies the Release 1.0 Defect Trends dashboard created by jriley to a new dashboard called Release 2.0 Defect Trends, with a fixed filter for the release 2.0 project.

Options

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

• --shareWith=u=user1[:modify],user2[:modify],...; g=group1[:modify],group2[:modify],...

specifies the users and groups that can use and modify the dashboard. Your administrator defines users and groups.

• --name=value

specifies the name of the dashboard. Names may be a maximum of 100 characters and cannot contain square brackets.

If you do not specify a different name for the new dashboard, PTC RV&S adds Copy of as a prefix to the query name, for example, Copy of Project Overview.

• --description=value

specifies a short description for the dashboard.

• --fieldFilterConstraint=field:[Open[:value,value,...]|[Fixed[:value,value,...]|[Restricted[:value,value,...][:value,value,...

specifies how field filters can be applied to the dashboard at runtime. The first component of the value is the field name. Currently, only project field filters are supported. The second component is the filter type.

Open specifies that all projects can be selected as filter values when the dashboard is run. You can also specify default filter values to apply.

Fixed specifies that when the dashboard is run it will be filtered by the specified values. You cannot change this filter at runtime.

Restricted specifies that when the dashboard is run you can select any of the specified filter values. You can also specify default filter values to apply.

Depending on how you design your dashboard layout, the dashboard filter may not be applied to chart, report, report link or query link dashboard components. If this option is not specified, the Open filter is used.

• --layoutFile=value

specifies the file that contains the complete definition of the dashboard layout.

• --layout=value

the XML representation of the dashboard layout. The layout must conform to a specified format. For more information, see the PTC RV&S Help Center. This setting is optional.

• --sharedAdmin

specifies the dashboard 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.

Important:

Once a user object is converted to a system provided object, you cannot revert it to a user object again.

If the dashboard you are copying is a system provided dashboard, the --sharedAdmin option is not set in the copy.

• [user:]dashboard

specifies the name of the dashboard to copy, and the user who created that dashboard. This is useful when multiple users have the same name for a dashboard.

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