Skip to main content

CR Lifecycle

This page is the hub for the Caution Report business flow.

This lifecycle was cross-checked against the current CR implementation in mvp2-data-service and intt-portal.

API Endpoints​

Main routes across lifecycle:

  • POST /data/caution-report/create
  • POST /data/caution-report/goth/create
  • GET /data/caution-report/all
  • GET /data/caution-report/by-id/:id
  • GET /data/caution-report/get-all-notes
  • POST /data/caution-report/note/create
  • PUT /data/caution-report/note/update/:id
  • PUT /data/caution-report/update/:id
  • PUT /data/caution-report/update/status/:id
  • POST /data/caution-report/trigger/dispatch-tmf
  • GET /data/caution-report/tmf/work-order/get
  • GET /data/caution-report/tmf-work-order/find

Purpose​

CR lifecycle documentation helps developers and users understand how a caution report is:

  • created
  • listed and filtered
  • opened in detail view
  • annotated with notes
  • updated
  • moved through status changes
  • optionally dispatched to TMF

Main lifecycle path​

At business level, the CR lifecycle is best understood as:

  1. create the Caution Report
  2. view the CR in list form
  3. open one CR detail page
  4. read or add notes
  5. update CR data such as area, severity, diagnosis, attachments
  6. update CR status through allowed transitions
  7. dispatch the CR to TMF when needed

Flow pages​

Flow pageWhat it covers
CR Creationcreating a new caution report from the portal
CR GOTH Createcreating a CR from the GOTH integration path with duplicate detection
CR List and Detailfiltering multiple CRs and opening one CR
CR Notesreading and creating note history
CR Update Notesediting an existing CR activity note and synchronizing it to TMF
CR Ticket Historyreading lifecycle timeline history and audit/change history
CR NEPS Moduleresolving building data from coordinates and maintaining polygon support data
CR Update Rulesupdating area, severity, diagnosis, and attachments
CR Status Rulesmoving the CR through allowed statuses
CR to TMF Handoffcreating downstream TMF work order activity
CR TMF Workorder Lookupreading live TMF workorder data and local grouped CR workorder history

Suggested reading order​

  1. start here for the big picture
  2. read CR Creation
  3. read CR GOTH Create
  4. read CR List and Detail
  5. read CR Notes
  6. read CR Update Notes
  7. read CR Ticket History
  8. read CR NEPS Module
  9. read CR Update Rules
  10. read CR Status Rules
  11. read CR to TMF Handoff
  12. read CR TMF Workorder Lookup
StageRelated flowchart
overviewCR Overview PDF
createCreate CR PDF
GOTH createGOTH Create CR PDF
listCR List PDF
detailCR Detail PDF
notesGet CR Notes PDF
note updateUpdate CR Notes PDF
historyTicket History PDF
geospatial helperNEPS Module PDF
updateUpdate CR PDF
statusUpdate CR Status PDF
downstream handoffDispatch to TMF PDF
post-dispatch lookupGet TMF Workorder PDF

Still worth confirming with the team​

These are the remaining gaps after the code cross-check:

QuestionWhy it matters
whether the CR overview flowchart should explicitly say it is centered on the caution-report module in mvp2-data-serviceavoids confusion when readers compare it with other modules shown nearby
whether every status transition in the diagram is still current business policycode confirms implementation, not product intent
whether some update restrictions changed recently but the diagram was not refreshedupdate logic is rule-heavy
whether batch or cron-triggered CR flows should get their own business-flow pagesthey already exist in code and may matter for support