Developer Resources FeedUpgrading to Enterprise Edition in IBM LWCM
This document is intended to be a guide for upgrading to EditLive Enterprise Edition (“EE”) for LWCM. The assumption is that you are currently using the OEM Edition (provided by IBM).
Before You Start
Before you begin this process you should make sure you have operating system level access to the LWCM server. Most of the work to be done during the upgrade process is done on the LWCM server at a command line. In addition, make sure you have the following:
Enterprise License Key
The Enterprise Edition download includes a 30 day trial which does not require any license key to be installed. If you are evaluating the Enterprise Edition, you do not need a key and should skip step 4.
Once you have purchased the Enterprise Edition from Ephox, you will be sent (via email) a valid enterprise license key. The key will need to be deployed during the upgrade process in order to have access to the Enterprise Edition features. If you do not have the key please contact your Ephox sales representative.
Quick Upgrade
If you have not customized the OEM edition of EditLive! provided with IBM Lotus Web Content Management, the upgrade process simply requires installing the license key if you have one and running the EditLive! installer. In this case you only need to download the enterprise edition and perform step 4 and step 5 below.
Step 1: Backup key files
In the process of installing the OEM Edition of the integration you may have made some customizations to certain files. If you want these customizations to be available after the upgrade you need to copy the files to a safe location prior to installing the Enterprise Edition version.
Begin by navigating to the directory where the OEM Integration is installed on the LWCM server. This will vary based on Operating System and/or decisions made during the initial install of WebSphere Portal / LWCM. As an example, on a Windows server the correct location would be something like:
C:/Program Files/IBM/PortalServer/installedApps/WCM_Authoring_UI_PA_dmpc04g.ear/PA_dmpc04g.war
(the correct location is the WAR file for the Authoring Portlet)
From this location we need to locate and backup several files that are likely modified during the OEM installation.
/res/editlivejava Folder
This folder contains the configuration file(s) that are in use by EditLive. At a minimum you will want to backup sample_eljconfig.xml - this is the file that is used at runtime to tell the editor which features are enabled.
Note: If you are not using role/group-based configuration the instructions in this next paragraph are not needed.
If you have enabled role/group-based configuration of EditLive you will want to backup a few additional files. The most critical of these files is ephox.config.properties. This file provides the mapping between LDAP Groups and XML configuration files in the /res/editlivejava folder. In addition to this file, make sure you backup any additional xml files located in this folder. It would be prudent to open the ephox.config.properties file with a text editor to see what xml files are referenced - make sure you backup all of the xml files referenced in ephox.config.properties.
/jsp/html Folder
This folder contains the core JSP files that are used at runtime to invoke EditLive. If you have chosen to extend the editor, you may have added custom JavaScript to the jsp/html/customFunctionality.jsp. If you have made any changes to this file please backup this file as you will later need to copy these customizations into the Enterprise Edition installer.
Note: It is recommended you make a copy of all of the Ephox OEM installation folders just in case you forget to back up a specific file. If you have written any of your own custom plugins or other custom extensions we recommend you re-deploy these after you are sure the basic installation of the editor and role/group-based configuration is working.
Step 2: Download Enterprise Edition from Ephox
The Enterprise Edition distribution of the LWCM integration is only available from Ephox - it is not available from the IBM site where you downloaded the OEM Edition. Please download the EditLive! for IBM LWCM Enterprise Edition from the Ephox website.
Step 3: Configure the Enterprise Edition installer
After you have downloaded the Enterprise Edition software, unzip the downloaded software in a temporary folder on the LWCM server. Before we install the Enterprise Edition to the server we need to make sure the customizations backed up in Step 1 are put back in place.
Restore customFunctionality.jsp to Ephox_LWCM_6/web/jsp/html
If you had modified customFunctionality.jsp from the OEM installation, copy these customizations into the customFunctionality.jsp file in the Ephox_LWCM_6/web/jsp/html folder.
Restore ephox.config.properties to Ephox_LWCM_6/web/res/editlivejava
Note: If you are not using role/group-based configuration this step is not needed.
If you are using role/group-based configuration you will need to copy your existing ephox.config.properties file into the Ephox_LWCM_6/web/res/editlivejava folder.
Merge configuration settings
This step is the trickiest portion of the upgrade process. The XML configuration file(s) that you have been using with the OEM Edition do not have the Enterprise Edition features enabled. The sample_eljconfig.xml that is currently in the Ephox_LWCM_6/web/res/editlivejava folder does have all the configuration parameters needed to enable the Enterprise Edition features.
For each of the configuration files you were using before (and backed up in step 1) you will need to create a new configuration file of the same name (but based off the Enterprise Edition sample_eljconfig.xml) and merge in the customizations you made before.
If you are not using role/group-based configuration you likely have only a single file to merge (sample_eljconfig.xml). If you are using role/group-based configuration you will have 2 or more files to merge.
Step 4: Install the Enterprise Edition License
The final step of the process (prior to running the installer) is to place your Enterprise Edition license into each of the XML configuration files in the Ephox_LWCM_6/web/res/editlivejava folder. Installing the license is as simple as copying the contents of your license file (.lic) into each of the XML configuration files.
Open your license file in a text editor
When you purchased EditLive you should have received an email file is the default Configuration File provided by Ephox. The default name of the license file is editlive.lic. When you open this license in a text editor you will find a simple XML file that looks like this:
<ephoxLicenses> <license accountID="123456789100" activationURL="http://www.ephox.com/…" domain="MY.SERVER.COM" expiration="NEVER" forceActive="false" key="8FFF-FFFF-FFFF-FFFF" eqEditor="true" licensee="ME" product="EditLive for Java" release="5.0" type="UNLIMITED" /> </ephoxLicenses>
The <license> section of this file is the portion that we need to “deploy” to your EditLive implementation.
Modify each XML configuration file
Open each of your XML configuration files using a text editor and locate the <ephoxLicenses> element in the configuration file. By default it will look similar to this:
<!-- Add your Ephox-provided license key here --> <ephoxLicenses> <license accountID="BB56B8DD47EF" activationURL="http://www.ephox.com/…" domain="LOCALHOST" expiration="NEVER" forceActive="false" key="6FFF-966C-C34A-3688" licensee="For Evaluation Only" product="EditLive! for Java" release="5.0" seats="" type="Evaluation License" eqEditor="true" /> </ephoxLicenses>
This default license provides you access to the editor when using the host name “localhost”. This license is provided for free and never expires – but limits access to the “localhost” domain. To add your license to the configuration file, copy the <licences> element from the editlive.lic file into the <ephoxLicenses> element, under the current <licences> element. For example, if your editlive.lic file contained the following:
<ephoxLicenses> <license accountID="123456789100" activationURL="http://www.ephox.com/…" domain="MY.SERVER.COM" expiration="NEVER" forceActive="false" key="8FFF-FFFF-FFFF-FFFF" eqEditor="true" licensee="ME" product="EditLive for Java" release="5.0" type="UNLIMITED" /> </ephoxLicenses>
The <ephoxLicenses> element in each of your configuration files should appear as follows:
<!-- Add your Ephox-provided license key here --> <ephoxLicenses> <license accountID="BB56B8DD47EF" activationURL="http://www.ephox.com/…" domain="LOCALHOST" expiration="NEVER" forceActive="false" key="6FFF-966C-C34A-3688" licensee="For Evaluation Only" product="EditLive! for Java" release="5.0" seats="" type="Evaluation License" eqEditor="true" /> <license accountID="123456789100" activationURL="http://www.ephox.com/…" domain="MY.SERVER.COM" expiration="NEVER" forceActive="false" key="8FFF-FFFF-FFFF-FFFF" eqEditor="true" licensee="ME" product="EditLive for Java" release="5.0" type="UNLIMITED" /> </ephoxLicenses>
Step 5: Run the Enterprise Edition Installer
The final step of the process is to follow the install instructions in Ephox_LWCM_6/docs/index.html. These steps will have you modify the build.properties file and run the installer to deploy the Enterprise Edition files to the LWCM server.
It is strongly recommended you use the supplied installation script(s) for Windows or Linux/Unix installations. This is by far the easiest method for installing Enterprise Edition.
Step 6: (Optional) Deploy Custom Plugins
If you have written any of your own custom plugins or other custom functionality we recommend you re-deploy these after you are sure the basic installation of the editor and role/group-based configuration is working. Consult with your developers who created the customizations on how they are to be re-deployed.