Skip to main content

Database

Database

The Database page serves as the central management hub for generating, distributing, and maintaining SQLite databases used by mobile scanning devices. This specialized interface provides comprehensive database lifecycle management, from initial generation through device deployment and updates. The system automatically creates compact, optimized databases containing match data, product information, and configuration settings tailored for offline scanning operations.

The Database Module operates with integrated components for complete database management:

  • Database Generation: Automated SQLite database creation from project match data
  • Device Distribution: Streamlined database deployment to scanning devices and device groups
  • Version Management: Job tracking, progress monitoring, and database lifecycle control

Access Requirements​

Required Roles​

  • View Databases
  • Generate Databases
  • Cancel Generation
  • Remove Databases
  • Import Databases

Permission Scope​

  • Project-Based: Database operations limited to user's assigned projects
  • Role-Based Features: Advanced features available based on role level
  • System-Level Access: Import operations require system-level permissions

Database Page Interface Layout​

Main Database Overview​

database

The match database name is part of the project and is verified by the Android app during the login process.

Database Page Usage Guide​

Getting Started with Database Generation​

  1. Navigate to Database page via main navigation menu
  2. Review Match Database: Check current project match database name
  3. Check Record Counts: Review available match records per database type
  4. Select Database Type: Choose appropriate type for generation needs
  5. Monitor Generation: Track progress and download completed databases

Generating Databases​

  1. Standard Generation:

    • Review match record count for database type
    • Click Generate button for standard SQLite generation
    • Monitor progress with real-time percentage updates
    • Wait for completion (typically 2-10 minutes depending on data size)

  2. Android-Optimized Generation (Super Admin):

    • Click Generate Android for Android-optimized databases
    • Enhanced optimization for Android scanning devices
    • Improved performance on mobile hardware
    • Same monitoring process as standard generation

  3. Monitor Generation Progress:

    • Real-time progress bar with percentage completion
    • Background job processing without blocking interface
    • Error handling with detailed failure messages
    • Automatic notification upon completion

Managing Generated Databases​

  1. Download Databases:

    • Wait for Completed status in generation history
    • Click Download button to get compressed database file
    • Save database file for distribution or backup
    • Verify file integrity before deployment

  2. Job Management:

    • Cancel: Stop running generation jobs
    • Remove: Delete completed/failed jobs and associated files
    • History: Review generation history and timestamps
    • Error Review: Check failure details for troubleshooting

Device Distribution (Super Admin Only)​

  1. Select Target Devices:

    • Choose device group from left panel
    • Review devices in selected group
    • Check upload status and progress for each device
    • Verify devices are available for upload

  2. Upload to Individual Devices:

    • Click Upload for specific device
    • Monitor upload progress percentage
    • Use Cancel to stop uploads if needed
    • Confirm successful installation

  3. Batch Upload to Groups:

    • Select device group
    • Click Upload All for group-wide deployment
    • Monitor progress across all devices in group
    • Use Cancel All to stop group upload if needed

Understanding Database Status Indicators​

  • Record Count: Number of match records available for database generation
  • Running Running: Database generation in progress with percentage complete
  • Completed Completed: Generation finished successfully, ready for download
  • Error Failed: Generation encountered errors and stopped
  • Cancelled Cancelled: Generation was manually stopped by user
  • Download Download Available: Compressed database file ready for download
  • Progress Upload Progress: Device upload progress percentage
  • Completed Upload Complete: Database successfully installed on device

Troubleshooting​

Common Database Generation Issues​

Invalid database name Error​

  • Project Configuration: Verify project has valid database name configuration under Match Data category
  • Database Settings: Check project database settings in configuration under Match Data category
  • Name Format: Ensure database name follows required naming conventions
  • Admin Contact: Request database name setup from administrator

Database generation failed Status​

  • Data Integrity: Verify match data is complete and valid
  • Resource Availability: Check server resources (memory, disk space)
  • Record Count: Ensure sufficient match records exist for generation
  • Error Logs: Review detailed error messages in job failure details

No match records Warning​

  • Data Import: Ensure match data has been imported into project
  • Type Configuration: Verify match type is properly configured
  • Data Validation: Check that imported data passed validation
  • ScanFlow Setup: Confirm ScanFlowConfig includes required match types

Generation already running Message​

  • Wait for Completion: Only one generation per type allowed at once
  • Cancel Existing: Cancel running job if needed to start new generation
  • Check Progress: Monitor existing job progress before starting new one
  • Job Queue: Wait for current job to complete before queuing new one

Device Distribution Issues (Super Admin)​

Upload failed Error​

  • Device Connectivity: Verify target device is online and accessible
  • Database Availability: Ensure generated database file exists
  • Network Connection: Check network connectivity to devices
  • Device Storage: Confirm sufficient storage space on target device

Device not responding Status​

  • Device Status: Check if device is powered on and connected
  • Network Issues: Verify network connectivity between server and device
  • Device Software: Ensure device has compatible scanning software
  • Retry Upload: Attempt upload again after connectivity is restored

Database Performance Optimization​

  • Generate During Off-Peak: Schedule generation during low system usage
  • Monitor Record Counts: Large databases may require more time for generation
  • Regular Cleanup: Remove old database files to maintain performance
  • Batch Device Updates: Update device groups during maintenance windows