ReadMe
New in 9.0.x Releases
New in Release 9.0.0
The following new features were added in the 9.0.0 release:
Platform SDK for Java
Release 9.0.010.28:
- The default TLS version in PSDK is now TLSv1.3. (PSDK-9908)
- The third-party Spring component is updated to version 5.3.34. (PSDK-9900)
- Third-party libraries are updated to their latest version to address security issues. (PSDK-9909)
- The netty library is upgraded to version 4.1.109.Final. (PSDK-9895)
- The IP installers for Linux are 64-bit starting with this release. (PSDK-9912)
Release 9.0.010.06:
- The Netty version included with Platform SDK for Java has been upgraded to Netty 4.1.100.Final. (PSDK-9843)
- Supports OpenJDK 17. (PSDK-9826)
- Added a new system property ReconnectOnErrorRestoreSession in PsdkCustomization. (PSDK-9830)
- Added a new attribute msgCheck for the MessageText object of Flex Chat Protocol. (PSDK-9836)
- Added the ConfCalculateTimeZone() function in CfgUtilities. It transforms the formula stored in CfgTimeZone into the real timestamp value. (PSDK-9845)
Release 9.0.010.00:
- A new getAttributes method is added to the ConfObjectBase class. (PSDK-9764)
- New getReferenceID and setReferenceID methods are added to the Message class. (PSDK-9775)
Release 9.0.009.08:
- This release includes only resolved issues.
Release 9.0.009.06:
- Support has been added for Red Hat Enterprise Linux 8. (PSDK-9680)
Release 9.0.008.01:
- The DeleteInteraction message has been extended with new datasource attribute. (PSDK-9594)
- The Interaction Server protocol in Platform SDK now supports the following new attributes:
- _attr_place_dbid
- _attr_agent_dbid
- _attr_actor_place_dbid
- _attr_actor_agent_dbid
- (PSDK-9593)
- EventInteractionListGet has been extended with new TotalCount (int) attribute. RequestInteractionListGet and RequestContactListGet also support two new fields:
- ESQuery (String)
- CloseScroll (String)
- (PSDK-9589)
- Platform SDK now prevents creation of RestApiClient using RestApiClientBuilder if the schema or host are not specified. (PSDK-9370)
- Support for Platform SDK custom loggers has been improved for stability. Exceptions in custom logger implementations are now suppressed to avoid breaking main application/Platform SDK functionality. (PSDK-8242)
Release 9.0.007.09:
- The PSDKRuntime.awaitTermination() methods now wait for the ThreadPoolExecutor that is being used by Netty to shutdown. Also, Platform SDK explicitly shuts down ThreadPoolExecutor when all Netty channels are closed. (PSDK-9626)
Release 9.0.007.07:
- The Netty version included has been upgraded to 4.1.51 to address vulnerabilities in earlier versions.
Release 9.0.007.05:
- Platform SDK for Java now supports Windows Server 2019.
Release 9.0.007.00:
- Platform SDK Stat Server Protocol now supports Interaction Queue and Tenant actions, and correspondent action masks (PSDK-9473, PSDK-9295)
- Enhanced session recovery for SIP Server Cluster. (PSDK-9472)
Release 9.0.005.02:
- AppTemplate Application Block logging configuration has been extended with option default-logdir. Use this option to change the default directory for application log files storage. If not specified, the default value for log file storage is your working directory. (PSDK-9366)
- Platform SDK for Java now uses Netty 4 instead of version 3. (PSDK-9304)
- Platform SDK for Java libraries and jars have been extended to support Java 11 compilation and the new Java modularization feature. (PSDK-9113)
Release 9.0.004.04:
- The AppTemplate Application Configuration Managers' built-in listener for Log4j2 configuration has been improved to check connection configuration options to Message Server.
- This release of Platform SDK for Java adds support for Open JDK 11, and discontinues support for Java 9.
- The Platform SDK pom.xml files and code generation tools have been improved to allow compilation with Java 9 or higher. Refer to the Platform SDK Deployment Guide for more information about this dependency.
Release 9.0.003.09:
- A new group of document management messages has been added to support OMService.
- The KeyValueCollection.toString() helper method has been extended to filter out content of sensitive user-defined sections from logging.
- Changes to the Application Template Application Block Log4j2 logging configuration no longer causes log files to rollover unless the filename is changed or segmentation configuration is reached.
- The Application Template Application Block now supports automatic archiving of rotated Log4j2 log files.
- The Application Template Application Block client configuration helper method now uses the Reconnect Timeout value for WarmStandby configuration.
- The Application Template Application Block Log4j2 plugin now generates common LMS messages/events when the Message Server connection state changes.
- The Application Template Application Block logging configuration has been extended to support explicit log message formatting using the new "outputPattern" option.
- Platform SDK now supports the GroupBy feature for StatServer.
- The legacy Platform SDK Logger Component has been annotated with deprecation marks.
Release 9.0.002.04:
- Platform SDK supports compatibility with Java 9.
- Platform SDK Connection layer component has been updated to use newer version of Netty (3.10.6) to resolve known vulnerabilities of its earlier versions.
- Application Template AB Log4j2 plugin has been updated to work with Log4j v2.10.0.
- Application Template AB Log4j2 configuration has been extended to support custom log messages format; layout pattern may be specified explicitly.
- Application Template AB Log4j2 configuration functionality has been extended with ability to pass the application configuration options to custom FileHeaderProvider.
- Application Template AB Log4j2 Logging functionality has been updated to comply with the Microservices Requirement to have unique log files names.
- Common GEnum based enumerations values, including COM AB, configuration, and other servers' protocols attributes are now properly serializable.
- Configuration protocol schema generation stability has been improved.
Release 9.0.001.02:
- The Application Template application configuration structure has been extended to provide information about referred tenants.
- ESP-based cluster protocols have been extended with RequestorInfo support
- Platform SDK now supports Windows Server 2016.
- TLS target name checking now works correctly, even for TServer protocol.
- The Application Template Application Configuration Manager has been extended with internal state control methods: init(boolean) and refresh(boolean). Set the boolean argument to true for synchronous waiting for application configuration readiness.
- Reading helpers for Platform SDK TLS properties have been corrected to treat null source values as empty, instead of throwing IllegalArgumentException.
Release 9.0.000.01:
- The build procedure for Platform SDK for Java has been updated to use Java version 8, allowing the latest versions of dependencies to be used.
- The Application Template Application Block Log4j logging configurator has been updated for the Log4j 2.7+ configuration API.
- Cluster Protocol now allows substitutes for the default implementation of the Cluster Protocol load balancer.
- Basic and Chat protocols have been extended with the new eventAttribute attribute of type kvlist.
- Interaction Server Protocol has been extended with three new messages in order to support ESP messages:
- EspRequest3rdServer
- EspEvent3rdServerResponse
- EspEvent3rdServerFault
- You can now change the default BACKLOG size, or set it for a specified server channel.
- ConfService is now able to use the channel's invoker.
New in Release 9.0.0
The following new features were added in the 9.0.0 release:
Platform SDK for .NET
Release 9.0.009.00:
- Platform SDK for .NET now supports Windows 11.
- TLS configuration now supports the TLSv13 constant when setting TLS version.
- The handshake procedure with Configuration Server now distinguishes between specific exception types, allowing improved Warm Standby performance.
Release 9.0.007.00:
- Platform SDK for .NET now supports Microsoft .NET Framework 4.8.
Release 9.0.006.05:
- Platform SDK for .NET now supports Windows Server 2019.
Release 9.0.005.01:
- This release includes only resolved issues.
Release 9.0.004.00:
- This release includes only resolved issues.
Release 9.0.003.02:
- Platform SDK for .Net now supports .NET Framework 4.7.x.
- A new group of document management messages has been added to support OMService.
- Platform SDK now supports the GroupBy feature for StatServer.
Release 9.0.002.01:
- This release includes only resolved issues.
Release 9.0.001.02:
- The Application Template application configuration structure has been extended to provide information about referred tenants.
- ESP-based cluster protocols have been extended with RequestorInfo support.
- Platform SDK now supports Windows Server 2016.
- Platform SDK now supports .NET Framework 4.6.x.
- Platform SDK now supports NLog library 4.4.x version. Tests were performed using version 4.4.10, installed with the package manager command: Install-Package NLog -Version 4.4.10
- Improvements to the TLS layer allow Platform SDK to keep data that must be sent in an encrypted state.
Release 9.0.000.02:
- XML printer now shares the KeyValuePrinter filter set, ensuring that sensitive information is not printed to log files.
- The WarmStandby reconnection algorithm now attempts reconnection when the nodes list is no longer empty.
- Platform SDK for .NET has been extended with a new library to support UCS 9.0 clusters.
- Basic and Chat protocols have been extended with the new eventAttribute attribute of type kvlist.
- Interaction Server Protocol has been extended with three new messages in order to support ESP messages:
- EspRequest3rdServer
- EspEvent3rdServerResponse
- EspEvent3rdServerFault
- The TLS certificate verification algorithm has been improved in order to support wildcard certificates.
- The Application Template application block has been extended with GFApplicationConfigurationManager.
- The WSConfig class has been extended with the new Name string property.
New in Release 9.0.7
The following new features were added in the 9.0.7 release:
Platform SDK for Java
Release 9.0.007.09:
- The PSDKRuntime.awaitTermination() methods now wait for the ThreadPoolExecutor that is being used by Netty to shutdown. Also, Platform SDK explicitly shuts down ThreadPoolExecutor when all Netty channels are closed. (PSDK-9626)
Release 9.0.007.07:
- The Netty version included has been upgraded to 4.1.51 to address vulnerabilities in earlier versions.
Release 9.0.007.05:
- Platform SDK for Java now supports Windows Server 2019.
Release 9.0.007.00:
- Platform SDK Stat Server Protocol now supports Interaction Queue and Tenant actions, and correspondent action masks (PSDK-9473, PSDK-9295)
- Enhanced session recovery for SIP Server Cluster. (PSDK-9472)
Platform SDK for .NET
Release 9.0.007.00:
- Platform SDK for .NET now supports Microsoft .NET Framework 4.8.
New in Release 9.0.4
The following new features were added in the 9.0.4 release:
Platform SDK for Java
Release 9.0.004.04:
- The AppTemplate Application Configuration Managers' built-in listener for Log4j2 configuration has been improved to check connection configuration options to Message Server.
- This release of Platform SDK for Java adds support for Open JDK 11, and discontinues support for Java 9.
- The Platform SDK pom.xml files and code generation tools have been improved to allow compilation with Java 9 or higher. Refer to the Platform SDK Deployment Guide for more information about this dependency.
Platform SDK for .NET
Release 9.0.004.00:
This release includes only resolved issues.
New in Release 9.0.6
The following new features were added in the 9.0.6 release:
Platform SDK for .NET
Release 9.0.006.05:
- Platform SDK for .NET now supports Windows Server 2019.
New in Release 9.0.5
The following new features were added in the 9.0.5 release:
Platform SDK for Java
Release 9.0.005.02:
- AppTemplate Application Block logging configuration has been extended with option default-logdir. Use this option to change the default directory for application log files storage. If not specified, the default value for log file storage is your working directory. (PSDK-9366)
- Platform SDK for Java now uses Netty 4 instead of version 3. (PSDK-9304)
- Platform SDK for Java libraries and jars have been extended to support Java 11 compilation and the new Java modularization feature. (PSDK-9113)
Platform SDK for .NET
Release 9.0.005.01:
This release includes only resolved issues.
New in Release 9.0.3
The following new features were added in the 9.0.3 release:
Platform SDK for Java
Release 9.0.003.09:
- A new group of document management messages has been added to support OMService.
- The KeyValueCollection.toString() helper method has been extended to filter out content of sensitive user-defined sections from logging.
- Changes to the Application Template Application Block Log4j2 logging configuration no longer causes log files to rollover unless the filename is changed or segmentation configuration is reached.
- The Application Template Application Block now supports automatic archiving of rotated Log4j2 log files.
- The Application Template Application Block client configuration helper method now uses the Reconnect Timeout value for WarmStandby configuration.
- The Application Template Application Block Log4j2 plugin now generates common LMS messages/events when the Message Server connection state changes.
- The Application Template Application Block logging configuration has been extended to support explicit log message formatting using the new "outputPattern" option.
- Platform SDK now supports the GroupBy feature for StatServer.
- The legacy Platform SDK Logger Component has been annotated with deprecation marks.
Platform SDK for .NET
Release 9.0.003.02:
- Platform SDK for .Net now supports .NET Framework 4.7.x.
- A new group of document management messages has been added to support OMService.
- Platform SDK now supports the GroupBy feature for StatServer.
New in Release 9.0.0
The following new features were added in the 9.0.0 release:
Platform SDK for Java
Release 9.0.000.01:
- The build procedure for Platform SDK for Java has been updated to use Java version 8, allowing the latest versions of dependencies to be used.
- The Application Template Application Block Log4j logging configurator has been updated for the Log4j 2.7+ configuration API.
- Cluster Protocol now allows substitutes for the default implementation of the Cluster Protocol load balancer.
- Basic and Chat protocols have been extended with the new eventAttribute attribute of type kvlist.
- Interaction Server Protocol has been extended with three new messages in order to support ESP messages:
- EspRequest3rdServer
- EspEvent3rdServerResponse
- EspEvent3rdServerFault
- You can now change the default BACKLOG size, or set it for a specified server channel.
- ConfService is now able to use the channel's invoker.
Platform SDK for .NET
Release 9.0.000.02:
- XML printer now shares the KeyValuePrinter filter set, ensuring that sensitive information is not printed to log files.
- The WarmStandby reconnection algorithm now attempts reconnection when the nodes list is no longer empty.
- Platform SDK for .NET has been extended with a new library to support UCS 9.0 clusters.
- Basic and Chat protocols have been extended with the new eventAttribute attribute of type kvlist.
- Interaction Server Protocol has been extended with three new messages in order to support ESP messages:
- EspRequest3rdServer
- EspEvent3rdServerResponse
- EspEvent3rdServerFault
- The TLS certificate verification algorithm has been improved in order to support wildcard certificates.
- The Application Template application block has been extended with GFApplicationConfigurationManager.
- The WSConfig class has been extended with the new Name string property.
New in Release 9.0.1
The following new features were added in the 9.0.1 release:
Platform SDK for Java
Release 9.0.001.02:
- The Application Template application configuration structure has been extended to provide information about referred tenants.
- ESP-based cluster protocols have been extended with RequestorInfo support
- Platform SDK now supports Windows Server 2016.
- TLS target name checking now works correctly, even for TServer protocol.
- The Application Template Application Configuration Manager has been extended with internal state control methods: init(boolean) and refresh(boolean). Set the boolean argument to true for synchronous waiting for application configuration readiness.
- Reading helpers for Platform SDK TLS properties have been corrected to treat null source values as empty, instead of throwing IllegalArgumentException.
Platform SDK for .NET
Release 9.0.001.02:
- The Application Template application configuration structure has been extended to provide information about referred tenants.
- ESP-based cluster protocols have been extended with RequestorInfo support.
- Platform SDK now supports Windows Server 2016.
- Platform SDK now supports .NET Framework 4.6.x.
- Platform SDK now supports NLog library 4.4.x version. Tests were performed using version 4.4.10, installed with the package manager command: Install-Package NLog -Version 4.4.10
- Improvements to the TLS layer allow Platform SDK to keep data that must be sent in an encrypted state.
New in Release 9.0.2
The following new features were added in the 9.0.2 release:
Platform SDK for Java
Release 9.0.002.04:
- Platform SDK supports compatibility with Java 9.
- Platform SDK Connection layer component has been updated to use newer version of Netty (3.10.6) to resolve known vulnerabilities of its earlier versions.
- Application Template AB Log4j2 plugin has been updated to work with Log4j v2.10.0.
- Application Template AB Log4j2 configuration has been extended to support custom log messages format; layout pattern may be specified explicitly.
- Application Template AB Log4j2 configuration functionality has been extended with ability to pass the application configuration options to custom FileHeaderProvider.
- Application Template AB Log4j2 Logging functionality has been updated to comply with the Microservices Requirement to have unique log files names.
- Common GEnum based enumerations values, including COM AB, configuration, and other servers' protocols attributes are now properly serializable.
- Configuration protocol schema generation stability has been improved.
Platform SDK for .NET
Release 9.0.002.01:
- This release includes only resolved issues.
Platform SDK 9.0.x Readme
The Genesys Platform SDK CD contains software for developing custom applications to handle the full range of work that arrives in your contact center. In contrast to the abstraction of the Interaction SDKs, the Platform SDKs offer low-level components and fine-grained, message-driven interfaces that are also XML-friendly. Both Java and .NET development technologies are supported (in addition to XML).
There are three types of components included with this CD. A brief overview of these components follows, with a detailed list of components provided below.
- Platform SDK protocols connect directly to the underlying Genesys servers and can be used to develop client-side, server-side, supervisor, monitoring, and driver-type applications (among other things).
- Platform SDK application blocks offer production quality code solutions, designed by Genesys engineers to showcase best practice techniques, that should be integrated into your applications to handle common functionality. Application blocks are offered "as-is", but are supported through online discussion forums.
- Platform SDK libraries are binary files that provide powerful new functionality for applications developed with the Platform SDKs.
Platform SDK Protocols
- Configuration Platform SDK enables Configuration Layer data querying and manipulation.
- Contacts Platform SDK enables Universal Contact Server integration for contact and interaction history querying and manipulation.
- Management Platform SDK enables you to design applications that monitor and start/stop applications in your Genesys environment.
- Open Media Platform SDK enables you to develop applications for handling non-voice interactions.
- Outbound Contact Platform SDK enables you to develop applications for programmatically starting and stopping outbound campaigns to accommodate your business logic.
- Routing Platform SDK enables Custom Server integration for your applications.
- Statistics Platform SDK enables you to subscribe to statistics through Stat Server, or perform ad hoc querying of statistics in your contact center.
Note: With Platform SDK 8.0, this protocol was completely updated to offer improved functionality and access to the full Stat Server protocol. This protocol is not compatible with releases of the Platform SDK prior to 8.0. - Voice Platform SDK enables you to develop applications that handle voice interactions.
- Web Media Platform SDK enables design of applications that integrate with Genesys non-voice media servers, enabling you to introduce into a Genesys environment e-mail, chat, and callback request interactions that begin in a web environment.
Platform SDK Application Blocks
- The Application Template Application Block allows Platform SDK connections to use parameters stored in Configuration Server when establishing connections, and provides various helper classes for features including Warm Standby, assigning message filters, and configuration monitoring and logging.
- The Cluster Protocol Application Block allows your applications to communicate with multiple servers configured as a cluster, using a standard Platform SDK protocol interface.
- The Configuration Object Model Application Block provides an illustration of how to access and manipulate Configuration Layer data by means of programmatic objects.
- The Warm Standby Application Block provides code showing how to implement warm standby high availability in your application development.
- (Deprecated) The Message Broker Application Block is considered a legacy product as of release 8.1.1 due to changes to the default event-receiving mechanism.
- (Deprecated) The Protocol Manager Application Block is considered a legacy product as of release 8.1.1 due to improvements in the configuration of core protocol classes.
Platform SDK Libraries
- Logging Library provides an easy-to-use API for creating and configuring custom-built loggers for your Genesys SDK applications. Please note that this functionality is also supported through extensions in the Application Template Application Block.
Genesys Customer Care links:
Licensing:
- Genesys Licensing Guide
- Licensing section of the Genesys Migration Guide
Information on supported hardware and third-party software is here:
Copyright
All Genesys software is © Copyright 2024 Genesys Cloud Services, Inc. All rights reserved.
Complete information about Genesys proprietary intellectual property, including copyrights, can be found here.
Trademarks
Genesys and the Genesys logo are registered trademarks of Genesys Cloud Services, Inc. in the U.S.A. and other countries. Complete information about Genesys proprietary intellectual property, including all trademarks, can be found here.
All other trademarks are the property of their respective owners.
Third Party Software
Genesys follows applicable third-party redistribution policies to the extent that Genesys solutions utilize third-party functionality. Please contact your customer care representative if you have any questions. The following list describes specific third-party code and functionality for this product:
| Used In | Component Name | Web Page |
|---|---|---|
| Platform SDK for Java | Netty | http://www.jboss.org/netty/ |
NOTICE OF RESTRICTED RIGHTS FOR ORACLE PRODUCTS LICENSED TO THE US GOVERNMENT Oracle Programs delivered to the United States government subject to the DOD FAR Supplement are 'commercial computer software' and use, duplication, and disclosure of the programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable license agreement therefor. Otherwise, Oracle programs delivered subject to the Federal Acquisition Regulations are 'restricted computer software' and use, duplication, and disclosure of the programs, including documentation, shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software-Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
