|This documentation provides details on troubleshooting if any issues are encountered while working with Lotus Web Content Management (WCM) EditLive! Rich Text Editor (RTE).
ShowTable of Contents
Lotus Web Content Management – EditLive! Rich Text Editor Troubleshooting Guide for Common Scenarios.
This documentation provides details on troubleshooting if any issues are encountered while working with Lotus Web Content Management (WCM) Ephox Rich Text Editor (RTE). Below are some of the most common issues reported to Product Support.
How to get EditLive! RTE (Ephox) for WCM
EditLive! RTE is available with WCM 6.1.x or later. Once you upgrade WebSphere Portal / Web Content Management to 184.108.40.206 or later, EditLive! is available out of the box and is ready to use. If you use version 220.127.116.11 to 18.104.22.168, then you must download the EditLive! Editor from the Passport Advantage website and install the Ephox Editor. The recommended approach is to upgrade to 22.214.171.124 or later.
EditLive! Editor displays as trial version
Ensure that the EditLive! RTE is downloaded from the Passport Advantage website and is the IBM-licensed application. Also if you installed the trial version prior to installing the IBM-licensed version, you must uninstall the trial version completely and then install the version downloaded from Passport Advantage website.
Editlive! RTE not available / working after applying WCM cumulative fixes
In version 126.96.36.199 and later, EditLive! RTE is included with the product and is redeployed / updated as part of the update-wcm task executed in the cumulative fix install process. This situation may occur mostly likely with version 188.8.131.52 or earlier. In version 184.108.40.206 or earlier, the update-wcm task redeploys/updates the WCM portlets and as part of this update, the Ephox-related files are deleted. You must redeploy / copy the EditLive! files again as documented in the EditLive! ReadMe file included in the EditLive! RTE download.
After upgrading to 220.127.116.11, Ephox not working.
EditLive! RTE is now completely integrated with WCM and is available out of the box with versions 18.104.22.168 and later. During the 6.10.3 upgrade, the EditLive! Editor is now deployed as a separate application and configured. Post-upgrade, to use the EditLive! RTE, you must access the Configure or Edit Shared settings for the WCM Authoring Portlet and select the Extended Editor in the Rich Text Option section. This should resolve the issue. You do not have to copy any EditLive! files after version 22.214.171.124 as you do in 126.96.36.199 or earlier versions.
Cannot see the option for Extended Editor after upgrading to WCM v188.8.131.52/v184.108.40.206
This is controlled by the property wcm.editor.extended which is set in WAS here:
It is possible that the property did not get set correctly during upgrade. One can confirm this by reviewing the logs __WP_PTF_6104_wp.ptf.config_install.log or __WP_PTF_6104_wp.ptf.config_install.log along with the other logs. Message like below
Result: [wplc-create-res-env-custom-property-directory] (Resource ENV Provider) J2EEResourceProperty property wcm.editor.extended create success.
By manually creating this value as above, restarting the server the issue should be resolved.
Using the EditLive! Editor in local Web content viewer portlets
To use the EditLive! Editor in a local Web content viewer portlet, you must add a new configuration parameter to the portlet configuration:
1. Go to Administration > Portlet Management > Portlets.
2. Open the Web content Viewer portlet in configuration mode.
3. Type WCM_RICH_TEXT_EDITOR in the New Parameter field.
4. Type /wps/ephox;/jsp/html/EditLiveJavaEditor.jsp in the New Value field.
5. Click Add.
6. Click OK.
Ephox Editor and JSR 286 Local Rendering Portlet / Inline edit.
When rendering an Authoring Tool component / using Inline edit with JSR 286 Web content viewer portlet, if any issues occur with Inline edit / EditLive!, then ensure that the reserved authoring portlet is configured and available. Refer to the following link in the Information Center for more details:
If the reserved authoring portlet or the hidden portlet page are removed inadvertently, you can deploy them again using the action-install-wcm-hidden-authoring configuration task. Once the hidden portlet page is available and the RTE is set to extended editor, any content when edited using Inline edit or the Authoring tool
component will be edited with EditLive!.
How to disable the Click-to-Edit feature so that the Edit applet loads automatically
The feature that causes you to click into the editor before using it is an EditLive! feature called Inline editing. Inline editing was implemented for two reasons. First, if content creators do not want to modify the rich text, they do not have to wait for the editor to load. Second, many clients have as many as 7 or 8 rich text fields in a single form. In these situations, Inline editing eliminates the need to wait for all 7 or 8 rich text fields to load in parallel. This significantly improves the load time of the Authoring template. At this time, it is not possible to disable this feature.
How to get latest version of Editlive!
EditLive! RTE is now completely integrated with WebSphere Portal / Lotus Web Content Management 6.10.3 or later versions. Once you install Fixpack 3 or higher, EditLive! 7.x is readily available out of the box. The WCM Cumulative Fix also contains updates to Editlive. If you are in 220.127.116.11 or 18.104.22.168, you can get PM28339 from IBM Support Site that contains the latest version of Editlive!. Recommended approach is to upgrade to latest version of WCM.
How to customize the EditLive! RTE
EditLive! RTE can be customized to display only the needed Menu or Styles for different users / group. The EditLive! Developer Documentation provided details for customizing Editlive.
ephox.config.properties can be edited to specify which config file to use when the Ephox is loaded based on who the users is or which groups the user belongs to by addding additon entries like below
- Configuration files for users
- Configuration files for groups
ephox.config.properties, For WCM 22.214.171.124 & later, it is in \wp_profile\installedApps\
|\EphoxEditLive.ear\EphoxEditLive.war\res\editlivejava. For WCM 126.96.36.199 & 188.8.131.52 it is in \wp_profile\installedApps\||\PA_WCM_Authoring_UI.ear\ilwwcm-authoring.war\res\editlivejava & \wp_profile\installedApps\||\PA_WCMLocalRendering.ear\ilwwcm-localrende.war \res\editlievjava (Required if using Inlineedit)|
For 184.108.40.206 and 220.127.116.11, the default config file used is ibm_eljconfig.xml and 18.104.22.168 and later it is ibm_eljconfig.xml.jsp. Would recommend to make a copy of this file, and then refer to the sample_eljconfig.xml for available option and customize as needed. The sample config file is just a template for reference If you replace to use the sample, then you point to Evaluation Copy / License and not the IBM one. It is recommended to use the sample as a template, but do a save as of the config file IBM uses and then customize it, if there is a need to have different config files. The config file also contains the license information and the IBM default had the details to get that from the Portal / WCM install binaries in the server.
The EditLive! Developer Documentation section in the Infocenter, does not specifically refer the config file ibm_eljconfig.xml or ibm_eljconfig.xml.jsp, but refers to sample_eljconfig.xml in all places.
Also the location for customFunctionality.jsp is \wp_profile\installedApps\
|\EphoxEditLive.ear\EphoxEditLive.war\jsp\html for 22.214.171.124 and later. The customized version of the files needs to be copied each time after applying cumulative fix or a fixpack, since the config task executed as part of install re-deploys the application and any customization will be lost. |
Data to collect to troubleshoot Ephox-related issues.
If you need assistance from IBM Product Support on any Ephox-related issue, collect the logs and debug data listed in below link
Ephox® EditLive! OEM Edition for IBM® Lotus Web Content Management (WCM) version 6.1,” and send to Product Support
WCM technotes that may be useful