Documentation Nexus IQ Server 1.32

10.1. Component Labels

Component labels are actually one of the more powerful features of policy management, and they should have a familiar look, since you’ve likely used other systems that employ a sort of tagging or labeling.

Essentially, component labels are metadata. More specifically a component label is metadata that is assigned to a component within the context of a particular application or organization. Labels can assist with identifying components you want to review, approve, or even avoid altogether. We call this component label assignment.

When component labels are assigned, this is an action that takes place in the application composition report. Before it can be assigned though, a label needs to exist for a particular organization or application.

As we learned in our Organization and Application Management chapter, inheritance plays a big role in policy. The same thing is true for labels, in that if a component label is created in an organization, any application attached to that organization will also have the label available for use when assigned. In fact, the system will prompt you to choose the scope (organization or application) a label should exist in when it is assigned.

[Tip]

You can customize a policy to use a component label as a condition when IQ Server evaluates applications. For more information about policies and creating conditions, see the Basic Policy Management chapter.

10.1.1. Viewing a Component Label

To view a component label:

  1. Click the Organization & Policies icon figs/web/clm-server-manage-app-org-icon.png on the IQ Server toolbar.
  2. Select an organization or application in the sidebar. A page of customizable settings is displayed.
  3. Click Component Labels in the menu bar at the top of the page to scroll to the Component Labels section.

The Component Labels section displays two types of labels:

  • Local - Component labels with a scope that’s specific to the selected organization or application.
  • Inherited - Component labels derived from an organization that’s higher in the system hierarchy than the currently selected organization or application.
figs/web/clm-server-component-label-tile.png

Figure 10.1. Component Label Section


10.1.2. Creating a Component Label

To create a component label:

  1. Click the Organization & Policies icon figs/web/clm-server-manage-app-org-icon.png on the IQ Server toolbar.
  2. In the sidebar, select the organization or application in which the component label will be used.
  3. In the Organization & Policies area, click Component Labels.
  4. In the Component Labels section, click the Add a Label button. The New Component Label editor is displayed.
  5. In the New Component Label editor, set the following attributes:

    1. Component Label Name - Enter a name for the component label that is easily identified.
    2. Short Description - Enter a description that provides additional information about the component label.
    3. Color - Select a desired color for the component label.
  6. Click the Create button to add the component label to the selected organization.

A few things to remember:

  • An organization’s component labels can be seen by any of its applications, the reverse is not true.
  • Component labels can only be edited (or deleted) at the level they were created.
figs/web/create-component-label.png

Figure 10.2. Using the Add a Label Button


10.1.3. Editing a Component Label

To edit a component label:

  1. Click the Organization & Policies icon figs/web/clm-server-manage-app-org-icon.png on the IQ Server toolbar.
  2. In the sidebar, select the organization or application in which the component label was created. The component label is displayed in the Component Labels section under the Local heading, and has a chevron in its row to indicate it’s editable.
  3. Click the component label you want to edit. The Edit Component Label dialog is displayed.
  4. In the Edit Component Label dialog, you can change the following attributes:

    1. Component Label Name - Enter a different name for the component label.
    2. Short Description - Enter a description that provides additional information about the component label.
    3. Color - Select a desired color for the component label.
  5. Click the Update button to save the component label to the selected organization or application.
figs/web/edit-component-label.png

Figure 10.3. Editing a Component Label


10.1.4. Deleting a Component Label

To delete a component label:

  1. Click the Organization & Policies icon figs/web/clm-server-manage-app-org-icon.png on the IQ Server toolbar.
  2. In the sidebar, select the organization or application in which the component label was created. The component label is displayed in the Component Labels section under the Local heading, and has a chevron in its row to indicate it’s editable.
  3. Click the component label you want to delete. The Edit Component Label dialog is displayed as shown in the figure, Figure 10.3, “Editing a Component Label”.
  4. In the Edit Component Label dialog, click the Delete Component Label button. A Delete Label alert dialog is displayed.

    [Warning]

    When you delete a component label, the action cannot be undone.

  5. In the Delete Label dialog, click Continue to delete the component label or Cancel to keep the component label.