VoiceObjects licenses are stored within the VoiceObjects Metadata Repository and can be viewed or modified from within VoiceObjects Desktop or using the Web Services Interface.

License Editor

To open the License editor, select Configure Licenses from the VoiceObjects menu in Desktop for Eclipse. When using Desktop for Web, you can find the Configure Licenses command in the Tools menu. For further information see the Desktop for Eclipse Guide or the Desktop for Web Guide.

This entry is only available to Server Administrators and Server Controllers. For detailed information on user roles and their privileges see Chapter 2 – User Management – Basic Topics.

The License editor displays summaries of the VoiceObjects Desktop and VoiceObjects Server licenses, and allows updates of either one.

For details on how to extract license information using the Web Services Interface, refer to the Web Services Guide.

8     Caution: In some cases it might be necessary to delete the file .ezlm20jk from the VoiceObjectsDesktop\plugins\com.voiceobjects.eclipseDesktop_9.1.0\config folder if a problem occurs on startup of VoiceObjects telling you that there is an “Invalid EasyLicenser configuration condition”. When working in Desktop for Web the file has to be deleted from the VoiceObjects\Platform\WEB-INF\config folder respectively.

VoiceObjects Desktop license

The VoiceObjects Desktop License section contains two subsections:

 

The Definition section contains the actual VoiceObjects Desktop license key in XML format.

To update the license key, paste the new key into the License key field. The updated license key will be validated automatically and the validity will be indicated by the respective symbol to the right of the Definition field (if it is valid and  if it is invalid). If the pasted license key is valid the information in the Summary section is updated and the dirty flag appears on the tab header of the editor indicating that the editor has been modified and the license may be saved now.

In Desktop for Web you may use the validation button  to check the validity. License validity is also checked when saving the new license.

The Summary section provides a summary of the contents of the license key, including

·          Name of the customer the license key was created for

·          Expiration date of the license key

·          Indication whether this is a license bundled with a specific partner

·          Indication whether this is an evaluation, as opposed to production, license

·          Number of available Desktop seats in total, and per role group (Reviewers/Designers/Service Controllers, Site Administrators/Controllers, Server Administrators/Controllers)

·          Indication whether the XML Development Kit (XDK) is available

·          Indication whether the Web Services Interface (WSI) is available

·          Indication whether the integration with OpenSpeech DialogModules (OSDMs) is available

VoiceObjects Server license

The VoiceObjects Server License section contains two sections:

 

The Definition section contains the actual VoiceObjects Server license key in XML format.

To update the license key, paste the new key into the License key field. The updated license key will be validated automatically and the validity will be indicated by the respective symbol to the right of the Definition field (if it is valid and  if it is invalid). If the pasted license key is valid the information in the Summary section is updated and the dirty flag appears on the tab header of the editor indicating that the editor has been modified and the license may be saved now.

In Desktop for Web you may use the validation button  to check validity. License validity is also checked when saving the new license.

The Summary section provides a summary of the contents of the license key, including

·          Name of the customer the license key was created for

·          Expiration date of the license key

·          Indication whether this is a license bundled with a specific partner

·          Indication whether this is an evaluation, as opposed to production, license

·          Maximum number of concurrent sessions available for the installation

·          Maximum number of servers deployed at the same time for the installation

·          Maximum number of services deployed at the same time for the installation

·          Maximum number of cluster groups available for the installation

·          Indication whether the XML Development Kit (XDK) is available

·          Indication whether the Web Services Interface (WSI) is available

·          Indication whether Infostore is available

·          Indication whether the integration with OpenSpeech DialogModules (OSDMs) is available

·          Indication whether multi-server clustering is available

·          Indication whether notifications are available

·          Indication whether the channel voice is available

·          Indication whether the channel video is available

·          Indication whether the channel web is available

·          Indication whether the channel text is available

With the Cluster Groups section, currently only available in Desktop for Web, names and concurrent session limits can be assigned to the individual cluster groups. This is only relevant if your license allows more than one cluster group. For a single cluster group (the default), leave this section empty.

Updating a License

Licenses are updated differently depending on the situation:

·          When a valid license exists, e.g. to upgrade the current license to more ports or additional functionalities.

·          When no valid license exists, e.g. because this is a first-time install or because the previous license has expired.

8     Caution: Only users with a Server Administrator or a Server Controller role may view or modify the VoiceObjects license key. When modifying licenses, be careful not to damage them. Without valid licenses keys, your VoiceObjects installation may become unusable.
When updating or initially entering a license, make sure that the system clock on your server is set correctly. An incorrect system clock may lead to licenses being rejected.
When updating a VoiceObjects Desktop license that does not include OSDM support to one that does include it, a restart of VoiceObjects Desktop is required.

The paragraphs below describe how to update licenses using VoiceObjects Desktop. To update them using the Web Services Interface, refer to the Web Services Guide.

When a valid license exists

To update an existing license, open the License editor as described above. Switch to the appropriate section for either VoiceObjects Desktop or VoiceObjects Server license.

From the license file you have received, copy the entire XML structure and paste it into the License key field in the Definition section, replacing the entire existing license key.

To check the validity of the new license, simply click somewhere outside the Definition section. If the pasted license key is valid the information in the Summary section is updated and the dirty flag appears on the tab header of the editor indicating that the editor has been modified and the license may be saved now.

8     Caution: If you do not validate the license it will not be applied to the repository as the editor will not be flagged as modified.

In Desktop for Web you may use the validation button  to check validity. License validity is also checked when saving the new license.

If the key is correct, the updated summary will be displayed. If the key is not correct the License editor will not be flagged as modified and thus cannot be saved. In Desktop for Web an error message will be shown in this case. Make sure that you copy the entire XML structure from the license file, and that you replace the entire existing key. If you still encounter problems, contact VoiceObjects Technical Support.

Click Save and Close to save the updated license key.

@8    Tip: Updates to the license key do not immediately affect running instances of the server. You need to either fully restart the instances (including JVM), or wait until they automatically update their license key. This happens about once every hour.

When no valid license exists

When no valid license key exists for VoiceObjects Server, it is not possible to start any server instances. You first need to provide a valid license key through VoiceObjects Desktop or through the Web Services Interface. Normally this is done during the installation process, but you can also do it manually as described below.

When no valid license key for VoiceObjects Desktop exists, you may start it but only Server Administrators or Server Controllers can log in. They must configure a valid license first in order to start working with VoiceObjects Desktop.

To provide a valid license in Desktop for Eclipse, open the License editor and enter the license key as described in License Editor above.

When working with Desktop for Web a window with two text boxes comes up automatically into which license keys for VoiceObjects Desktop and VoiceObjects Server may be pasted.

From the license key files you received, copy the entire XML structure and paste it into the respective boxes. Then click Register to activate the license key.

License Failover

When the Metadata Repository does not contain a valid license for VoiceObjects Server, it is not possible to start any server instances. A valid server license first needs to be inserted into the Metadata Repository as explained above.

If a valid license runs out while servers are running, or if the database containing the license becomes unavailable, they will continue to run for a grace period of 72 hours. During this time, a valid replacement license needs to be inserted into the Metadata Repository as explained above. Otherwise, the servers will stop accepting new dialog requests after the grace period expires.