CLI Reference > Workflows and Documents Commands > im dashboards
im dashboards
displays the list of dashboards
im dashboards [--fields=field1[:width1],field2[:width2]...] [--fieldsDelim=value] [--[no]showHistory] [--[no]showReferences] [--height=value]  [--width=value][-x value ] [-y value ] [--user=value ] [--hostname=value] [--password=value ] [ --port=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
im dashboards displays the list of Windchill RV&S dashboards. By default, the command displays all dashboards that are currently shared to you.
This command takes the universal options available to im commands, as well as some general options. See the options reference page for descriptions.
specifies the dashboard fields to display and the width of each field in characters. If the output is directed to the GUI, the width is specified in pixels.
For example,
im dashboards --fields=name,description,lastModified --fieldsDelim=, jriley:"Release 2 Overview"
displays the name, description, and date of the last modification for the Release 2 Overview dashboard create by
The dashboard fields you can specify are:
displays the name of the user who created the dashboard.
displays a description of the dashboard.
displays the database ID of the dashboard. This is for PTC Technical Support only.
displays the XML representation of the dashboard layout. The layout must conform to a specified format. For more information, see the Windchill RV&S Help Center.
displays the date the dashboard was last modified.
displays the name of the dashboard.
displays all system provided and user objects that reference the dashboard.
displays the users and groups that the dashboard is shared with.
displays whether the dashboard is a system provided object.
specifies the string to be used as a delimiter between fields.
specifies the name of the dashboard to view, and the user who created it, for example, jhoyt:ProjectOverview. If you are viewing a dashboard you created, you do not have to specify the user name, but you must specify the dashboard name.
Windchill RV&S initially assumes that text before the colon (:) is a user name and text after it is a dashboard name. If Windchill 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
, Windchill RV&S searches for the dashboard named
created by
. If Windchill RV&S cannot find the dashboard and/or user, it searches for the dashboard named
created by any user.
See Also
Commands: im copydashboard, im createdashboard, im deletedashboard, im editdashboard, im viewdashboardim rundashboard
Miscellaneous: options