Plugin Settings¶
How to manage and configure plugins in the LysisAI Platform.
Prerequisites¶
Before you begin
- You are logged in as Administrator
- Only administrators can manage plugins
- Plugins extend the functionality of the platform
What are Plugins?¶
Plugins are modular extensions of the LysisAI Platform:
- Modular Architecture - Independently activatable functions
- Document Management - Extended document management
- Communication - Conversations and messaging
- Individual Customization - Activate only needed features
- Resource Optimization - Deactivated plugins consume no resources
Plugin Overview¶
The LysisAI Platform includes the following core plugins:
| Plugin | Status | Description |
|---|---|---|
| Documents | ✅ Active (Recommended) | Document management, upload, download, categories |
| Conversations | ✅ Active (Recommended) | Messages and conversations between users |
| Notifications | 🔄 Planned | Advanced notifications (In Development) |
| Analytics | 🔄 Planned | Dashboard statistics (In Development) |
Documents Plugin¶
What is the Documents Plugin?¶
The Documents Plugin enables complete document management:
Features: - ✅ Upload documents (PDF, DOCX, XLSX, images) - ✅ Categorize documents - ✅ Organize documents by year - ✅ Full-text search - ✅ Document preview - ✅ Download and sharing
Settings¶
Configure Upload Limits¶
- Go to Settings → Plugins → Documents
- Configure:
Maximum File Size: - Default: 10 MB - Recommended: 10-25 MB - Maximum: 100 MB
Allowed File Types: - PDF (application/pdf) - Documents (DOCX, DOC, ODT) - Spreadsheets (XLSX, XLS, ODS) - Images (JPG, PNG, GIF)
Storage Space per Tenant: - Unlimited (default) - Custom (e.g., 500 MB)
Category Management¶
Define default categories for documents:
Predefined Categories: - Tax Documents - Invoices - Contracts - Accounting - Miscellaneous
Add Categories: 1. Click Add Category 2. Enter a name 3. Optional: Choose color and icon 4. Click Save
Document Preview¶
Configure preview functionality:
Supported Formats: - ✅ PDF - Native browser preview - ✅ DOCX - Converted to HTML - ✅ XLSX - Table view - ✅ Images - Direct display
Settings: - Enable/disable preview - Maximum file size for preview (default: 5 MB) - Enable caching (better performance)
Storage Management¶
Monitor and manage storage space:
Statistics: - Total occupied storage - Storage per tenant - Largest files - Storage by category - Storage trend (last 30 days)
Actions: - Automatic cleanup of old files (optional) - Notification on storage limit - Enable compression (lossless compression)
Conversations Plugin¶
What is the Conversations Plugin?¶
The Conversations Plugin enables secure communication:
Features: - ✅ Direct messages between users - ✅ Thread-based conversations - ✅ File attachments in messages - ✅ Real-time notifications - ✅ Conversation history - ✅ End-to-end encryption (planned)
Settings¶
Message Limits¶
Configure limits for messages:
Maximum Message Length: - Default: 5,000 characters - Recommended: 5,000-10,000 characters
File Attachments: - Maximum size: 5 MB (recommended) - Allowed types: PDF, images, Office documents - Maximum number per message: 5 files
Conversation Limits: - Maximum active conversations per user: Unlimited - Automatic archiving after: 90 days inactivity (optional)
Notification Settings¶
Configure how users are informed about new messages:
In-App Notifications: - ✅ Enabled (default) - Popup position: Top right - Display duration: 5 seconds
Email Notifications: - Immediately (on every message) - Summary (once daily) - Never - Default: Immediately
Push Notifications: - 🔄 Planned (In Development)
Conversation History¶
Manage conversation retention:
Retention Period: - Unlimited (default) - Custom (e.g., 2 years) - After expiration: Automatic archiving or deletion
Archiving: - Automatically archive inactive conversations - Archiving period: 90 days (adjustable) - Archived conversations remain searchable
Export: - Export conversations as PDF - Complete export for compliance - GDPR-compliant deletion on request
Activate/Deactivate Plugin¶
Activate Plugin¶
How to activate a deactivated plugin:
- Go to Settings → Plugins
- Find the plugin in the list
- Click Activate
- The system installs required components
- The feature is immediately available
Activation
Activation may take a few seconds as database migrations are executed.
Deactivate Plugin¶
How to deactivate an active plugin:
- Go to Settings → Plugins
- Find the plugin in the list
- Click Deactivate
- Confirm the deactivation
Caution when Deactivating
Data is preserved, but: - Users can no longer use the feature - Menu items disappear from navigation - API endpoints are no longer available
NEVER deactivate core plugins (Documents, Conversations) if users are actively using them!
Plugin Dependencies¶
Some plugins have dependencies:
| Plugin | Requires | Description |
|---|---|---|
| Documents | - | No dependencies |
| Conversations | - | No dependencies |
| Analytics (planned) | Documents, Conversations | Needs data from both plugins |
Automatic Dependencies
When you activate a plugin, required dependencies are automatically activated as well.
Advanced Settings¶
Plugin Permissions¶
Some plugins allow granular permissions:
Documents Plugin: - Who can upload documents? (Default: Tenants + Employees) - Who can delete documents? (Default: Only Admins + Employees) - Who can manage categories? (Default: Only Admins)
Conversations Plugin: - Who can start conversations? (Default: All roles) - Maximum recipients per conversation (Default: 1) - Allow conversations between tenants? (Default: No)
Plugin API Settings¶
For developers and integrations:
API Access: - REST API enabled (Default: Yes) - API rate limiting (Default: 100 requests/minute) - Webhook support (Default: No)
Developer Mode: - Enable debug logging - Show API documentation - Webhook test tool
Future Plugins (In Development)¶
Planned Extensions
The following plugins are in development:
Notifications Plugin (v3.0)¶
- Advanced Notifications
- Push notifications (browser)
- SMS notifications (optional)
- Slack/Teams integration
- Notification center with history
Analytics Plugin (v3.1)¶
- Dashboard Statistics
- Document upload trends
- Conversation analytics
- User activity reports
- Export as PDF/Excel
Backup & Restore Plugin (v3.2)¶
- Automatic Backups
- Incremental backups
- Cloud backup (Azure, AWS)
- One-click restore
- Disaster recovery
E-Signature Plugin (v4.0)¶
- Digital Signatures
- Sign documents
- Signature workflows
- eIDAS compliance
- Audit trail
Plugin Development¶
Create Custom Plugins¶
Administrators with developer knowledge can create custom plugins:
Plugin Template:
plugins/
└── my-plugin/
├── backend/
│ ├── api.py
│ ├── models.py
│ └── schemas.py
├── frontend/
│ └── components/
└── plugin.yaml
Requirements: - Python 3.12+ (Backend) - React 18+ (Frontend) - Follows LysisAI Plugin API
Plugin Documentation
Detailed documentation for plugin developers can be found in the Developer Docs.
Troubleshooting¶
| Problem | Solution |
|---|---|
| Plugin won't activate | Check dependencies and server logs |
| Feature not visible after activation | Clear browser cache and reload |
| Plugin deactivation fails | Check if other plugins depend on it |
| Settings not saving | Check admin permissions |
| "Plugin not found" error | Plugin may have been deleted - reinstall |
Best Practices¶
Recommended Plugin Configuration¶
- Keep Core Plugins Active:
- Documents and Conversations should ALWAYS be active
-
Only deactivate for maintenance
-
Set Storage Limits:
- Define upload limits per file
- Set total limits per tenant
-
Monitor storage usage
-
Configure Notifications:
- Not too aggressive (avoid spam)
- Let users customize their settings
-
Use summaries instead of individual emails
-
Regular Review:
- Quarterly check which plugins are being used
- Deactivate unused plugins
- Update plugin settings as needed