im setprefs
sets preferences
Synopsis
im setprefs [--command=value] [--[no]resetToDefault] [--[no]save] [--[no]ask] [--ui=[unspecified|gui|cli|api]] [(-?|--usage)] [(-F value|--selectionFile=value)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=value] [--forceConfirm=[yes|no]] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] string...
Description
im setprefs sets preference options for
Windchill RV&S. These settings are used to determine default behaviors for other commands - each command option has a preference key associated with it. The
im viewprefs command lists the commands and preference keys. Changes to your preferences are either for the current client session (until
im exit is used) or can be permanently saved in your system's
home directory, in the file named
Windchill RV&S Client.rc, using the
--save option.
For example:
im setprefs --command=viewissue --save showTimeEntries=true
sets the preferences for the im viewissue command to always display time entries for the issue.
Caution: Do not edit the Windchill RV&S Client.rc file manually. Preferences that appear more than once in the Windchill RV&SClient.rc file can cause unpredictable behavior in Windchill RV&S.
Options
This command takes the universal options available to
im commands, as well as some general options. See the
options reference page for descriptions.
• --command=value
identifies the command to be set.
• --[no]resetToDefault
controls whether to revert specified settings to the default values as shipped with Windchill RV&S Client. If specifying --resetToDefault, you must not specify individual preferences.
• --[no]save
controls whether changes should be permanently saved.
• --[no]ask
controls prompts to the user for specific preferences. Each preference option may be set to either --ask or --noask. When the command itself is run, any option set to --ask and that is not explicitly set with command line options will be queried. If this --ask option is set, then you do not specify a value for the preference at the same time, but instead the pref=value must supply one of the following four valid ask values:
◦ once
asks the user the first time only, and then uses the provided value every time after.
◦ never
never asks the user for a response, but uses the current setting (which may be specified by a preference).
◦ element-last
asks the user for each element of the selection, providing the most recently used value as the default.
◦ element-pref
asks the user for each element of the selection, resetting the default to the value specified by the preference.
• --ui=[unspecified|gui|cli|api
controls whether to apply the preference to the graphical user interface, the command line interface, or when the interface is unspecified. By default,
--ui=
cli is implied when using
im setprefs. To set preferences for GUI behavior, however, you should specify
--ui=
gui. For example, to set the
showHistory preference to be true in the GUI for the
im printissue command, you would type:
im setprefs --command=printissue --ui=gui showHistory=true
These correlate to settings in theIntegrityClient.rc file that have the gui.im. or cli.im. prefix, or the im. prefix when it is unspecified.
• string...
identifies the preference string. If you specified the --resetToDefault option, then you only need to specify the preference name; otherwise specify a value for the preference. Use spaces to specify multiple preferences.
See Also