Skip to main content

File List Widget

File List Widget

Overview

The File List widget displays and manages files associated with Things. It provides easy access to documents, images, manuals, certificates and other files related to your IoT devices, all within the dashboard interface.

Use Cases

  • Documentation Access - Quick access to device manuals and guides
  • Certificate Management - Display calibration and compliance certificates
  • Image Gallery - Show device photos or inspection images
  • Report Storage - Access maintenance and inspection reports
  • File Repository - Centralized file management for devices

Key Features

  • File listing with details
  • File upload and download
  • File preview capabilities
  • File type filtering
  • Search and sort functionality
  • Delete and manage files

Configuration

Basic Settings

FieldRequiredDescription
Files❌ NoSelect specific files to display
Search Labels❌ NoFilter files by tags (comma-separated)
Allow Upload❌ NoEnable file upload functionality (default: true)

File Selection

You can populate the File List widget in two ways:

  1. Specific Files - Manually select individual files to display
  2. Search Labels - Use tags to dynamically filter files based on their labels

Note: At least one of Files, Search Labels, or Allow Upload must be configured.

Display Options

FieldRequiredDescription
Border color❌ NoCustom border color

Schema Details

Widget Type: fileList

Config Properties:

  • file (required) - File ID to display
  • imported (required) - Boolean indicating if file was imported

Optional Properties:

  • searchLabels - Comma-separated string of label names for filtering files
  • allowUpload - Boolean to enable/disable file upload (default: false)
  • bgColor - Background color
  • borderColor - Border color

File Management

  • Files must be customer-managed (not system files)
  • Only non-folder files are displayed
  • Files can be added/removed from the widget
  • Upload functionality can be enabled to allow users to add new files directly from the widget
  • Search labels automatically filter files tagged with specified labels

Best Practices

  1. File Organization - Use clear naming conventions for files
  2. Regular Cleanup - Remove outdated files periodically
  3. Access Control - Ensure proper group permissions for sensitive files
  4. File Types - Support common formats for easy access
  5. Widget Size - Size appropriately for expected file count

What's Next?