This article provides information about the Settings/Configuration/Comments Library page. Upload your standard comments and checklists into the Library to provide a resource for your plan review staff. There is no limit to the number of records that can be uploaded to the Library.
Prerequisites:
Configure Groups for Permitting and Design Review Lists.
Configure Review Types for Permitting and Design Review Lists (as needed).
Configure Comment Sources for Permitting and Design Review Lists.
Configure Categories and Sub-categories for Permitting and Design Review Lists.
Gather plan reviewer checklists and standard comments.
Verify that the comments to be uploaded are correct and accurate.
In this article:
The Standard Comments Library tools allow the Agency to populate one or more lists of standard comments for use by staff during plan review. Since reviewers are able to edit the standard comment text on-the-fly as needed, setting up a standard comment library can help improve plan review times by saving users the need to type the same comments over and over again. Instead, reviewers can insert standardized comments from the library and then just change the text to fit the current review needs.
| Note |
|---|
Before adding standard comments to the Comments Library, the Agency Admin will first need to:
|
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
The Standard Comments Library
Standard comments uploaded to the Library can be inserted into plan review projects.
When records from the Library are inserted into a project, the record's Group, Source, Review Type and category/sub-category values are inserted as well.
Comment records can be batch uploaded into the Library via the Sample Spreadsheet template CSV or XLS format.
Comment records can be manually added/edited to the Library.
Comments flagged ‘in-active’ are not visible to users for plan review.
Where applicable, comment records should be associated to a Group and Review type, Comment source and Checklist name.
Comment records are associated to either For Permitting or For Design Review purpose.
...
Batch update features allow selected records to be:
Marked as active or in-active.
Copied as ‘New’ comment records.
Deleted.
About Category and Sub-category lists
Client's who want to generate project correction report/deficiency reports that are grouped by headings and/or sub-headings should enter those values as Category and Sub-category list types.
For example:
Standard Comments can be associated to a 'General Requirements' category and a 'Building Envelope' sub-category.
The Sort Order value of those list records is then used to control the sorting on the correction reports.
Preparing Comments for Batch Upload
Follow these best practices to prepare standard comments for batch upload:
...
Start by downloading this SampleStandardComment.csv
...
Using Microsoft Excel add your standard comments to the sample SampleStandardComment.csv
...
During upload, data mapping is based on the Row 1 labels. Do not rename the column headers.
...
Export your standard comments as DOS comma separated values (csv)
On Windows Excel "Save As" "CSV (MS-DOS)(*.csv)
On Mac go to File > Save As... MS-DOS Comma Separted (.csv)
...
For each comment being uploaded, provide either the entire item label or the entire item abbreviation to populate these columns in the spreadsheet.
Click here to download the CSV template for comments
...
Uploading to the Comments Library
...
From the Comment Library page, download the CSV template using the Download button ( 
).
...
Enter the standard comment into the CONTENT column.
...
Complete the other columns as described below, validating that the Purpose, Review Type, Sources, Categories, Groups have matching Label or Abbreviation values.
...
Set 'Active' to False only if the comment should be unavailable to users.
...
To configure standard comments, navigate to Settings > Configuration > Comments Library. Standard comment can be added either one-at-a-time or in batches to the Comments Library.
| Info |
|---|
To import standard comments in batches, see Batch Importing Standard Comments. |
...
Create a New Standard Comment
Most often, the Agency will upload standard comments in batches, but you can also create a single comment directly on the Comments Library page.
To create a single standard comment:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Click on
in the lower right corner. The “Add Standard Comment” form pops up.Fill out the form with your standard comment information:
Select a Purpose.
Select a Group.
Fill out the comment text in the text box.
To make the comment more searchable within the library, and ensure it is better organized within future comment report letters, adding as much other information (Category, Subcategory, Source, Review Type and/or List Name) as possible is recommended. Refer to the table below for more details about each field.
| Info |
|---|
When a library comment is inserted by plan reviewers, the comment’s Group - along with any Category, Subcategory, Source, and/or Review Type information - is also included in the new comment. Depending on the Agency’s Comment Report Letter configurations, some of these values may also be used when sorting comments within the letter. |
Batch Import Standard Comments
The most common method of adding standard comments to the Standard Comment Library is to import them in batches via a spreadsheet template provided by EPR by an Admin. Periodic review and updating of library comments (such as when revised codes become available) is recommended.
To batch upload standard comments:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Click on
to download the standard comment XLS template.Fill out the spreadsheet with your standard comment information:
Filling out the CONTENT, PURPOSE, and ACTIVE fields is required.
To make the comment more searchable within the library, and ensure it is better organized within future comment report letters, filling out as much other information (Category/categories, Subcategory/subcategories, Source/sources, Review Type and/or List Name) as possible is recommended. Refer to the table below for what each field represents.
Save the file in CSV or XLS format.
Select the Once ready to upload, click on
(Batch Upload button ( ) on the Comments Library page.
Required Column Values
These column values must be provided in order to uploaded standard comments into EPR successfully:
Purpose - Either "For Permitting" or "For Design Review".
EPR will only make standard comments available when they match the purpose of the Project the user is working on.
...
). This will open a window for you to select the file.
Select the file and click on OPEN to import comments to the library.
| Note |
|---|
A message will indicate whether import was successful or if any comments failed to import. Comments will only import successfully if:
|
Standard Comment Template Fields
The following table contains descriptions and examples of each field included in the “SampleStandardComment” upload template provided by EPR.
Comment Field | Required for Upload? | Must Match Existing EPR List Value or Abbreviation? | Description | Examples | |
|---|---|---|---|---|---|
Content | YES | NO | The comment text (which can be up to 8,000 characters in length).
|
...
Optional Column Values
These column values are optional, but provide two helpful functions:
They can be used as filters when plan reviewers search the Standard Comment library.
Some fields, such as Category and Subcategory, can be used to sort comments in the Corrections Report letter prepared for the applicant.
Review Type - If used, this field must match an existing Review Type value configured in EPR.
...
|
| |||||
Purpose | YES | YES | When users search for comments in the library during plan review, EPR will only show comments that match the current project’s Purpose.
| Must be either:
| ||
Review Type | NO | YES | Typically used only if specialized subgrouping is required beyond what Group, Categories, and Subcategories can provide. If a Group such as “FIRE” has a large number of comments, specialized subgroupings can improve searchability and/or sorting, such as for comments under a “Fire Life Safety” or other specialized review type.
|
...
|
...
As an example, Review Type would be configured if an agency has a "FIRE" group and requires individual review tasks done for "Fire Life Safety" and "Fire Sprinklers". In this scenario, "Fire Life Safety" and "Fire Sprinklers" would need to be configured as Review Types.
Sources - If used, this field must match an existing Source value configured in EPR.
Typically refers to a Code base or Code source.
Example: "2016 CBC" or "2019 IBC".
...
(For a sample FIRE Group):
| ||||
Sources (Source) | NO | YES | Typically refers to the code base or code source from which the comment originated. |
|
Categories (Category) | NO | YES | Most often, checklists have standard comments |
...
organized into sections and then subsections. |
...
A "Category" is roughly equivalent to a main comment section heading. |
...
|
...
| |||
Subcategories (Subcategory) | NO | YES | Most often, checklists have standard comments |
...
organized into sections and then subsections. |
...
A "Subcategory" is roughly is equivalent to a comment section |
...
sub-heading. |
...
|
...
|
Groups - This field must match an existing Group value configured in EPR.
Examples: "Building" or "BLDG" or "Fire" or "FIRE" (abbreviation must match EPR configuration).
...
| ||||
Groups (Group) | NO | YES | Typically refers to the main group of users who will most frequently use the standard comment. |
|
Checklist Name | NO | NO | This field provides an extra filter or grouping option that can be whatever text string the user wants |
...
to type in.
|
...
Examples: "John's Checklist" or "Plumbing Checklist 2019".
ACTIVE - Refers to comment status.
...
|
| ||||
Active | YES | NO | The comment’s default availability. “ACTIVE” means the comment will be available to reviewers/plan checkers during their reviews and “INACTIVE” means it will exist in the library but is not available for use during plan review.
|
...
Typically, any new standard comment uploaded to EPR will have ACTIVE = TRUE.
Formatting Comment content after uploading
Comment content may have lost some formatting after loading. Click on the pencil icon to open the Edit Standard Comment form.
...
At the end of each paragraph, hit the ENTER key to create a new line, then apply the desired formatting to the selected text, as desired.
Correction reports will honor this formatting.
...
Must be either:
| ||||||
Vendor_ID | NO | NO | If an Agency wants to track how frequently a specific library comment is used, provide a unique Vendor_ID number for that comment or comments.
|
|
| Info |
|---|
Required fields must be filled into uploaded standard comments into EPR successfully. Providing optional fields is recommended as these values are used to sort and filter for standard comments with the library and, potentially, in comment report letters. |
...
Formatting Comments After Upload
Comment formatting HTML must often be removed prior to uploading comments into the EPR comment library to prevent the transition from the comment source, to the CSV or XLS file, to the EPR library from resulting in unexpected reformatting. However, once inside EPR comments can be reformatted using the available editing tools.
To format a standard comment in the library:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Apply any filters (if necessary).
Hover over the comment.
Click on
(View/Edit Comment) to open the “Edit Standard Comment” form.
Apply formatting as desired (see Comment Formatting Tools for options).
Before Editing | After Editing |
|---|---|
 |  |
