Upgrading an existing installation of Studio – Home

Info: The information in this article only applies to the on-premise version of Studio, not to the cloud version.

This article describes the required steps for upgrading an existing Studio installation to a new version of Studio.

Before you start

Before upgrading, please read the Release Notes for any important changes or upgrade instructions. Verify this for all versions that were released after the version that you have currently installed.

Performing a minor upgrade of Studio

This involves the following steps:

Downloading the new files
Upgrading Studio
Upgrading the Studio plug-in for Studio Server
(Optional) Upgrading the Desktop Application
Testing the installation

1. Downloading the new files

Download the new version of Studio and the Studio Server plug-in from the Software Release page (either the latest version or an intermediate version made available in an announcement).

2. Upgrading Studio

Step 1. For reference purposes, access the configuration settings of your current Studio installation. Do this by opening the following file and copying the content to a temporary text file:

<Studio Server path>/contentstation/config.js

Step 2. Remove Studio by removing the folder named 'contentstation' from the root of your Studio Server installation.

Step 3. Unzip the downloaded version of Studio and place the extracted folder named 'contentstation' in the root of your Studio Server installation.

Step 4. Open the following file and update the settings with the settings from the reference file created earlier:

<Studio Server path>/contentstation/config.js

Caution: Do this by comparing the files to find the differences. You must not just copy your old configuration settings over the new ones as important modifications may have been made.

Step 5. Save the file.

3. Upgrading the Studio plug-in for Studio Server

Tip: To ease the upgrading process of the Studio plug-in, store all modified configuration settings in the config_overrule.php file of Studio Server instead of in the config.php file of the plug-in itself. This way, only the plug-in needs to be replaced without having to update its configuration file.

Step 1. (Optional, only when the settings are not stored in the config_overrule.php file) For reference purposes, access the configuration settings of your current Studio plug-in installation. Do this by opening the following file and copying the content to a temporary text file:

<Studio Server path>/config/plugins/ContentStation/config.php

Step 2. Remove the currently installed Studio Server plug-in by removing the folder named 'ContentStation' from the following folder of your Studio Server installation:

config/plugins

Step 3. Unzip the downloaded version of the Studio Server plug-in and place the extracted folder named 'ContentStation' in the config/plugins folder of your Studio Server installation.

Step 4. (Optional, only when the settings are not stored in the config_overrule.php file) Open the following file, update the settings with the settings from the reference file created earlier.

<Studio Server path>/config/plugins/ContentStation/config.php

Caution: Do this by comparing the files to find the differences. You must not just copy your old configuration settings over the new ones as important modifications may have been made.

Step 5. Log in to Studio Server, access the Server plug-ins page and verify that the plug-in named 'Studio' is enabled (as indicated by a green icon). When a red icon is shown, click it to enable the plug-in.

4. (Optional) Upgrading the Desktop app

the Desktop application is used for setting up the communication between Studio and other applications and for controlling some of the features of the Desktop app itself (For more information, see Using the Desktop app of Studio.)

When the Desktop app is already installed and a new version of the Desktop app and/or the Chrome extension is made available, perform the steps below.

Upgrading the Desktop app

Step 1. Quit the Desktop app by right-clicking the icon in the system tray (Windows) or menu bar (Mac OS) and choosing Quit.

Step 2. Install the new version by following the general installation steps. During this process, overwrite the already installed version when asked to.

Step 3. Start Chrome and start the Desktop app. It will connect to Chrome and detect that the Chrome extension is already installed; it will not offer to install it.

Upgrading the Chrome extension

No steps are required for upgrading the Chrome extension, it is automatically updated by Chrome.

5. (Optional) Create Component Sets and assign them to Digital article templates

Component Sets control which components a user can make use of in the article, how these components look and how they work.

Component Sets are made available for a Digital article by assigning them to the template on which a Digital article is based when it is created.

Create as many Component Sets as needed and assign them to the Digital article template in which the set of components need to be available.

Note: When a Digital article is based on a template which does not have a Component Set assigned, the user is asked to choose one when the article is opened. Note that users may not be familiar (enough) with Component Sets to make a correct choice, so it is advised to add a Component Set to each Digital article template.

6. Testing the installation

Step 1. Access the Health Check page in Studio Server.

Step 2. Click Clear All to deselect all selected tests.

Step 3. Select the following tests:

InDesign Server / CS Editor
Studio

Step 4. Click Test.

The test results are displayed next to the test and should display OK.

Note: If the test fails, an error is displayed together with instructions for how to solve it. Follow the instructions to fix the issue and then run the test once more.

Step 5. Access Studio by entering the following URL in a Web browser:

<Studio Server URL>/contentstation

Example: http://127.0.0.1/StudioServer/contentstation

Step 6. Test the installation by performing tasks that are part of the daily workflow such as creating an article, checking-out a layout or image, and so on.

Step 7. (Optional, only when you are seeing unexpected results) Clear the Web browser cache, close the tab in which Studio is run and access it again.

Revisions

2 September 2020: Corrected the path of the config.php file.