Release Note

Platform SDK & Application Blocks for Java

8.1.x

Genesys Telecommunications Laboratories, Inc. © 2011-2017

Contents

Introduction

Release Number AIX HP-UX PA HP-UX IPF Linux Solaris Windows
8.1.401.11 [10/25/2017] – Hot Fix X     X X X
8.1.401.10 [10/13/2016] – Hot Fix X     X X X
8.1.401.09 [02/05/2016] – Hot Fix X     X X X
8.1.401.07 [11/19/2014] – Hot Fix X X X X X X
8.1.401.05 [10/24/2014] – Hot Fix X X X X X X
8.1.401.03 [06/24/2014] – General X X X X X X
8.1.400.04 [12/24/2013] – General X X X X X X
8.1.300.52 [12/05/2013] – Hot Fix X X X X X X
8.1.300.51 [11/15/2013] – Hot Fix X X X X X X
8.1.300.50 [08/08/2013] – General X X X X X X
8.1.200.60 [05/23/2013] – Hot Fix X X X X X X
8.1.200.50 [03/26/2013] – General X X X X X X
8.1.100.16 [10/07/2013] – Hot Fix X X X X X X
8.1.100.14 [11/30/2012] – General X X X X X X
8.1.100.13 [10/04/2012] – General X X X X X X
8.1.000.18 [04/30/2013] – Hot Fix X X X X X X
8.1.000.16 [04/03/2013] – Hot Fix X X X X X X
8.1.000.15 [01/16/2013] – Hot Fix X X X X X X
8.1.000.14 [10/17/2011] – General X X X X X X

Link to 8.0 Product Release Note (Cumulative)
Known Issues and Recommendations
Discontinued Support
Internationalization
Additional Information


Introduction

As of February 1, 2012, Genesys is no longer an affiliate of Alcatel-Lucent; any indication of such affiliation within Genesys products or packaging is no longer applicable. Please see the Genesys website at http://www.genesys.com for more details.

This release note applies to all 8.1 releases of Platform SDK & Application Blocks for Java.

Use of Third-Party Software

Genesys follows applicable third-party redistribution policies to the extent that Genesys solutions utilize third-party functionality. For additional information about third-party software used in this product, see the Read Me. Please contact your Genesys Customer Care representative if you have any questions.


Release Number 8.1.401.11 [10/25/2017] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


Contacts Platform SDK: Stability when unmarshaling EntityAttributes in Universal Contact Server (UCS) has improved. (PSDK-8909)


Voice Platform SDK: High availability (HA) split-brain recovery logic has improved. (PSDK-8894)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.401.10 [10/13/2016] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


Stat Server protocol now includes a corrected Campaign Actions enumeration. This enumeration now includes DialWrongNumber and LeadWrongNumber items, and is reordered to be in sync with StatServer Campaign Actions Mapping. (PSDK-8539)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.401.09 [02/05/2016] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


The handshake for Local Control Agent protocol has been extended with following parameters: AutoRestart, Workdir, CmdLine, CmdParams, Version, CheckTimeInterval, StartupTimeout, ShutdownTimeout, and AppParams. (PSDK-8216)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.401.07 [11/19/2014] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


Support for the Explicit Hang-up Detection feature has been fixed. (PSDK-7464, PSDK-7281)


Platform SDK endpoints now support host names that include an underscore (_) character. (PSDK-7452)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.401.05 [10/24/2014] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


The Platform SDK timer now shuts down correctly. Previously, it was possible for a NullPointerException to be thrown when the timer shut down. (PSDK-7229)


Configuration Object Model Application Block: This application block now works correctly with binary option values in the CfgApplication object. For example, the confserv application uses binary values for the license option, found under the confserv section of the Options tab. (PSDK-7244)


Configuration Platform SDK: The handshake procedure for Configuration Server protocol has been fixed to ensure the ClientEncoding parameter is not lost. Previously, this parameter could be missing in some connection open/reopen scenarios. (PSDK-7225)