Comment Formatting Tools
Apply formatting to a comment using any of the following tools.
Feature | Icon | Description |
|---|---|---|
Heading 1 |  | Click to resize any selected text to use the largest font size (intended for a main heading). |
Heading 2 |  | Click to resize any selected text to use the large font size (intended for a sub-heading). |
Heading 3 |  | Click to resize any selected text to use the medium font size, which is slightly larger and bolder than standard text (intended for a third-level sub-heading). |
Bold |  | Click to make any selected text bold. |
Italic |  | Click to make any selected text italic. |
Underline |  | Click to underline any selected text. |
Unordered List |  | Click to sort selected text into a list using bullets. |
Ordered List |  | Click to sort selected text into a list using numbers. |
Undo |  | Click to undo the last edit. |
Redo |  | Click to redo the last edit. |
Increase Indent |  | Click to increase the indent for the selected line. |
Decrease Indent |  | Click to decrease the indent for the selected line. |
Insert / Edit link |  | Click to insert or edit an existing hyperlink. |
...
Other Standard Comment Library Batch Features
In addition to batch importing comments, the Standard Comment Library also allows users to batch export, batch update, and even batch delete standard comments.
Batch Update Comments to Inactive or Back to Active
To prevent a standard comment from being used by staff - in case the text needs to be reviewed and possibly updated, for example - Admins can simply mark the comment as “Inactive.” Inactive comments remain visible to Admins in the library page, but will not show up in reviewers' search results.
To set one or more standard comment as INACTIVE:
Navigate to the Settings > Configuration > Comments Library page.
Click on the checkbox next to each desired comment in the library list.
At the top right of the table, click on
SET INACTIVE.
...
| Warning |
|---|
Once inactive, the selected comments become unavailable for use by staff during plan review. |
To set one or more standard comment back to ACTIVE:
Navigate to the Settings > Configuration > Comments Library page.
Click on the checkbox next to each desired comment in the library list.
At the top right of the table, click on
SET ACTIVE.
| Info |
|---|
Once active, the selected comments are again available for use by staff during plan review. |
Batch Copy As New
To duplicate an existing library comment:
Navigate to the Settings > Configuration > Comments Library page.
Click on the checkbox next to each desired comment in the library list.
At the top right of the table, click on
COPY AS NEW.
| Info |
|---|
The selected comments are duplicated in the library. This saves time whenever existing comments have to be copied over to other user groups and/or departments. |
Batch Export Comments From the Library
The Standard Comment Library allows users to download comments from the library by exporting to a CSV file. Staff can then review these standard comments and even update them if necessary.
To batch export comments:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Apply any filters (if necessary).
Select one or more comments to export.
Click on
DOWNLOAD to export the selected comments as a CSV file.
...
| Info |
|---|
Unlike the sample XLS file for uploading new comments, the Standard Comment download CSV file includes an additional column named “Comment ID” that is used to track the standard comment in EPR’s library. |
Batch Update Comment Text
In addition to updating comments individually if desired, users also have the option to batch update their library comment text.
To batch update several comments at once:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Apply any filters (if necessary).
Select one or more comments to export.
Click on
DOWNLOAD to export the selected comments as a CSV file.Review comment text within the CSV file and edit as desired.
Once done, click on
(UPLOAD) to reupload the updated CSV file back into the Standard Comment Library.
...
| Info |
|---|
Because the CSV file includes the library’s comment id values, it will then update the existing library comments to reflect any changes made by the users. |
Batch Delete Comments
Like with any delete function, users are advised to only perform a batch delete of library comments if certain that the selected comments are no longer necessary.
To batch delete several comments at once:
Navigate to the EPR Standard Comment Library page at Settings > Configurations > Comments Library.
Apply any filters (if necessary).
Select one or more comments to delete.
In the batch options menu that appears, click on
(MORE OPTIONS) to see the DELETE option.Click on DELETE.
A pop-up will appear showing how many standard comments will be deleted and ask for confirmation.
Click DELETE again to confirm or CANCEL to stop.
...
...
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...