Plugins

1. Overview

Plugins are external code packages that extend OCCS with additional functionality beyond the system’s core, built-in features. A Plugin is imported into OCCS as a .zip package and, once installed, can be enabled, disabled, updated, or removed by a Super Admin from the Plugins dashboard.

Each Plugin is self-contained and adds a specific capability to the system. For example, the Sms Provider adds the ability to send SMS notifications based on call results.

2. Available Plugins

Plugin Description

Sms Provider

Sends SMS notifications using a configurable template, triggered by specific result codes.

3. Managing Plugins

From the Plugins screen (Plugins in the left-hand navigation of the Super Admin dashboard), a Super Admin can:

  • Import a new plugin from a .zip file

  • Enable / Disable an installed plugin using the toggle switch

  • Update an installed plugin to a newer version by uploading a new .zip file

  • Delete an installed plugin using the bin icon

plugindashboard
Only users with the Super Admin role can access the Plugins section.

4. Steps to Install a Plugin

Follow these steps to install and enable a plugin:

  1. Log in as Super Admin.

    Sign in to OCCS using a Super Admin account.

  2. Open the Plugins section.

    Click the Plugins icon on the left-hand navigation of the Super Admin dashboard.

  3. Import the plugin.

    Click the IMPORT button in the top right corner of the Plugins screen.

  4. Upload the plugin package.

    Drag and drop the provided plugin .zip file into the upload area (or click to upload), then click SAVE.

    Import Plugin screen with a plugin package uploaded and the Save button highlighted
  5. Enable the plugin.

    After saving, the plugin appears in the Installed list. Turn on the toggle switch next to the plugin name to enable it.

    Installed Plugins list showing a plugin with its enable toggle switched on

Once enabled, the plugin becomes active and performs its configured functionality.

5. Updating a Plugin

To update a plugin to a newer version:

  1. Go to Plugins > Installed.

  2. Click UPDATE on the plugin card.

  3. Upload the newer .zip file and save.

6. Deleting a Plugin

To remove a plugin:

  1. Go to Plugins > Installed.

  2. Click the bin (delete) icon on the plugin card.

  3. Confirm the deletion when prompted.