Deploying extensions

Installing an extension is a three-step process:

1. Deploy the extension package
2. Approve and configure the extension
3. Assign user permissions and mappings

Deploying the extension package

Extensions are packaged in zip files, with the type directory in the root, e.g:

• \Query
• \DataProcessing
• \ResultReporting

Packages may contain many extensions, e.g. related query and import extensions. The subfolder is the familiar name of the target system:

• \Query
  • SystemName
    • \...
  • \DataProcessing
    • SystemName
      • \...

• Extract the package and check that the system name doesn’t conflict with any existing extensions.
• Copy the package content into <plugin_home>.

Approving and configuring extensions

Before extensions can be used by users they must be approved by an administrator. The approval is performed against an extension ID and a checksum​. The process of approving extensions is covered in detail here.

Many extensions require additional configuration, for example service URL's and API keys. Extension configuration is covered in detail here.

Assigning permissions and mappings

Extensions require explicit permission to use in OmniFi, either through individual or through group assignment. Further, many extensions are designed to connect to 3'rd party systems and API's, and require additional keys or credentials.

How to assign permissions and mapped credentials is documented in detail here.