Overview
Plugins are encapsulated solution components, it can embrace displays, scripts, symbols, templates, and more. When integrated into solutions, they can operate in a read-only mode, ensuring that the original configurations remain intact. On the software platform, users encounter two distinct interfaces concerning plugins:
Solution/Import Plugin: Here, users manage the plugins integrated into their existing solution.
Solution/Export: This interface is designated for the creation of new plugins, catering to evolving needs and functionalities.
On this page:
Importing a Plugin
On Project Settings → Import Plugin, you find all the information required to import a component into your project. Once you have an exported item from any other project, you will be able to import it in your own project.
On the top of the display, you will find these buttons:
| Components functions and options | |
|---|---|
| Refresh | Refreshes the display; updating the grid with all the components that can be imported into the project. |
| Clear Cache | Clear the component cache. |
| Add Component | This button opens the “Add Component” display where you can configure the properties of the component. This display allows you to select if the component will be an embedded component or if it will be added as a manageable plugin. |
| Edit Component | This button allows editing of the pre-created component, but it will not be possible if the “Contents Hidden” option was used to create it. In the grid below these buttons, you will find all the components already exported and some information about them |
| Show plugins from local folder | Directly searches the directory for any pre-built components available on your computer. |
| Show components from Cloud | This list can contain any pre-created component available in your computer or in the Cloud. |
Note Item
If the component has been exported using the “Force as Plugin” option, the “Add as component” option (embedded in the project) will not be able to be selected.
| Add component popup window | |
|---|---|
| Component | Name of the component |
| Add and merge to project | Select if the component will be an embedded component. |
| Add as Plugin | If it will be added as a manageable plugin. |
| Components grid on the project | |
|---|---|
| Name | The name of the component. |
| Preview | A preview image that represents the component. |
| Source | The location of the component; it can be Local or in the Cloud. |
| Version | The version of the component (e.g.: 0). |
| Product Version | The version of the product used to create the component (e.g.: fs- 8.1.1). |
| Plugin Installed | A check that represents if there are available updates for the plugin. |
Installed Plugins
On Run → Extensions → Installed PlugIns, you find information about the pre-installed plugins in the project.
On the top of the display, you will find four buttons:
| Installed Plugins functions and options | |
|---|---|
| Refresh | Refreshes the display; updating the grid with all the items that had already been imported into the project. |
| Update | Search for updates in the Plugin, based on the version number. |
| Remove | Remove the plugin and dependencies from the project. |
| Import and Merge | If the plugin has not been created with the option "Force as Plugin" enabled, so you can convert the plugin into a component and merge it into your project. |
In the grid below these buttons, you will find all the components already exported and some information about them.
Component information | |
|---|---|
| Name | The name of the component. |
| Preview | A preview image that represents the component. |
| Source | The location of the component; it can be Local or in the Cloud. |
| Version | The version of the component (e.g.: 0). |
| Has Update | A check that represents if there are available updates for the plugin. |
Creating a New Plugin
Creating a new component or plugin is a very interesting feature if you have different projects that require similar structures/functionalities. The first step in this process is to create a new project that only contains the elements required to fulfill the desired purpose.
Once you have the project working, go to Project Settings → Export. On the top of the display, you will find five buttons:
| Export functions and options | |
|---|---|
| Refresh | Refreshes the display; updating the grid with all the items that can be exported from the project. This list can contain scripts, tags, tables, devices, and any other pre-built item on your project. |
| Check Selected Items | Check all the pre-selected items on the grid. You can use both the SHIFT and CTRL keys to select one or more items. The checked items will be exported at the end of the process. You can manually check them. Then, go to the “Export” column and edit it. |
| Uncheck Selected Items | Uncheck all the pre-selected items on the grid. You can use both the SHIFT and CTRL keys to select one or more items. The unchecked items will not be exported at the end of the process. You can manually uncheck them. Then, go to the “Export” column and edit it. |
| Export to Component | This button opens the “Make new component” display, where you can configure the properties of the component. |
Save as Text File | Export the components as a XML file while keeping the structure and information about the component. |
When exporting tags also export | The tags created on the project can be used in many different configurations on the system; such as Alarms, Historian, and Devices. To include these configurations when you export a tag, you have three checkboxes: Alarm Items: Include the pre-configured alarm items for the specified tag. Tag Historian: Include the pre-configured tag historian information for the specified tag. Device Points: Include the pre-configured device points for the specified tag. |
Auto Check Dependencies | When you use the checkbox “Auto Check Dependencies”, whenever an object is checked, any secondary dependency on this object like tags, templates, images, will be checked too. |
Under this display you have:
| Create a new component | |
|---|---|
| Name | The name of the component to be exported. |
| Force as Plugin | Force the component to be a plugin, instead of a default component. |
| Contents Hidden | Hides the contents of the component; this means that this component cannot be edited once its imported to a new project. |
| Preview | A preview image that represents the new component. |
| Version | The version of the new component (e.g.: 0). |
| Description | Description of the component being created. |
In this section: