This article describes the steps that need to be followed to upgrade an existing installation of Enterprise Server 10. For example, from Enterprise version 10.0.0 to version 10.0.1, to version 10.2.x, and so on.
Note: Make sure to read the Release Notes that accompany the minor upgrade for any important installation or configuration details.
Before you start
Before you start the process of upgrading to a new version, please check the Compatibility Matrix to see if 3rd-party software also need to be upgraded or updated. This is especially true when upgrading from Enterprise Server 10.0 or 10.1 to version 10.2. Significant changes to the Elvis integration have been made in Enterprise Server 10.5.0.
Also closely follow the Enterprise Server Release Notes for any important installation or configuration details.
Upgrading InDesign and InCopy
When you are upgrading to a new version of Adobe InDesign or InCopy, keep the following in mind:
- All InDesign and InCopy users should use the same Adobe CC version. This is because documents created in a newer version cannot be opened in a previous version.
- Convert any InDesign and InCopy templates to the new version of InDesign and InCopy. Do this by opening the file and re-saving it.
Support for Overruled Issues
Support for the Overruled Brand feature (used in print publications, also known as the 'Overruled Issues feature') has been dropped since Enterprise Server 10.7.0.
Should you make use of this feature in your current Enterprise Server environment, do the following before upgrading to Enterprise Server 10.7.0 or higher:
- Safeguard the content by either migrating or archiving it.
- Make sure that 'Overrule Brand' is not selected on the Issue Maintenance pages for any of the Brands.
1. Creating a backup
Create a backup of your system to make sure that no files are lost should anything go wrong.
2. (Optional) Installing and configuring the ExifTool
When images are uploaded, Enterprise Server extracts metadata. This metadata is used for populating basic metadata fields (such as author, credit, format, and so on), as well as specific fields such as width and orientation (used for cropping images).
For best results, the ExifTool needs to be installed and optionally configured.
Note: This step is only required when upgrading from Enterprise Server 10.0.x to 10.1 or higher; the ExifTool cannot be used in combination with Enterprise Server 10.0.x and is already installed for Enterprise Server 10.1 or higher.
Step 1. Download the ExifTool and install it in a preferred location.
Note: For Mac OS X and Linux, the default installation path is assumed to be: /usr/local/bin.
Step 1a. In "C:/Program Files", create a folder named "ExifTool".
Step 1b. Extract the downloaded file, for example to your Downloads folder.
Step 1c. Copy the file named "exiftool(-k).exe" to the "C:/Program Files/ExifTool" folder.
Step 1d. In that folder, rename "exiftool(-k).exe" to "exiftool.exe".
Step 2. (Optional. Only if you have installed ExifTool in an alternate location.) Note down the path to the installation, it is used for configuring Enterprise Server in a later step.
Info: This feature requires Enterprise Server 10.5.4 or any higher version of Enterprise Server 10.5.
The order in which image properties are resolved can be based on the metadata containers (such as 'Exif', 'XMP', an 'IPTC') that are extracted by the ExifTool application.
Different metadata containers can contain different values for the same image attribute.
Example: 'Credit' => [ 'IPTC', 'XMP' ] means that first the 'IPTC' metadata container is used to resolve the 'Credit' attribute. If this gives a result, the 'XMP' container is ignored. Only in case of no result is the 'XMP' container used.
To do this, configure the following option:
- File: config_overrule.php file
- Name of option: EXIFTOOL_METADATA_ORDER
- Possible values: See below.
Uncomment the attribute and change the order of the containers as needed.
3. Reviewing required and optional steps
Depending on the version of Enterprise that you are upgrading from or to, some additional steps may be need to be performed.
Review the following information and implement when necessary.
- RabbitMQ integrations. In previous versions of Enterprise Server 10.1, RabbitMQ queue names used the following format:
In Enterprise Server 10.1.10 and any other higher version of Enterprise Server 10.1, this has changed to the following format:
To make sure that no orphaned queues exist after the upgrade, run the RabbitMQ test on the Health Check page in your current installation.
- RabbitMQ integrations. In Enterprise Server 10.2.0, RabbitMQ queue names used the following format:
In Enterprise Server 10.2.1 and any other higher version of Enterprise Server 10.2, this has changed to the following format:
To make sure that no orphaned queues exist after the upgrade, run the RabbitMQ test on the Health Check page in your current installation.
- Enterprise Server plug-ins. Enterprise Server requires PHP 7.2 and does not support PHP 7.1. Should you have any custom Enterprise Server plug-ins, do the following.
- Scan the plug-ins for PHP 7.2 changes as listed in the PHP documentation.
- Scan the plug-ins for usages of the "Object" class and rename "Object" to "WflObject".
- Publication Channels. Support for Publication Channels (a feature of Content Station 9) has been marked as deprecated in Enterprise Server 10.6.0. Customers are advised to move to publishing using Content Station Aurora instead. Before upgrading to Enterprise Server 10.6.x or 10.7.x, do the following in your current instance of Enterprise Server:
- Remove (or archive, or un-publish) all workflow objects (Publish Forms, articles, images, and so on) that were published to the following channels:
- Drupal 7
- Drupal 8
- Remove the above mentioned Publication Channels from the Brand Maintenance page on which they are configured.
- Clear the Trash Can.
- HTML Link Files. Support for the HTML Link Files feature has been dropped in Enterprise Server 10.6.0. Before upgrading to Enterprise Server 10.6.x or 10.7.x, remove the following in your current instance of Enterprise Server:
- The HTML Link Files feature from your configserver.php or config_overrule.php files
- The /<FileStore>/_BRANDS_ folder that contains the HTML files
4. Installing the new Enterprise Server
Note: In most production environments, the new Enterprise server is initially installed next to the existing server so that the new setup can be tested before it is made live. For this explanation therefore, the current Enterprise Server will initially be left intact and a new Enterprise Server will be installed separately.
Step 1. Download the Enterprise Server application from the software release page.
Note: The name of the file is EnterpriseServer_10.x.x_Buildyy.zip, where "x" stands for the Server version number and "y" for the build number. For example: EnterpriseServer_10.0.0_Build100.
Step 2. Unzip the file.
A folder named 'Enterprise' is created containing files such as index.php, index.html, index.htm.
Step 3. Copy the complete Enterprise folder to the server machine’s Web root folder (such as webroot).
Step 4. Configure Enterprise Server by doing one of the following:
- (Optional, for Enterprise 10.1.x only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.
- (Optional, for Enterprise 10.1.x only) When upgrading from Enterprise 10.1 on which the overrule_config.php file is used, copy this file over to the new Server.
- For all configuration files in the <Enterprise Server path>/config folder (such as config.php, configserver.php, config_solr.php), compare the settings in the files of the new installation with those of the old installation and update the new version where needed.
Caution: You must not just copy your old configuration files over the new ones, as important modifications may have been made which are necessary to run Enterprise 10.
Step 5. (Optional. This step is only required when configuring Enterprise Server 10.1; this option is not used in Enterprise Server 10.0.) Verify the following option of the ExifTool in the configserver.php file:
5. (Optional) Installing Content Station 9 Web and / or Content Station Aurora
Do one of the following:
- When Content Station 9 Web or the Multi-Channel Text Editor in Content Station 9 is used: install Content Station 9 Web in Enterprise Server.
- When Content Station Aurora is used, install it in Enterprise Server. When Content Station Aurora is already installed you can optionally also copy the following folders from your current Enterprise Server 10 installation:
- <Enterprise Server folder>/contentstation
- <Enterprise Server folder>/config/plugins/ContentStation
Note: Make sure that Content Station Aurora is configured correctly so that it points to the correct URL of Enterprise Server.
6. Activating licenses
In order to complete the setup process of Enterprise Server, licenses need to be activated first.
7. Initializing Enterprise Server plug-ins
Initializing the Enterprise Server plug-ins is necessary because much of the functionality of Enterprise Server is based on the functionality of Server plug-ins. During the initialization process, the available Server plug-in folders are accessed and the plug-ins that are found are added to the database.
Step 1. (Optional) Copy any customized Server plug-ins from the current Server to the new upgraded Server. Location:
- For custom plug-ins: <server path>/config/plugins
Step 2. In Enterprise 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 3. 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.
8. (Optional) Updating the Elvis integration
When upgrading to Enterprise Server 10.5.0 or higher, be aware that significant changes have been made to the Elvis integration. As a result, Enterprise Server 10.5 or higher is only compatible with Elvis 6.18 or higher and require different configuration steps.
When you have Elvis integrated, please see Integrating Elvis 6 in Enterprise Server 10.5 or higher.
9. (Optional) Updating the Drupal 8 integration
Performing the following steps is only required when all of the following is true:
- You are upgrading from Enterprise Server 10.1.8 or lower to 10.1.9 or any higher version of 10.1.x.
- A Drupal 8 integration is used for publishing to a Web CMS.
- A 'Database Error S1004' appears when publishing to a Drupal site that is configured in two Publication Channels, each for a different Brand.
Step 1. Access your database and empty the tables 'smart_terms' and 'smart_termentities'.
TRUNCATE TABLE `smart_terms`
TRUNCATE TABLE `smart_termentities`
For MS SQL:
TRUNCATE TABLE [smart_terms]
TRUNCATE TABLE [smart_termentities]
Step 2. In Enterprise Server, import the taxonomies for all Drupal 8 channels.
10. Testing Enterprise Server
The setup is now ready to be tested.
Step 1. Open a Web browser and enter the URL for the installed Server.
The log in screen appears.
Step 2. Log in using your admin credentials.
The main screen appears.
When you are not able to log in, for instance because of an incorrect configuration, access the Health Check page by entering the following URL in your Web browser:
Continue with Step 2.
Step 1. Access the Health Check page.
Step 1a. In Enterprise Server, click Advanced in the Maintenance menu or on the Home page. A page with all advanced Maintenance features appears.
Step 1b. Click Health Check. The Health Check page appears.
Step 2. (Optional) In case not all licenses are activated yet, clear the check box for Licenses.
Step 3. (Optional) For those systems or features which are not installed yet (such as LDAP, Drupal, and so on), clear their check boxes.
Step 4. Click Test.
The test(s) are executed and the results are displayed next to each test. They should all display “OK”.
Note: If a test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.
11. Taking the new Server into production
When upgrading Enterprise Server you very likely installed the new Server next to the existing Server so that it could be tested before it is ready to take into production.
As soon as everything is found to be in order, the new Server will have to be made live at some stage. This can be done in one of the following ways:
- Replace the full folder content of the old (current production) Enterprise Server with the full folder content of the new Enterprise Server.
Note: Make sure that the INETROOT option in config.php is updated correctly.
- Remove the old (current production) Enterprise Server folder and rename the new Enterprise Server folder so that it matches the name of the old (current production) Enterprise Server folder.
- Keep the newly created folder and provide all administrators with the new URL and update the WWSettings.xml files for the client application users with the new path to the Server. When Content Station Aurora is used, make sure that it is configured correctly so that it points to the correct URL of Enterprise Server. Once the new Server is taken into production, you might want to remove the old server installation.
Note: Switching from the “old” environment to the “new “environment should be done when no user is logged in. Furthermore it is preferable that the “old’ environment is cleaned (for example: see if there are any objects which can be removed, and subsequently empty the Trash Can. For more information about cleaning up the system, see Deleting an Issue and Permanently deleting files from Enterprise Server 10).
- 1 October 2019: Renamed section 'Reviewing optional steps' to 'Reviewing required and optional steps'.
- 1 October 2019: Updated section 'Reviewing required and optional steps' with references to Enterprise Server 10.7.x.
- 10 September 2019: Updated section 2 'Installing the ExifTool' by adding configuration steps.
- 14 August 2019: Added section 'Support for Overruled Issues'.