Defining custom attributes on the Project Properties page

On the Project Properties page, you can define custom attributes for your test artifacts.

Procedure

  1. Log in as a user who has permission to save and modify a project area:
    • A user granted permission to save and modify a project area in the process configuration.
    • A user who is an administrator of the project area.
    • A user who is granted either the JazzProjectAdmins or JazzAdmins repository group permissions.
  2. Click the Administration icon (Administration) on the banner, and then click Manage Project Properties.
  3. Expand the Custom Attributes section and then select one of the following options:
    • Test Plan Attributes
    • Test Case Attributes
    • Test Script Attributes
    • Manual Step Attributes
    • Test Suite Attributes
    • Test Case Execution Record Attributes
    • Test Suite Execution Record Attributes
    • Test Case Results Attributes
    • Test Suite Results Attributes
    Note: Attributes that you create for manual steps are also applicable to the manual Execution page and the Result Details section of a test case result.
  4. Click the Add Attribute icon (Add) to create a new attribute.
  5. Type the name of the new attribute, and select the type: Text (Small) (up to 250 characters), Text (Medium) (up to 1000 characters), Text (Large) (up to 32000 characters), Integer, Date/Time, or Link. The Manual Steps section of a test script supports additional attribute types: Enumeration and Rich Text.
  6. Optional: Define whether the attribute is required.

    If an attribute is required, users must select a value for that attribute when they complete the Summary section of a test artifact.

    1. Select an attribute.
    2. Click Required.

    A small asterisk is added to the name of the attribute.

    Note: Fields that are required are enforced when users create and modify test artifacts. They are not enforced when artifacts come from external tools, such as the automated test execution adapters and the Microsoft Excel plug-in.
  7. Optional: In the External URI field, specify an external URI to identify an attribute across projects.

    Within a project, you might use an external URI for each attribute. If another project has an equivalent attribute, use the same external URI of the equivalent attribute to ensure consistency across projects. Jazz Reporting Service (JRS) uses the external URIs to map attributes that are equivalent to each other. Equivalent attributes might have different names or enumeration values across projects, but if you assign the same external URI to these equivalent attributes, they are treated equally when you create reports across projects. It avoids the need to set filters for each of the attributes when you create reports across projects. To specify the external URIs, use the following format:

    [scheme:][//authority][path][?query][#fragment]
    For example:
    "http://xyz.com/path?validate=how"
  8. Click Save.

Results

After you add the new custom attributes, you can start to use them in individual test plans, test cases, test scripts, test suites, test case results, and test suite results. Custom attributes are displayed in the Attributes section of the summary for a test artifact.
You can also edit the values of the manual step attributes in a test script when you run the test case or view the result page.
Note: To edit the values of the manual step attributes, you must configure the appropriate manual step attributes to be editable on the execution page and result page. For more information, see Project properties.