Overview
Plugins are encapsulated solution components that can include Import Plugin allows you to add pre-built, self-contained solution components (plugins) into your current solution. Plugins can contain tags, displays, scripts, symbols, templates, and more. They can either be imported as a read-only, allowing for easy removal and update of plugins or as a merge, fully integrating the plugin into the solution and allowing the user to edit all components that come with the plugin. To know more about exporting/creating plugins, click here.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
and other configuration objects.
Access: Solution → Import Plugin
Parent Page: Solution Settings & Tools (Reference)
Plugin Interface
Import Controls
| Control | Function | Notes |
|---|---|---|
| Browse | Select plugin file | .plugin or .dbplugin files |
| Preview | View plugin contents | Before import |
| Options | Import settings | Override behavior |
| Import | Execute import | Adds to solution |
| Cancel | Abort operation | No changes |
Plugin Information Display
| Field | Description | Example |
|---|---|---|
| Name | Plugin identifier | HMI_Standards_v2 |
| Version | Plugin version | 2.1.0 |
| Author | Creator | Engineering Team |
| Description | Purpose and contents | Standard HMI templates |
| Created | Creation date | 2024-01-15 |
| Platform | Compatibility | Multiplatform |
Plugin Contents
Supported Objects
| Object Type | Imported | Notes |
|---|---|---|
| Tags | Yes | Including templates |
| Displays | Yes | With all graphics |
| Scripts | Yes | Classes and tasks |
| Symbols | Yes | Custom symbols |
| Images | Yes | Embedded resources |
| Reports | Yes | Report definitions |
| Datasets | Partial | Structure only |
| Devices | Optional | Configuration only |
Dependencies
| Dependency Type | Handling |
|---|---|
| Internal | Automatically resolved |
| External Tags | Warning if missing |
| Templates | Created if needed |
| Categories | Created if missing |
| Symbols | Imported with plugin |
Import Process
Step 1: Plugin Selection
| Action | Result |
|---|---|
| Browse to file | Loads plugin metadata |
| Validate plugin | Checks compatibility |
| Display info | Shows plugin details |
Step 2: Conflict Resolution
| Conflict Type | Options | Default |
|---|---|---|
| Duplicate Name | Skip/Replace/Rename | Skip |
| Version Conflict | Keep/Update | Keep current |
| Template Mismatch | Merge/Replace | Merge |
| Category Missing | Create/Skip | Create |
Step 3: Import Options
| Option | Description | When to Use |
|---|---|---|
| Preserve IDs | Keep original IDs | Never (automatic) |
| Update Existing | Overwrite objects | Updating plugin |
| Create Backup | Backup before import | Always recommended |
| Import History | Track in history | Always enabled |
Plugin Types
Standard Plugins
| Type | Contents | Purpose |
|---|---|---|
| HMI Templates | Displays, layouts | UI standards |
| Equipment Models | Tags, templates | Asset definitions |
| Communication | Device configs | Standard protocols |
| Reports Pack | Report templates | Standard reports |
| Script Library | Functions, classes | Reusable code |
Industry Plugins
| Industry | Typical Contents |
|---|---|
| Water/Wastewater | Pump controls, SCADA displays |
| Oil & Gas | Pipeline monitoring, tank farms |
| Manufacturing | OEE, production tracking |
| Building Automation | HVAC, lighting controls |
| Power Generation | Grid monitoring, load management |
Version Management
Version Compatibility
| Plugin Version | Solution Version | Compatible |
|---|---|---|
| Same major | Same major | Yes |
| Older major | Newer major | Usually |
| Newer major | Older major | No |
| Any | Same platform | Check |
Update Process
| Step | Action | Location |
|---|---|---|
| Check version | Compare to installed | History page |
| Backup solution | Create safety copy | Export |
| Update plugin | Import new version | Import Plugin |
| Verify changes | Review modifications | History |
Plugin Registry
Installed Plugins
Tracked in Solution History:
| Information | Purpose |
|---|---|
| Plugin Name | Identification |
| Version | Version tracking |
| Install Date | When imported |
| Objects Added | What was imported |
| Update Available | Newer version exists |
Plugin Sources
| Source | Description | Access |
|---|---|---|
| Local Files | On disk | Browse |
| Network Share | Shared folder | UNC path |
| Plugin Library | Company repository | Configured path |
| Vendor | Third-party | Download |
Creating Plugins
Plugins are created using Export:
| Step | Action | Result |
|---|---|---|
| Select objects | Check items | Marked for export |
| Set metadata | Name, version, author | Plugin info |
| Export as plugin | Choose plugin format | .plugin file |
| Document | Add description | Usage guide |
Best Practices
Before Import
- Backup solution
- Review plugin contents
- Check version compatibility
- Verify dependencies
- Test in development
During Import
- Use preview feature
- Handle conflicts carefully
- Document changes
- Keep import log
- Monitor errors
After Import
- Verify functionality
- Test all features
- Update documentation
- Train users
- Track version
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Can't import | Wrong version | Check compatibility |
| Objects missing | Dependencies | Import dependencies first |
| Conflicts | Duplicate names | Use rename option |
| Plugin corrupted | Bad file | Get new copy |
| Update fails | Objects modified | Manual merge needed |
See Also
- Solution Settings & Tools (Reference) - Parent section
- Solution Export (Reference) - Creating plugins
- Solution History (Reference) - Plugin tracking
Importing a Plugin
In Solution / Import Plugin, you find all the information required to import a component into your solution. Once you have an exported item from any other solution, you will be able to import it in your own solution.
Import plugins options
Merge to the Solution
Fully merges the plugin into the solution, allowing the user to edit the plugin’s components directly in the Solution Designer.
Add as Read-Only Plugin
Imports the plugin in an encapsulated manner. Ensures the possibility to safely remove or update them later.
Plugin search options
Show plugins from local folder
Directly search the directory for any pre-built components available on your computer.
Show plugins from Cloud
Shows the solution components available on the Cloud.
Plugins info
Name
The designated title assigned to the plugin.
Preview
A preview image that represents the plugin.
Source
Specifies where the plugin is stored, either locally, in solution or on cloud-based storage.
Date modified
The most recent date when changes were made to the plugin.
Version
The current release number of the plugin indicating its development stage or iteration.
Product version
Specifies the version of the product on which the plugin was based.
ReadOnly
This attribute indicates whether the plugin's settings or configurations can be altered.
Locked
Completely restricts access to the plugin in Designer, preventing users from viewing or modifying its configuration. The plugin remains fully functional at runtime.
Description
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|