Version 2021.3

OVERVIEW

These release notes are for Nectar Foundation APM (formerly Nectar Foundation). For more information, contact Nectar Support (support@nectarcorp.com).

FOUNDATION APM

• It is not possible to use Remote Software Upgrade on a Linux platform to upgrade from a version prior to v8.6.
• RIG Client requires JRE 1.8 and above.
• Note: Runtime version will be enforced before RIG Client JAR files are downloaded.
• Before upgrading to v2021.3, your existing installation must be at v5.6.2.x or later, licensed, and started successfully. If you attempt to upgrade directly to v2021.3, then the installer will display the following message:

Selected installation’s main version is earlier than 5.6.2 required for upgrade. 

• For the server to start successfully, the port number specified for the serverport property of the server. properties file must not be in use. If the port is already in use, change the port number to an unused port number to correct the issue. The default port number is 80.

TECHNICAL NOTES

UPGRADE REQUIREMENTS

The database migrations started with release 2021.1 and will make it difficult to downgrade to Foundation APM releases 8.7.1 and below. We strongly advise customers to back up the RIG database before upgrading to v2021.3.

CISCO UCM VKM

• When upgrading RIGs from a release prior to v8.0 that are monitoring Cisco UCM systems, additional time will be required based on the number of historical call detail records (CDRs) to perform database migration following restart.
• If the Cisco UCM VKM module is enabled on a system when upgrading to v2021.3 from a pre-7.x release, the Installer will detect it and display a warning message, informing the user to offboard any existing Cisco UCM systems before proceeding with the upgrade. For more information on offboarding, see Cisco UCM VKM Configuration Guide.
• Once the Cisco UCM system(s) has been offboarded, the user can re-run the upgrade process and select the Module Override to complete the upgrade.

CISCO MEETING SERVER VKM

For licensing, a status is received for each type of license (nolicense, activated, or expired). If a nolicense case, a WARNING event is generated. However, if the customer does not want to see these nolicense events, they can disable the associated poller(s).

CISCO EXPRESSWAY VKM

When onboarding Cisco Expressway VKM, use the same username and password across all cluster peers.

MICROSOFT SKYPE FOR BUSINESS VKM

Customers who upgrade to v2021.3 have the option to continue using the Legacy SfB module. However, to access the new SfB features available since v8.0, you must:

1. Offboard the Legacy SfB system.
2. Enable and onboard the new SfB VKM and system.

AVAYA CALL MANAGEMENT SYSTEM (CMS) VKM

As of v8.1, Nectar no longer supports Avaya CMS r16 (and earlier). CMS r16 uses the 256-bit Diffie-Helman encryption algorithm, which is considered a security risk and has been deprecated. It is no longer supported in current SSH-2 implementations.

If you accept this CMS security vulnerability, you can maintain CMS r16 monitoring with Nectar using a Nectar version prior to v8.1.

AVAYA SYSTEM MANAGER VKM

If you onboard Avaya System Manager with invalid credentials, you must delete the incorrect entry and re-onboard the System Manager.

For more information, see Avaya System Manager r7.1 and above.

IP OFFICE VKM (r10.1 and above)

Nectar leverages Avaya’s Service Monitoring Web Services API to monitor IP Office r10.1 and above. If you are currently monitoring an IPO r10.1 or above with Nectar v7.3 and prior, you can migrate to Nectar’s new API support by following these steps:

• Disable and remove the existing monitoring.
• Delete any IP Office traps in the Receiver module.
• Disable the previous module and enable the new module using RIG > Module Configuration.
• Restart the RIG.

For more information, see Avaya IP Office r10.1 and above Deployment Guide.

MOTHER MODULE

The Mother Module must be enabled for Perspective deployments. For more information, see Mother Module RIG Guide.

PROPERTIES FILE

After upgrading to v2021.3, if you have or plan to manipulate a properties file that uses a file path or directory, then you must verify that you are using the proper backslash (\) or forward slash (/):

Windows: 

• Use double backslash (\\), for example, <drive>:\\<folder>\\<folder|file>
  or
