im createdashboard

CLI Reference > Workflows and Documents Commands > im createdashboard

im createdashboard

creates new dashboard

Synopsis

im createdashboard [--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=value] [--sharedAdmin] [--hostname=value] [--port=value] [--password=value] [--user=value][(-?|--usage)] [(-g|--gui)] [(-Fvalue|--selectionFile=value)] [--quiet][--settingsUI=[gui|default]][--status=[none|gui|default]] [(-N|--no)] [(-Y|--yes)] [--[no]batch][--cwd=value] [--forceConfirm=[yes|no]]

Description

You can define and store any number of dashboards using PTC RV&S. A dashboard is a static, user-definable view comprised of any combination of the following components: charts, reports, images, labels, links to reports, links to queries, and URLs. For more information on dashboards, refer to the PTC RV&S Help Center.

Options

This command takes the universal options available to all imcommands, 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 new dashboard. Names may be a maximum of 100 characters and cannot contain square brackets.

• --description=value

specifies a short description for the new dashboard.

• --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.

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.

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, theOpen filter is used.

• --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.

• --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.