Skip to main content

Attributes Used to Define a Custom Field for Inventory

The following attributes are used to define a custom field for inventory.

AttributeDescription
EnabledThe attribute controlling whether the custom field is activated in Code Insight.
- Yes —The field will be activated and made available in Code Insight. (Default) Use the Visible in UI attribute (see next) to determine whether the field will be displayed in both the Code Insight REST interface and the Web user interface or only in the REST interface.
- No —The field will not be available in Code Insight. All other attributes defined here are ignored (until the field is enabled).
Visible in UIThe attribute that controls whether the custom field is visible in both the Code Insight REST interface and the Web user interface (that is, on the Inventory Details tab in both the Project Inventory tab and the Analysis Workbench ) or in the Code Insight REST interface only.
- Yes —The field is visible in both the Code Insight REST interface and the Web user interface, enabling project Analysts and Reviewers to use either the REST interface or the user interface to view and update field’s value for individual projects. (Default)
- No —The field is not visible in the Code Insight Web user interface. Users must use the REST interface to view and update the field’s value for individual inventory items.
Field Label(Required) The name of the custom field. The maximum length is 30 characters.
Help TextInformation that is displayed when a user selects the (i) icon for the field in the Web user interface. When updating this attribute, be sure to provide content that helps users enter an appropriate value for the custom field. For example, you might describe the purpose the field and the type of value it requires. If you include a string that starts with http:// or https://, the string will be hyperlinked. The maximum length is 150 characters. If this attribute is left blank, the (i) icon will not be available for the custom field in the Web user interface.