Skip to main content

Reports / Export

Reports/Export

The Reports / Export Page serves as the central hub for generating, managing, and downloading various project reports and data exports. This interface provides a comprehensive job management system where users can initiate export operations, monitor progress in real-time, and access generated files. The system supports configurable export types, backup operations, and project publishing workflows.

Access Requirements​

Required Permissions​

  1. View
  2. Start
  3. Cancel
  4. Remove
  5. Reset Export Sessions

Permission Scope​

  • Project-Based: Access limited to exports within user's assigned projects
  • Role-Based Operations: Different actions available based on user permissions
  • Project State Dependency: Some exports require project to be Closed or Published

Interface Layout​

Main Export Overview​

set minimum version

Key Features​

Export Types & Categories​

  • System Operations:

    • Project Backup: Complete project data backup
    • Project Publishing: Publish project files to production

  • Data Exports (configurable via Export Config in the Settings):

    • Scan Data: Complete scanning records with metadata
    • User Data: User accounts and activity reports
    • Zone Information: Zone configurations and statistics
    • Session Data: Zone session records and analytics

  • Financial Reports:

    • Cost Analysis: Project cost breakdowns
    • Statistical Reports: Performance and efficiency metrics

Job Management System​

  • Real-time Progress: Live progress bars and status updates
  • Job Queuing: Prevents duplicate jobs for same export type
  • Status Tracking: Comprehensive job lifecycle monitoring
  • Error Handling: Detailed error reporting and recovery options

File Management​

  • Automatic Downloads: Direct download links for generated files
  • File Organization: Files grouped by job and export type
  • Multiple Formats: Support for Excel, PDF, CSV, and other formats

Usage Guide​

Starting an Export​

  1. Navigate to Reports & Exports page
  2. Select Export Type from available categories
  3. Configure Variables (if required)
  4. Click Generate to start the export job
  5. Monitor Progress in real-time

Monitoring Export Jobs​

  • Progress Indicators:

    • Running Running: Job is running - shows percentage complete
    • Completed Completed: Job has been completed successfully and it is ready for download
    • Warning Completed with Warnings: Job has been completed with warnings - check details
    • Failed Failed: Job has been completed with errors - review error messages
    • Cancelled Cancelled: Jobs has been manually stopped

  • Job Actions:

    • Cancel: Stop running jobs
    • Remove: Delete completed/failed jobs
    • Details: View logs and error information
    • Reset Sessions: Reset export-related zone sessions

Downloading Reports​

  1. Wait for Completion: Job status shows Completed Completed
  2. Click File Links: Download generated files directly
  3. Multiple Files: Some exports generate multiple formats
  4. File Naming: Files include timestamp and export type

Troubleshooting​

Project must be closed (Error)​

  • Close Project: Change project status to "closed"
  • Check Status: Verify project state in project settings
  • Contact Admin: Request project closure if needed

Export job already running (Warning)​

  • Wait for Completion: Only one job per type allowed
  • Cancel Existing: Cancel running job if needed
  • Check Queue: Monitor job queue status

Permission denied (Error)​

  • Check Roles: Verify required export permissions
  • Project Access: Confirm registration in target project
  • Contact Admin: Request appropriate role assignment

Export failed (Status)​

  • Check Details: Review error logs via Details button
  • Data Validation: Ensure project data integrity
  • Resource Check: Verify server resources availability
  • Retry Export: Attempt export again after issue resolution

Files not downloading​

  • Browser Settings: Check download permissions
  • File Existence: Verify file was actually generated
  • Network Issues: Check internet connectivity
  • Server Access: Confirm file server accessibility