Managing type definitions

Edit online

Type definitions are artifact types, attributes, data types, and link types that you can customize for a Global Configuration Management (GCM) project area. Users can select attributes and links that are defined at the project area level when they create or edit a global configuration or global component.

To manage type definitions, click Administration Shows the Administration icon > Manage Type Definitions.

Before you begin

  • All project area members can view the Manage Type Definitions page.
  • To create, edit, or remove type definitions, you must have the Configuration Lead role or higher, or Create and modify type definitions privilege for the project area.
  • To import type definitions or modify imported type definitions marked as final (cannot be changed), you must have the Administrator role or higher, or be assigned the corresponding privilege.
  • You cannot modify system-defined attributes, data types, and link types.

About this task

Before you create attributes, data types, or links, see what's already defined for each artifact type: click the Artifact Types tab and then click an item in the Name column.
  • The order of the attributes in the Attributes table determines their order in the configuration tree view under Custom Attributes, or on the Browse Components > component_name > Attributes tab.
  • The order of the links in the Link Types table determines their order in the tree view on the Links tab, or on the Browse Components > component_name > Links tab.
  • Changing the order in the tables reorders the items in the artifact type editor. Change the order so that team members can easily find the information they need.
If you do not see the attribute that you need on the Artifact Types tab, create one on the Attributes tab. When selecting the data type of the new attribute:
  • If you see the data type that you need, use it to build your attribute.
  • If you do not see the data type that you need, create it on the Data Types tab. You can then use it to build your attribute.

For each artifact type that needs it, add the new attribute to the Attributes table on the Artifact Types tab.

Example

The following example shows a possible workflow for creating a custom Geo global configuration attribute. Users can then specify a country when they create or modify a global configuration.
  • The configuration lead opens the Manage Type Definitions page, looks at the Artifact Types tab for an attribute that contains a list of countries, but does not find one.
  • On the Data Types tab, he creates a data type and calls it Country. He selects a value of Enumerated list of values, and then adds values, such as UK, US, Japan.
  • On the Attributes tab, he creates an attribute and calls it Geo. He sets the Data Type to the one he just created, Country. He sets the number of values to Multiple values allowed. He does not set an initial value so that users can select it themselves.
  • On the Artifact Types tab, he adds the Geo attribute to the global configuration artifact type so that it is available for users to select when they create a global configuration.

See the following topics for detailed instructions.