Electronic Updates
The following enhancements have been added to the Electronic Update process in this release.
Notification Banner Displayed When an Electronic Update Is in Progress
Whenever an Electronic Update is in progress, a banner is displayed across the top of the Code Insight screen, indicating that an update is running and that scheduled scans will resume once the update completes. The banner is shown for any Electronic Update—whether server or local, forced or automatically run by schedule—and persists across the top of all Code Insight pages until the update is complete.
Automatic Remapping of Existing Inventory Names According to Changes in the Data Library
Once an Electronic Update (in Code Insight 2021 R4 or later) is complete, a new post-update service will automatically update names of existing inventory based on the following changes made to the Code Insight Data Library:
| • | The latest short names for licenses (to support the common convention of using the license’s short name in inventory names) |
| • | The latest component-license mapping changes |
Note:This automatic remapping applies to only system-generated inventory, not to custom inventory.
The following sections provide more information about this remapping effort:
| • | Short Name Changes |
| • | Component-License Remapping |
| • | Electronic Update and Post-Update Service Scenarios |
| • | Remapping of Inventory Names: Impact on the Project Import Process |
When a specific license short name is changed, it is released as part of an Electronic Update and updated to your Code Insight Data Library. For example, suppose the License Id 744 currently in the library has the short name “MIT License”. After the Electronic Update, the short name for License Id 744 is updated to “MIT-Style” in the Data Library.
Once the Electronic Update completes, the post-update service is automatically run to update existing inventory names with the latest associated license short name. Without this update, an inconsistency can exist between an inventory item’s actual short name and the one used in the inventory name.
If the Electronic Update applies a component-license mapping change to the Data Library (for example, the Acorn component is now mapped to the Apache License), this change is not reflected in the names of your already scanned inventory items, thus resulting in an inconsistency between the actual mapping and the inventory name.
Once the Electronic Update completes, the post-update service is automatically triggered to update existing inventory names with their latest component-license mappings (which can also incorporate new license short names).
The following examples show how a change to a license short name or a component-license mapping is propagated to the name of an inventory item in your project.
Example Short Name Change
Apache-1.0 is renamed to Apache License-1.0.
| • | Current inventory: jquery (Apache-1.0) |
| • | Expected inventory after the Electronic Update and post-update service: jquery (Apache License-1.0) |
Example Component-License Mapping Change
Acorn (MIT) is remapped to the GPL license.
| • | Expected inventory after the Electronic Update and post-update service: Acorn (GPL) |
Electronic Update and Post-Update Service Scenarios
For your reference, the following table compares the results of license-remapping scenarios in Code Insight 2021 R4 or later (or in a pre-2021 R4 version) when you run or do not run the latest Electronic Update. Note the following about the table:
| • | The “Latest Electronic Update Run?” column refers to latest Electronic Update that is available at the time of the Code Insight 2021 R4 release and thereafter. |
| • | The “Results” column refers to the previous examples in the Additional Examples section. |
|
Release |
Latest Electronic Update Run? |
License-Remapping Results for Inventory |
Notes |
|
2021 R4 (post-update service provided) |
Yes |
jquery (Apache License-1.0) Acorn (GPL) |
The correct license short name is applied to jquery; and the Acorn component is remapped to its new license. |
|
2021 R4 (post-update service provided) |
No |
jquery (Apache-1.0) Acorn (MIT) |
No license-remapping is performed on your inventory. |
|
2021 R3 and earlier (post-update service not provided) |
Yes |
jquery (Apache-1.0) Acorn (MIT) |
No license-remapping is performed on your inventory. However, in this scenario, the value for Possible Licenses will show the newly mapped license for the component, as stored in the Code Insight Data Library. (For example, the Possible Licenses value for “Acorn (MIT)” shows GPL.) To correct license mappings for inventory throughout your Code Insight system, users in this scenario can run the cleanup SQL script found in the codeinsight-MITCleanupPackage archive. (Download this archive from the Product and Licensing Center.) |
|
2021 R3 and earlier (post-update service not provided) |
No |
jquery (Apache-1.0) Acorn (MIT) |
No remapping is performed on your inventory. |
Remapping of Inventory Names: Impact on the Project Import Process
When you are using Code Insight 2021 R4, projects that are exported after running an Electronic Update available at the time of the 2021 R4 release (and thereafter) will have no problem importing the project data. However, projects that are exported before this current Electronic Update is run will have import issues with license-mapping inconsistencies in the target projects. For a successful import of such projects, perform the following steps. (Be sure that you have already run the current Electronic Update.)
Note:These same steps can be used by 2021 R3 and earlier users to perform an import after they have run the current Electronic Update.
| 1. | Import the source project to the target project. |
| 2. | Run the Code Insight cleanup SQL script to correct the license-mapping inconsistencies in the Code Insight system, including the target project. (To obtain this script, download the codeinsight-MITCleanupPackage archive from the Product and Licensing Center, and extract the script and its instructions.) |
| 3. | For the target project, select the On data import or rescan, delete inventory with no associated files option on the Edit Project window. (From the project Summary tab, select Manage Project | Edit Project | General tab.) |
| 4. | Upload the codebase and scan. |
Note:Only system-generated inventories can have incorrect license mappings are removed. License mappings for Custom inventory are not processed.