Public API Entry Points and Contexts
Code Insight 6.14.2 SP2
The following places in Code Insight are accessible via the public APIs.
ScriptRunner
ScriptRunner is a standalone module that allows for communication with the Code Insight Core Server and Scan Servers to perform various application functions. For more information, see “Using ScriptRunner” in the Code Insight Installation and System Administration Guide.
In addition, Code Insight provides Groovy scripts that can be used to import and export group definitions and associated file information, such as tags applied to files, along with all attendant custom data. For information, see Importing & Exporting Workspaces in the Code Insight Installation and System Administration Guide.
Web UI Administration Scripts Page
Custom Groovy scripts can be registered in the Code Insight central database via a SQL script and can be executed via the Script option on the Administration page in the Code Insight Web UI.
Note:These scripts are not interactive and therefore parameters cannot can be passed to the script.
Some Code Insight customers have custom features and/or integrations that have been implemented using external Groovy scripts. These scripts are invoked by custom buttons in the Code Insight Web UI that are activated by a Code Insight license key (Code Insight.key) that enables such functionality. If your Code Insight license key does not activate these features, the custom buttons will not be visible.
Groovy scripts may be executed from the Code Insight Detector client either via the built-in Groovy console or via the Scripts menu. These scripts are limited to functionality available within a given Code Insight workspace, and must operate within that context.
There are several Code Insight scanner hooks that is used to execute custom logic at various phases of the workspace scan process. The following phases are supported: workspace open, on error, on success, before & after scan, after scan commit, and after post-scan analysis. These scripts are provided a WorkspaceCover object for convenience.
Code Insight workspace reports in some cases have been implemented in Groovy and make use of Code Insight public APIs. Workspace reports are provided a WorkspaceCover object and are limited to functionality available within a given Code Insight workspace.
Code Insight Web reports have all been implemented using Groovy scripts to allow customers to modify existing reports or create new ones.