This article provides information a high level overview the project and plan review lifecycle and typical integration scenarios for connecting eplansoft REVIEW to an external application using our Connect API toolkit.
...
Table of Contents |
---|
...
High Level Overview
A typical plan review Project undergoes this basic process:
- Create a Project: A project record is created that includes at minimum, one primary Contactnecessary as a container to upload files.
- Conduct Intake on the new plan review documents.
- Plan review documents (in PDF format) are uploaded to the project.
- Supporting attachments (any file type) are uploaded to the project.
- Trigger Distribution Workflows to create group and/or named-user assignments.
- Multiple assignments are created for each plan review document.
- Conduct plan review.
- Complete assignments.Each assignment is given a pass/fail status by the reviewers.Upload files via the Upload API
- Uplaod files
- Trigger assignment creation for plan files to be reviewd
- Conduct plan review and Complete assignments.
- Reviwer 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.
- 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.
- Existing assignments are reopened with a Not Started status and markups are carried forward to the latest version.
- Comments found to be resolved are marked ‘closed’.
- Plan Review Assignments are completed.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:
...
The integrated application pushes project data, documents and plan review assignments to EPR. The integrated application manages document versioning.
No manual data entry of projects, upload of documents or creating plan review assignments is necessary in EPR.
Plan review is conducted in EPR.
Plan review deliverables are checked in to :
- 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
The integrated application pushes project data and documents to EPR using API calls.
EPR manages document versioning.
EPR's Workflow Distribution module is configured and enabled to auto-create assignments.
Plan review is conducted in EPR.
Plan review deliverables are checked in to the integrated application using API calls or downloaded to another network location.
Integration Option 3
EPR is connected to the e-PlanSoft goPost Customer Portal.
goPost pushes new project data and documents created by the customer to EPR using Connect API.
goPost manages document versioning.
Manual data entry of projects/contacts and uploading documents to EPR is unnecessary.
Plan review is conducted in EPR.
...
- 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.
Info | ||
---|---|---|
| ||
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. |
...