Edit Custom Rule Dialog

The Edit Custom Rule dialog enables you to edit an existing custom detection rule. Custom detection rules are user-defined when needed to supplement the internal detection rules used by Automated Analysis to automatically create inventory during a scan. These custom rules are saved to the Code Insight library for global use across projects. For complete details about custom detection rules, see Managing Custom Detection Rules.

The following table describes the fields, buttons, and icons on the Edit Custom Rule dialog. You can edit any of the fields, using the methods described in the table.

Edit Custom Rule Dialog

Category

Column/Field

Description

Component selection

The following fields describe the component on which the custom detection rule is based. These fields are editable.

Component

The name of the component on which this detection rule is based. You cannot edit this value directly, but you can switch to another component. To do so, click Lookup Component to select another component, along with its version, license, and forge URL.

License

The license associated with the component. You cannot edit this value directly, but you can select a different license. Click to switch to another license and, optionally, change the component version.

Additionally, you can click to view the details and text of the selected license as stored in the Code Insight data library.

Description

A description of the component.

URL

The forge URL for the component.

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 fields are editable.

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 content to include in the Notices report. This is usually a modification of the content in As-Found License Text pane. (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 lists the codebase files (by file name and MD5 value) on which the rule is based. You can add or delete files as needed within this list. When adding a file, you are required to manually enter the its MD5 value.

At least one file must be associated with the rule.

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

To add a file, click Add File and enter the exact file name and MD5 value for the file.

To remove a file from the rule, click in the file entry.

Actions

The following are actions conclude your update session.

Save

Click Save to save the rule updates to the Code Insight data library. You will be asked for confirmation to proceed with the creation.

Cancel

Click Cancel to cancel your updates. You will be asked for confirmation to proceed with the cancellation.

See Also