Troubleshooting SDL Online Editor issues

A series of items that you need to troubleshoot potential integration issues between WorldServer and SDL Online Editor.

Check the logs of the SDL Online Editor services

By default, these logs are stored in the \bin\logs subfolder of each service. For example, C:\Program Files\SDL\Editor Service Router\bin\logs.

Check the way in which the SDL Online Editor services are configured

If you get a 401 Unauthorized error when trying to open SDL Online Editor, go to C:\Program Files\SDL\Editor Service\bin and open the Sdl.EditorService.Host.exe.config file with a text editor. Then, add http:// or https:// to the value of the RouterUrl property. For example, <add key="RouterUrl" value="http://localhost:90/" />

Check the WorldServer configurations related to SDL Online Editor

These are the configurations that you made when configured WorldServer to connect to SDL Online Editor. You can find each file in the WS_CONFIG folder. Open each file with a text editor.
FilePropertyValue
general.propertiessdl_online_editor_enabledtrue
bcm_service.url<protocol>://<oe_host>:<bcm_port>
sdl_online_editor.url<protocol>://<oe_host>:<oe_port>
bcm_service.use_compressiontrue
ui.propertieses.language_host<oe_host>:<oe_port>
es.router.url<oe_host>:<oe_router_port>

Check WorldServer configurations through wsgate

You can check WorldServer configurations by making calls to various wsgate endpoints. For more information, see the topic about troubleshooting configuration issues in the troubleshooting section.

Check and validate the BCM converter

If you cannot open certain assets in SDL Online Editor and SDL Online Editor has been configured correctly, check the logs and the information in the console. If the information does not help you identify the root cause of the issue, go to the task history in WorldServer and look for the BCM URL of the asset that you cannot open (usually displayed when the Enable Online Editing step is completed). For example: Completed Enable Online Editing step of task 2 in time [00:00:24] on engine [mydemomachine11401:ws-legacy:engine#1] with result Done. Execution output: Enabled online editing for asset [1,766, http://11.234.56.78:8080/bcms/bcm/documents/<unique id>].

Copy the BCM URL and paste it in a new tab or window in your browser.

To run the BCM validator, in the same tab or window, add /validate to the URL between /documents/ and the unique ID and select Enter. For example, http://name.mydomain.com:8080/bcms/bcm/documents/validate/<unique id>.

Modify the logging level through wsgate

To view more information about BCM conversion in your logs, enter the following in your browser's address bar, and then select Enter: <protocol>://<ws-host>:<ws-port>/ws-legacy/ws_gate?action=log&category=<category>&level=<level>&token=<token>

You can replace <category> with one of the following:
  • com.idiominc.ws.storage.BCMReader – for the BCM Reader.
  • com.idiominc.ws.storage.BCMWriter – for the BCM Writer.
  • bcmconversion.BCMConversionLogger – for the BCM Conversion Logger.
The levels are the standard WorldServer logging levels; by default, logging is set to warn, but you should switch to debug when troubleshooting issues.

Configure WorldServer to record requests related to SDL Online Editor in your logs

To make sure that all the requests between SDL Online Editor and WorldServer are recorded in your logs, configure the following properties in the general.properties file (in the root WS_CONFIG folder):
log4j.appender.online_editor.File=<log path>
log4j.appender.online_editor=org.apache.log4j.RollingFileAppender
log4j.appender.online_editor.MaxFileSize=50000KB
log4j.appender.online_editor.MaxBackupIndex=10
log4j.appender.online_editor.layout=org.apache.log4j.PatternLayout
log4j.appender.online_editor.layout.ConversionPattern=[%d] %p %t %c: %m%n

log4j.category.com.sdl.lt.worldserver.service.lp=<level>, online_editor
In this context, <log path> is the path to the log file that records that logs the requests being made between SDL Online Editor and WorldServer and <level> is the logging level of the appender. Use debug if you want to record requests or trace if you want to record both requests and responses.