Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes how to create and manage Correction Report TemplatesCorrection Reports are used to return a list of open project comments to the project applicant/owner after plan review completes.  . 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.



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.

Prerequisites:

...



In this article:

Table of Contents

Features of the Correction Report Designer

...


...

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. 


Image Added




Choosing a Comment Sort Order Option


Image Added





Options for Grouping Comments on your Correction Reports

EPR provides several options for how the comment records are grouped on the report templates, as shown below:


Option 1st Data Field2nd Data Field

3rd Data Field

Notes
1GroupReview TypeReviewer Name

Choose this option to sort comments primarily by Group and then, (optionally) by *Review Type, followed by the Reviewer's First and Last name, Reviewer's email address and phone number. Groups and Review Types are sorted alphabetically.

This *option works best when Review Type list values are included in your Standard Comment Library records.

2*CategorySub-categoryReviewer Name

Choose this option to sort comments primarily by Category and then, (optionally) by Sub-category, followed by the Reviewer's First and Last name, Reviewer's email address and phone number.  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.

3*CategorySub-category-

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.

Choosing a Comment Sort Order Option

Image Removed

Option 1 Example: 

Category Grouping without Review Types

Image Removed

Modifying Sample Reports

Two sample correction report templates for Permitting projects are provided in new EPR installations, as shown below:

Corrections Report by Category and Corrections Report by Group.

Create a New Correction Report template

Follow the steps below to create a new template:

Image Removed

...



*Sorting Category and Sub-category list numerically

Relies on the numerical Sort Order Value of the Category and Sub-Category list records.








Correction Report Template Components

A Correction Report consists of the following components which may be dragged onto the Template, resized and reordered as desired.

...

ComponentDescriptionRequiredLocked
Report Header


Report Instructions


Report Logo


Report Document List


Report Comment List
YesYes
Report Footer


Report Project Info


Report Table


Report Title


Custom Text Editor

...







Create a new Template

...

Follow the steps below to create a new template:





Image Added




Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@10c5c
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "EKB"
labelskb-how-to-article

...