Info: Some of the described steps can only be performed on the on-premise version of Assets Server, not on the cloud version.
Note: For Assets Server 6.59 and higher, the recommended way of developing and installing plug-ins is by hosting them externally. For more information, see Working with external plug-ins in Assets Server.
The functionality of Assets Server and its client applications can be extended through the use of plug-ins. This makes it possible to schedule regularly occurring tasks in Assets Server, or add buttons, menus or panels in Assets and/or the Brand portal.
Using plug-ins in Assets Server involves installing them in Assets Server and subsequently activating them. When they are temporarily not needed anymore, they can be deactivated. This article describes these processes.
Where to get 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 Assets Server sample plug-ins.
The plug-in structure
Plug-ins are managed in Assets Server in the following location:
Assets Server path > Config > plugins
The following structure is used:
|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 Assets Server starts.
To install a plug-in, simply place its folder in the following location:
Assets 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. Assets Server supports the following types:
After installation, a plug-in needs to be activated.
Step 1. Access the Management console.
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 Assets 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.
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 Assets Server
Step 2. Access the Management console.
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 Assets Server for plugins. and verify that the removed plug-in is not listed anymore.
- 5 January 2021: Renamed from 'Installing and managing plug-ins in Assets Server'.
- 5 January 2021: Added a note about using external plug-ins as the preferred way of adding plug-ins.