Note templates

This page contains:

The case for Note templates

Why would you want to use a Note template?

  • Create baseline content for all your Issues. The Note template always contains the same fields so you don't have to remember them.

  • Constistent output for reports. If you are outputting your Evidence objects into the report, the Note template can ensure you have the rall the fields your report has placeholders for.

  • Capture scoping information (e.g. account credentials, URLs, etc.) in a consistent way by creating a Note template and reusing it across projects.

Creating a note template

  1. Sign in as Administrator.
  2. Navigate to Projects Dashboard > Templates > Note Templates.
  3. Click New Note Template in the right-hand sidebar.
  4. Fill in the fields you want to appear in every note. If you are creating fields, make sure to use the #[...]# syntax to define them. Automatically include any standard text in the note as well. The example below creates a note template that automatically includes a Title, a Type, and a Description field for each note.
  5. Give the note template a unique name.
  6. Click Create New Note Template and your new template will now display on the Note Templates page.

Existing Note Templates

Editing a note template

To edit the details of an existing note template:

  1. Sign in as Administrator.
  2. Navigate to Projects Dashboard > Templates > Note Templates.
  3. Click the yellow Edit button below the correct note template.
  4. Edit the name or the content of the note template.
  5. Click Update Note Template to save your changes.

Deleting an old template

  1. Sign in as Administrator.
  2. Navigate to Projects Dashboard > Templates > Note Templates.
  3. Click the red Delete button below the correct note template.
  4. Confirm that you want to delete the note template.

Automatically generate an Issue, Evidence, or Content Block from Report Template Properties

You’re already using the Report Template Properties for automatic validation, right? We’ve extended the Issue fields, Evidence fields, and Content blocks even further to help make your life easier. Use the report template propererties to automatically generate a template from your Issue, Evidence, or Content Block fields.

  1. Define the Issue fields in your Report Template Properties:

  2. When you manually create an Issue, select Default for template in the dropdown of note template options.

  3. Dradis will automatically pull in the Issue fields from your Report Template Properties to create your Issue template.

    If you specified values for your text field, they’ll even appear in a list so that you can be sure that your Issue has the fields and values that your report template is looking for.

Note: the example above walks through defining the Issue fields and automatically generating an Issue template. The same process is available for Evidence fields, just follow the instructions to define your Evidence fields and create a piece of Evidence instead!

To generate a Content Block, just navigate to the Report Content page and click the + button to the right of Content Blocks. Then, select the correct Block Group from the dropdown that appears.

Using a note template

In the interest of keeping information organized, I'm going to have to ask you to open the Working with Notes page of the Working with projects manual that explains how to work with and customize the note field in your projects.

We want to ensure that the latest and most up-to-date information about each topic is in a single page.

Next help article: Project templates →