Introduction to the Plugin Gallery
The Plugin Gallery is the place where you can see which potential Plugins are available for your app, which plugins and plugin versions you have installed, and update versions where required, configure the fields of each individual plugin within your app, etc...
The plugin gallery is accessed via the app family screen, by clicking on the "Plugin Configuration" button from the side menu of each individual app version:
Clicking on the "Plugin Configuration" button, launches the Plugin Gallery screen for the particular app version.
This means that changes/additions/etc... conducted in the plugin gallery that was opened, will Only affect this specific app version.
Note that the shortcut from the UIB’s left menu which enabled to configure plugins on an general App-Level, instead of a version-specific level, has been removed. Plugin management is available only in the context of a specific version.
Action required modal
Upon entering the Plugin Gallery, you will be prompted by an "Action Required" screen, in the event that one or more of your plugins, requires attention (elaborated below). The following modal will be displayed:
As can be seen, the screen will be prompted with 3 options:
1) Update to recommended version (x.x.x) -
This option shall be available for plugins who's currently installed version, IS compatible with the App's SDK, BUT there is another NEWER compatible version. In that case, it’s possible to choose to update to the latest supported version, remove the plugin or skip action.
2) Remove -
This option shall be prompted for plugins who's currently installed version, IS NOT compatible with the App's SDK, and there is no other compatible version. In this case, the optional actions are to Remove the plugin or Skip action.
You can select the different options for all plugins that appear in the modal. Clicking on the “Apply” button, will execute all of the selected actions in one shot!
You can always return to the "Attention Required" screen modal, by clicking on the Attention Required triangular indicator, at the top-right corner of the plugin gallery screen:
Let’s take a quick tour into the Gallery grid view.
(1) Installed plugins and all plugins tabs:
Switching between "Installed Plugins" and "All Plugins", will filter the plugins in the view according to the selection, making it easy see what’s installed and what else is available to install.
(2) Plugin block:
The Plugin block hosts a cover image, plugin name, a short description and the following labels:
- Installed - indicates the plugin is added to this version along with the version number.
- Update available - indicates a newer plugin version is available.
- Update required - indicates the currently installed version is not compatible with the SDK version that will cause the next build to fail.
- Need to be Removed - indicates the currently installed versions is not compatible with the SDK and there is no other available plugin version; if not addressed, the next build will fail.
Use this filter to view plugins according to categories. Combined with the installed/all tabs results in a powerful filter. You can also search for plugins within each category, by entering its' name in the "Filter Plugins" search bar.
The plugin view
Clicking on any plugin, will open a new window with the Plugin View.
The plugin view offers comprehensive information as well as a standardised Configuration Pane, where you can set all of the plugin configurations (where relevant), for the specific app version you are working on.
(1) Action button:
- Add - in case of an uninstalled plugin.
- Remove - in case of an installed plugin.
(2) Markdown compatible information pane:
- Developers' note: this view can be a principal medium to describe the plugins, provide guidance, requirements, change log, preview images, known issues and answers to frequently asked questions and contact information. Please use this to provide answers and reduce Support load.
(3) Configuration pane (see image below):
- Allows the selection of the plugin version (where available).
- Enables plugin level configuration (see developer’s documentation to learn more about plugin vs. instance configuration)
Learn how to take advantage of all those new features with the elaborate developers' documentation.
This document will clearly guide you how to create plugin configurations, instance configurations, configuration sections, preview media, and much more.