WorldServer - Unable to login to WorldServer following upgrade to 11.x - WorldServer API not available!


Following an upgrade to 11.x, the user is unable to login to WorldServer and the login screen displays the error message World Server API not available!

Note: When this error appears it is necessary to get the ws-legacy/login to work correctly before addressing the new UI error. Correcting the failure for the legacy view should resolve the new UI.


The ws.log file shows an error indicating the file cannot be found. Here is an example of the error (the path will vary):

E:\app\Idiom\WorldServer\tomcat\webapps\WS_CONFIG\ (The system cannot find the file specified)

Root Cause:

Root Cause 1:
The database had not been upgraded and the schema was incorrect or still at an earlier version.

Root Cause 2:
The files aren't properly configured or the database property settings are incorrect

Root Cause 3:
The database connection isn't configured properly in
Resolution for Root Cause 1:
Run all the database upgrade scripts to upgrade the WorldServer database to the installed version.

Resolution for Root Cause 2:
There are two possible causes for this scenario.

1- Per the WorldServer documentation in the section titled Installing and configuring WorldServer, the ws.api.url and ws.legacy.url values must be configured in the file located in the WS_CONFIG folder.

The installer does not update the configuration property files so they need to be manually configured.

Update the file by uncommenting and configuring the following properties:  In this scenario the file was placed in the WS_CONFIG location and both the ws.legacy.url and ws.api.url were included in the file. Moreover: the URL assocated with the ws.api.url property needs to be http even if you are using secure URL (https) in your WorldServer environment. This is a hard-coded limitation and will have to be kept as HTTP

Once the file is corrected, restart the Idiom service and the error message will not display. The user will be able to successfully login to WorldServer.

Resolution for Root Cause 3:
Another possible cause of this error is a mismatch of the database entries between different property files.

In one case the database entry in under WS_CONFIG was different than the database entry in under WS_CONFIG\ws-api.

For example:


This causes a failure where the client fingerprint cookie doesn't match up.  For more information on the client fingerprint, check the Oracle documentation.