CLI Reference > Workflows and Documents Commands > im editdashboard
im editdashboard
edits a Windchill RV&S dashboard
im editdashboard[--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,...]]] | [None] [--layout=value] [--layoutFile=file] [--sharedAdmin] [--[no]confirmSharedAdmin] [--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
im editdashboard edits the properties of a Windchill RV&S dashboard. You may only edit one dashboard at a time, and only dashboards created by you are available for editing. For more information on dashboards, refer to the Windchill RV&S Help Center.
For example,
im editdashboard --name="Docs Weekly Status" --fieldFilterConstraint=project:Open "Docs Weekly Status Release 2.0"
edits the Docs Weekly Status Release 2.0 dashboard to change its name to Docs Weekly Status and enable it to be filtered by any project value.
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 users and groups that can use and modify the dashboard. Your administrator defines users and groups.
specifies the name of the dashboard. Names may be a maximum of 100 characters and cannot contain square brackets.
Note: If you do not specify a different name for the new dashboard, Windchill RV&S adds "Copy of" as a prefix to the query name, for example, Copy of Project Overview.
specifies a short description for the dashboard, for example, "Overview of current project status".
--fieldFilterConstraint=field:[Open[:value,value,...] | [Fixed[:value,value,...] | [Restricted[:value,value,...[:value,value,...]]] | [None]
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.
Openspecifies that all projects can be selected as filter values when the dashboard is run. You can also specify default filter values to apply.
Fixedspecifies 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.
None specifies that when the dashboard is run, no project filter displays.
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.
specifies the file that contains the complete definition of the dashboard layout.
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. This setting is optional.
specifies the dashboard 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.
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 an admin dashboard, the --sharedAdmin option is not set in the copy.
specifies whether to confirm the conversion of the dashboard to a system provided object.
specifies the name of the dashboard to edit, and the user who edited that dashboard. This is useful when multiple users have the same name for a dashboard.
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 jhoyt:ProjectOverview, Windchill RV&S searches for the ProjectOverview dashboard created by jhoyt. If Windchill RV&S cannot find the dashboard and/or user, it searches for the jhoyt:ProjectOverview dashboard created by any user.
See Also
Commands: im copydashboard, im deletedashboard, im createdashboard, im viewdashboard, im dashboards, im rundashboard
Miscellaneous: options