This article describes the steps to upgrade an existing installation of Enterprise Server 8 or Enterprise Server 9 to Enterprise Server 10.x.
Before you start
Before starting the upgrade, make a plan of what is needed:
- Which features of Enterprise Server and its clients do you want to make use of and which additional (third-party) software does this require?
- Is a direct upgrade to the latest Enterprise Server possible?
- Which features and changes have been implemented since the version that is upgraded from?
- What type of access do you want to give each user?
As a starting point, use the Compatibility Matrix to verify if your currently installed operating systems, databases, and other third-party applications require upgrading and what implications this might bring.
Note: It is assumed here that any third-party software is upgraded to a compatible version where needed and is fully working.
Verify the upgrade path to Enterprise Server 10; it may be required to upgrade Enterprise Server to one or more intermediate versions before being able to upgrade to Enterprise Server 10.
Read through the Release Notes to verify if your setup is affected by any new features or changes that have been introduced since the version that you are upgrading from.
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 version (Adobe CC 2018, Adobe CC 2019, Adobe 2020, and so on). 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. Its related functions have been removed since Enterprise Server 10.9.0.
Should you make use of this feature in your current Enterprise Server environment and are upgrading to a version of Enterprise Server in which this feature is no longer supported, perform the following steps:
Step 1. Safeguard the content by either migrating or archiving it.
Step 2. In your original Enterprise Server installation, make sure that 'Overrule Brand' is not selected on the Issue Maintenance pages for any of the Brands.
Step 3. Upgrade your database using the newly installed Enterprise Server (see the instructions later in this article).
Step 4. (For Enterprise Server 10.9 or higher) When the Overruled Issue feature is referenced in custom Enterprise Server plug-ins, do the following:
- Remove the calls to any of the following functions:
|Removed function||Removed from class or module|
- When the following references are used in the plug-in, remove them:
- The OverrulePublication flag on Issue, AdmIssue or Targets > Issue data objects.
- The 'overrulepub' field in SQL.
- The 'issue' field in SQL for the smart_states, smart_publsections and smart_editions tables.
- Note that when integrating your client application through Enterprise Server Web services, that Enterprise Server will:
- Ignore the PublicationOverrule flag in workflow Web service requests and return null in its responses.
- Show an error when the PublicationOverrule flag is set to true when creating or updating Issues through the administration Web services.
Step 1. Creating a backup of Enterprise Server
Create a backup of your system to ensure that no files are lost should anything go wrong during the upgrade process.
Note: The following steps are needed if you want to migrate your existing data storage to the new version. If you have planned to create a brand new data store, these steps can be skipped.
Step 1. Log out all users.
Step 2. Wait until all running Enterprise jobs and InDesign Server jobs are completed.
Step 3. Stop the Web server.
Step 4. Stop Solr.
Step 5. Stop InDesign Servers.
Step 6. Create a backup of the database tables.
Step 7. Create a backup of the File Store folder.
Step 8. Create a backup of the Solr indexes.
Step 2. 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.
- When Elvis is integrated. Support for the import module which was used in previous versions of Enterprise Server for archiving files from Enterprise to Elvis has stopped. As a result, the ELVIS_ARCHIVED_STATUSES option in the config_elvis.php file needs to be removed.
- When MadeToPrint is integrated. The build-in support for the Axaio MadeToPrint integration has been replaced by a dedicated server plug-in. As a result, the setup for the MadeToPrint integrations used in older installations of Enterprise Server is no longer valid.
No automated migration is provided for upgrading the integration. Refer to the configuration and settings of your current Enterprise Server installation to set up the integration in Enterprise Server 10.9. For more information about the new setup, see Integration MadeToPrint in Enterprise Server 10.
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. Install Enterprise Server by performing these steps from the Enterprise Server 10 full installation article:
- Step 4. (Optional, for Enterprise Server 10.1 only) Installing the ExifTool
- Step 5. Installing Enterprise Server
Caution: You must not just copy your old config.php file and configserver.php over the new one, as important modifications have been made which are necessary to run Enterprise.
Tip: (Applies to Enterprise Server 10.1 only) To ease the process of upgrading Enterprise Server installations, manage and configure settings of all configuration files by adding them to a single configuration file.)
Step 2. Open the Solr configuration file on Enterprise Server and make sure that the ‘SOLR_SERVER_URL’ setting points to your Solr environment:
<Enterprise installation directory>/config/config_solr.PHP
define ('SOLR_SERVER_URL', 'http://localhost:8080/solr');
Caution: You must not just copy your old config_solr.php file over the new one, as important modifications have been made which are necessary to run Enterprise.
Note: The remaining settings in this file are needed to fill the Solr environment with Enterprise data and to query these data. This should work out-of-the-box.
Step 3. In Enterprise Server, run the Database Connection test on the Health Check page.
If the database is not up-to-date, you are redirected to the Database - Installation / Upgrade page. Enterprise will automatically detect the current status of the installation and will list the necessary SQL scripts to run.
Step 4. (Optional, only when directed to the Database - Installation / Upgrade page). Review the settings on the page and click Start.
The SQL scripts are executed; Enterprise tables are altered and new tables are created. Because you are upgrading, data will be migrated as well. Each SQL command is echoed to your browser; in case any errors occur, these will be shown in red. After running the scripts, be sure to check for these red errors as they will almost always point out a significant problem, most likely to do with the configuration of either Enterprise or the database.
Step 5. Return to the Health Check page and run the remaining tests. Resolve any conflicts that may arise.
Step 4. Activating the Enterprise license
In order to complete the setup process of Enterprise Server, its license needs to be activated first.
Step 5. Initializing Enterprise Server plug-ins
Much Enterprise Server functionality is provided through plug-ins. These plug-ins need to be initialized first.
Step 1. 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 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.
Step 6. Preparing the Solr environment
The Solr index has to be filled with the characteristics of the Enterprise objects that exist in the database.
Step 1. In the Maintenance menu, click Integrations. A page showing links to integrated services appears.
Step 2. Click Search Server.
The Search Server page appears. It provides an overview of the installed search servers, including the number of Enterprise objects that are indexed for searching. As you are upgrading, the number of indexed objects will be zero.
Step 3. Run an index on the Solr Search Server by clicking the Start button below the Indexing progress bar. The indexing process starts.
Note: The indexing can take a while depending of the number of objects to be handled.
Step 4. Optimize the Solr index by clicking the Start button located below the Optimizing bar.
Step 7. Configuring the InDesign Server installations
The available InDesign Server instances need to be verified in Enterprise.
Step 1. In Enterprise Server, access the Overview of InDesign Servers page.
Step 1a. Click Integrations in the Maintenance menu or on the Home page.
Step 1b. In the InDesign Server Jobs section, click InDesign Servers. The Overview of InDesign Servers page appears.
Figure: The Overview of InDesign Servers page.
Step 2. Click an already installed InDesign Server.
The InDesign Server Maintenance page appears.
Figure: The InDesign Server Maintenance page.
Step 3. Verify that all settings are correct.
Step 8. 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.
Step 9. Upgrading the InDesign and InCopy templates
Upgrade any layout templates or article templates to version CS6, CC 2014 or CC 2015.
Convert any InDesign and InCopy templates that you use to the new version of InDesign and InCopy by opening the file and re-saving it.
Note: Once layouts have been saved to the newer version of InDesign, they cannot be opened in a previous version without converting them to .IDML format. Doing so will remove all links to any placed database files.
Step 10. 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. 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).
- 25 March 2020: Updated section 'Support for Overruled Issues' with information about Enterprise Server 10.9.0.
- 25 March 2020: Added step 2 'Reviewing required and optional steps'.