WoodWing Help Center

Plug-ins introduction - management

Elvis 5 plug-ins introduction - management

All plug-ins are located in the <Elvis Config>/plugins folder, this folder and its contents are available after the Elvis server service is started for the first time. The plug-ins folder contains several sub folders:

  • active - all activated plug-ins
  • active/internal - all Elvis default internal plug-ins
  • disabled - all disabled plug-ins
  • plugin_base - shared plug-in codebase
  • samples - all default bundled plug-ins

Please take note of the following:

  • Do not make modifications to the plugin_base folder, it will be completely overwritten each time the server starts.
  • The path to the plug-in folder must be identical on each node in the cluster.

A valid plug-in is a folder that contains a plug-in configuration file. This configuration file defines the plug-in type, Elvis supports two types:

The entire plug-in configuration is in this single configuration file in most cases.

Plug-in admin

Plug-ins can be managed via System > Manage plug-ins.

This admin section shows status info for activated plug-ins, per plug-in type. All plug-ins and all web access configuration files can be reloaded from disk using Reload All plug-ins.

For manual execution of schedule plug-ins, select a schedule plug-in and choose Execute Schedule plug-in.

The Manage plug-ins screen in the Elvis Client

Activating plug-ins

  1. Copy a plug-in folder to the active folder, either in the root or any subfolder.
  2. Configure the plug-in, the schedule plug-ins and action plug-ins configuration articles provide detailed info.
  3. Go to the plug-in admin (System > Manage plug-ins) and reload all plug-ins.
  4. Check the plug-in's details in the admin to verify that it is correctly loaded without errors or warnings.

Tip: Sub folders can be used to group or categorize plug-ins.

Deactivating plug-ins

  1. Remove the plug-in from the active folder or move it to the disabled folder.
  2. Go to the plug-in admin (System > Manage plug-ins) and reload all plug-ins.

Document history

  • 6 October 2016: Added that the path to the plug-in folder must be identical on each node in the cluster.
Was this article helpful?
1 out of 1 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Article is closed for comments.