Action Point Dashboard
  • Action Point Dashboard Documentation
  • INTRODUCTION
    • Glossary / Terminology
    • FAQ
    • Releases / Changelog*
    • Report an Issue / Contact us
  • PRODUCT / END-USER DOCUMENTATION
    • Overview
      • Objectives
      • User roles and permissions
    • Action Points Dashboard Navigation
    • Overall User Interface
    • List of Action Points
    • Action Points Workflow
    • Action Points
      • Creation of Action Point
      • Modification of Action Point
      • Completion of Action Point
      • Additional options for Action Point
    • Connections to other modules
      • Overview
      • Action Points in FAM
      • Action Points in Field Monitoring
      • Action Points in TPM
      • Action Points in Trip Management (T2F)
  • TECHNICAL DOCUMENTATION
    • Architecture
    • Development Setup
    • Deployment / DevOps
    • Data Model
    • Fixtures & management commands
    • API Documentation
      • Error Handling
    • Backend module structure
    • Integration with permissions framework
    • Frontend
      • Module structure
      • Build process
      • Tests
Powered by GitBook
On this page
  • Action Points module files structure
  • action_points.categories app
  1. TECHNICAL DOCUMENTATION

Backend module structure

PreviousError HandlingNextIntegration with permissions framework

Last updated 6 years ago

Action Points module files structure

- categories - nested global application to store list of available categories for action points - export - everything that is related to csv & pdf exports - renderers.py - csv renderers - serializers.py - csv & pdf serializers - management - specific management commands (in our case there is only one command for updating permissions) -migrations - database migrations - notifications - templates for email notifications - tests - tests for models, views, serializers, transitions flow - transitions - everything that is related to fsm transitions - conditions.py - custom checks for transitions (for example in case of submitting report we need to be assured that report attachments exist) - admin.py - admin site definitions for models - apps.py - python app configuration - conditions.py - conditions to perform FSM transitions, see more details - filters.py - rest framework views filters - metadata.py - base metadata class to be used in viewsets. more in - models.py - country-related audit models - serializers- rest framework serializers - signals.py - app signals. custom logic for user deletion; sending notifications in case of assigning action points - urls.py - app urls - views.py - just set of views to work with models

action_points.categories app

To store action points categories which are global, nested application named categories was implemented. Views and serializers are still placed in the parent application to keep consistant place for all module logic.

The App consists of the following parts: - migrations - database migrations - admin.py - admin site config - apps.py - python app config - models.py - partner with their staff members - serializers.py - rest framework category serializer

here
API Metadata section