Custom Detection Rule Dialog
The Custom Detection Rule dialog enables you to create a custom detection rule. You can define custom rules as needed to supplement the internal detection rules used by Automated Analysis to automatically create inventory during a scan. The custom detection rules are saved to the Code Insight data library for global use across projects. For complete details about custom detection rules, see Managing Custom Detection Rules.
This dialog is accessed from two locations:
| • | From the Inventory Details tab in the Analysis Workbench for an inventory item of the “component” type—whether system-generated or manually created—to which codebase files have been manually associated (as described in Creating a Custom Detection Rule from Inventory of “Component” Type). |
| • | From Custom Detection Rules tab accessed from the Data Library page on the Code Insight main menu (as described in Creating a Custom Detection Rule from Scratch). |
The ability to edit certain fields depends on how you accessed the dialog. To help explain these differences, the following table designates the two access locations as “Inventory Details tab” and “Custom Detection Rules tab”.
The following describes the columns and actions you can perform from the Custom Detection Rule dialog.
|
Category |
Column/Field |
Description |
|||||||||||
|
Component selection
|
The following fields describe the component on which the custom detection rule is based. If you have accessed this dialog from the Inventory Details tab for an inventory item in the Analysis Workbench, these fields are auto-populated with component information from the inventory item and are not editable. If you have accessed this dialog from the Custom Detection Rules tab, these fields are populated once you select the component and are editable as described below. |
||||||||||||
|
Component |
The name of the component on which this detection rule is based. If you accessed this dialog from the Custom Detection Rules tab, click Lookup Component to select the component and its version, license, and forge URL. The License and URL fields are populated accordingly. If you accessed this dialog from the Inventory Details tab, this field is not editable. |
||||||||||||
|
License |
The license associated with the component. If you accessed this dialog from the Custom Detection Rules tab, you cannot edit the field directly once it is populated from the component selection, but you can select a different license. To do so, click If you accessed this dialog from the Inventory Details tab, this field is not editable. |
||||||||||||
|
Description |
A description of the component. If you accessed this dialog from the Custom Detection Rules tab, this field is editable. It is not editable if you accessed the dialog from the Inventory Details tab. |
||||||||||||
|
URL |
The forge URL for the component. If you accessed this dialog from the Custom Detection Rules tab, this field is editable. It is not editable if you accessed the dialog from the Inventory Details tab. |
||||||||||||
|
License, notices, and note content |
The following fields are used to provide license or notice content and any audit notes for the inventory item generated from this rule. These field are editable. If you accessed this dialog from the Inventory Details tab, these fields might be pre-populated with information from the manually created inventory. However, you can edit this information as needed. |
||||||||||||
|
As-Found License Text |
The license content you want to associate with the inventory item. If no Notices Text content is provided, the Notices report uses the information in this field as the license text for the third-party component. For more information, see Finalizing the Notices Text for the Notices Report. |
||||||||||||
|
Notices Text |
The exact content to include in the Notices report. This is usually a modification of the content in As-Found License Text. (You can copy the As-Found License Text content to the Notices Text pane and edit it.) If content exists in this field, the Notices report uses it as the license text for the third-party component and ignores any information in the As-Found License Text pane. For more information, see Finalizing the Notices Text for the Notices Report. |
||||||||||||
|
Audit Notes |
Any notes you want to add to the inventory item based on your findings during the analysis. |
||||||||||||
|
Associated codebase files |
This pane identifies the codebase files (by file name and MD5 value) on which to base the rule. You must identify at least one file. If you have accessed this dialog from the Inventory Details tab, the files associated with the inventory item are automatically listed and available for selection. If you have accessed this dialog from the Custom Detection Rules tab, you must manually provide file name and MD5 value for each file. Keep in mind that, if the custom detection rule is associated with multiple files, the scan uses OR logic when processing the files against the target codebase. Consequently, only one file match between codebase and the rule is required to automatically create an inventory item. |
||||||||||||
|
File MD5 |
If you accessed this dialog from the Inventory Details tab:
If you accessed this dialog from the Custom Detection Rules tab:
|
||||||||||||
|
Actions |
The following are actions conclude the rule-creation session. |
||||||||||||
|
Save |
Click Save to save the new custom detection rule to the Code Insight data library. You will be asked for confirmation to proceed with the creation. |
||||||||||||
|
Cancel |
Click Cancel to cancel the rule creation process. You will be asked for confirmation to proceed with the cancellation. |
||||||||||||
to switch to another license and, optionally, change the component version. Additionally, click 
to view the details and text of the selected license as stored in the Code Insight data library.
in the file entry. See Also
Managing Custom Detection Rules
Creating a Custom Detection Rule from Inventory of “Component” Type