The functionality of Elvis 6 Server and its client applications can be extended through the use of plug-ins. This makes it possible to schedule regularly occurring tasks in Elvis Server, or add buttons, menus or panels to the Pro client and/or the Brand portal.
Using plug-ins in Elvis 6 involves installing them in Elvis Server and subsequently activating them. When they are temporarily not needed anymore, they can be deactivated. This article describes these processes.
Where to get Elvis plug-ins from
Plug-ins contain custom functionality and are typically created whenever the need for that functionality arises. To get you started, various sample plug-ins are available. For more information, see Elvis 6 sample plug-ins.
The plug-in structure
Plug-ins are managed in Elvis Server in the following location:
Elvis Server path > Config > plugins
Notes:
|
The following structure is used:
Folder | Content |
---|---|
active | All currently active plug-ins. |
active/internal | All default internal plug-ins. |
disabled | All plug-ins that should be (temporarily) disabled. |
plugin_base1 | The shared plug-in code base. |
samples | Samples for Scheduled and Active plug-ins. 2 |
1 Do not make modifications to the plugin_base folder; it is completely overwritten each time Elvis Server starts.
2 See Elvis 6 sample plug-ins. Sample Panel plug-ins for the Pro client are available in the Integrations & Samples section on the Help Center (log-in required).
Installation
To install a plug-in, simply place its folder in the following location:
Elvis Server path > Config > plugins > active
Tip: Create subfolders to group or categorize plug-ins.
Note: A valid plug-in folder is one that contains a plug-in configuration file. This configuration file defines the plug-in type. Elvis supports the following types:
|
Activation
After installation, a plug-in needs to be activated.
Step 1. Access the Management console.
Do one of the following:
- Access the following URL and log in using system administrator credentials (a 'Super user' account):
<Elvis Server URL>/console
- Access the Elvis Pro client by accessing the following URL, log in using system administrator credentials, and choose Management Console from the Avatar menu.
<Elvis Server URL>/app
Step 2. From the menu, choose Plugins, followed by Scheduled plugins, Action plugins, Panel plugins or API plugins.
Figure: The Action plug-ins page.
Step 3. In the top right corner of the page, click Scan Elvis Server for plugins.
Step 4. Verify that the added plug-in is listed. In case a warning or error icon is shown, click the plug-in for more details and resolve the issue.
Controlling user access
For those plug-ins in which a requiredRole is defined (such as Action plug-ins and Panel plug-ins), user access to these plug-ins needs to be controlled by setting up the Capabilities for a user or user group.
Deactivation
When a plug-in is not needed anymore, it can be deactivated.
Step 1. Do one of the following:
- Move the plug-in from the 'active' folder to the 'disabled' folder (this makes it possible to easily re-activate it later when needed)
- Completely remove the plug-in from Elvis Server
Step 2. Access the Management console.
Do one of the following:
- Access the following URL and log in using system administrator credentials (a 'Super user' account):
<Elvis Server URL>/console
- Access the Elvis Pro client by accessing the following URL, log in using system administrator credentials, and choose Management Console from the Avatar menu.
<Elvis Server URL>/app
Step 3. From the menu, choose Plugins, followed by Scheduled plugins, Action plugins, Panel plugins or API plugins.
Step 4. In the top right corner of the page, click Scan Elvis Server for plugins. and verify that the removed plug-in is not listed anymore.
Document history
- 8 August 2018: Renamed from 'Elvis 6 plug-ins introduction - management'.
- 8 August 2018: Added section 'Controlling user access'.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
0 comments
Please sign in to leave a comment.