Managing List Types and List Items
Most drop-down list values used throughout e-PlanREVIEW® (EPR) are configured from the Settings > Configuration > Lists page, which requires Administrator access. List items have different uses based on their List Type, such as defining project details or status, setting and updating assignment values, selecting comment information, or selecting users and/or their groups.
When EPR is first deployed it will include a default set of list item values for most List Types which can be used or replaced as needed. During the implementation process, agency staff should review these and inform the e-PlanSoft implementation team if they want any removed or if they have additional list item values they want to add to any list.
List Type Purposes
In EPR, list types and their list items fall under one of three purposes, depending on how they are used: General, For Permitting, and For Design Review.
Purpose | Description |
---|---|
General | General lists are those that are shared between ‘For Permitting’ and ‘For Design Review’ projects without any differences. |
For Permitting | For lists that are only displayed within ‘For Permitting’ projects. |
For Design Review | For lists that are only displayed within ‘For Design Review’ projects. |
General Purpose List Types
Below are the list types that fall under the General purpose. These list types are shared between “For Permitting” and “For Design Review” projects.
List Type | Required? | Intended Use | Examples | Notes |
Attachment Type | Required | Used to identify the kind of attachment file being uploaded to a project and/or comment. | Comment Attachment, Calculations, Other | The pre-configured “Comment Attachment” value is used by EPR and should not be modified or deleted. |
Construction Type | Optional | Used to identify the classification and fire rating of a project's buildings or structures. | Type 1-A, Type 1-B, Type 2-A |
|
Contact Role | Optional | Used to identify a contact person’s relationship to a project. | Architect, Project Owner |
|
Country | Optional | Used within address records for projects, users, contacts. | Canada, United States | Used to filter State/Province choices. A default country can be set so that it is pre-selected when new projects are created. |
District/County | Optional | Used within address records for projects, users and contacts. | Abbotsford, Orange County |
|
Document Type | Optional | Used to describe the content of the document being uploaded. | Calcs, Plans, Specs | Refers to the content of the file, not the file format. |
Occupancy | Optional | Used to categorize project building structures based on their usage; primarily used for building and fire code enforcement. | Business, Residential1, Residential 2 |
|
Source | Optional | Used in Standard Comments to reference where the comment came from. | 2025 Intl Building Code, 2022 Intl Fire Code | Typically, the year and name of code base from which a comment is sourced; see Standard Comment Library. |
State/Province | Optional | Used within address records for projects, users and contacts. | Alberta, California | State/Province choices are filtered based on Country selection. |
Street Direction | Optional | Used within address records for projects, users and contacts. | East, North, Northeast |
|
Street Type | Optional | Used within address records for projects, users and contacts. | Avenue, Boulevard, Drive |
|
For Permitting and For Design Review List Types
All non-general list types can be configured to include different list values depending on whether they are intended “For Permitting” projects or “For Design Review” projects. This is intentional as terminology may vary between projects intended to result in permits versus projects that are designed for internal peer review.
Whether you choose to create projects for one or both purposes, functionality and workflow processes are the same.
List Type | Required? | Intended Use | Examples | Notes |
Application Type | Optional | Used to identify a project’s application type. | Addition, Renewal, Signage |
|
Assignment Status | Required | Used to denote the current standing of an assignment. | Not Started, Active, Canceled, Corrections Required, Approved | Each kind of assignment status, based on Parent Item (Not Started, Active, Canceled, Rejected, Approved) must have exactly one active, default selection. Additional assignment statuses may be created for one or more Parent Items to provide non-default choices. |
Category | Optional | Used to categorize comments; also used as the primary heading and to sort comments within Comment Report Letters/Corrections Reports. | General, Electrical, Fire, Mechanical, Plumbing, Site | If used, sort order is important because those values (0,1,2…) are used to organize comments within the comment report letter. See Standard Comment Library. |
Comment Disposition | Required | Used to denote the current status of the project comment. | Open, Closed, Conditionally Approved | Each kind of comment disposition, based on Parent Item (Open, Closed) must have exactly one active, default selection. Additional dispositions may be created for one or more Parent Items to provide non-default choices. |
Custom Field Group | Optional | Used to create additional custom project fields. | Regulations, Internal Staff Notes | After a Field Group is created, it must be mapped to one or more project types and then used to create one or more custom fields. See Create a Field Group. This list appears on its own page (Settings > Custom Fields > Field Groups). |
Document Cycle | Required | Used to denote the current review cycle for the document. | 1st Submittal, 2nd Submittal | Whichever value is set as the ‘Default’ will be used for the first version of incoming documents, then each resubmittal will automatically use the next value based on incremental Sort Order (1, 2, 3…). Document Cycle Sort Order values cannot be repeated. Create document cycle records for as many cycles as you typically have. Additional cycles will be generated on-the-fly if you ever exceed the maximum you have created. |
Groups | Required | Used to organize assignments, users, and users' markups. A group is often a discipline, division, department, or equivalent to which users and assignments belong. | Building, Fire, Planning, Public Works | For details about how to set up groups, see Managing Groups for Document Review. This list appears on its own page (Settings > Custom Fields > Groups). |
Impact | Optional | Used to denote the relative importance of a project comment. | Major, Minor |
|
Priority | Optional | Used to denote the relative urgency of a project. | 5 Days, 10 Days, 21 Days, Expedited |
|
Project Cycle | Required | Used to denote the current cycle/phase of a project. | 1st Submittal, 2nd Submittal, 3rd Submittal | Whichever value is set as the ‘Default’ will be used when a project is first created. Users can then manually update this value as desired (it will not update automatically). Create project cycle records for as many cycles as you typically have. |
Project Status | Required | Used to denote the current standing of a project record. | Open, On Hold, Canceled, Cycle Complete, Corrections Required, Approved | Each kind of project status, based on Parent Item (Open, On Hold, Withdrawn, Cycle Complete, Pass, Fail) must have exactly one active, default selection. Additional project statuses may be created may be created for one or more Parent Items to provide non-default choices. |
Project Type | Required | Used to classify a project, usually based on the type of work expected. | Addition and Remodel, New Construction, SFR | If Automated (assignment) Distribution workflows will be used in EPR, they require Project Type selections. |
Review Type | Optional | Used to denote a specific discipline affiliation for assignments when multiple assignments must exist within a single Group for the same document. | Civil, Electrical, Structural | Distributions can also rely on the 'abbreviation' to distribute plans during intake. |
Service Area | Optional | Used to denote the regional/geographical area of a project site/address. | Unincorporated Area A, Unincorporated Area B | For agencies using goPost with more than one portlet set up, the Service Area can be used to reference which goPost portlet the project comes from. |
Subcategory | Optional | A comment sub-affiliation; used as a secondary heading and to sort comments within a Comment Report Letter / Correction Reports. | Grading, Fixtures | If used, sort order is important because those values (0,1,2…) are used to organize comments within the comment report letter. See Standard Comment Library. |
Managing List Items
List items have a variety of uses in EPR, depending on the kind of list type they belong to, but most are created using the same process.
There are two list types that are created following slightly different processes:
Groups are managed on their own page rather than with the other Lists, but function very similarly. Refer to Managing Groups for Document Review for more information.
Custom Field Groups, on the other hand, are managed from their own page and are used differently than other lists. Refer to Creating and Managing Custom Fields for more information.
Create a List Item
To create a new list item:
Navigate within the EPR menu to Settings > Configuration > Lists.
Click within the “Purpose” dropdown and select General, For Permitting, or For Design Review.
This will load all List Types for that purpose.
Any existing group values will load within the table.
To add a new list item, click the (Add) button in the lower right corner.
The “Purpose” and “List Type” values will be pre-selected.
Type the desired name into the “Label” field.
Can use alphanumeric characters, as well as “-”, “_” or “/”.
The full label displays wherever space allows it.
Type an abbreviation into the “Item Abbreviation” field.
Can use alphanumeric characters only.
Abbreviation length should be between 1-4 characters at maximum.
Abbreviation is displayed most often throughout EPR, appearing within table columns, in comment tags, and other places where saving space is a priority.
If present, such as for status lists, a “Parent List Item” must be selected from the dropdown.
Type an “Order” value (if desired).
If all values are left as 0, items will list alphabetically.
If present, such as for status or disposition lists, an “Item Color” can be set to display where applicable.
To set, either type in a hex color value into the “Item Color” field or click on the circle next to it and select from the color picker.
Not all list items make use of color.
Using black, gray, or white colors is not recommended.
Click on the List Item is Active toggle to enable or disable the list item, as applicable.
Click SAVE to complete.
For Assignment Status, Comment Disposition, and Project Status lists only, choose the appropriate “Parent List Item.” This is used for managing workflows internally.
List Item Page Layout | Add List Item Window |
---|---|
Assignment Status List Item Table | Create New List Item |
Edit a List Item
Most list item information can be edited as needed, though because of how information is tracked behind the scenes, updating an existing “Label” is not recommended. If a label needs to be changed, it is usually better to create a new group record (with the new label) instead of repurposing an existing group.
To edit a list item:
Navigate within the EPR menu to Settings > Configuration > Lists.
Click within the “Purpose” dropdown and select General, For Permitting, or For Design Review.
This will load all List Types for that purpose.
Search for the list item to edit.
Click on (Edit) to open an existing list item.
Update the record as needed.
Purpose, List Type, and/or Key cannot be changed.
List items set as “Default” values cannot be made inactive; to inactivate a default record, first make another record the default then return to the one you want to edit.
List items which have already been used in EPR cannot be made inactive.
Click SAVE to complete the update or CANCEL to close the form without making any changes.
Updating an existing list item’s label after it has been saved is not recommended. Instead, create a new group with the desired label, and, if the old group is no longer needed, make the group inactive.
Delete a List Item
If a list item has not been used, it can be safely deleted from EPR unless it is linked to another list item. Deleting should be reserved as a last resort, however.
To delete a list item:
Navigate within the EPR menu to Settings > Configuration > Lists.
Click within the “Purpose” dropdown and select General, For Permitting, or For Design Review.
This will load all List Types for that purpose.
Click (Delete) to remove the list item.
Deletion will be successful as long as it has not been used anywhere within EPR. For list items that have been used already, go ahead and inactivate the list item instead.
Inactivate a List Item
If a list item has already been used but is no longer necessary going forward, edit it to make it inactive.
Inactive list items:
Stop appearing in their respective dropdowns
Can be reactivated at any time by toggling the ‘Is Active’ setting back to ON
Managing Project Types for Agencies with Multiple goPost Portlets
List Type Abbreviations must be unique, except for agencies using goPost with multiple portlets set up.
When multiple goPost portlets are in use, sharing the same abbreviation across multiple Project Types can ensure that only those values will show up within that portlet’s dropdown choices. Agencies can therefore filter different Project Type choices for each of their goPost portlets. See the goPost Wiki page: Managing goPost Portals for more information.
Related articles