Resolving Common Licensing Problems

December 30, 2008

The first step in resolving any licensing issues with EditLive! is to obtain a debug log which will provide detailed information on the licensing process and what went wrong. See How To Create A Debug Log for information on how to create a debug log.

Is the License Installed?

The first thing to check is that the license is correctly installed in the configuration file. EditLive! will print the contents of the configuration file it's using as part of the debug log when it first starts up. Look for a line similar to:

[DEBUG] EditorCommandHandler - -(AWT-EventQueue-0) XML Configuration File:

This will be followed by the contents of your configuration file. You want to make sure that the license is correctly listed under the ephoxLicenses element. For example:

<ephoxLicenses>
    <license
      accountID="C128723423"
      activationURL=""
      domain="EPHOX.COM"
      expiration="NEVER"
      forceActive="false"
      key="5FFF-ACDF-8323-8923-2839"
      licensee="EPHOX LTD"
      product="EditLive!"
      release="6.0"
      seats="unlimited"
      type="Enterprise License"
      eqEditor="true"
      productivityPack="true"
    /></ephoxLicenses>

Verify that the information in the debug log matches the contents of the configuration file you added the license to and that both match the license information that Ephox sent to you.

Problems and Resolutions

If the configuration file EditLive! is using does not match the configuration file on the server:

Close all browser windows and then with a fresh browser session, load EditLive! again. In some situations the configuration file is cached and restarting the browser may overcome this.
Ensure that you are editing the correct configuration file, on the correct server. Load the configuration file directly in a browser and verify that the content matches the server and verify that the URL is correct.
- EditLive! will print the URL to the configuration file in the debug log, generally just above where it prints the configuration content. Look for a line like:
```
[DEBUG] ContentCache - -(AWT-EventQueue-0) Caching: http://localhost/eljconfig.xml
```

Why Did The License Fail?

Once we know that the license is installed correctly, we need to check the log to find out why the license wasn't considered valid by EditLive! Fortunately, the log shows what's happening fairly clearly in most cases. Look for a section like:

[DEBUG] EditorCommandHandler - -(AWT-EventQueue-0) Check license local.
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   Company: AJ
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   sDomain: SYMPHONIOUS.NET
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   sKey: 5FFFDG8723073JK5
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   sParentDom: EPHOX.COM
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   Checking domain with subdomains allowed.
[WARN] ServerRegister - -(AWT-EventQueue-0)    License is not valid because domain does not match. Expected: SYMPHONIOUS.NET but was: EPHOX.COM.
[DEBUG] ServerRegister - -(AWT-EventQueue-0)   ServerRegister returns: 0
[DEBUG] EditorCommandHandler - -(AWT-EventQueue-0) Local license checked as: 0
[ERROR] EditorCommandHandler - -(AWT-EventQueue-0) No valid licenses found.

Here's what the information in this section means:

Company	This is the licensee attribute from your configuration. It must match the licensee specified in the information you received from Ephox.
sDomain	The domain that your license is for. This is from the the domain attribute in your configuration.
sKey	The license key in use. Taken from the key attribute in your configuration.
sParentDom	The domain that the editor considers it's running on. This is normally the same as the domain in the location bar of the browser
Checking domain with subdomains allowed.	Indicates that the license in use allows sub-domains. So www.symphonious.net and wcm1.symphonious.net would both be valid if the license is for symphonious.net.
License is not valid because domain does not match. Expected: SYMPHONIOUS.NET but was: EPHOX.COM.	This line tells us why the license wasn't valid. In this case, it's being used on the wrong domain.

If you have multiple licenses specified in your configuration file, you may see blocks like this multiple times in the log, one for each license. If any of the licenses are considered valid, the editor will be licensed.

Problems and Resolutions

License is not valid because domain does not match. Expected: DOMAIN.COM but was: OTHER.COM

This indicates that the editor is being used with a different domain to what the license allows.

Attempting to use an expired license. The license for domain "EPHOX.COM" has expired.

The key in use is a timed license and the license has expired. Timed licenses contain the expiry date at the end of the domain attribute. e.g. EPHOX.COM20080912 would expire on the 12th of September 2008.

Key doesn't match.

This indicates that either the domain, licensee or key attribute in the configuration is incorrect. Check that it is specified exactly as it was provided to you by Ephox.

License supports the Enterprise Edition but does not include enterpriseEdition="true"

This is not actually an error, but indicates that the license element is not an accurate record. The license includes support for enterprise edition features, but the element does not reflect that. All features will be enabled and work correctly.

License claims to include the Enterprise Edition but the key does not include the Enterprise Edition component.

This indicates that the license element includes enterpriseEdition="true" but the license doesn't actually allow enterprise edition functionality to be used. The editor will work, however only professional edition features will be enabled.

Incorrect license version. This is version 5.0 but license is for version 6.0.

Indicates that the version of EditLive! in use is different to the version that the license is for. In general, you need a different license for each major version - so a version 6.0 license will work with 6.0, 6.1, 6.5 etc but will not work with version 5.0 or version 7.0. If you have a current annual upgrade subscription (AUS), you are entitled to free upgrades - contact support and request an upgraded license.

What's The ServerRegister returns: Bit About?

Debug logs are written by engineers, for engineers so sometimes they get a bit geeky. In this case, the "ServerRegister returns:" line is how we check what product the license is for. The same license code is shared between EditLive! (and the various integrations of it) and EditLive! for XML. So if ServerRegister returns: 0, it means there was no valid license. 1 means a valid EditLive! license was found and 2 means a valid EditLive! for XML license was found.

The "Local license checked as" line uses the same numbering scheme.