TIBCO Spotfire® Server and Environment - Installation and Administration

set-preference

Sets a preference for a group.

set-preference
<-g value | --group=value> 
<-c value | --category=value>
<-p value | --type=value> 
<-n value | --name=value>
[-v value | --value=value] 
<-T value | --value-type=value> 
{-Vvalue}
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]

Overview

Use this command to set a preference for a group.

Note: There is no validation of entered values when using this command. If invalid values are entered, then nothing will happen and you cannot see any changes in the Administration Manager. If a preference value has been previously specified for a group using Administration Manager, you can use show-preference to see the current values and their formats before using the set-preference command.

Options

Option Optional or Required Default Description
<-g value | --group=value> Required none The group to set the preference for.
<-c value | --category=value> Required none The preference category to set.
<-p value | --type=value> Required none The preference type to set.
<-n value | --name=value> Required none The preference name to set.
[-v value | --value=value] Optional none The single preference value to set. Used for all value types that are not arrays.
<-T value | --value-type=value> Required raw The value type for the preference to set.

Valid values are boolean, integer, string, stringArray and raw (i.e., what is stored in the database).

{-Vvalue} Optional none The preference array value to set , used with value type stringArray. This argument can be specified multiple times with different values.
[-b value | --bootstrap-config=value] Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
[-t value | --tool-password=value] Optional none The configuration tool password used to decrypt the database password in the bootstrap.xml file. If the tool password is omitted, the command will prompt the end-user for it on the console. See Bootstrap.xml file for more information.