Managing Server plug-ins in Studio Server

Much of the Studio Server functionality is provided through plug-ins. Managing these plug-ins is done on the Server Plug-in Maintenance page. It can be accessed by clicking Server Plug-ins in the Maintenance menu or on the Home page.

This article describes how to manage these plug-ins.

Activating a deactivated Server plug-in

To activate a deactivated Server plug-in, click its icon. It should automatically be activated.

Deactivating an active Server plug-in

To deactivate an active Server plug-in, click its icon. It should automatically be deactivated.

Registering Server plug-ins

Before Studio Server plug-ins can be used, they need to be registered. During this process, the available Server plug-in folders are accessed and the plug-ins that are found are added to the database.

Step 1. In Studio Server, click Server Plug-ins in the Maintenance menu or on the Home page.

The Server Plug-ins page appears and any installed plug-ins will be automatically registered.

Note: Because the plug-ins are registered while the page is opened, the process of opening the page can take a few moments.

Step 2. Make sure that the required plug-ins are enabled. If needed, resolve any conflicts.

Note: Normally, no conflicts should arise and no further action will be required after accessing the page.

Configuring a custom Server plug-in

Info: Performing the described step 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.

Some custom Server plug-ins provide configuration options that can be set in a config.php file (recommended: config_overrule.php file).

They can also add their own Maintenance page on which specific actions can be performed. When a custom Server plug-in for which such a page is available is installed or activated, an icon is automatically added to the Integrations page. Double-clicking the icon opens the Maintenance page for that plug-in.

Note: For more information about configuring custom Server plug-ins, see the readme.txt file that is provided with the plug-in.

Styling your code

Info: This feature requires Studio Server 10.34.0 or higher.

The coding for PHP modules in Studio Server is styled in the PSR-12 coding style. This style is automatically applied to the entire code base of Studio Server using the PHP CS Fixer tool. The tool itself is shipped with Studio Server and can be found in the server/vendor/bin folder.

For consistency and readability reasons you may want to apply the PSR-12 code style to your custom server plug-ins as well. Do this as follows:

Step 1. Set up Studio Server and install your plug-in.

Step 2. Make a safety backup of your plug-in.

Step 3. Open a terminal or command prompt.

Step 4. Enter the command below and replace the [YOUR_PLUGIN] placeholder with the actual internal name of your plug-in and execute the command:

./server/vendor/bin/php-cs-fixer fix ./config/plugins/[YOUR_PLUGIN] --rules=@PSR12 --verbose

Step 5. Change code style settings in your favorite IDE or code editor into PRS-12.

Disclaimer: WoodWing does not provide development support applying code styling, but with the above information you should be able to make your custom plug-ins consistent with Studio Server.