Management Platform SDK: Message Server protocol now sends large (greater than 16 KB) RequestLogMessages properly. (PSDK-7259)


Management Platform SDK: AttributeListCodec now supports reading values that are two bytes in length. (PSDK-7221)


Statistics Platform SDK: The handshake procedure for Stat Server protocol now includes information about extended client capabilities, allowing Stat Server to send extra data to fill the DnStatusEx structure correctly. (PSDK-7217)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.401.03 [06/24/2014] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This release contains no new features or functionality.

Corrections and Modifications

This release includes the following corrections and modifications:


API Reference documentation now provides correct information for the legacy Packaged Statistics Platform SDK component. (PSDK-6824)


Switch Policy Library: Platform SDK now supports the Do Not Disturb (DND) Call Reject feature for Cisco Unified Communications Manager 8.1.2. (PSDK-6902)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.400.04 [12/24/2013] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release also includes the following corrections and modifications:


Maximum size of the Platform SDK ServerChannel default queue for internal client requests has been increased. This helps to prevent the server from dropping client requests due to temporary delays with handling (when taking requests out of the ServerChannel). (PSDK-6551)


Platform SDK now provides improved handling for threads, as follows:

(PSDK-6538)


Application Template Application Block: This application block no longer throws an exception when the CfgApplication configuration has no CfgHost reference assigned. (PSDK-6352)


Configuration Object Model Application Block: This application block now works correctly when a read request is submitted for multiple objects. Previously, the read request could fail if Configuration Server did not provide enough information about the object folders (due to permission restrictions or database corruption). (PSDK-6492)


Configuration Platform SDK: Objects can now use empty string values as keys for the Options or UserProperties KVLists. Previously, this would cause a transportation exception. (PSDK-6520, PSDK-6560)


Configuration Platform SDK: The delta object creation logic for Configuration Server has been corrected to properly handle empty sections in Options and UserProperties KVLists. (PSDK-6506)


Configuration Platform SDK: The Configuration Server protocol no longer allows a request to read objects (RequestReadObject or RequestReadObject2) to be sent without first specifying the object type. If objectType is not set, or set to null, then the user application receives an immediate exception instead of waiting for the request to time out. (PSDK-6333)


Contacts Platform SDK: The kvbinding for the OtherProperty attribute has been fixed in the following structures:

Previously, the structures contained an extra OtherProperty attribute inside of OtherProperty. Now each structure contains only one OtherProperty. (PSDK-6324)


Contacts Platform SDK: Added support for null attributes in the following structures:

(PSDK-6570, PSDK-6563)


