Upgrading integrations of Elvis 6 and Enterprise Server 10

With the release of Enterprise Server 10.5.0, significant changes have been made to the way the integration is implemented. Some of these changes affect the way the Content Source plug-in is installed and configured.

Other releases of Enterprise Server also come with important changes to be aware of.

If you are upgrading Enterprise Server 10.0 – 10.4 to version 10.5 or higher and have Elvis integrated, take note of the changes described below.

Plug-in location

In Enterprise Server 10.5 and higher, the Content Source plug-in is shipped as part of Enterprise Server and is therefore also stored in a different location:

Take note of the following:

• As part of the upgrade process, you might be planning to copy any custom plug-ins from the Enterprise/config/plugins/ folder to the same folder in the new installation. When doing so, make sure to not include the Elvis folder.

In other words: the Enterprise/config/plugins/Elvis folder should not exist in Enterprise Server 10.5 or higher.

• The paths that have been defined in the sync.php file for Crontab or Scheduler need to be modified. See 'Setting up the communication between Enterprise and Elvis' below.

Configuration file

The name and location of the configuration file of the Content Source plug-in has changed. However, this should not affect the upgrade process.

Configuration options

The following configuration options have changed:

Content Station 9 integration

Support for integrating the Elvis app in Content Station 9 has been dropped when Enterprise Server 10.5.0 or higher is used. Please be aware that you will loose this functionality when upgrading to Enterprise Server 10.5. Content Station 9 itself can still be used in combination with Enterprise Server 10.5. Adding files from Elvis to Enterprise can then be done by using the Pro client of Elvis 6.

Field mapping

Metadata fields in Elvis are mapped to metadata fields in Enterprise Server to make it possible for metadata changes in Elvis to appear in Enterprise and the other way round.

The configuration for this mapping is done through field handlers. The names of these field handlers have changed.

If you have configured the default field mapping, this needs to be adjusted.

Step 1. Open the Enterprise/config/config_overrule.php file and verify if the following function exists. If it does not exist, add it. When done, leave the file open.

function Elvis_Config_GetAdditionalFieldHandlers()
{
 // Field handler parameters: Elvis fieldname, multivalue field, Elvis data type, Enterprise fieldname
 $cfgFieldHandlers = array();
// Paste it here ....
 return $cfgFieldHandlers;
}

Step 2. Copy the configured fields from your older Enterprise/config/plugins/Elvis/config.php file and paste them to the Elvis_Config_GetAdditionalFieldHandlers function in the Enterprise/config/config_overrule.php file of step 1.

Step 3. Rename the field handlers as shown in the table above.

Step 4. Save the file.

$cfgFieldHandlers = array();

$cfgFieldHandlers['C_BooleanTest'] = new ReadWriteFieldHandler( "cf_BooleanTest", false, "boolean", "C_BooleanTest" );
$cfgFieldHandlers['Comment'] = new ReadWriteFieldHandler("versionDescription", true, "text", "Comment");

function Elvis_Config_GetAdditionalFieldHandlers()
{
 // Field handler parameters: Elvis fieldname, multivalue field, Elvis data type, Enterprise fieldname
 $cfgFieldHandlers = array();
 $cfgFieldHandlers['C_BooleanTest'] = new Elvis_FieldHandlers_ReadWrite( "cf_BooleanTest", false, "boolean", "C_BooleanTest" );
 $cfgFieldHandlers['Comment'] = new Elvis_FieldHandlers_ReadWrite("versionDescription", true, "text", "Comment");

 return $cfgFieldHandlers;
}

Database model

In the Elvis InDesign plug-in that is shipped with Enterprise Server 10.5.2 and 10.6.0, changes to the database model have been made.

Make sure therefore to run the 'Elvis Content Source' test on the Health Check page of Enterprise Server to ensure that the changes are reflected in the database. Follow the suggested steps that are shown in the test results.

Show me how to run the test

Step 1. In Enterprise Server, access the Health Check page.

Show me how

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. At the bottom of the page, click Clear All.

Step 3. Only select the Elvis Content Source test.

Step 4. Click Test.

The test result is displayed.

Step 5. (Optional, only if the test failed). Follow the instructions and run the test once more. Repeat this process until the test is performed successfully.

Enterprise Server Health Check

When running the Elvis Content Source test on the Health Check page of Enterprise Server after upgrading from an older version of Enterprise to version 10.5.x, it might be that a white page is shown and that the following error is logged in the Server Logs:

Cannot declare class WW_TestSuite_HealthCheck2_Elvis_TestCase, because the name is already in use in /var/www/html/Enterprise/config/plugins/Elvis/testsuite/HealthCheck2/Elvis_TestCase.php on line 516
Bad detection of Elvis plugin installed in config/plugins folder. HTTP 500 on Health Check. In php.log there is:
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP Fatal error: Cannot declare class WW_TestSuite_HealthCheck2_Elvis_TestCase, because the name is already in use in /var/www/html/Enterprise/config/plugins/Elvis/testsuite/HealthCheck2/Elvis_TestCase.php on line 516
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP Stack trace:
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP 1. {main}() /var/www/html/Enterprise/server/wwtest/testsuite.php:0
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP 2. TestSuiteFactory::getTestsAsXml() /var/www/html/Enterprise/server/wwtest/testsuite.php:47
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP 3. TestSuiteFactory::readTestObjectsFromFolders() /var/www/html/Enterprise/server/wwtest/testsuite/TestSuiteFactory.class.php:197
[06-Sep-2018 08:53:27 Europe/Amsterdam] PHP 4. TestSuiteFactory::createTestModule() /var/www/html/Enterprise/server/wwtest/testsuite/TestSuiteFactory.class.php:134
[06-Sep-2018 08:53:58 Europe/Amsterdam] PHP Fatal error: Cannot declare class WW_TestSuite_HealthCheck2_Elvis_TestCase, because the name is already in use in

To resolve this, remove the Elvis folder from config/plugins.