Skip to main content

Attributes Used to Define a Custom Field for Projects

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

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 for projects. (Default) Use the Visible in UI attribute (see next) to determine whether the field will be visible 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 a project’s Summary tab and on its Summary > Manage Project > Edit Project > Custom Fields tab) or in the REST interface only.
- Yes—The field is visible in both the Code Insight REST interface and the Web user interface, enabling project users 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 projects.
Field Label(Required) The name of the custom field. The maximum length is 30 characters.
Field TypeThe type of custom field:
- Text Field—A text field that has a maximum of 128 characters.
- Text Area—A large text field that has a maximum of 512 characters. (Default)
- Drop-Down List—A dropdown list of multiple options from which a user selects one option. When you select this field type, the Drop-Down List Options field is enabled to define the options (see the next description).
Drop-Down List Options(Available when Field Type is Drop-Down List ) The field that defines and manages the options in the dropdown list.
- To add an option to the dropdown list, click Add Item next to the field. The Add Item pop-up window is displayed, allowing you to create an option label up to 30 characters.
- To remove an existing option, click the x to the right of the option label.
- To edit an option label, remove the option and re-add the option with the updated label.
- No limit exists on the number of options the field can have.
Help TextInformation that is displayed when a user selects the (i) icon for the custom 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 of the help text 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.