Versions Compared

Key

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

This article provides information regarding managing user accounts, project team membership, stamps, and email notifications. Select Security/Users to open the Users page.PrerequisitesAdministrator(s) have the ability to create, update, and otherwise manage their Agency’s e-PlanREVIEW® (EPR) user accounts. This ensures that Admins can regulate how an Agency’s user licenses are apportioned among staff members.

Info

The following must be completed before additional user accounts can be created:

  1. Configure User Role Permissions.

  2. Configure Groups for Permitting (and, if applicable, Design Review

...

  1. ).

  2. Upload

...

  1. and configure stamps.

A User record requires:

  1. A User Role.

  2. A unique email address and a password.

  3. First and Last name.

  4. User's who will conduct plan review:

    1. Must be associated to one or more Groups.

    2. Should be assigned Stamps.

In this article:

...

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
exclude.*Related articles.*
typelist
class
printablefalse

...

Understanding Standard and Specialized User Roles

Each e-PlanREVIEW® ( EPR ) user must be assigned a the User Role that most closely matches their expected tasks in EPR.

User Role

License Type

Description

Admin (A)

Standard

The Admin role is mainly tasked with assisting in the initial configuration of the EPR portal and with updating portal configurations as needed.

Some of the most significant Admin abilities include managing:

  • User accounts

  • Assignment distribution workflows

  • Project Membership distributions

  • The standard comment library

  • Corrections Report Letter templates

  • Stamps, custom stamps, and user stamp access

  • Email notification templates

Drop-down
  • Dropdown list values throughout EPR

Info

The Admin role can also perform the functions of every other user role in EPR, including project creation, assignment intake, plan review, and packaging deliverable back to applicants.

Project Coordinator (PC)

Standard

The Project Coordinator is usually reserved for intake staff/permit technicians.

The

main

most common responsibilities for these users are to:

  • Create plan review tasks (“assignments”) for reviewers

  • Update

assignment tasks
  • review assignments or reassign review tasks, as needed

.
  • Prepare corrections report letters

(typically)
  • Prepare deliverable packages of marked-up or approved plans to

send back
  • return to applicants at the end of a review cycle

.

When all review assignments have been given an approved, rejected, or canceled status, Project Coordinators will be notified so they can prepare a Corrections Report letter with all reviewer feedback and then package files to return to the applicant, either through email or, more commonly, through check-in to an integrated portal.

This user role typically cannot

Note

The Project Coordinator role cannot typically perform plan review.

Reviewer (R)

Standard

The Reviewer (or "plan checker", "plans examiner", etc.) has these main responsibilities:

  • Review and markup plans

submitted by an applicant
  • Provide feedback through comments and/or stamp approved plans as appropriate

.
  • Evaluate the submittal by

setting
  • selecting an

assignment
  • Assignment Status (Approved, Resubmittal Required, etc.) to complete their review

Reviewers belong to one or more Groups (think of these as Departments or Sub-departments) and are responsible for completing plan review tasks (“assignments”) made for their Group. In some cases, especially for larger agencies, assignments are made for a specific named Reviewer within a Group. Although other users are still able to access the assignment, the named Reviewer is expected to complete the review

assignment task.At the end of a review cycle, the reviewer must provide either an approval, rejection, or other status for the assigned plans and, if appropriate, may stamp plans as well.

assignments. Reviewers can also create

Corrections Report letters

corrections reports, if desired.

Note

The Reviewer role is not configured to perform intake of plans or prepare deliverable packages to

send back to an applicant – for this functionality, see Project Coordinator.

The Reviewer role is not configured to perform intake of plans or prepare deliverable packages to send back to an applicant – for this functionality, see Project Coordinator.

Group Manager

return to applicants.

Group Manager (GM)

Standard

The Group Manager functions as an elevated ‘Reviewer-type’ role.

  • The

difference is the
  • GM has the added ability to edit and delete markups created by other reviewers within his or her Group (by default, a reviewer can only edit his or her own markup activity).

Note

A Group Manager cannot edit or delete another Group’s markups

for another Group

unless

they

the user also

belong

belongs to the other Group as well.

Project Manager (PM)

Standard

The Project Manager is the highest level of ‘Reviewer-type’ role.

  • The

