Page tree
Skip to end of metadata
Go to start of metadata

A plugin allows you to add additional functionality on top of the core Ubersmith system.  Written with the Ubersmith SDK, plugins extend and add features at specific areas in Ubersmith. You can create your own plugin as well as use plugins provided by Ubersmith.  See Creating Plugins for developing and installing plugins, and Enabling Plugins (below), for enabling and configuring . 

Enabling Plugins

Access the Plugins Page

  1. From the Ubersmith Dashboard, click Settings

    The Ubersmith Settings page appears.
  2. From the Global Settings section, from the Customization section, click Plugins . 

    The Plugins page appears.

Complete the Plugin Details Section

  1. On the Plugins page, click the plugin you want to enable. 

    The Plugin page appears.
  2. In the Plugin Details section, click Disabled to toggle the plugin to enabled.

    A confirmation message appears.
  3. Click Yes.
  4. In the Client Access field, select No Access for the plugin to be hidden from the Client Portal, select View for the plugin to be seen from the Client Portal, and Edit for the plugin to be changed from the Client Portal. 

  5. The Hooks and Datasources sections are toggles to either show or hide their respective implemented hooks or data sources used by the plugin.

Complete the Modules Section

Modules configure the plugin’s system hooks. For example, if a module has the brand component, you can add an instance for multiple brands with the same configurations. Alternatively, you can add two separate module instances for two separate brands, each with different configurations. An instance is an entire plugin. You can have multiple instances of a given plugin, each one with different configuration options.

  1. Click add new instance

    The Add New Instance section displays. 
  2. Click Select datasources

    The data sources field expands to list all available data sources
  3. In the Datasources field, select Apply to all to select all listed data sources, or select the individual data sources you want to apply to the plugin. Click in the Datasources field again to toggle it closed.
  4. In the Configuration section, select the appropriate settings for each field. This section displays different fields, based on the enabled plugin. 

  5. Click Save.

Viewing Plugin Usage

  • In the Plugin Usage section, click Show Datasources Used to toggle the data sources used on. This field either shows or hides the data sources used by the plugin.
On this page:

On this page:

Related Topics 

Managing Service Plans