Property Settings
The following table lists property settings that you can update:
| Property | Required/Optional? | Description |
|---|---|---|
| codeinsight.server | Required | The Code Insight server URI (for example, http(s)://your\.codeinsight\.server:port/ )\. |
| codeinsight.auth.token | Required | Authorized user token generated in the Code Insight user interface. |
| codeinsight.project.name | Required | The Code Insight project name where all the inventory information will be published. |
| plugin.root.path | Required | The local root path that can be replaced with path prefix. |
| plugin.project.name | Optional | The name of the plugin project (for example, “Codeinsight Jenkins”). |
| plugin.project.description | Optional | The plugin’s instance name/build number or tag that can be sent to the Code Insight server. |
| plugin.path.prefix | Optional | Prefix to be added to file paths for display to the user. For example, it could be the URL for a Jenkins workspace. |
| plugin.alias.name | Required | A name that you define for the scan-agent plugin. The alias is used to represent the “container” (scan root) under which all the files scanned in this instance will be listed in the API output and in the file tree in the Analysis Workbench . This name must be unique within the project. |
| plugin.proxy.host | Required when using proxy server | The IP address or Hostname of the proxy server. |
| plugin.proxy.port | Required when using proxy server | The port used for the proxy server. |
| plugin.proxy.user | Required when using proxy server | The user name used to authenticate the proxy. |
| plugin.proxy.password | Required when using proxy server | The password used to authenticate the proxy. |
| plugin.has.proxy | Required when using proxy server | The value indicating whether the proxy is enabled for the plugin: true enables the proxy. false disables it. |
| plugin.host | Optional | (Optional) A user-defined name for the instance where the scan-agent plugin is configured to run scans. This property along with the alias property will remain unchanged for each subsequent rescan. Although optional in general, this value is required if you are running the scan in a dynamic host environment. See Note About Rescans Performed by v2.0 and Later Plugins. |