Setting Up a Global Component Search
From the Global Component & License Lookup > Components tab (see Accessing the Global Component & License Lookup Feature), use any one of these search mechanisms by which to search for specific OSS and third-party components:
Use the Forge, URL, or Component ID search to obtain the most targeted search results. The Keyword search can provide a broader set of results to explore.
If the search finds no results that meet your criterion, a pop-up message is displayed, stating that no results are found.
Keyword
Use the Keyword option to search components by their name in the Code Insight Data Library. For the search criterion, enter one or more character strings found in a component name. Multiple strings must be separated with spaces (not commas) and can be listed in any order, as in the following example:
tomcat apache
The search will filter to only those component names that contain all the strings entered for the Keyword field.
Note:The search is case-insensitive, so it filters to all such components, no matter the upper or lower case used in the strings in the Keyword field or in the actual component name.
In general, the name of a component is a unique identifier that can be based on the project, package, or gem name of the component or on another convention such as the component’s author or repository. For your reference, the following shows the common conventions used for component names in the various forges:
|
•
|
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” |
|
•
|
GitLab—<AUTHOR/ORGANIZATION>-<REPOSITORY_NAME>, for example: |
|
•
|
“cryptsetup-cryptsetup” (as found in component URL: https://gitlab.com/cryptsetup/cryptsetup) |
|
•
|
“redhat-bison” (as found in component URL: https://gitlab.com/redhat/centos-stream/rpms/bison) |
|
•
|
Other— <PROJECT_NAME>, for example “openssl” |
To search for components by a keyword, do the following:
|
1.
|
On the Global Component & License Lookup > Components tab, select the Keyword option. |
|
2.
|
In the Keyword field, enter one or more character strings found in the name of the component(s) for which you are searching. For more information about this value, see the introductory content (just above) in this section. |
Note: If a component that you want to explore is not available with the keyword search, try the URL, forge, or component ID search. If you are still unable to locate the component, the component might not exist in the Code Insight Data Library nor be saved as a custom component.
URL
If you know the URL of the forge containing the components you want to locate, you can use the URL search option. For the URL value, you can enter the complete path for the forge, such as https://github.com/jquery/jquery, or a string in the path, such as jquery.
To search for components by the forge path, do the following:
|
1.
|
On the Global Component & License Lookup > Components tab, select the URL option. |
|
2.
|
In the URL field, enter the forge path (or a partial string in the forge path) for the component(s) you want to locate. |
Note:The search is case-insensitive, so the results will include all components with a matching forge path or path string (whichever criterion you entered in the URL field), no matter the upper or lower case used in the criterion or in the actual component path.
Forge
Use the Forge option to search for a specific component if you know the exact name of its forge and third-party project/repository.
To search for a specific component by the name of its forge and project/repository, do the following:
|
1.
|
On the Global Component & License Lookup > Components tab, select the Forge option. |
|
2.
|
From the Forge dropdown list, select the forge that contains the component for which you are searching. |
|
3.
|
In the additional field(s) associated with the forge, identify component’s third-party project/repository. |
Component ID
Use the Component ID option to search for a component by its unique ID within Code Insight.
To search for a specific component by its ID, do the following:
|
1.
|
On the Global Component & License Lookup > Components tab, select the Component ID option. |
|
2.
|
In the Component ID field, enter the complete ID of the component for which you are searching. |
If you enter a non-integer value, a negative integer, or a value greater than 19 characters, the field is bordered in red and the Search button is disabled. You can hover over the value to determine the type of error and then try another value if you want.