integrity setprefs
sets Windchill RV&S administration client preferences
Synopsis
integrity setprefs [--command=value] [--[no]resetToDefault] [--[no]save] [--[no]ask] [--ui=[unspecified|gui|cli|api]] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] pref[=value]...
Description
integrity setprefs sets
Windchill RV&S administration client preferences. These settings are used to determine default behaviors for other commands - each option on each command has a preference key associated with it. The
integrity viewprefs command lists the commands and preference keys. Changes to your preferences are either for the current client session (until
integrity exit is used) or may be permanently saved in your system's
home directory, into a file named
IntegrityClient.rc, using the
--save option.
Options
This command takes the universal options available to all
integrity commands, as well as some general options. See the
options reference page for descriptions.
• --command=value
identifies the command to be set. For an easy way to see a list of commands and values that may be set, simply type the
integrity viewprefs command, either piped through
|more or redirected to a file, for example:
integrity viewprefs --global --showValidValues >prefs.txt
The commands and preference keys are also listed on the
preferences reference page.
• --[no]resetToDefault
controls whether to revert specified settings to the default values as shipped with the Windchill RV&S client. If specifying --resetToDefault, you must not specify =value for each preference.
• --[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.
• For example, to set the server host for Windchill RV&S to connect to a specific host name, you specify something like:
integrity setprefs --command=connect
server.hostname=specific.hostname.com
but to set the preference to ask for a host name, you specify something like:
integrity setprefs --command=connect --ask
server.hostname=element-last
• --ui=[unspecified|gui|cli|api]
controls whether to apply the preference to the graphical user interface, the command line interface, the application programming interface, or when the interface is unspecified. By default, --ui=unspecified is used and applies any changes you make to all interfaces unless there is already an interface specific preference configured.
These correlate to settings in the IntegrityClient.rc file, which can be seen as having the gui.integrity., api.integrity. or cli.integrity. prefix, or simply the integrity. prefix when it is unspecified.
• pref[=value]...
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.
Diagnostics
See the
diagnostics reference page for possible exit status values.
See Also