Skip to main content

Plugin Management

How to extend platform functionality and integrate third-party systems?

Typical scenarios:

  • Need to add features not available in the platform, extend platform capabilities
  • Need to integrate internal systems, achieve data interoperability
  • Need to customize data processing logic to meet specific requirements
  • Need to quickly validate new features, develop as plugins first

Plugin management is designed to solve these problems. Through installing, enabling/disabling and uninstalling plugins, or integrating third-party systems, it extends platform functionality, supporting permission types and project scope settings.

Plugin Management

Quick Start: Install Your First Plugin​

Step 1: Select Plugin​

  1. Go to Plugin Management page
  2. View available plugin list
  3. Select plugin to install
  4. View plugin description and features

Step 2: Install Plugin​

  1. Click "Install" button
  2. Configure plugin parameters (if needed)
  3. Set permission types and project scope
  4. Confirm installation

Step 3: Enable Plugin​

  1. After installation completes, plugin is disabled by default
  2. Click "Enable" button to enable plugin
  3. Verify plugin functionality
  4. Start using plugin

Plugin Management​

How to Install Plugins?​

Installation Steps:

  1. Go to Plugin Management page
  2. Select plugin to install
  3. Click "Install" button
  4. Configure plugin parameters:
    • Permission Type: Set permissions needed by plugin
    • Project Scope: Select projects plugin applies to (global or specific projects)
  5. Confirm installation

After Installation:

  • Plugin will appear in plugin list
  • Default is disabled
  • Need to manually enable to use

How to Enable/Disable Plugins?​

Enable Plugin:

  1. Find plugin to enable in plugin list
  2. Click "Enable" button
  3. Plugin starts running
  4. Verify plugin functionality

Disable Plugin:

  1. Find plugin to disable in plugin list
  2. Click "Disable" button
  3. Plugin stops running
  4. Plugin configuration will be retained

Use Cases:

  • Enable: Enable plugin when needed
  • Disable: Disable plugin when temporarily not needed, retain configuration
  • Switch: Can switch between different plugins

How to Uninstall Plugins?​

Uninstallation Steps:

  1. Find plugin to uninstall in plugin list
  2. Ensure plugin is disabled
  3. Click "Uninstall" button
  4. Confirm uninstallation operation

⚠️ Note: Uninstalling plugins will delete plugin configuration and data, please operate with caution.

Plugin Configuration​

How to Configure Plugin Permissions?​

Permission Types:

  • Data Access Permissions: Control which data plugins can access
  • API Call Permissions: Control which APIs plugins can call
  • System Operation Permissions: Control which system operations plugins can perform

Configuration Method:

  1. Set permissions in plugin configuration
  2. Select needed permission types
  3. Set permission scope
  4. Save configuration

How to Set Project Scope?​

Project Scope:

  • Global: Plugin applies to all projects
  • Specific Projects: Plugin only applies to selected projects

Setting Method:

  1. Select project scope in plugin configuration
  2. If selecting specific projects, select projects to apply
  3. Save configuration

Usage Recommendations:

  • General features set as global
  • Project-specific features set as specific projects
  • Test plugins can be set as specific projects first

Third-Party System Integration​

How to Integrate Third-Party Systems?​

Integration Methods:

  • API Integration: Integrate third-party systems through API interfaces
  • Data Synchronization: Synchronize data from third-party systems
  • Feature Extension: Extend functionality of third-party systems

Integration Steps:

  1. Prepare API keys or configuration information for third-party systems
  2. Create integration plugin in Plugin Management
  3. Configure connection parameters
  4. Test connection
  5. Enable integration

How to Manage Integration Configuration?​

Configuration Management:

  • Connection Configuration: Configure connection information for third-party systems
  • Synchronization Settings: Set data synchronization frequency and methods
  • Permission Configuration: Configure access permissions for integrated systems

Management Method:

  1. Manage integration settings in plugin configuration
  2. Update connection parameters
  3. Adjust synchronization settings
  4. Test integration functionality

Common Questions​

What to Do When Plugin Installation Fails?​

Troubleshooting Steps:

  1. Check if plugin file is complete
  2. Check if plugin version is compatible
  3. View error logs to understand failure reason
  4. Contact plugin developer for help

How to Update Plugins?​

Update Method:

  1. Find plugin to update in plugin list
  2. Click "Update" button
  3. Upload new version plugin file
  4. Wait for update to complete

What to Do When Plugins Affect System Performance?​

Optimization Methods:

  1. Disable unnecessary plugins
  2. Check plugin configuration, optimize parameters
  3. Contact plugin developer to optimize performance
  4. Consider using lighter alternatives

Applicable Roles​

Administrator​

You can:

  • Install and manage all plugins
  • Configure plugin permissions and project scope
  • Integrate third-party systems
  • Monitor plugin operation status

Project Manager​

You can:

  • Install project-specific plugins
  • Configure project-specific plugin settings
  • Manage project plugin usage

After completing plugin management, you may also need: