Managing custom artifact types
Overview
Project administrators with the correct privileges can create custom artifact types at the project level to meet the needs of the project. Each custom artifact type must have a unique ID prefix and must be associated with one of the pre-configured base types. Custom artifact types provide you with an extremely large amount of flexibility in the way you categorize the artifacts in your projects.
Example
Tyler, a business analyst, is configuring a new project which involves the creation of a large number of business and functional requirements in textual form. He wants to ensure there is a high level of visibility between business and functional requirements.
He considered adding a custom property (with Business or Functional options) to the existing Textual Requirement artifact, but he feels it will not offer enough visibility.
Tyler decides to create two different artifact types called Business Requirements and Functional Requirements. He sets the Base Type to TextualRequirement for both of the new artifact types. Tyler deletes the existing Textual Requirement artifact type as it is no longer needed. Now, users must choose between a business requirement or a functional requirement when creating a new requirement.
Project administrators with the correct privileges can create and edit custom artifact types using the Custom Artifact Types tab in the Project Administration Console. The Custom Artifact Types tab looks like this:
The left side of the page provides you with a table containing the following columns of information about each artifact type:
-
Name: Indicates the name of the artifact type. This name appears in the list of options when users are selecting a new artifact to create. It also appears in the Artifact Type column when users are viewing the artifact list.
-
Prefix: Indicates the ID prefix of the artifact type. Prefixes are unique across artifact types. All artifacts have a unique ID that begins with this prefix.
-
Tooltip: If specified, provides a tooltip description when users are selecting a new artifact to create and they hover over the artifact type.
-
Group Label: If specified, this artifact type appears under the specified label when users are selecting a new artifact to create.
-
Base Type: All artifact types must have a base type. The base type determines the type of editor that is used when a user opens an artifact. The available base types are pre-configured.
-
Is Standard: Indicates the artifact type exists in all projects across the instance.
Note: Standard artifact types can only be edited at the instance level by instance administrators with the applicable privileges.
After you select a custom artifact type from the table, the custom artifact type details are displayed on the right side of the page.
Tasks
Creating custom artifact types
Modifying custom artifact types
Deleting custom artifact types
