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.
...
Choosing a Comment Sort Order Option
Each Correction Report Template consists of:
- A Purpose (For Permitting or For Design Review).
- A descriptive Report Name.
- A Sort Order Option, as shown below.
- A Template of pre-defined components.
| Info | ||
|---|---|---|
| ||
The Report Name and Sort Order option can be changed at any time. Once a Purpose has been selected, it cannot be changed. |
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.
...
- 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
...
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
...
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.
...
The
...
Report Header component
...
is a combination of four individual components.
The Report Table Component
...
Follow the steps below to create a new template, choose the appropriate Purpose then:
- Under 'Selected Template', choose '[Create New Report]'
- Provide a descriptive Report Name. This name will be used in the 'Report Title' component.
- Choose one of the three Sort Options, as shown below.
- You may change the sort option at any time without modifying the report components.
- Select the SAVE button at the top of the page.
- Select the EDIT REPORT TEMPLATE button.
- In the Report Template window that opens, choose the appropriate Components.
- Save the Component layout in the Report Template window.
- Close the Report Template window.
...
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...