• Use single forward slash (/), for example, <drive>:/<folder>/<folder|file>

Linux/iOS:

• Use single forward slash (/), for example, /<folder>/<folder|file>

GENERAL DATA PROTECTION REGULATION

You must upgrade to ‘Version 7.2 or later’ (CIP, EIP, RIG, Perspective Agent/Controller as well as the Nectar Foundation Client) to enable the new General Data Protection Regulation (GDPR) audit logging. Logging is enabled by default but can be customized to suit your specific auditing needs. The Apps\<partner name>\etc\log4j2.xml file is used to enable that customization after the upgrade to ‘Version 7.2 or later’.

The upgrade to ‘Version 7.2 or later’ will back up your existing log4j2.xml file before installing the new version of that file.

If you have previously customized the log4j2.xml file, you will have to manually migrate those changes to the new log4j2.xml file. Your previous version can be accessed by navigating to Apps\<partner name>\rollback\etc\log4j2.xml AFTER you have upgraded.

NEW FEATURES, IMPROVEMENTS, AND RESOLVED ISSUES

Below you will find improvements, bug fixes, and technical upgrades for v2021.3.

NEW FEATURES

• [CMP-10418] - Cisco registered devices by device pool
  • Overview
    • Within the CISCO UCM module and under the CUCM_PHONE table, you can find all these details.
  • Agents
    • When onboarding a CUCM, we will create an agent for the CUCM called <definitionName>-DevicePools. This agent information will be stored in the CUCM_AGENTS table...
      • public void populateAgentTable(String onboardedAgentIndex, String agentIndex, String agentName, String ip, String treeName)
      • public void deleteFromAgentTable(String cucmAgentIndex, String pollAgentIndex)
        We will create a dependency tree for this agent.
  • Device Pool Table
    • We will add a new column to this table called "ConfiguredUsers".
    • This data will come from the Phone collection.
    • The "ConfiguredUsers" count is the number of rows in the Phone table <CiscoUCM>/<CUCM_Phone> for each unique Device Pool.
  • Pollers
    • For each device pool there will be 1 (push) poller created.
    • Poller name will be "<definitionName> <device pool name> Registrations".
    • Device pool name is the Name column in <CiscoUCM>/<CUCM_DevicePool> table.
    • Spaces, no hyphen, no underscore, to be consistent with existing Poller nomenclature.
    • The poller will be a COUNTER POLLER to start with no thresholds attached.
    • An END_NODE will be created for each poller under the <definitionName>-DevicePools dependency tree. 
    • These end nodes will stay blue unless the customer adds threshold information to the pollers.

IMPROVEMENTS

• [CMP-10320] - Configured CMS Syslog patterns into the CMS VKM--adds a few new patterns to the syslog matching rules for CMS.
• [CMP-10336] - Use the controller/zone/traversal client API to gather the status of all types of Expressway Zones: Active, Warning, Failed, and Unknown. 
• [CMP-10497] - Upgraded OpenJDK to the latest release.
• [CMP-10499] - Implemented processing insert/update Ticket Watcher events using queue.

RESOLVED ISSUES

• [CMP-10292] - ESS status dashboard scroll option is not moving in 8.7.1 and 8.6 client.
• [CMP-10361] - Increased Event ID to over 40 characters for Event Escalation.
• [CMP-10410] - Fixed bug that caused manual changes made to thresholds of System Manager SipEntity Status pollers to revert back to default once RIG server/service restarted.
• [CMP-10459] - Fixed issue in UCM CDR Receiver.
• [CMP-10478] - Video Endpoint discovered by TMS and removed in TMS, also removes it from the Video Endpoint Collection list.
• [CMP-10495] - Critical Vulnerability in Log4j library was resolved. 

DOCUMENTATION

• Nectar Foundation Installation Guide

SUPPORTED PRODUCTS

Currently, Nectar supports the following devices and applications. Nectar is consistently adding support for different devices and applications.

VENDOR KNOWLEDGE MODULES

VENDOR KNOWLEDGE SCRIPTS

INFORMATION PACKS