Creating requirement artifact types

Artifact types classify requirements and related artifacts and provide a consistent set of attributes for each type. You can use the artifact types that come with the sample project templates, or you can create custom artifact types and assign predefined and custom attributes to them.

Before you begin

You must have administrator permission to create and modify artifact types.

Procedure

  1. From the Administration menu , click Manage Project Properties.
    Note: If configuration management is enabled for your project, on the Administration menu, click Manage Component Properties.
  2. Click the Artifact Types tab, and then click New Type.
  3. Enter a name and description.
  4. Optional: To change the default icon for the artifact type, click Change. If you select a different icon, all artifacts of this type are shown with that icon.
  5. Select a default artifact format.
  6. If you selected Module as the format, in the Preferred Module Content field, select multiple artifact types to use and specify how they are ordered. When other team members add artifacts to modules, the preferred artifact types are shown by default. You can change the order of the preferred artifact types or remove them. The order of preferred artifact types is used in several menus:
    • The menu from the blue Create button
    • The artifact row menu
    • The Type menu on the inline editor toolbar for modules
    Tip: If you plan to use headings in the module, include a type that is identified as a heading type.
  7. Optional: Select Preferred Link Types. If you select preferred link types, you limit the link types that are available when you create a link.
  8. Optional: To place a frequently used artifact type at the top of the list when you create an artifact with the Create button, select the Make this artifact type a preferred artifact type check box. Infrequently used artifact types are available under the Other option.
  9. Optional: To enable the Lookup Term feature for text-based artifact types, select the Use artifacts of this type as glossary terms check box. You can use the Lookup Term feature to search for term artifacts from within text-based artifacts.
  10. Optional: If you want artifacts of this type to be shown as headings when you add them to a module, select the In modules, display artifacts of this type as headings by default check box.
  11. Optional: If this artifact type is a supporting document that you frequently upload, select the Make this artifact type a preferred upload option check box. When you upload an artifact, the supporting document is the default artifact type.
  12. Optional: In the RDF URI field, specify a unique URI to identify the artifact type across RM projects.

    Within a project, you must use a unique URI for each artifact type. If another project has an equivalent type, you should use the equivalent type's URI to ensure consistency across projects and enable a shared vocabulary for reporting. In a project that is enabled for configuration management, you can use the same URI for equivalent artifact types that are in different components.

    For example, Project_A has an artifact type named "Functional Requirement". When you create Project_B, you define an attribute named "Requirement - Functional". Your organization considers these attributes equivalent even though their names and enumeration values differ. Assign the same URI to both artifact types to ensure consistent meaning across projects and so that you can report on equivalent types across projects.

  13. To add an attribute to the artifact type, click Add Attribute.
  14. Click Save.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki