Guidelines for Component Lookup
Code Insight 2021 R1
When possible, use the Forge or URL search for the most targeted search results, and use the Keyword search in other cases.
|
•
|
Use the Forge option if you know the forge (that is, the third-party project repository) of the component. For example, Github, NuGet Gallery, and PyPI are forges. |
|
•
|
Use the Keyword option to search all the component names in the Code Insight data library. The component name is a unique identifier that may be based on the project name, package name, gem name, or other convention such as author and repository. The following are common conventions for component names: |
|
•
|
Github— <AUTHOR>-<REPOSITORY_NAME>, for example “jquery-jquery-ui” |
|
•
|
NuGet Gallery— <PACKAGE_NAME>, for example “newtonsoft.json” |
|
•
|
Apache— <PROJECT_NAME>, for example “apache-batik” |
|
•
|
Pypi—<PACKAGE_NAME>, for example “hash_ring” |
|
•
|
RubyGems— <GEM_NAME>, for example “x-editable-rails” |
|
•
|
Other— <PROJECT_NAME>, for example “openssl” |
|
•
|
If you cannot locate the component by keyword, select a Forge or URL search. If you are still unable to locate the component, the component might not exist in the Code Insight data library. In this case, you have options to do one of the following: |
|
•
|
Create your inventory item as Work in Progress and name it using the convention <COMPONENT> <VERSION> (<LICENSE>). For example, myComponent 1.2 (MIT). (You can later edit this inventory item to convert it to one of the other inventory types—Component or License.) |