Adding Custom Applications to Studio

Info: The described steps can only be performed on the on-premise version of Studio, not on the cloud version.

One of the ways of adding custom functionality to Studio is by adding Custom Applications. These are accessed through the Applications menu and — as is the case with the default applications such as the Publication Overview and the Trash Can — run in a full Studio window, including a header and a Back button.

Actions can be performed within the application through the use of parameters.

Example: You can add custom reports based on data from Studio Server, display external sources, and so on.

Samples

To get you started, 2 simple samples are provided (see the contentstation > sdk > samples folder).

Sample 1 contains a page with some text and a button in the header that displays a message when clicked.

Sample 2 contains a page with a button that displays some random parameters on the page. The header contains two buttons: one that displays a message and another that updates text on the page.

How Custom Applications are accessed

Users access a Custom Application through the Applications menu in the top right corner of the page.

Custom Applications are automatically added to the menu below the default applications (as defined in the config.js file).

How Custom Applications are provided

Custom Applications should be provided in the form of a javascript plug-in.

Where to get Custom Applications from

Custom Applications need to be created or obtained yourself; they are not provided by WoodWing.

Creating a Custom Application

To help you create your own plug-ins, an SDK and sample files are available in the following location:

• Content Station folder > sdk

It contains the following files and folders:

• content-station-11-sdk.md. The SDK describing the available options that can be implemented.
• plugins.md. Sample code showing how to enable plug-ins in Studio
• samples. Folder containing some example plug-ins. See the SDK for more information.

The process

The process of creating and adding a plug-in is as follows:

Step 1. Create the plug-in by following the instructions in the SDK.

Step 2. Place the plug-in in the following folder (optionally in a subfolder of this folder):

• Content Station folder > sdk

Step 3. Enable the plug-in in Studio by opening the contentstation > config.js file and adding a reference to the plug-in in the plugins section. For details about how to configure this, see the plugins.md file in the sdk folder.

Step 4. Save the file.

Step 5. Log in to Studio — or refresh the page when you are already logged in — and test the working of your plug-in.