difference is the
  • PM has the added ability to edit and delete markups created by other reviewers within the project he or she is managing.

Note

A Project Manager cannot edit or delete markups for another

Project

project unless they also manage that

Project

project or are a project team member.

Contributor (CTR)

Contributor

A Contributor is a non-standard, licensed user who

has been

is granted access to view and respond

to comments made by the Reviewers in an existing project

to plan review staff comments across one or (usually) many projects.

  • The

contributor
  • Contributor can view all projects for which they are a

"
  • project team member

" (part of the Project Team)
  • .

  • They can view those

project
  • projects' comments and add responses to any that have the

'response enabled'
  • “Response Enabled” option set by the

reviewer
  • comment creator.

They cannot respond if response is not enabled, nor can they
Note

The Contributor role cannot perform plan review (they cannot create new comments

or markup plans. This user role cannot perform plan review.

...

Info

An Administrator account is included for technical support purposes. This user account is read only.

Creating a New User

Go to Settings > Security > Users in the Navigation menu to open the Users list. This page will show 'Active' users, meaning users who can successfully log into EPR, by default. (To view inactive users, click on the Active toggle so it changes to Inactive.)

Add a User Account

Admins can add user accounts as needed from the Users list page as follows:

  1. Click on the plus (plus) icon at the bottom right to create a new user account.

  2. Complete the PROFILE tab.

    1. User Role, Password, Email, First Name and Last Name are required.

    2. New accounts must have a unique email addresses that is not already in use by an Active or Inactive account.

    3. Confirm the account is set to Active to ensure the user can log into EPR. 

  3. On the GROUPS tab, add which Group(s) the user will belong to.

  4. On the STAMPS tab, select which Stamp(s), if any, that the user should have access to for plan review.

  5. On the NOTIFICATIONS tab, select any desired email notifications for the user (see User Notifications Settings for more information).

  6. Click SAVE.

...

, markup plans, or set assignment status values for an assignment).

Read-Only (RO)

Read-Only

A Read-Only user is a non-standard, licensed user who is granted global view rights to all information within EPR.

  • The Read-Only user cannot add, edit, run, or delete any data within the system.

Note

The Read-Only role is for viewing information purposes only.

One-Time-Access-User (OTAU)

N/A

A One-Time-Access-User (or “ReviewSession Guest”), is a non-standard, unlicensed role granted to guests invited through the ReviewSession feature so they can view one project’s details, comments, and access pages where those comments exist. The invitation is for a limited time (with an end date set by the invitation sender) and the guest will lose access after that date.

Warning

An email address already in use by a user with another user role cannot be invited to access project(s) through the ReviewSession feature. ReviewSession guests can be re-invited after their original invitation has expired, however.

A Standard license grants one individual the right to be any one (1) user role within EPR except for Contributor and Read-Only roles, which have their own specialized license types. If you have questions regarding licenses and license types, contact the e-PlanSoft Support Team by creating a Service Desk Ticket.

Info

Permissions can be changed to either remove or confer additional rights to a user role within certain limits, but it is still recommended for staff to begin with the role closest to their expected behavior.

Note

One or more Administrator account is included for technical support purposes (or for performing automated tasks when integrated with a partner system). This account (or accounts) are not included in an Agency’s license count and should not be modified, inactivated, or deleted without prior confirmation from the e-PlanSoft staff.

...

Creating a New User

Go to Settings > Security > Usersin the Navigation menu to open the Userspage. This page will show Active users - meaning users who can successfully log into EPR - by default.

Info

To view Inactive users, click on the “Active” toggle so it changes to “Inactive.”

Note

Deleted users will not be listed under either “Active” or “Inactive” lists, but they still exist in the database and their email addresses cannot be repurposed for a new account. If necessary, contact e-PlanSoft Support for help with restoring a deleted account.

Add a User Account

...

