Public API Entry Points and Contexts

FlexNet Code Insight 6.13.3

The following places in FlexNet Code Insight are accessible via the public APIs.

ScriptRunner

ScriptRunner is a standalone module that allows for communication with the FlexNet Code Insight Core and Scan servers to perform various application functions. For more information, see “Using ScriptRunner” in the FlexNet Code Insight Installation and System Administration Guide.

In addition, FlexNet 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 FlexNet Code Insight Installation and System Administration Guide.

Web UI Administration Scripts Page

Custom Groovy scripts can be registered in the FlexNet Code Insight central database via a SQL script and can be executed via the Script option on the Administration page in the FlexNet Code Insight Web UI.

Note • These scripts are not interactive and therefore parameters cannot can be passed to the script.

Web UI Custom Buttons

Some FlexNet 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 FlexNet Code Insight Web UI that are activated by a FlexNet Code Insight license key (Code Insight.key) that enables such functionality. If your FlexNet Code Insight license key does not activate these features, the custom buttons will not be visible.

Detector Groovy Console

Groovy scripts may be executed from the FlexNet 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 FlexNet Code Insight workspace, and must operate within that context.

Scan Server Autorun Scripts

There are several FlexNet 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.

Workspace Reports

FlexNet Code Insight workspace reports in some cases have been implemented in Groovy and make use of FlexNet Code Insight public APIs. Workspace reports are provided a WorkspaceCover object and are limited to functionality available within a given FlexNet Code Insight workspace.

Web Reports

FlexNet Code Insight Web reports have all been implemented using Groovy scripts to allow customers to modify existing reports or create new ones.

Open topic with navigation