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
- Create and manage Correction Report Templates for either Permitting or Design Review purposes.
- Modify an existing sample report Template (recommended).
- Choose an option for how comment records are grouped on the report.
- Choose the report components and layout for the Template.
- Customize the report text/layout using pre-built report components.
- Preview the report Template to validate the report layout.
- Delete a report Template.
- Create a new Template from scratch.
- Use the 'Save as New' feature to copy an existing Template to a New Template.
...
- Complete the information on the Environment/Address page.
| Info |
|---|
Correction reports are generated on the Project Comment page. The user selects the comment records to include on the report, generates the report in Preview Mode and may make edits to the report body prior to saving the report as an Attachment. |
...
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
Options for Grouping Comments on your Correction Reports
EPR provides several options for how the comment records are grouped on the report templatesEach Correction Report Template consists of:
- A Purpose (For Permitting or For Design Review).
- A descriptive Report Name.
- A Sort Order Option, as shown below
...
- .
...
...
3rd Data Field
...
...
| Info | ||
|---|---|---|
| ||
The Report Name and Sort Order option can be changed at any time. Once a Purpose has been selected, it cannot be changed. |
Option 1: Sort by Group Label and (optionally) by Review Type, then by Reviewer Name
Choose this option to sort comments primarily by Group
...
This *option works best when Review Type list values are included in your Standard Comment Library records.
...
.
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.
...
Option 2: Sort 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).
For Option 2 and 3, we highly recommend including the Category and optionally, Sub-Category values in your Standard Comment Library records
...
Choose this option to sort comments primarily by Category and then (optionally by Sub-category). The Reviewer's information does not appear with this option. Categories and Sub-categories are sorted numerically.
This option works best when Category list values (and optionally sub-category list values) are included in your Standard Comment Library records.
*Sorting Category and Sub-category list numerically
Relies on the numerical Sort Order Value of the Category and Sub-Category list 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.
Option 2 and 3: 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
...
Correction Report Template Components
A Correction Report consists may be comprised of the following components which components described below. Newly 'added' components are placed at the bottom of the Template.
These may be dragged onto the Template, resized and reordered as desired.
Components that are Locked may be re-positioned, but are not editable.
Component |
| Required/ Recommended |
|
|---|---|---|---|
| *Report Header | Consists of the Report Logo (left margin), Client Info (center), Report Title (center) and Project Info (left margin). | Recommended | Yes |
| Report Instructions | Large text box. This component is editable when the Report is generated, prior to saving it as a Project attachment. This component may be used multiple times in the Template. | Recommended | No |
| Report Logo | Upload a high resolution logo for best results. | No | - |
| Report Document List | This component will display the plan review document names, document cycle values and version date information for comments associated to those documents. Include this component on each Template so Applicants can see which documents need corrections. | Recommended | Yes |
| Report Comment List |
| Place this component below the Report Instructions and Document List. This component is not editable when the Report is generated. | Required | Yes | |
| Report Footer | This component includes the current Date and Page number(s). | Recommended | Yes |
| Report Project Info | This component contains the project number, project name, primary Contact name, etc. | Required | Yes |
| Report Table | Use this component to insert a column/row elements to the report. This component is editable when the Report is generated, prior to saving it as a Project attachment. | No | No |
| Report Title | This component consists of the saved 'Report Name'. | Recommended | Yes |
| Custom Text Editor | Small text box. This component may be used multiple times in the Template. | No |
Below are examples of some of the Report Components and typical layout.
...
Create a new Template
Follow the steps below to create a new template:
...