Creating artifacts

In a requirements project, you can create rich-text and graphical artifacts.

Before you begin

Before you can create an artifact, the artifact type must exist in the project. If you are an administrator, you can view or create the artifact types for a project by clicking the Administration menu Administration menu icon and then clicking Manage Project Properties.

Note: If configuration management is enabled for your project, on the Administration menu, click Manage Component Properties.

About this task

When you create an artifact, the artifact can be new or based on another artifact. You can also create an artifact by extracting text from a text-based artifact. After you create an artifact, you can capture its URL to make it easy for other team members to access it. Watch a video about creating requirement artifacts.

When you create an artifact by extracting text from a text-based artifact, the text that you extract becomes a link to the new artifact. You select the text and then either use the toolbar or right-click the text to create an artifact.

If you right-click the text and use the menu to create the artifact, you can quickly save the selected text as a new artifact. However, this method uses a truncated form of the selected text as the artifact name and uses the same artifact type and location as the initial artifact.

Procedure

  • To create an artifact:
    1. On the Artifacts page, click Create, and select an artifact type.
    2. In the Create Artifact window, enter information about the new artifact and click OK.
      You can also create artifacts from the Folder menu. You can click the pencil icon Pencil icon or right-click a folder in the Folder menu. The Create Artifact option on the Folder menu displays the preferred artifact types.
  • To create an artifact that is based on another artifact:
    1. On the Artifacts page, select the check boxes of one or more artifacts that you want the new artifact to be based on.
    2. Click the pencil icon Pencil icon and click Duplicate Artifact.
    3. In the Duplicate Artifact to Folder window, enter a new name for the artifact and choose a destination folder.
    4. Optional: To copy links and tags from the original artifact to the new one, select the corresponding check boxes.
    5. Optional: To create a link between the original artifact and the new one, select the corresponding check box.
  • To create an artifact by extracting text from a text artifact:
    1. Open a text-based artifact and click Edit.
    2. Highlight the text to base the new artifact on, and then complete one of these steps:
      • Right-click the text and, on the menu, click either Save as New "Artifact" and Link or Save as New "Artifact" and Insert.
      • From the toolbar, click the Save Selection as New Artifact and Link icon or the Save Selection as New Artifact and Insert icon.
    3. Provide the information about the new artifact, click Finish, and then click Done.

Results

The newly created artifacts or content of the modules are stored by default in a folder. Use the drag-and-drop action to move one or more folders and re-organize them. You can also double-click in the content area of a text artifact or diagram artifact to put it into edit mode. After making the required changes save the artifact.

To edit an artifact, you can double-click in the content area of a text artifact or diagram artifact, make changes, and then save the artifact.

What to do next

After you create an artifact, you can capture the URL of the artifact to make it easy for your team members to directly access the artifact. You can capture the URL in a format that includes both the artifact name and ID. You can capture URLs in a rich hover from the Artifacts page, from dashboard widgets, or from the full-text search widget.