Admins can add user accounts as needed from the Users page as follows:

  1. Click on the plus (blue star) icon at the bottom right to create a new user account.

  2. Complete the PROFILE tab:

    1. Select a License Type based on the intended usage (Standard, Contributor, Read-Only, or Shared).

    2. Password, User Role, Email, First Name and Last Name are required.

    3. New accounts must have a unique email addresses that is not already in use by any Active, Inactive, or deleted user, nor by any Contact records.

    4. Confirm the account is set to “Active”to ensure the user can log into EPR. 

  3. Click on the GROUPS tab and select one or more Group(s) which the user will represent when performing plan review.

  4. Click on the STAMPS tab, and select one or more Stamp(s) which the user will be able to place during plan review (if necessary).

  5. Click SAVE to complete creating the account. The form will close.

  6. If the user needs to receive email notifications from EPR, reopen the user profile by clicking (blue star) (go to arrow).

  7. Click on the NOTIFICATIONS tab, where a list of options now appears.

    1. First, check the box for “Email notifications to…” at the top if this user should receive email notifications from EPR. This may not apply for agencies integrating EPR to another system that can handle user notifications.

    2. Next, select which specific notifications the user should receive (see User Notifications Settings [link] for more information).

Info

EPR monitors the total count of active user accounts to compare this to the purchased user license count. Only active accounts are counted toward the license total. Inactivating a user account will free up a license for other personnel.

Copy an Existing Account

Admins can save time when creating a new account by copying an existing profile 's User to auto-fill the License Type, User Role, Group(s), Stamp(s) and Notification settings by using the Copy as New User option.

  1. First, select an existing user account.

  2. Click on the ellipsis icon (three dots) on the far right of the account record.

  3. Click on the pop-up for "Copy as New User."

  4. Complete the new account by providing any missing information, such as the new user's unique email address, and save when completed. (You can also modify existing configurations before saving.)

...

Requesting a New Account

If an Admin wants staff to fill out their own information, they can ask a future user to "Request a new Account" from the EPR Login page. This creates the user's profile with a temporary password, but sets their status to Inactive and leaves their user role blank. The Admin would then need to define a user role and switch the account to Active to give the user the ability to log in.

To view 'requested account' records in the User list:

...

) and Notification choices.

To copy an account:

  1. Search for an existing user account to copy.

  2. Click on the (blue star) (three dots) button on the far right of the record.

  3. Click on the option for Copy as New User.

  4. A new account form pops up with License Type and User Role auto-populated.

    1. Complete the PROFILE tab by inputting a new Password, Email, First Name, Last Name, and any other desired field manually.

    2. Click the GROUPS tab to confirm that desired group(s) are auto-populated.

    3. Click the STAMPS tab to confirm that desired stamp(s) are auto-populated.

    4. Click the NOTIFICATIONS tab to confirm that desired notification(s) are auto-populated.

  5. Click SAVE to complete the new account. The form will close.

...

Info

Any auto-populated information can be changed as needed while creating a new account.

Image Added

Requesting a New Account

To have staff fill out their own basic account information rather than creating it for them, ask any future user(s) to go to the EPR login page and click on Request a new account. This will create the user's account with the basic PROFILE information, but sets their status to “Inactive” and leaves their User Roleblank. The Admin needs to then edit the account(s) to set a user role, make the account “Active”, add group(s), add stamp(s), and select notification options before the user(s) can actually log in.

To view requested account records in the User page:

  1. Toggle the list view from “Active” to “Inactive” at the top of the page.

  2. Search for and select the desired inactive record.

  3. On the Profile PROFILE tab, set the desired 'User Role' and switch the Inactive “Inactive” toggle to Active“Active.

  4. On the Groups GROUPS tab, select the group(s) the user will belong to.

  5. If necessary, grant access to stamp(s) in the Stamps STAMPS tab.

  6. On the Notifications NOTIFICATIONS tab, select any desired notifications for the user.

  7. The new user will receive an email with login instructions when once their account status has been switched updated from inactive “Inactive” to Active“Active.

Info

Administrator's Administrators responsible for managing user accounts should subscribe to the USER - New User Request notification option.

...

Here is a breakdown of all available notification options and how they are triggered.

Notification Type

Notification Sub-type

Notification Check box

Condition(s) for Notification

Notification Description

PROJECT

Comment

Allow Response

Subscribed AND user is a Contributor.

Notifies user when comment has “Response Enabled” activated.

User did not create the comment BUT has previously added a response to the comment’s thread.

