Generate documents

Vera makes it easy to generate documents so that you can boost compliance, efficiency, and collaboration.

To help you navigate this topic, the following terms define and explain key concepts:

  • Document Type: Defines the classification of query data and lists the available filter fields to populate the document template. Note that type queries require GraphQL formatting.

  • Document Template: Provides a customizable, pre-formatted reusable file with placeholder text. Note that templates require Carbone formatting.

  • Document Definition: Specifies the document type, template, and selected filter fields for document generation. You can find definitions stored in the database, where they are accessible at any time. Note that only document definition owners can edit the definitions, but all users in the same domain can view them.

  • Generated Document: One-time generated file populated with data from the Document Type and Document Definition, using the formatting of the selected Document Template. Note that this downloads to your local machine and it's not saved in Vera.

Note: We don't support the upload of your own document types or templates at the moment. Instead, use the provided options for document generation.

To generate a document, follow these steps:

  1. From the side navigation bar, select Documents.

  2. Go to the top right corner and select Add New Document Definition.

  3. In the Document Definition page, fill out the fields accordingly:

    • Specify a Name and Description for your document.

    • Choose the Document Type that matches your document template. For example, if you select the Execution Summary document type, you're going to select one of the Execution Summary templates.

    • Select the Document Template that matches your document type.

      Tip: Document types and templates have the same names.

    • Select the Output Format. Note that the template format determines the output format. If your preferred format isn't available, it means the template doesn't support that specific format:

      Template format Supported output formats
      XLSX

      XLSX, PDF

      ODT, DOCX

      DOCX, PDF

    • Optionally, in Tags, add filters for fields.

      Note: To use the domains filter and to create, edit, or view a document definition, you must be a member of a domain. Users without domain memberships, or those set as document definition owners but not belonging to the domain, won't be able to proceed further.

  4. In the bottom right corner, select Save Changes for future usage. Note that this downloads to your local machine and it's not saved in Vera.

  5. Select Generate Document.

Document templates

Here's a list of the default document templates:

  • Requirement Traceability Matrix (xlsx): A specialized document that tracks and ensures all records within a specific domain and release are linked to a clear requirement, test case, and corresponding test execution. It systematically maps relationships between records and their requirements.

    Execution Summary Report (docx, xlsx): A summary document that records and analyzes the outcomes of a specific test run or process execution. It includes information on the test case for each test run, execution log details, and any defects, if applicable. This report is essential for evaluating performance, effectiveness, and identifying issues during execution.