Creating an artifact template

You can create an artifact template from an existing artifact. The template includes the content, attribute groups, and outgoing links. For rich-text artifact types, such as documents, requirements, use cases, and actors, the template also includes embedded images and text formatting. The template does not include tags, comments, and incoming links.

About this task

The artifact and the template you create from it are independent of each other. When you create a template, the artifact it was created from is not affected. If you edit the artifact at a later time, the template is not affected.

Note that you cannot create a template for glossaries or terms.

Procedure

  1. Do one of the following actions:
    • Open an artifact. Click File > Create Artifact Template.
    • Open the project Artifacts page. Right-click an artifact in the list and click Create Artifact Template.
  2. In the New Artifact Template window, type a template name.
  3. Click Finish.

What to do next

You cannot modify a template after it has been created. To overwrite the template with an updated version, modify the original artifact or an artifact that you created from the template. Then create a template with the same name as the original template.
Note: Templates can only be used within the project in which they were created. If you need to transfer a template to a different project, you might be able to download the artifact that was used to create the template, upload it into another project, and use it to create another template

Important: Creating a template from a sketch or part

If you elect to create a template from a sketch or part, you should keep the following concept in mind: templates can be used to initially populate an artifact with content, and for this purpose, they can be created from user interface sketches and user interface parts; however, changes made to a template are not reflected in anything that was created using the template. Sketches and parts, on the other hand, are inherently reusable artifacts, which means that if you change a part or sketch, the change is automatically reflected in any artifact that was created using the part or sketch. Consequently, in most development scenarios, you probably will not want to create templates from sketches or parts. For more information, refer to Creating a user interface part


Feedback