AddOverrideSetting

Owned by Jeremy Sommer (Deactivated)
Last updated: Feb 11, 2019 by Vlad Baderca (Deactivated)
2 min read

The "AddOverrideSetting" command overrides a setting for Repository or connection

From a Windows command prompt, within the "Tools" folder, enter the following to run the AddOverrideSetting command:

 via.repository AddOverrideSetting /param

Allowable parameters are:


/connId:<Int32>                               ID of connection where setting will be added/overriden
/repoId:<Int32>                                ID of repo where setting will be added/overriden
/settingName:<String>                    Name of setting (required)
/plaintextSettingValue:<String>      Setting value (required)
/dataType:<String>                         Data type of setting value (string/bool/int/float) (required)
/encrypted:<String>                        Whether the value should be encrypted when stored (true/false) (required)
/description:<String>                      Description of setting (required)
/help|?[:<Boolean>]                        Get help

Example

Let's say we have a connection with id:1 with one setting, called BoolSetting:

  • ConnectionId = 1
  • Settingname = NewSetting
  • Value = false
  • Datatype = bool
  • Encrypted = false
  • Description = "Description, which is always a string"

Running the following commands will create two new settings to connection 1: StringSetting and NumericalSetting

  • addoroverridesetting /connId:1 /settingname:StringSetting /plaintextsettingvalue:"the value in string format" /datatype:string /encrypted:false /description:"Description, which is always a string"
  • addoroverridesetting /connId:1 /settingname:NumericalSetting /plaintextsettingvalue:"2" /datatype:int /encrypted:false /description:"Description, which is always a string"

Running the following command will override the BoolSettting, and it will update both the value and description, as well as encrypt the value of the setting

  • addoroverridesetting /connId:1 /settingname:BoolSettting /plaintextsettingvalue:"true" /datatype:bool /encrypted:true /description:"Description, which is always a string"

Note: the AddOverrideSetting can be used to change the type  of an existing setting, though this should rarely be needed


ayfie