DocsOmniFi APIsChangelog
SkySparcContact UsLog In
Docs

Folder structure

All extensions are collected in a root folder configured in the bootstrap configuration file as ExtensionDirectory, or OmniFi installation directory\Plugins by default. We will refer to this directory as the <plugin_home> directory from here on.

Each type of extension has a sub-folder in the root directory:

Extension typeFolder
Query<plugin_home>\Query
Import<plugin_home>\DataProcessing
Result reporting<plugin_home>\AutotestResult
Workflow<plugin_home>\Workflow

Predefined extension folder structure.

Within these folders you can maintain any folder structure you prefer. The custom folder structure will be visible to end users and affects portability of your extensions. (Please see also Best practices for more details).

In addition, there are several folders containing supporting elements:

FolderComment
<omnifi_home>\PythonContains the default Python installation
<omnifi_home>\lib\PythonContains the OmniFi python extensibility API libraries.
<omnifi_home>\Plugins\EnvironmentsContains python environment configuration files.
📘

Note that workflow extensions only install under OmniFi Web. Please see instructions for deploying workflow extensions.

Relocating plugins

The <plugin_home> directory is configurable per installation, in the bootstrap.config file.

<Bootstrap 
    CallbackStartPort="1695" 
    CallbackPortCount="5"
    ExtensionDirectory="<Custom path>">

Did this page help you?