CLI Reference > Workflows and Documents Commands > tm setprefs
tm setprefs
sets preferences for test management commands
tm 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...
This command sets preference options for Windchill RV&S test management commands. These settings are used to determine default behaviors for other test management commands - each command option has a preference key associated with it. The tm viewprefscommand 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&SClient.rc, using the --save option.
For example:
tm setprefs --command=resulteditor --save substituteParameters=true
sets the preferences for the tm resulteditor command to always substitute parameters in the test result editor.
Do not edit the Windchill RV&SClient.rc file manually. Preferences that appear more than once in the Windchill RV&SClient.rc file can cause unpredictable behavior in Windchill RV&S.
This command takes the universal options available to Windchill RV&S commands, as well as some general options. See the options reference page for descriptions.
identifies the command to be set.
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.
controls whether changes should be permanently saved.
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:
asks the user the first time only, and then uses the provided value every time after.
never asks the user for a response, but uses the current setting (which may be specified by a preference).
asks the user for each element of the selection, providing the most recently used value as the default.
asks the user for each element of the selection, resetting the default to the value specified by the preference.
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 tm setprefs. To set preferences for GUI behavior, however, you should specify --ui=gui. For example, to set the substituteParameters preference to be true in the GUI for the tm resulteditor command, you would type:
tm setprefs --command=resulteditor --ui=gui substituteParameters=true
These correlate to settings in theIntegrityClient.rc file that have the or prefix, or the tm. prefix when it is unspecified.
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
Commands: tm viewprefs. tm createresult, tm editresult, tm viewresult, tm extractattachments, tm stepresults, tm resulteditor, tm deleteresult, tm editresult, tm testcases, tm setresults, tm results, tm viewuntested
Miscellaneous: options