This article provides information on a high-level overview of the project and plan review lifecycle and typical integration scenarios for connecting e-PlanREVIEW® (EPR) to an external application using our Connect API toolkit.

In this article:

High Level Overview

A typical plan review Project undergoes this basic process:

Create a Project: A project record is necessary as a container to upload files.
Upload files via the Upload API
1. Upload files
2. Trigger assignment creation for plan files to be reviewed
Conduct plan review and Complete assignments.
1. Reviewer will give a status upon completion of assignment (completed, cancelled, approved, etc)
A deliverable package with the marked up documents is prepared, this completes the 1st submittal cycle.
1. Return the deliverable package to the customer for corrections via 3rd party upload api or pull from EPR api.
Corrected documents are provided by the customer as the next submittal. Repeat from step 2.
1. Existing assignments are reopened with a Not Started status and markups are carried forward to the latest version.
2. Repeat steps 3 and 4
  - The process repeats until all noted issues are resolved and project is closed or archived.

Integrated Environments

Variations on the process described above include the following scenarios when EPR is integrated to another application using our Connect API toolkit:

Integration Option 1

The integrated application:

creates a project via project create API
uploads file to EPR
manually creates plan review assignments in EPR thus not using EPR's API
return final PDF files to the integrated application using API calls provided to EPR.

Integration Option 2

creates a project via project create API
uploads file to EPR
creates plan review assignments in EPR using EPR's assignment API
during plan review, based on some event trigger a callback to 3rd party application
return final PDF files to the integrated application using API calls provided to EPR.

Best Practices

For stand alone deployments, email notifications should be configured to alert the appropriate project team members when a project cycle is set to Cycle Complete so that a deliverable package can be prepared.

Related articles

Page:

Project Management
Page:

Managing List Types and List Items
Page:

EPR Release Notes
Page:

Managing Contacts
Page:

Managing Groups for Document Review

Browser not supported