Skip to main content

Document Management

The Document Management module handles file storage and management across PulseCRM.

Overview​

This module provides:

  • File storage and organization
  • Document categorization
  • Access control
  • Version tracking
  • Metadata management

Core Components​

Key Tables​

files​

Primary table for file information:

- id: Primary key
- name: File name
- type: File type
- size: File size
- path: Storage path
- metadata: File metadata
- created_at: Creation timestamp
- updated_at: Last update timestamp

applicationDocuments​

Maps documents to applications:

- file_id: Reference to files
- application_id: Reference to applications
- category: Document category
- status: Document status
- required: Required flag
- created_at: Creation timestamp

Features​

File Management​

  • Upload handling
  • Storage organization
  • Access control
  • Version tracking
  • Deletion management

Document Categories​

  • Application documents
  • Merchant documents
  • Support documents
  • System documents
  • Compliance documents

Metadata Management​

  • Document properties
  • Category information
  • Status tracking
  • Relationship mapping
  • Access controls

API Endpoints​

File Management​

Upload File​

POST /api/files/{table_name}/{id}

Multipart form data:

  • file: File data
  • category: Document category
  • metadata: Additional information

Response:

{
  "id": "string",
  "name": "string",
  "type": "string",
  "size": "number",
  "url": "string",
  "metadata": {
    "category": "string",
    "status": "string",
    "tags": ["string"]
  }
}

Get File​

GET /api/files/{table_name}/{id}/{file_name}

Returns file data with appropriate headers.

Document Management​

List Documents​

GET /api/files/{table_name}/{id}

Query Parameters:

  • category: Filter by category
  • status: Filter by status
  • type: Filter by file type

Update Document Status​

PATCH /api/files/{table_name}/{id}/{file_name}

Update document status:

{
  "status": "string",
  "metadata": {
    "reviewed": "boolean",
    "notes": "string"
  }
}

Document Categories​

Application Documents​

  • Business licenses
  • Financial statements
  • Tax returns
  • Bank statements
  • Identification documents

Merchant Documents​

  • Processing statements
  • Equipment contracts
  • Support documents
  • Compliance certificates
  • Communication records

System Documents​

  • Templates
  • Policies
  • Procedures
  • Reports
  • Logs

Storage Management​

File Organization​

  • Hierarchical structure
  • Category-based storage
  • Access-based organization
  • Version management
  • Archive handling

Storage Types​

  • Local storage
  • Cloud storage
  • Secure storage
  • Archive storage
  • Temporary storage

Version Control​

  • Version tracking
  • Change history
  • Rollback capability
  • Audit logging
  • Access tracking

Security​

Access Control​

  • Permission-based access
  • Role-based access
  • User-level permissions
  • Group permissions
  • Temporary access

Data Protection​

  • Encryption at rest
  • Secure transmission
  • Access logging
  • Backup management
  • Retention policies

Compliance​

  • Data protection
  • Retention requirements
  • Access controls
  • Audit requirements
  • Security standards

Best Practices​

  1. File Management

    • Consistent naming
    • Proper categorization
    • Regular cleanup
    • Version control
    • Access review

  2. Storage

    • Space monitoring
    • Backup verification
    • Archive management
    • Performance optimization
    • Security checks

  3. Access Control

    • Permission review
    • Access monitoring
    • Audit logging
    • Security updates
    • Policy enforcement

  4. Compliance

    • Retention policies
    • Security standards
    • Access controls
    • Audit trails
    • Documentation

Integration Points​

Application Processing​

  • Document requirements
  • Status tracking
  • Access management
  • Workflow integration
  • Notification handling

Merchant Management​

  • Document storage
  • Access control
  • Version tracking
  • Status management
  • Archive handling

Compliance Management​

  • Document retention
  • Access control
  • Audit logging
  • Policy enforcement
  • Report generation

File Operations​

Upload Process​

  1. File validation
  2. Virus scanning
  3. Metadata extraction
  4. Storage allocation
  5. Access configuration

Download Process​

  1. Permission verification
  2. Access logging
  3. File retrieval
  4. Delivery method
  5. Activity tracking

Archive Process​

  1. Retention check
  2. Access verification
  3. Storage transition
  4. Metadata update
  5. Notification handling