What is a Plugin?

A plugin is a software component that adds specific functionality to an existing application, i.e. Znode.

A plugin:

• Acts as an add-on that adds new features or capabilities to Znode.
• Provides a flexible way to customize Znode.
• Leverages Znode services to complete the desired operations.
  
  

A plugin does not: 

• Function independently.
• Modify Znode core code.
  
  

What is a Configuration Set?

A configuration set is a collection of settings that define how an application, i.e. Znode,  behaves and operates.  Each configuration set is a variation of a plugin’s configurable settings. The Znode Admin Plugin management tooling uses the “Configuration Set” terminology to label the different variations of a group of plugin settings.

Why use the label “Configuration Set” instead of “Settings”?  A configuration set is a collection of settings, whereas an individual setting is just a single entity.  Znode uses “Configuration Set” because each set defines the configuration values for a group of related settings.

Browsing Available Plugins

Navigate to: System Settings > Plugins > Available Plugins

Browse to the “Available Plugins” tab to view available plugins to install.  If needed, use the search to search for a plugin name or filter the grid of available plugins by “Plugin Type” to locate a specific type of plugin.  

If the desired plugin is not found in the “Available Plugins” grid, then the plugin has already been installed or is not available for installation.

Browsing Installed Plugins

Navigate to: System Settings > Plugins > Installed Plugins

Browse to the “Installed Plugins” tab to view plugins that are installed into Znode.  If needed, use the search to search for a plugin name or filter the grid of installed plugins by “Plugin Type” to locate a specific plugin.  

If the desired plugin is not found in the “Installed Plugins” grid, then the plugin has not yet been installed.

Activating an Installed Plugin

Navigate to: System Settings > Plugins > Installed Plugins

Once a plugin has been installed to the Znode system, it needs to be configured and activated to be used within Znode.  

Select the plugin to be configured by clicking the Plugin Name link or selecting the gear icon under Action.  Each plugin has a “Plugin Information” tab that describes the plugin that is installed.

Installed Plugin List Details

To enable a plugin, check the “Activate” configuration. To disable a plugin, uncheck the “Activate” configuration. 

Configuration Sets

Each plugin has a “Configuration Sets” tab. A configuration set is a collection of settings that define how an application behaves and operates.  Essentially, each configuration is a variation of a plugin’s configurable settings.  Unless otherwise noted, a plugin can have multiple configuration sets that can be applied to different entities in Znode. 

The data to be configured for each configuration set varies depending on the plugin. Review the plugin specific configuration guidance for specific settings to be configured.

Additional Configuration Tabs

The configuration for a plugin may include more than the “Plugin Information” and “Configuration Sets” tabs in the left-hand navigation.  The additional tabs will be plugin specific and the plugin specific documentation should be referenced for more detail.

Editing an Installed Plugin 

Navigate to:  System Settings > Plugins > Installed Plugins

1. Select the plugin to be edited by clicking the Plugin Name link or selecting the gear icon under Action.
2. The user will default to the “Plugin Information” tab where the plugin can be activated/inactivated.
3. If the user is trying to edit a configuration set for the plugin, browse to the “Configuration Sets” tab in the left-hand navigation.
4. Find the Configuration Set in the grid that needs to be updated and select the “Edit” action. 
5. Edit the configuration values that are not read-only.
6. Save the updates using the “Save” action. The page reloads with the updates.
7. The plugin is now updated.
   
   

Deactivating an Installed Plugin

Navigate to: System Settings > Plugins > Installed Plugins

1. Select the plugin to be edited by clicking the Plugin Name link or selecting the gear icon under Action.
2. The user will default to the “Plugin Information” tab where the plugin can be activated/inactivated.
3. Edit the “Activate” configuration value.
   1. Check the “Activate” configuration to activate the plugin.
   2. Uncheck the “Activate” configuration to inactivate the plugin.
4. Save the update using the “Save” action. The page reloads with the updates.
5. The plugin is now updated.