Notifies user whenever another comment response is added.

User did not create the comment BUT user is currently assigned to the comment.

Notifies user whenever another comment response is added.

User did not create the comment.

Notifies user when they have been assigned to the comment.

User is currently assigned to the comment.

Notifies user when a comment assignment is marked complete/incomplete by someone else.

User created the comment.

Notifies user when another user marks the comment assignment as complete/incomplete.

PROJECT

Document Assignment

Create (Assigned)

Subscribed AND user is named Assignee.

Notifies user whenever they are

assigned

tasked with a review

task

assignment by name.

PROJECT

Document Assignment

Reassigned

Subscribed AND user is named Assignee.

Notifies user whenever they

are re-assigned an already

become the new assignee for an existing review

task

assignment.

PROJECT

Document Assignment

Status Updated to Active

Subscribed AND is a project team member.

Notifies user whenever an assignment status is changed to any value with the parent status "Active." (These are assignments currently in review.)

PROJECT

Document Assignment

Status Updated to Approved

Subscribed AND is a project team member.

Notifies user whenever an assignment status is changed to any value with the parent status "Approved." (These are approved assignments.)

PROJECT

Document Assignment

Status Updated to Canceled

Subscribed AND is a project team member.

Notifies user whenever an assignment status is changed to any value with the parent status "Canceled." (These assignments are not needed.)

PROJECT

Document Assignment

Status Updated to Not Started

Subscribed AND is a project team member.

Notifies user whenever an assignment status is changed to any value with the parent status "Not Started." (Review for these assignments has not yet started.)

PROJECT

Document Assignment

Status Updated to Rejected

Subscribed AND is a project team member.

Notifies user whenever an assignment status is changed to any value with the parent status "Rejected." (These assignments require resubmittal.)

PROJECT

-

Document Awaiting Intake

Subscribed

Notifies user whenever a document on the Intake tab requires assignments to be created.

PROJECT

-

Status Changed to Cycle Complete

Subscribed AND is a project team member.

Notifies user whenever a project status is changed to any value with the parent status "Cycle Complete." (This project review cycle is done.)

PROJECT

-

Status Changed to Finished

Subscribed AND is a project team member.

Notifies user whenever a project status is changed to any value with the parent status "Pass" or "Fail." (This project has been approved or requires resubmittal.)

PROJECT

-

Status Changed to On Hold

Subscribed AND is a project team member.

Notifies user whenever a project status is changed to any value with the parent status "On Hold." (Work on this project has been paused.)

PROJECT

-

Status Changed to Open

Subscribed AND is a project team member.

Notifies user whenever a project status is changed to any value with the parent status "Open." (This project is undergoing review.)

PROJECT

-

Status Changed to Withdrawn

Subscribed AND is a project team member.

Notifies user whenever a project status is changed to any value with the parent status "Withdrawn." (Work on this project has been canceled.)

USER

Auth

New User Request

Admin-role user.

Notifies Admin whenever someone requests a new user account from login page.

USER

User Account

Create

Admin-role user.

Notifies Admin whenever someone creates a new user account (either from the Users page or API).

Info

Some notifications do not require users to subscribe in order to receive them. For example, if a user created a comment, they will be notified when another user replies regardless of whether they are subscribed to a comment event (as long as they have Email notifications to… selected).

Note

Note that Project notifications will only trigger for users who are involved in the project as project group team members (these can be users named to a specific review assignment , or just users added to the project and listed in the project's through the DETAILS > Team subsection).

...

Each user should be subscribed to the events that are relevant to them/their role. The following basic notification subscriptions are recommended:

  • For Project Coordinators

...

/their role. The following basic notification subscriptions are recommended:

User Role

Description

Example(s)

Administrators

Any event notifications, but especially those related to administrative functions such as new user requests and the creation of user accounts any anyone.

Image Added

Project Coordinators

Any notifications related to assignment creation, reassignment, assignment status changes, and/or project status changes.

Image Added

Reviewers,

Group Managers, and/or

Project Managers

...

  • For Administrators

...

Notifications for the assignment or reassignment of a plan review.

Image Added

Users subscribed to an event will receive an email notification whenever the event is triggered, as recorded in the event log.

...