Installing a custom Studio Server plug-in in Studio Server

Info: Performing the step described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

Installing a custom Server plug-in involves adding the plug-in folder to the Server, registering the plug-in in the database, installing and configuring its feature and activating the plug-in.

Note: Installation and configuration of system plug-ins is part of the Server installation steps.

Tip: See these examples of custom Server plug-ins.

Step 1. Add the folder containing the plug-in files to the following location:

<Studio Server path>/config/plugins

Step 2. Apply Read access for the Internet user to the folder and its files.

Step 3. Access the Server Plug-in Maintenance page by clicking Server Plug-ins in the Maintenance menu or on the Home page.

All the newly available plug-ins that are found in the plug-ins folders are registered in the database. Similarly, any plug-ins that are no longer available are unregistered.

Note: In case many plug-ins need to be initialized, the process of opening the page can take a few moments. When the page is loaded, all registered plug-ins are displayed. Each plug-in indicates whether or not it needs to be installed and activated automatically.

The Server plug-in icons indicate the status of the Server plug-in:

Activated. The plug-in is active.

Deactivated. The plug-in is not active.

Error. Errors occurred during the installation.

Step 3. (Optional) Activate any deactivated plug-ins by clicking their icon.