Report template properties

This page contains:

Report template properties give you control over the content of your report template in a different way. Define fields needed to validate your project, filter the contents of your project, or even change the title of your document.


Report template details

Quickly edit the Title of your template. The Template file field will always display the original name of the document at the time you uploaded it.

  1. Log in as Administrator.
  2. From the Projects page, navigate to Templates > Reports.
  3. Click the Edit icon below the correct template.
  4. Edit the Template field.

Document properties

Define the custom document properties in your Word report so that Validate Export can check your document for any missing properties on export.

For the example below, we're going to define the three fields in this simple report template:

These fields are defined within Dradis as #[dradis.client]#, #[dradis.startdate]#, and #[dradis.enddate]# respectively.

To define these custom document properties:

  1. Log in as Administrator.
  2. From the Projects page, navigate to Templates > Reports.
  3. Click the Edit icon below the correct template.
  4. In the Document properties section, define all of the fields within your Project Properties template. For the example above, we would define custom properties for dradis.client, dradis.startdate, and dradis.enddate as shown below:

Issue fields

Define the fields within your Issues so that Validate Project knows what to look for on export and can warn you about any missing or incorrect fields in your project.

For the example below, we're going to define the fields for this simple template:

  1. Log in as Administrator.
  2. From the Projects page, navigate to Templates > Reports.
  3. Click the Edit icon below the correct template.
  4. In the Issue fields section, define all the fields within your Issue Template. For example template above, we need to define fields for Title, Rating, Description, and Recommendation.
    Note that we've specified acceptable values for our Rating field. This is especially important if your report template's Issue are being sorted/filtered by specific values. For example, if you're sorting your Issues by Rating, this setup will flag any values that don't belong (e.g. Critical).

Issue fields: validate your projects

The Issue fields are used to validate your project on export and check every Issue in your project as you save them.

Now when you validate your project on export, you'll know immediately whether your project's Issue fields match your template.

When your project is associated to a report template with Issue fields defined, Dradis will automatically validate each Issue as you save it.

When you create your project, make sure that it is associated with the correct report template that has the Issue fields defined.

Then, every time you save an Issue, Dradis will check to make sure that the fields match the expected Issue fields you set in the report template properties. In this example, Dradis is expecting a Rating field with a value of High, Medium, or Low. We misspelled the field value and entered Hgih so we will see the following error message:


Issue sorting

Sort the Issues in your project by any of the numeric Issue Fields you've defined. When selected, this property will sort the Issues in your report by this field, highest to lowest, before exporting them.

  1. Log in as Administrator.
  2. From the Projects page, navigate to Templates > Reports.
  3. Click the Edit icon below the correct template.
  4. Under the Issue sorting section, just select Numeric field you want to sort by from the dropdown that appears.

Next help article: Note templates →