Table of Contents
-
Introduction
- Overview of the platform
- Objectives and Goals
- Key Features
- Target Users
- Technology Stack
-
Architecture Overview
- High-level architecture diagram
- Description of each component and its role in the system
- Interaction between different microservices
- Integration points with external systems
-
Data Aggregation and Integration System
-
Public Data Scrapers
- Sources and respective scripts and spiders in use
- For each source
- Supported Inputs and Output schema
- SOP followed to fetch data
-
Data Warehouse and ETL Pipeline
- Sources and respective models depicting the warehouse schema
- For each source
- Approach used to build full database offline
- Ensuring full coverage
- Periodic Incremental Update capability
- Ondemand record syncing capability
-
Data Services
- Overview of Data Services
- Internal Data Services for the Data Warehouses
- Data Services for Live Data Scraping
- 3rd Party Data Services
- Other Data Services
-
-
Report & Analysis Execution System
-
Analysis Services & respective Data Attributes being generated
- Overview of Analysis Services
- Target Overview Analysis
- Financial Analysis
- Media Analysis
- Filing Analysis
- Regulator Checks Analysis
- Risk Scorecard Metrics
- Continuous Monitoring Signals
-
Report Preparation
- Overview of Different Report Types
- Report Configuration and Analyst Inputs
- Report Execution (Analyst Flow)
- Report Preparation Workflows
- Analyst Interface
-
Other Capabilities
- data extraction from mca filings or from any other pdf form
- data extraction from xbrls
-
-
Client App
-
Client Django App and Rest APIs
- Login, Registration
- User Management & Invitaion
- Report Request
- Requesting Reports (User Flow)
- Accessing and Exploring Reports
- TPRM
- Third party list management
- Risk Console - bird eye view of risk scores across all third parties and all risk dimensions
- Third Party Due Diligence and Risk Assessment History
- Continuous Monitoring
- Service Requests, Billing & Payments
-
Micro Apps & Data APIs
- Compliance Toolkit Overview
- Available Micro Apps and their Usage
- Available APIs and their Usage
-
Central Service Gateway and Databridge
-
Platform Development
- Backend Development
- Overview of Python Backend
- Microservices with Nameko Framework (Extended)
- Django Rest Framework Usage
- PostgreSQL Database Management
- Unit Testing with Pytest
- Frontend Development
- Overview of React JS Architecture
- Component Library
- Storybook Testing
- Backend Development
-
Additional Areas
-
Deployment and DevOps
- Containerization with Docker
- Deployment on AWS (EC2, RDS, etc.)
- CI/CD with GitLab
- Supervisord and Poetry Usage
-
Machine Learning Models
- PyTorch for ML Models Training
- Models Overview
- Model Training and Testing Process
-
Data Security and Privacy
- Overview
- Data Storage and Management
- Data Protection Measures
- Data Compliance and Regulation
-
-
Troubleshooting and FAQs
- Common Errors
- Troubleshooting Steps
- Frequently Asked Questions
-
Appendices
- Glossary of Terms
- API Reference Documentation
- Software Licenses and Attributions