This article describes how to create and manage Correction Report Templates. Select Configuration/Reports from the Navigation panel to open the Correction Report Template page.

No programming is necessary.

Features of the Correction Report Template Designer

1. Create and manage Correction Report Templates for either Permitting or Design Review purposes.
2. Modify an existing sample report Template (recommended).  
3. Choose an option for how comment records are grouped on the report.
4. Choose the report components and layout for the Template.
   1. Customize the report text/layout using pre-built report components.
5. Preview the report Template to validate the report layout. 
6. Delete a report Template.
7. Create a new Template from scratch.
8. Use the 'Save as New' feature to copy an existing Template to a New Template.

Prerequisites:

1. Complete the information on the Environment/Address page.

In this article:

Modifying an existing sample report Template

Two sample correction report templates are provided in new EPR deployments. These templates can be renamed and modified as desired. 

The option to sort comments by Category or by Group are described below.

Choosing a Comment Sort Order Option

Each Correction Report consists of:

1. A Purpose (For Permitting or For Design Review).
2. A descriptive Report Name.
3. A Sort Order Option, as shown below.
4. A Template of pre-defined components.

Comment Sort Order Option 1: By Group Label and (optionally) by Review Type, then by Reviewer Name 

Choose this option to sort comments primarily by Group.

If you also want to sub-sort comments by Review Type, we recommend including the Review Type to your Standard Comment Library records.  This will ensure that the Review Type is carried forward from the Library into the project's comment record automatically, saving a step for users to 'choose' a Review Type each time they create a comment.

Option 1 Sample Comment record

In the example below, Comment 00007 will be sorted under the Planning Group. 

Because a Review Type has not been selected by the user (it is optional), this comment record will sort ahead of other Planning comments that do contain a Review Type. 

Option 1 Sample Correction Report: by Group

Groups (and optionally, Review Types) are sorted alphabetically. 

Additional sorting notes

For each of the three sort options, comments will be sorted by these additional data values:

• Document filename (if one exists).
• Sheet number (if one exists), otherwise by Page number.
• Comment tag number.

Comment Sort Order Option 2: By Category and (optionally) by Sub-Category, then by Reviewer Name 

Choose this option to sort comments primarily by Category (a heading), then optionally, by Sub-Category (sub-heading).  Reviewers' first and last name, email address and phone number are displayed with this option.

For Option 2 and 3, we highly recommend including the Category and optionally, Sub-Category values in your Standard Comment Library records.  This will ensure that these values are carried forward from the Library into the project's comment record automatically, saving a step for users to 'choose' one each time they create a comment.

Option 2 Sample Comment record

In the example below, Comment 0007 will be sorted under the Structural Category, then under the Grading Sub-Category.  

Numerical Sorting of Category/Sub-Category values

Option 2 and 3 are rely on the configured Sort Order values found in the Configuration/Lists page. 

In the screen shot below, comments in the General Requirements category will sort in the first position on the report templates. Comment records given a Civil category value will sort next, followed by Structural comments, etc.

Sort order values do not have to be sequential - there may be 'gaps' in the numbering sequences.

Duplicate Sort Order Values

When multiple Category records share the same sort order value, the Report template will sort those Categories alphabetically.

In the example above, Fire Alarm Systems comments will sort after Structural and before Mechanical/Electrical/Plumbing.

Option 2: 'Sample Correction Report' by Category

Option 2 Sample Comment record

In the example below, Comment 0007 will be sorted under the Structural Category, then under the Grading Sub-Category.  

Comment Sort Order Option 3: By Category and (optionally) by Sub-Category 

Choose this option to sort comments primarily by Category (a heading), then optionally, by Sub-Category (sub-heading).

No Reviewer information is displayed with this option.

For Option 2 and 3, we highly recommend including the Category and optionally, Sub-Category values in your Standard Comment Library records.  This will ensure that these values are carried forward from the Library into the project's comment record automatically, saving a step for users to 'choose' one each time they create a comment.

Correction Report Template Components

A Correction Report may be comprised of the components described below.  Newly 'added' components are placed at the bottom of the Template.

These may be dragged, resized and reordered as desired. 

Components that are Locked may be re-positioned, but are not editable.

Layout Example

Below are examples of some of the Report Components and typical layout.

The Report Header component is a combination of four individual components. 

Each of the individual components is shown in the example so you can see how they might be placed.

The Report Table Component

An easy to configure Table component is provided for situations where some on the fly 'editing' may be needed prior to generating and saving a Correction report as a project attachment.

(See Generating a Corrections Report.)

Steps to using the Table Component:

1. Select the pencil icon on this component to enter 'edit mode'.
2. Use the - and + buttons to add and remove columns and rows.
3. Click in a cell to enter text in either the columns or rows.
4. Click outside the component to exit edit mode.

Create a new Template

Follow the steps below to create a new template, choose the appropriate Purpose then:

1. Under 'Selected Template', choose '[Create New Report]' 
2. Provide a descriptive Report Name. This name will be used in the 'Report Title' component.
3. Choose one of the three Sort Options, as shown below. 
   1. You may change the sort option at any time without modifying the report components.
4. Select the SAVE button at the top of the page.
5. Select the EDIT REPORT TEMPLATE button.
   1. In the Report Template window that opens, choose the appropriate Components.
   2. Save the Component layout in the Report Template window.
   3. Close the Report Template window.

Related articles

• Page:
  EPR Release Notes
• Page:
  Managing Contacts
• Page:
  Document Rendering
• Page:
  Standard Comments Library
• Page:
  Project Statuses and Workflow