Contacts Platform SDK: Fixed kvbinding of the AttachedData and AttributeList structures, and corrected a misspelling in the IdList structure for EventGetInteractionsWithStatus. (PSDK-6491)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.300.52 [12/05/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Contacts Platform SDK: Null values are now handled correctly for AttrValue in SimpleSearchCriteria and for AttributeValue in Attribute. Previously, a NullPointerException was thrown. (PSDK-6550)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.300.51 [11/15/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Contacts Platform SDK: Fixed kvbinding of the AttachedData and AttributeList structures, and corrected a misspelling in the IdList structure for EventGetInteractionsWithStatus. (PSDK-6509, PSDK-6511)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.300.50 [08/08/2013] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release also includes the following corrections and modifications:


Voice Platform SDK: Values for CallMonitoringProperties attributes in TEvent objects (such as DialedNumber, CtrlParty, and ISLinkList) are now public values and are recorded in log files. (PSDK-6267)


Configuration Object Model Application Block: The CfgTreatment.getCallResult() method no longer generates a ClassCastException. (PSDK-6262)


Voice High Availability (HA) connections now offer improved performance. In previous releases, a memory leak might occur in some cases when connections were closed immediately after being opened, even after all HA connections are closed. (PSDK-6252)


An exception is now thrown when protocol.setEndpoint() is called on opened channel. Previously, a new configuration was implemented in this scenario. (PSDK-6226)


Multi-threading environment support has been improved, with a possible race condition being eliminated. (PSDK-6215)


Voice HA functionality is improved. Previously, Voice HA might enter an endless state-switching loop in some circumstances, causing many connections to open and then immediately close, exhausting network ports and consuming CPU resources. (PSDK-6195, ER# 324459501)


Statistics Platform SDK: The custom types definition is fixed in the validation schema. Previously, the EventInfo message would create a validation error for the CurrentState and CampCurrentState statistics. (PSDK-4974, ER# 257166378)


All requests are considered complete when a message with the same ID is received as a response. If a request submitted using the requestAsync() method does not include an ID, then a ProtocolException exception is thrown to indicate that the request cannot be completed. (PSDK-740)


Configuration Object Model Application Block: Initialization of delta collection type fields (added*, changed* and deleted*) has been corrected to not expose empty collections unless they are explicitly sent by the server. This change was made to separate cases such as:

(PSDK-716)


TLS now offers backwards compatibility with the 8.1.0 implementation by using the same configuration parameters used in that release. Note that applications connecting to the Configuration Server upgrade port do not need any special configuration.

Secure client example:

ConnectionConfiguration connConfig = new PropertyConfiguration();
Endpoint ep = new Endpoint("name", "localhost", port, connConfig, true, null, null);

Secure server example:

ConnectionConfiguration connConfig = new PropertyConfiguration();
connConfig.setOption(Connection.SSL_KEYSTORE_PATH_KEY, "server-cert.jks");
connConfig.setOption(Connection.SSL_KEYSTORE_PASS, "12345");

Endpoint endpoint;
endpoint = new WildcardEndpoint("name", port, connConfig, true, null, null);

In order to use TLS compatibility mode, be sure that neither application nor its host have any TLS-related parameters (that is, ensure there is no security section in Options and that transport parameters are empty). Configuration Server should have TLS upgrade parameters configured properly.

Warning: TLS compatibility mode does not actually validate certificates and does not provide authentication; only the connection encryption is provided. (PSDK-698, PSDK-6137, ER# 322536661)


ADDP support has been improved in this release of Platform SDK for Java:

(PSDK-681)


The internal management of connection invokers has been improved. Previously, the invoker named connection was not released in some cases even after all connections were closed. (PSDK-648)


Voice Platform SDK: Connections used with Voice HA are now managed correctly. Previously, underlying connections might be left open in some cases if a Voice HA connection was closed immediately after opening. (PSDK-640, PSDK-729)


Channel management for ClientChannel has been improved. Previously, the following issues were noted:

(PSDK-603)


Protocol Manager Application Block: An exception is now thrown if the applyConfiguration method is called on an opened channel. (PSDK-403)


Expired log files with the same creation time are now removed correctly. Previously, expired log files created with the same timestamp would persist; this issue was especially frequent where the OS in use created timestamps with a value of zero (0) for the milliseconds. (PSDK-399)


Updates to the Netty library provide improved performance and stability. Previously, Netty worker threads might remain running even after all connections were closed if there were TLS handshake errors. (PSDK-274, ER# 312746741)


When an application connects to the TLS upgrade port and performs certificate host name matching, a host name or IP address from the Endpoint is used as the expected value. Previously, there was no way to set the expected hostname when using the upgrade port to auto-detect a TLS connection. (PSDK-6113, PSDK-210, ER# 319278441)


Voice HA now processes switchovers correctly while using a secure connection. Previously, Voice HA connections using TLS would sometimes miss the EventPrimaryChanged event when RequestChangeExecutionMode was sent to SCS to cause a switchover. (PSDK-127, ER# 308345561)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.200.60 [05/23/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Web Media SDK: Improved release mechanisms now provide better performance when working with Chat Server. Previously, some internal threads were not released correctly which could cause a memory leak.

This correction was first made available in release 8.1.000.18 (see ER# 320142156) and is not included in Platform SDK for Java releases created before that date. (ER# 322897347)


Web Media SDK: Logic for handling attachments has been improved. Previously, attachments of a specific size could prevent an Email Server Java request from reaching UCS.

This correction was first made available in release 8.1.000.18 (see ER# 322215901) and is not included in Platform SDK for Java releases created before that date. (ER#s 322715511, 322706280)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.200.50 [03/26/2013] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release also includes the following corrections and modifications:


Platform SDK for Java no longer generates a "java.lang.IllegalArgumentException: Exception while registering mbean" exception while under heavy load. (ER# 313502533)


Platform SDK Connections now support user-set values for the reuseAddress option. This option can be set in ConnectionConfiguration using the Connection.REUSE_ADDRESS_KEY boolean key. The default value for server channels is "true" (which allows fast server restart), while the default value for client channels is not defined (where the OS default is usually "false").

If the Application Template Application Block is used to parse the configuration and set up Endpoints, then you can set this option using Configuration Manager. The option appears as reuse-address=<value> (with a value of "true" or "false") either in the port/connection Transport Parameters or in the commons-connection section of the Application Options tab.

If this option is set to "false", then attempts to bind a local socket to a host name or port that is already in use will result in an exception thrown from protocol.open() and error-level messages written in the log file. If the client has Warm Standby configured, then this will cause an endless loop of switching from primary to backup and vice versa, with error messages written to log file. (ER# 304663101)


Lazy Parsing no longer generates a ConcurrentModificationException exception. (ER# 283893674)


Configuration Platform SDK: XML serialization no longer includes properties with the SerializationHidden attribute set. Previously, XML serialization could reveal senstive information from messages such as RequestChangePassword. (ER# 312577856)


Contacts Platform SDK: EventGetSystemSettings now correctly handles all DatabaseInfo and PortInfo internal structure types. Previously, this event would only contain one Database even if the corresponding Event3rdServerResponse had two entries in Parameters/Database. (ER# 313292361)


Open Media Platform SDK: Creation of redundant, empty complex structures has been eliminated. (ER# 312653081)


Statistics Platform SDK: RequestOpenStatisticEx now handles insensitivity values correctly. Previously, when a time-based statistic request was created, the insensitivity attribute was overwritten with the notification frequency value that was passed. (ER# 311802051)


Voice Platform SDK: Updates to the Netty third-party component version provide improved performance. Previously, some network operations could cause a deadlock to occur while custom applications were experiencing high load. (ER# 312624921)


Platform SDK Log Library: Expiration logic for log files now works correctly with an expiration option value of greater than 24 days. (ER# 318005913)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.100.16 [10/07/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Configuration Object Model Application Block: Initialization of delta collection type fields (added*, changed* and deleted*) has been corrected to not expose empty collections unless they are explicitly sent by the server. This change was made to separate cases such as:

(PSDK-6419)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.100.14 [11/30/2012] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. There were no new features or functionality introduced in this release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release also includes the following corrections and modifications:


ConfService and ConfServiceFactory have been extended to work with the new event receiving mechanism without explicit creation of the MessageBroker service in user code. (ER# 311792276)


The RequestCompletionHandler interface has been removed to make the requestAsync method more flexible. Use the CompletionHandler interface instead. (ER# 311839411)


A specific AddpTraceMode enumeration and corresponding connection configuration property have been added to help users initialize the ADDP trace mode option. (ER# 311792274)


UniversalContactServerProtocol.getProtocolDescription() has been corrected to return the proper protocol description. (ER# 311542861)


Configuration Platform SDK: User passwords with Unicode symbols are now encrypted and decrypted properly. (ER# 311216741)


Netty has been upgraded to release 3.5.8. (ER#s 310864711, 306763954)


The Platform SDK Log Library for Java subcomponent has been extended with the ability to write versions of PSDK libraries (JAR files) to the log files headers. (ER# 308580372)


Thumbprint validation logic is now stricter, resulting in an exception if the thumbprint contains anything but hexadecimal and whitespace characters. This exception contains the position of the first invalid character and its character code. The MSCAPI key manager and KeyManagerHelper class both throw this exception directly when necessary, while the TLSConfigurationHelper class tries to create an SSLContext using the MSCAPI key manager (resulting in the same exception).

Note: Genesys recommends including a full chain of causes when logging security-related exceptions in order not to miss error details.

(ER# 308431683)


Duplicate classes in Commons.Connection and the Application Template Application Block have been removed. Now the main configuration parsing classes reside in Commons, and only the specific configuration reader is located in the Application Template Application Block.

(ER#s 310044639, 310094802)


The Configuration Protocol has been changed to suppress sending ADDP packets while Protocol Version is being requested and the TLS handshake is in progress. This prevents ADDP interference in case of small addp-timeout values.

Note: Small addp-remote-timeout values can still cause interference from server side if the client connecting to TLS upgrade port uses MSCAPI security provider. To avoid this issue, increase the addp-remote-timeout value or consider using a PEM provider. (ER# 309909861)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.100.13 [10/04/2012] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in this release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release also includes the following corrections and modifications:


The following table outlines IPv6 dual-stack support for Java/OS combinations (with IPv4 and IPv6 clients connecting to a wildcard IPv6 socket). Note that there is no difference between 32- and 64-bit OS formats.

Java 5 Java 6 Java 7
Windows XP, Windows Server 2003 OIO only OIO only OIO only
Windows Vista, Windows Server 2008 OIO only OIO only OIO and NIO
Windows 7, Windows Server 2008R2 OIO only OIO and NIO OIO and NIO

Note: To enable the use of a Netty connection with OIO transport, use one of the following methods:

For additional information about working with IPv6, refer to the Networking IPv6 User Guide for JDK/JRE 5.0 (http://docs.oracle.com/javase/1.5.0/docs/guide/net/ipv6_guide/index.html). (ER# 308580163)


KVList serialization now handles binary values with a length of 65536 (0x1'00'00) correctly. (ER# 307583285)


MSCAPI does not support setting passwords programmatically using a CallbackHandler. This feature is present in CAPI code, but undocumented. If a private key is protected using either prompt for permission or prompt for password, then a popup prompt is always presented to the user.

Java provides a uniform API to access all security providers, and requires a CallbackHandler for any provider that supports it. The CallbackHandler parameter for MSCAPI is present for uniformity and to support the possibility of additional functionality in the future. (ER# 308183193)


CRL files do not load correctly when using updates 2 through 6, inclusive, of Java 7. This issue is fixed starting with Java 7 update 7. For more details, refer to: http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=7166885. (ER# 308076943)


The Netty third party library included with Platform SDK is required by the Platform SDK 8.1.1 runtime. This library must be used in runtime classpaths and included in packages for Platform SDK-based applications. (ER# 302735741)


To ensure backwards compatibility, the default mode of operation for platforms where IPv6 support is available is still IPv4. IPv6 support must be explicitly turned on for each application by configuring the enable-ipv6 and ip-version options in the common section of the Options tab for the related Application Object. Older settings affecting IPv6 usage are now deprecated.

(ER# 301081321)


The Platform SDK for Java now handles e-mail interactions with large attachment files without throwing "out of memory" exceptions. (ER# 282863128)


Configuration Platform SDK: Delta object have been updated with the following improvements:

(ER#s 299990245, 296420441, 298027832)


Contacts Platform SDK: Messages from the Universal Contact Server protocol now include the ProtocolDescription information structure. (ER# 304687494)


Management Platform SDK: Message Server records are now handled correctly, even when they include attributes with:

(ER#s 296842607, 294763962)


Statistics Platform SDK: The StatServerProtocol object is now able to handle locale-sensitive string values inside statistic structures (such as agent or group names). (ER# 303273436)


Voice Platform SDK: Client-side stability has been improved for High Availability (Hot Standby). (ER# 306125029)


Warm Standby Application Block: Default behavior for the WarmStandbyService has been corrected to:

(ER# 296221543)


Warm Standby Application Block: Switchover now occurs quicker, as connections no longer wait for a timeout to occur before performing the first reconnection attempt. If fast primary and backup connections both fail, then WarmStandbyService returns to the initial endpoint and follows the usual reconnection scenario. (ER# 296878087)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.000.18 [04/30/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Web Media SDK: Improved release mechanisms now provide better performance when working with Chat Server. Previously, some internal threads were not released correctly and could cause a memory leak. (ER# 320142156)


Web Media SDK: Logic for handling attachments has been improved. Previously, attachments of a specific size could prevent Email Server Java request from reaching UCS. (ER# 322215901)


Statistics Platform SDK: RequestOpenStatisticEx now handles insensitivity values correctly. Previously, when a time-based statistic request was created, the insensitivity attribute was overwritten with the notification frequency value that was passed.

This correction was first made available in release 8.1.200.50 (see ER# 311802051) and is not included in Platform SDK for Java releases created before that date. (ER# 320864423)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.000.16 [04/03/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


The expiration period for log files is now handled correctly. Previously, expiration was calculated as an int value, which only allowed a maximum period of 24 days. If the expire setting was greater than that value, then log files would be removed incorrectly. (ER# 317599517)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.000.15 [01/16/2013] – Hot Fix

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

This is a hot fix for this product. This release contains no new features or functionality.

Corrections and Modifications

This release also includes the following corrections and modifications:


Platform SDK for Java no longer generates an exception (java.lang.IllegalArgumentException: Exception while registering mbean) when under heavy load. (ER# 315257631)


KVList serialization now handles binary values with a length of 65536 (0x10000) correctly. (ER# 315305901)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Release Number 8.1.000.14 [10/17/2011] – General

Supported Operating Systems
New in This Release
Corrections and Modifications
Subcomponents in This Release

Supported Operating Systems

The operating systems supported by this release are listed in the Contents, above.

New in This Release

There are no restrictions for this release. This section describes new features that were introduced in the initial 8.1 release of Platform SDK & Application Blocks for Java.

Corrections and Modifications

This release includes the following corrections and modifications that were made between Release 8.0 or earlier releases and the initial 8.1 release:


ADDP functionality has been enhanced. (ER#s 263625265, 270867441, 273926911, 274000185)


Threading for ADDP messaging has been improved. Previously, some ADDP packets could be sent twice which caused the connection with SIP Server to break. (ER# 277730333)


Configuration Platform SDK: Passwords containing special characters are now handled correctly when localization settings differ on the client and server side. Specify the type of encoding to use, as shown below:

PropertyConfiguration conf = new PropertyConfiguration();
conf.SetOption(Connection.STR_ATTR_ENCODING_NAME_KEY, "Cp1252");
protocol.Configure(conf);

(ER# 267396344)


Configuration Platform SDK: Serialization functionality has been fixed. Previously, non-delta objects inside of delta objects would be missing parameters. (ER# 273508181)


Voice Platform SDK: RequestStartCallMonitoring and RequestStopCallMonitoring are now handled as registration messages. Previously, these messages were not mirrored between primary and backup servers so that call monitoring events would be missed after a switch over.

Additionally, the RegModeMask enumeration has been extended with three new entries. (ER# 269998252)


Voice Platform SDK: The default code has been expanded to convert unexpected data types. Previously, a ClassCastException would occur when retrieving the NetworkCallID attribute from RequestMakePredictiveCall. (ER# 264042631)


Subcomponents in This Release

This release of the Platform SDK contains three types of subcomponents: SDKs, libraries, and application blocks. Release numbers of the individual subcomponents are provided below:

SDK Subcomponents
Library Subcomponents
Application Block Subcomponents

Top of Page


Known Issues and Recommendations

This section provides the latest information on known issues and recommendations associated with this product.


Documentation provided with the Platform SDKs is still being improved and enhanced. To ensure you are working with the most correct and comprehensive information, check the latest SDK documentation updates online at the Genesys Documentation website.


Due to a known issue with Java, TLS connections can generate an exception during the handshake process in some cases (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=7031830). The suggested workaround is upgrade your version of JDK to release 1.7.0_45 (or newer).


Platform SDK is unable to activate protocol.jar in an OSGI container. This is expected behavior, because the container doesn't provide the package. In service mix, it is possible to specify an exported package from JRE in the /etc/jre.properties file, for example:

jre-1.6= \
com.sun.security.auth.module, \

(PSDK-6245)


The deprecated Packaged Statistics Platform SDK is officially not supported starting with the 8.1.1 release of Stat Server. Please use the Statistics Platform SDK instead.


Beginning with release 8.1.100.13, the Platform SDK provides much richer support for TLS. However, backwards compatibility is not provided with TLS functionality from previous releases.

There are improvements in every aspect of core TLS support. The configuration mechanism is now a strongly-typed interface instead of a set of properties. TLS auto-detect (upgrade connection) logic now works by default for the Configuration Server protocol. It is possible to use minimal configuration without certificates data, and/or to use Java Keystore files and PEM files.

Due to the wide-reaching impact of TLS support, Genesys strongly recommends reading the Platform SDK Developer's Guide documentation, which describes TLS functionality in detail.

Note: TLS compatibility mode was introduced in Platform SDK release 8.1.3 to emulate the TLS behavior on Mina connections. Because the Mina connection type is deprecated, Genesys recommends using the (default) Netty connection. (PSDK-5518, ER# 280953780)


Configuration Platform SDK: The Configuration Platform SDK uses Advanced Encryption Standard (AES) cryptography with a 128-bit encryption key, which is considered too strong for some countries and is subject to export restrictions.


Protocol Manager Application Block: The Protocol Manager Application Block included with this release has been designed to support the Statistics Platform SDK, but does not support the deprecated Packaged Statistics Platform SDK. If you require the deprecated Packaged Statistics SDK to provide backwards compatibility for existing applications, see the Platform SDK 8.0 API Reference for instructions on how to support new protocols.


Switch Policy Library: To use this library, you must first download the following third-party component libraries:

Name Version Vendor Type
Spring Beans 3.0.5 or later Spring Framework Dynamically Linked
Spring Context 3.0.5 or later Spring Framework Dynamically Linked
Spring Core 3.0.5 or later Spring Framework Dynamically Linked

These components are not included in the IP, but are required to work with the Platform SDK Switch Policy Library for Java.


The version of the Netty third-party library that is included with Platform SDK allows some threads to continue running after the main application is stopped. This issue occurs when the client application and the server use different TLS settings (that is, one has TLS turned on while the other has TLS turned off). (ER# 312746741)

Found In: 8.1.100.14 Fixed In: 8.1.300.50

Using ConfService constructors causes deprecation warnings due to the the Message Broker Application Block being deprecated. Future releases will include a ConfService that is independent of Message Broker to avoid these warnings.

Found In: 8.1.100.14 Fixed In: 

Configuration Platform SDK: XML serialization of the RequestChangePassword message includes password properties. (ER# 312577856)

Found In: 8.1.100.14 Fixed In: 8.1.200.50

Platform SDK for Java does not validate the certificate's hostname field when connecting to TLS auto-detect port, even if the tls-target-name-check option is set to host. (ER# 319278441, PSDK-6113, PSDK-210)

Found In: 8.1.100.13 Fixed In: 8.1.300.50

Contacts Platform SDK: EventGetSystemSettings contains only one database, even if the corresponding Event3rdServerResponse has two entries in Parameters/Database. (ER# 313292361)

Found In: 8.1.100.13 Fixed In: 8.1.200.50

The TLSConfiguration, TLSConfigurationHelper and TLSConfigurationParser classes in the Platform SDK Commons Connection library are only used internally for TLS upgrade connection, and currently are not intended for any other use. For custom TLS configuration, use classes from the Application Template Application Block. (ER# 310044639)

Found In: 8.1.100.13 Fixed In: 8.1.100.14

When the MSCAPI security provider is used for a TLS upgrade connection, it may take few seconds to initialize TLS. If the ADDP timeout is less than ten seconds, there is a risk that ADDP would interrupt the TLS handshake and break the connection. Genesys recommends setting your ADDP timeout to a value large enough for the TLS initialization and handshake to complete. (ER# 309909861)

Found In: 8.1.100.13 Fixed In: 8.1.100.14

The Platform SDK for Java was developed and tested using the default XML interface provided by the JDK (Xerces). Although JVM allows user applications to use custom XML engines such as Saxon, the Platform SDK does not work correctly with other XML parsers. To resolve such issues, the Platform SDK implementation allows users to explicitly specify an XML engine factory for instead of using the JVM substituted one. (ER# 302570618)

Found In: 8.1.100.13 Fixed In: 

The Netty third-party library used as the networking layer in Platform SDK for Java had a bug in versions prior to 3.5.5. This bug causes client- and server-side connections to hang indefinitely if one side has TLS set up and other does not. For additional details, refer to https://github.com/netty/netty/issues/160. To avoid this issue, substitute the Netty library with release 3.5.5 or later. (ER# 306763954)

Found In: 8.1.100.13 Fixed In: 8.1.100.14

Voice Platform SDK: High-availability Voice connections do not process switchovers correctly while using a secure connection (TLS), causing EventPrimaryChanged to be missed in the Platform SDK logs. (ER# 308345561, PSDK-127)

Found In: 8.1.100.13 Fixed In: 8.1.300.50

A lack of synchronization in lazy parsing can cause ConcurrentModificationException errors to occur. (ER# 283893674)

Found In: 8.1.000.14 Fixed In: 8.1.200.50

The ip_description.xml and read_me.html files included with this installation package should indicate that Platform SDK for Java now includes support for:

(ER# 280554471)

Found In: 8.1.000.14 Fixed In: 8.1.100.13

Note: TLS compatibility mode was introduced in Platform SDK release 8.1.3 to emulate the TLS behavior on Mina connections. Because the Mina connection type is deprecated, Genesys recommends using the (default) Netty connection.

In some cases, Mina connections aren't established correctly on some Windows operating systems. This is a known issue with the Mina library; see https://issues.apache.org/jira/browse/DIRMINA-379?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12592088#action_12592088 for details.

Platform SDK provides the Netty connection layer as a workaround, and future replacement, for Mina. (ER# 280953780)

Found In: 8.1.000.14 Fixed In: 8.1.300.50

Web Media Platform SDK: Platform SDK for Java throws "out of memory" exceptions when handling e-mail interactions with large attachment files. (ER# 282863128)

Found In: 8.1.000.14 Fixed In: 8.1.100.13

Statistics Platform SDK: With the existing XML messages validation schema, the EventInfo message is not valid for CurrentState and CampCurrentState statistics. (ER# 257166378, PSDK-4974)

Found In: 8.0.200.03 Fixed In: 8.1.300.50

Top of Page


Discontinued Support

This section documents features that are no longer supported in this software. This cumulative list is in release-number order with the most recently discontinued features at the top of the list.


There are no discontinued items for this product.


Top of Page


Internationalization

Information in this section is included for international customers.


There are no internationalization issues for this product.


Top of Page


Additional Information

Additional information on Genesys Telecommunications Laboratories, Inc. is available on our Customer Care website. The following documentation also contains information about this software. Please consult the Deployment Guide first.

Product documentation is provided on the Customer Care website, the Genesys Documentation website, and the Documentation Library DVD (produced monthly).

Note: For the DVD, the New Documents on this DVD page indicates the production date for that disc. Due to disc production schedules, documentation on the Genesys Documentation website may be more up-to-date than what is available on disc immediately after a product is released or updated. To determine the version of a document, check the version number that is located on the second page in PDFs or on the About This File topic in Help files.

Top of Page