Financial Assurance Module
  • Financial Assurance Module Documentation
  • INTRODUCTION
    • Glossary / Terminology
    • FAQ
    • Releases / Changelog*
    • Report an Issue / Contact us
  • PRODUCT / END-USER DOCUMENTATION
    • Overview
      • User roles and permissions
    • Financial Assurance Module Navigation
    • Overall User Interface
    • Engagements section
      • Creation of Engagement
      • Reporting of Engagement
      • Submitting of Engagement
      • Finalize the Engagement
      • Export of Engagement
      • Cancellation of Engagement
    • Staff Spot Checks section
    • FAM workflow
  • TECHNICAL DOCUMENTATION
    • Architecture
    • Development Setup
    • Deployment / DevOps
    • Backend Module structure
    • Data Model
    • Fixtures & management commands
    • Integration with permissions framework
    • Interaction with VISION
    • API Documentation
      • Error Handling
    • Frontend
      • Module structure
      • Build process
      • Tests
Powered by GitBook
On this page
  1. TECHNICAL DOCUMENTATION

Data Model

PreviousBackend Module structureNextFixtures & management commands

Last updated 6 years ago

Main entity of Financial Assurance module is Engagement. It can be one of four types: Audit, SpecialAudit, SpotCheck, MicroAssessment. Each of them has own special fields & related models. They are stored inside tenants and doesn't share across the countries.

Main part of the data contains in the base Engagement model. In addition to the connected models, Risks are used to store the Questionnaire, their structure is shown below. They describe answers to the questions (RiskBluePrint) from the Questionnaire. Questions can be grouped using the categories (RiskCategory). Category has link to self, so they are organized to the tree.

Risks are also used in audit to store key weaknesses, they are flexible enough to store question-like structures.

Global models are base and can be shared across countries, namely partners & purchase orders. Tenant models are Engagement with its subclasses and all models that relate to it.

Engagements are mapped to the Purchase Orders. They were placed into single application because they are global and should be available from any country.

Purchase Orders are linked to the Audit Firms, with their members.

Full models structure is shown on the scheme below:

Micro Assessment
Risks structure
Audit
Spot Check
Special Audit
Risks models
Global structure of Financial Assurance models