Versions Compared

Key

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

...

  1. Configure Groups for Permitting and Design Review Lists.
  2. Configure Review Types for Permitting and Design Review Lists (as needed).
  3. Configure Comment Sources for Permitting and Design Review Lists.
  4. Configure Categories and Sub-categories for Permitting and Design Review Lists.
  5. Gather plan reviewer checklists and standard comments.
    1. Verify that comments to be uploaded correct accurate.

Required Column Values for Import

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.
  • Content - The comment text to be included (max. 8,000 characters). Remove any HTML formatting prior to uploading to EPR.

Optional Column Values for Import

The following column values are optional, but provide two helpful functions:

  1. They can be used as filters when plan reviewers search the Standard Comment library.
  2. 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.
    • If an agency does not expect to have multiple assignments/review tasks under a single Group, then Review Type is generally not used.
    • 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".
  • Categories - If used, this field must match an existing Category value configured in EPR.
    • Most often, checklists have standard comments grouped into sections and then subsections.
    • A "Category" is roughly equivalent to a main comment section heading.
    • Example: A Structural checklist may have sections specifically for comments about "Concrete" or "Steel". Alternatively, a large checklist may have sections in Parts, as shown below.

Image Removed

  • Subcategories - If used, this field must match an existing Subcategory value configured in EPR.
    • Most often, checklists have standard comments grouped into sections and then subsections.
    • A "Subcategory" is roughly is equivalent to a comment section subheading.
    • Example: A Structural checklist may have a Steel section with subsections (subcategories) for "General" and "Cantilevered Column" comments.
  • 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).
  • Checklist Name - This field is an extra filter that can be whatever text string the user wants - it does not need to match anything in EPR.
    • Examples: "John's Checklist" or "Plumbing Checklist 2019".
  • ACTIVE - Refers to comment status.
    • Set to "TRUE" or "FALSE", where "TRUE" means the comment will be available to reviewers/plan checkers during their reviews.
    • Typically, any new standard comment uploaded to EPR will have ACTIVE = TRUE.
Info
titleBest Practices

 In addition to the required Purpose and content text, include a Group and Comment Source for each comment record, at minimum. These records will be used to generate project comment reports, so the more optional fields you provide, the comprehensive your client deliverables will be, and the better data analytics you can capture for reporting, etc.


In this article:

Table of Contents

...

  1. From the Comment Library page, download the CSV template using the download icon. Download template icon
  2. Enter the standard comment into the CONTENT column.
  3. Complete the other columns as shown described below, validating that the Purpose, Review Type, Sources, Categories, Groups have matching Label or Abbreviation values.
  4. Set 'Active' to False only if the comment should be unavailable to users.
  5. If desired, use the 'Checklist Name' field to enter reference text (something like "Joyce's Checklist" or "Administrative Comments") that the comment owner will use as an additional filter option when searching for standard comments. Unlike other fields, checklist names do not need to be preconfigured in EPR as a List Item; instead, these filter options are populated from the user-supplied data within this upload form.
  6. Save the file in CSV or XLS format.
  7. Select the batch upload icon on the Comments Library page. Upload icon

...


Sample CSV templateImage Added

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.
  • Content - The comment text to be included (max. 8,000 characters). Remove any HTML formatting prior to uploading to EPR.


Optional Column Values

These column values are optional, but provide two helpful functions:

  1. They can be used as filters when plan reviewers search the Standard Comment library.
  2. 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.
    • If an agency does not expect to have multiple assignments/review tasks under a single Group, then Review Type is generally not used.
    • 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".


  • Categories - If used, this field must match an existing Category value configured in EPR.
    • Most often, checklists have standard comments grouped into sections and then subsections.
    • A "Category" is roughly equivalent to a main comment section heading.
    • Example: A Structural checklist may have sections specifically for comments about "Concrete" or "Steel". Alternatively, a large checklist may have sections in Parts, as shown below.

Image Added

  • Subcategories - If used, this field must match an existing Subcategory value configured in EPR.
    • Most often, checklists have standard comments grouped into sections and then subsections.
    • A "Subcategory" is roughly is equivalent to a comment section subheading.
    • Example: A Structural checklist may have a Steel section with subsections (subcategories) for "General" and "Cantilevered Column" comments.


  • 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).


  • Checklist Name - This field is an extra filter that can be whatever text string the user wants - it does not need to match anything in EPR.
    • Examples: "John's Checklist" or "Plumbing Checklist 2019".


  • ACTIVE - Refers to comment status.
    • Set to "TRUE" or "FALSE", where "TRUE" means the comment will be available to reviewers/plan checkers during their reviews.
    • Typically, any new standard comment uploaded to EPR will have ACTIVE = TRUE.

Formatting Comment content after uploading

...