Plugin Configuration

Certain plugins may have configuration settings. Settings of each plugin are available as a separate context within Drivers/Plugins container.

There are two types of configuration settings:

• Global settings. Each plugin has a single set of settings within an Iotellect Server.

• Per-user settings. There is a separate set of per-user settings for every system user.

To implement global configuration of your plugin, override globalInit(Context) method. Its implementations should call createGlobalConfigContext(Context, boolean, VariableDefinition...) and provide VariableDefinition's of global settings. These settings will be exposed to system administrators, their values get persisted in the database.

To access setting values from any method of the plugin, retrieve global config context using getGlobalConfigContext(), then call Context.getVariable() to fetch instances of DataTable representing setting values.

Use globalDeinit(Context) method to deinitialize the plugin.

Implementation of a per-user configuration is very similar to global settings. userInit(Context) and userDeinit(Context) methods should be implemented for managing plugin's configuration. Call createUserConfigContext(Context, boolean, VariableDefinition...) to add per-user configuration variables. Use getUserConfigContext(String) to access per-user configuration context for a specified username.

Was this page helpful?

Tell us more

Send

Thank you!