Overview
This Interim Fix provides various functional fixes for IBM Enterprise Content Management System Monitor (ESM) 5.5.2-000.
Requirements: Requires at least a working installation of ESM 5.5.2. Supersedes all previous Interim Fixes and Fix Packs for ESM 5.5.2-000. Certifications: None. |
Although stated in the documentation IBM DB2 is not supported as the IBM Enterprise Content Management System Monitor’s database with this Interim Fix. This database will be supported in the near future.
Additional information for the IBM Enterprise Content Management System Monitor can be found as IBM ESM Field Guides.
The updated documentation can be downloaded from the IBM download pages.
Installation Steps
New installation
The installer of this Fix Pack cannot be used for a fresh installations.
Before
-
Check if there is an installer.properties file in the same directory where the installer binary was copied to.
-
If so, remove this file from the directory before starting the installer.
-
-
Proceed as described in the Install Guide of the ESM.
Server
-
Proceed as described in the Install Guide of the ESM.
-
Due to a 3rd-party limitation whitespaces in the installation path are currently not supported under Unix/Linux.
Agent
-
Proceed as described in the Install Guide of the ESM.
-
Due to a 3rd-party limitation whitespaces in the installation path are currently not supported under Unix/Linux.
After
-
No further special actions must be taken directly after the installation has ended.
When updating an existing installation
Before updating make sure you have made a backup of your current installation.
Before
-
It is not recommended to mix GUI based and console mode based installations. This can lead to configuration settings erroneously enclosed with double quotes, e.g. "1883" instead of plain 1883.
-
Check if there is an installer.properties file in the same directory where the installer binary was copied to.
-
If so, remove this file from the directory before starting the installer.
-
-
When updating from ESM 5.5.0.0 Interim Fix 3 check if there are MkfLargeRecBlocks probes configured.
-
If so, these must be removed. Deactivating alone is not sufficient.
-
The MkfLargeRecBlocks probe is only supported for IS 3.6, which is no longer supported by ESM 5.5 and newer.
-
These version restrictions were already mentioned in the product’s documentation from ESM 5.5 on.
-
-
When updating from ESM 5.5.0.0 Interim Fix 2 check if there are BatchIt probes configured.
-
If so, these must be removed. Deactivating alone is not sufficent.
-
After the update, the BatchIt probes have to be created again manually.
-
-
The encryption strength is enhanced by the 5.5.2.0 Interim Fix 1; especially between server and agent. Updating from versions older than 5.5.2.0 Interim Fix 1 will prevent a communication between the updated component, e.g. the server, and an older component, e.g. an agent. So all agents must be udpated to be able to connect to an updated server.
Server
-
We recommend to stop the ESM server.
-
Proceed with the update guided by the installer.
-
Due to a 3rd-party limitation whitespace in the installation path are currently not supported under Unix/Linux.
Agent
-
We recommend to stop the ESM agent.
-
Proceed with the update guided by the installer.
-
Due to a 3rd-party limitation whitespace in the installation path are currently not supported under Unix/Linux.
After
-
When updating from ESM 5.5.0.0 Interim Fix 3 check if there are ICC4SAPArchiveStatus probes configured.
-
For probes with authentication type
NONE
no action is required. -
For probes with authentication type SERVER_AUTH: move the existing password from the field
Keystore Password
to the fieldTruststore Password
. -
For probes with authentication type CLIENT_AUTH: move the existing password from the field
Keystore Password
to the fieldTruststore Password
. Set the fieldKeystore password
to the password required for the TRUSTSTORE_FILE defined in the archint.ini file. -
Refer to probe description in the IBM Enterprise Content Management System Monitor Probes and Situations Guide for details.
-
-
When updating from ESM 5.5.2.0 or older check if there are MssqlProcesses probes configured
-
If so, review the evaluation of the sample
-
the return value (message)
up
has been changed to value = 1 -
the return value (message)
down
has been changed to value = 0 -
the return value (message)
remote
is no longer supported; trying to use this probe for remote MSSQL instances now results in an error
-
-
After an update it is recommended to explicitly clear the web browser’s caches to trigger a fresh update of the UI and its components. This is done by pressing the control key (CTRL) and the function key number 5 (F5) simultaneously on your keyboard while the focus is in the ESM’s browser window or tab. |
Known Limitations
Call # | IBM APAR # | Description |
---|---|---|
5684 |
- |
Probe ObjectstoreInfoSql only works for object type "Document" The probe ObjectstoreInfoSql currently only works for object type "Document". All other object types result in SQL queries that do not return a meaningful result. Solution None |
4271 |
- |
Status icon can show wrong count of agents The count of agents shown in the status icon in the upper right corner of the web-ui can be wrong if a system has performance issues. Solution Currently there is no workaround. You can reset the counter by pressing Ctrl-F5 to completely refresh the page.APAR= |
4204 |
- |
No incident for probes that create multiple samples in one run If a probe returns more than one sample in one run, no incident is created. This affects e.g. the probes CustomDatabaseQuery, WmiQuery and DiskSpace. Solution For the probes CustomDatabaseQuery and WmiQuery, use queries that return only one object. For the DiskSpace probe, there is no workaround. |
4186 |
- |
UI Performance Degradation with MS IE11 In Case Of Many Updates In the UI In case the dashboard is configured to show the data of probes with very short update times, less than 30 seconds, the UI can be become unresponsive or hard to use when using Microsoft Internet Explorer 11. Solution Use a Mozilla Firefox or Google Chrome. |
4185 |
- |
Large Page Support Needed for AIX The product installation fails under AIX with the error message "[…] JVMJ9GC032E System configuration does not support option '-Xlp' […]" in case the OS is not configured to use large pages. It is not necessary to allocate space, but the OS must be configured to potentially be able to allocate the space for large pages. Solution Activate large page support for the OS. |
4184 |
- |
Custom Database Query Probe Ignores Timeout Parameter The probe 'CustomDatabaseQuery' that is used to execute custom SQL queries against a supported databases currently ignores the setting for a timeout via the parameter 'Timeout'. Solution There is currently no workaround. |
4183 |
- |
Internal duplicate detection cannot be turned off If duplicate events (same Situation, same severity) occur in a very short timeframe (< 1 s), they will be filtered as duplicates. There is currently no way to turn off this behavior. Solution None |
4182 |
- |
Accessibility: Alt+s works in all editors but the monitoring configuration wizard With Alt+s one can close and save open editors through the keyboard in case the focus in the open editor. This does not work in the monitoring configuration wizard, where one defines the probe, the situation, and the task automation. Solution Navigate with tab-movements to the check-mark icon - in the editor’s toolbar to focus it and press enter. |
4181 |
- |
ICN plug-in shows wrong name The name of the ICN plug-in is currently shown as PhoenixPlugin instead of EsmPlugin. This will be fixed in an upcoming Fix Pack. Solution None |
3836 |
- |
Adding second subsystem for WindowsEventLog will generate old messages This happens in the following situation:
In that case, old entries from the Application protocol will be sent as samples. Solution Stop the agent and remove the eventlog.bkf file before adding another protocol. This will force the reading process to start with the newest entries of all protocols. Be aware that you might lose entries for protocols that have been monitored before the agent restart. |
Fixes and Feature list
5.5.2-000-002
Call # | IBM APAR # | Type | Area | Description |
---|---|---|---|---|
5691 |
- |
Fix |
Monitoring |
Incident of the Port Reachable probe showed a timeout of zero milliseconds as January 1st, 1970 00:00:00 UTC. This is now fixed and zero is shown as the correct value. |
5660 |
PJ45938 |
Fix |
Cross-Cutting-Concerns |
Setting the languages in the browser setting to a language code alone, e.g. "en" or "de", but not setting the country code, e.g. "English (United States Of America)" or "Deutschland" prevented the web-UI from loading. Now the web-UI will be loaded correctly. |
5659 |
- |
Fix |
Installation |
Security fix: It is now possible to turn the H2’s web server off by not setting its port in the installer. This works also while updating the product not only new installations. |
5152 |
- |
Fix |
Cross-Cutting-Concerns |
A memory leak in the web ui was fixed. This memory leak could be triggered by repeatedly switching between the Situations and the Task Portlets icon on the outer most left side of the Monitoring view. |
5107 |
- |
Fix |
Monitoring |
Filtering of samples on the Agent side works now reliable and can be configured through the Web-UI. |
5105 |
- |
Fix |
Tasks |
Selecting a task type and clicking on the add (plus) button now correctly opens the task editor for the selected type. |
5095 |
- |
Fix |
Tasks |
Exporting of incidents to slack works now. |
5086 |
PJ45876 |
Fix |
Cross-Cutting-Concerns |
Cumulative security fixes for (IBM Java 8) JREs included in the ESM 5.5 product line. |
5069 |
- |
Fix |
Monitoring |
Some cepest based probes unnecessarily used an internal locking mechanism to prevent parallel runs of the same probe. This could led to errors if the probe’s execution time took too long compared to the schedule. These probes are no longer utilizing the internal locking mechanism. |
5052 |
- |
Fix |
Monitoring |
Monitoring of rotating logfiles no longer unexpectedly stops. The monitoring of so called rotating or rolling logfiles stopped unexpectedly in cases where the logfile to monitor has got a new reference handle (aka I-node) in the file system when "rolling" occurred. |
5051 |
- |
Fix |
Cross-Cutting-Concerns |
Fixed context root prevented access to webconsole e.g. via Ingres in AWS. |
4967 |
- |
Fix |
Cross-Cutting-Concerns |
Security scans of the MQTT port of the server via OpenVAS no longer leads to high CPU loads. |
4902 |
- |
Fix |
Cross-Cutting-Concerns |
Continuous update of all portlets works now reliable even after switching between "Monitoring" and "Configuration" back and forth. |
4882 |
- |
Fix |
Monitoring |
All details of an agent shown in the sidebar below the list of agents are updated if the status of the corresponding agent changes. |
4296 |
- |
Fix |
Installation |
New installations no longer use non-standard ports for HTTP and HTTPS for the web-ui. |
4280 |
- |
Fix |
Installation |
The problems with the automatic start after the installation no longer exists. The issue was removed from the list of knonw limitations. |
4173 |
- |
Fix |
Monitoring |
The probes Icc4SapArchiveStatus and Icc4SapServerStatus failed on UNIX and Linux systems due to an incorrect directory name. This has been fixed. |
3869 |
- |
Fix |
Monitoring |
Icc4SapArchiveStatus probe no longer fails when authentication type is selected or more than one archive is defined in the INI file. |
3849 |
- |
Fix |
Monitoring |
Icc4SapProcess situation no longer fails with the error message The following processes do not have the specified number of instances […]. |
3839 |
- |
Fix |
Monitoring |
The WMI probe no longer triggers core dumps on agents. |
3813 |
- |
Fix |
Monitoring |
The ICN plug-in now filterts the incidents by the selected situation group. |
3781 |
- |
Fix |
Monitoring |
The limitation of columns in the monitoring dashboad does no longer exist. |
5.5.2-000-001
Call # | IBM APAR # | Type | Area | Description |
---|---|---|---|---|
4951 |
- |
Fix |
Monitoring |
The return value of the MSSQL Processes Probe was always 0. The correct return value was only shown in the message field. This is now fixed. The probe returns 0 (zero) and 1 (one) accordingly to measured state’s of the MS SQL processes. |
4945 |
- |
Enh |
Cross-Cutting-Concerns |
All server’s and the agent’s TLS based communication now uses only Diffie-Hellman (DH) keys sizes bigger or equal to 2048. Shorter key lengths are no longer supported. So e.g. agents prior to this fix will not be able to connect to the server after it was updated. All agents must be updated, too, to allow them to reconnect to the server. This fix can also have effects on HTTPS based communications. It can also have an effect on the overall performance while starting the server. If you want to downgrade to a key length of 1024 after the update, you can edit the JVM property " jdk.tls.ephemeralDHKeySize" in karaf/etc/system.properties. After a change of this property, the server has to be restarted to apply the change to the JVM. |
4941 |
- |
Fix |
Monitoring |
Microsoft Internet Explorer 11 only: Sometimes a tag element in the search dialog of the situation group list dispeared. Only manual refresh of the GUI showed the tag again. This behaviour is now fixed. The shown tags are stable now. |
4928 |
- |
Fix |
Monitoring |
The incident list for a situation can now correctly be sorted by timestamp. |
4879 |
- |
Fix |
Reporting |
Listing or saving reports could lead to rest errors like "Server could not perform requested action". This could only be fixed by upgrading a third-party library. |
4831 |
- |
Enh |
Monitoring |
The Listener probes have now access to all counters reported by the Listener API, especially the raw counters and accumulators and their statistics data. |
4824 |
PJ45793 |
Enh |
Installation |
Cumulative security update of the IBM Java 8 JRE, shipped with the product. |
4812 |
- |
Fix |
Monitoring |
All probes for subsystems of type eDiscovery received a wrong number of arguments. This has been fixed. |
4811 |
- |
Fix |
Monitoring |
The probes ContentNavigatorPingPageStatus and SyncServerPingPageStatus failed for ICN subsystems that contained a URL without port. This has been fixed. |
4305 |
- |
Fix |
Monitoring |
The DB2Statistics probe now works for DB2 installations that use other languages than English. |
4301 |
- |
Fix |
Monitoring |
The DB2Statistics probe failed because the GSK Kit was missing from the search path. |
4278 |
- |
Enh |
Usermanagement |
To streamline the LDAP configuration and to prevent confusion, the configuration settings were split of in two sections. A standard fields section, which is shown immediately after the LDAP configuration editor is opened and an experts settings section, which is hidden beneath an expert settings button in the configuration editor. |
4276 |
- |
Fix |
Cross-Cutting-Concerns |
Security fix to prevent Cross-Site Request Forgery (CSRF) attacks to succeed. |
4274 |
- |
Fix |
Reporting |
Creating line charts could lead to a NoSuchMethodError and would prevent generating such reports at all. This could only be fixed by upgrading to a newer charting library version. |
4255 |
- |
Fix |
Monitoring |
Sorting the history view of incidents by clicking on the "value" column is no longer broken. |
4254 |
- |
Fix |
Monitoring |
The format file for the P8 server error logfiles did not parse entries correctly if they ended with a Java exception. This has been fixed. |
4253 |
- |
Fix |
Knowledgebase |
Some existing Knowledgebase entries did not show up in the details view of an incident although they should. Now this is corrected and these entries are also shown. Mostly the descriptions for P8 server error log entires were affected by this issue. |
4206 |
- |
Fix |
Monitoring |
Lists in the sidebar and portlets scrolled spontaneously to the top if there are automatic refreshes or updates in the UI. This is no longer the case if one has scrolled down. |
4195 |
- |
Fix |
Monitoring |
Datacap Pages Queued Probe can now create more than one sample if needed. So the probe will return samples in such a case instead of returning none and failing silently. |
4191 |
- |
Fix |
Tasks |
Invalid hostnames in the SNMP configuration no longer generate very technical exceptions, but understandable and helpful error messages. |
4173 |
- |
Fix |
Monitoring |
The probes Icc4SapArchiveStatus and Icc4SapServerStatus failed on UNIX and Linux systems due to an incorrect directory name. This has been fixed. |
3871 |
- |
Fix |
Monitoring |
Datacap probes are now working properly with Oracle. |
3869 |
- |
Fix |
Monitoring |
Icc4SapArchiveStatus probe no longer fails when authentication type is selected or more than one archive is defined in the INI file. |
3849 |
- |
Enh |
Monitoring |
Icc4SapProcess situation no longer fails with the error message The following processes do not have the specified number of instances […]. |
3833 |
- |
Fix |
Monitoring |
The OracleProcesses probe had erroneously returned zero for a successful case instead of one. This is now fixed. |
3831 |
- |
Fix |
Monitoring |
Microsoft Internet Explorer 11 only: Filtering a situation group by a tag resulted in an empty situation list. This is now fixed. The filter works as expected and shows all situations that match the tag used for filtering. |
3804 |
- |
Enh |
Cross-Cutting-Concerns |
The communication between server and agent is now TLSv1.2 encrypted. Lower encryption protocols are no longer supported. So all agents prior to this fix will not be able to connect to the server after it was updated. All agents must be updated, too, to allow them to reconnect to the server. |
3744 |
- |
Enh |
Monitoring |
It is now possible to have more than one dashboard in the GUI. Dashboards can be created, named, and deleted. Each dashboard can have a different set of portlets. |
2298 |
- |
Enh |
Cross-Cutting-Concerns |
The welcome page of the product now shows a "Getting Started" section to help a new user to configure a good monitoring of his/her environment. |
5.5.2
Call # | IBM APAR # | Type | Area | Description |
---|---|---|---|---|
4192 |
- |
Enh |
Monitoring |
First probes for monitoring IBM ODM were added to the product. These probes are using the REST API of the RES server. |
4180 |
- |
Enh |
Monitoring |
For MS Windows Event Log monitoring a so called flow limiting or throttling of incidents can now be defined. This is equal to the throttling of incidents for text based logfiles. |
4173 |
- |
Fix |
Monitoring |
The probes Icc4SapArchiveStatus and Icc4SapServerStatus failed on UNIX and Linux systems due to an incorrect directory name. This has been fixed. |
3915 |
- |
Fix |
Cross-Cutting-Concerns |
Directory traversal vulnerability in ESM 5.5. IF4 does no longer exist. |
3909 |
- |
Fix |
Installation |
A pre-installed Java under MS Windows defining JAVA_HOME no longer interferes with the embedded Java used by ESM. |
3907 |
- |
Fix |
Monitoring |
No more connection failures (ERRORCODE=-4228 SQLSTATE=null) with the newest JDBC driver for DB2 11.1.4.4. So using the older driver is no longer needed to connect to a DB2 11.1.4.4. |
3905 |
- |
Enh |
Cross-Cutting-Concerns |
Optional automatic compression of the embedded database was added to the start-up procedure. For details ask your support personnel. |
3903 |
- |
Enh |
Monitoring |
First probes for monitoring IBM BPM were added to the product. These probes are using the REST API. |
3901 |
- |
Enh |
Cross-Cutting-Concerns |
The sidebars are now preserving their horizontal size between view changes and sessions. |
3889 |
- |
Fix |
Cross-Cutting-Concerns |
After deleting an entry in the sidebar the details of the deleted item are also removed from the UI. |
3885 |
- |
Enh |
Monitoring |
Closing of the details aka context view area for incidents is now possible without closing the complete view. |
3883 |
- |
Fix |
Monitoring |
Situation Groups that are defined by more than one tag are now showing all relevant situations again. |
3879 |
- |
Enh |
Monitoring |
New wizard to configure subsystems. The new wizard guides through the process of defining a complete set of related subsystems. For details the updated Configuration Guide. |
3877 |
- |
Enh |
Cross-Cutting-Concerns |
Cumulative security update of Apache Karaf and bundles Jetty server. |
3875 |
- |
Fix |
Monitoring |
Problems of Datacap probes on Oracle based system fixed. |
3869 |
- |
Fix |
Monitoring |
Icc4SapArchiveStatus probe no longer fails when authentication type is selected or more than one archive is defined in the INI file. |
3859 |
- |
Fix |
Monitoring |
Only relevant KnowledgeBase entries are now shown for cepest based probes with numeric values. Before this fix, all KnowledgeBase entries associated with the subsystem used by the probe were listed in the details view. |
3849 |
- |
Enh |
Monitoring |
Icc4SapProcess situation no longer fails with the error message The following processes do not have the specified number of instances […]. |
Details on features
Introduced in ESM 5.5.2-000-002
ESM 5.5.2-000-002 did not introduce any new features.
Introduced in ESM 5.5.2-000-001
-
All server’s and the agent’s TLS based communication now uses only Diffie-Hellman (DH) keys sizes bigger or equal to 2048. Shorter key lengths are no longer supported. So e.g. agents prior to this fix will not be able to connect to the server after it was updated. All agents must be updated, too, to allow them to reconnect to the server. This fix can also have effects on HTTPS based communications. It can also have an effect on the overall performance while starting the server. If you want to downgrade to a key length of 1024 after the update, you can edit the JVM property " jdk.tls.ephemeralDHKeySize" in karaf/etc/system.properties. After a change of this property, the server has to be restarted to apply the change to the JVM.
-
The Listener probes have now access to all counters reported by the Listener API, especially the raw counters and accumulators and their statistics data.
-
Cumulative security update of the IBM Java 8 JRE, shipped with the product.
-
To streamline the LDAP configuration and to prevent confusion, the configuration settings were split of in two sections. A standard fields section, which is shown immediately after the LDAP configuration editor is opened and an experts settings section, which is hidden beneath an expert settings button in the configuration editor.
-
Icc4SapProcess situation no longer fails with the error message The following processes do not have the specified number of instances […].
-
The communication between server and agent is now TLSv1.2 encrypted. Lower encryption protocols are no longer supported. So all agents prior to this fix will not be able to connect to the server after it was updated. All agents must be updated, too, to allow them to reconnect to the server.
-
It is now possible to have more than one dashboard in the GUI. Dashboards can be created, named, and deleted. Each dashboard can have a different set of portlets.
-
The welcome page of the product now shows a "Getting Started" section to help a new user to configure a good monitoring of his/her environment.
Introduced in ESM 5.5.2
-
First probes for monitoring IBM ODM were added to the product. These probes are using the REST API of the RES server.
-
For MS Windows Event Log monitoring a so called flow limiting or throttling of incidents can now be defined. This is equal to the throttling of incidents for text based logfiles.
-
Optional automatic compression of the embedded database was added to the start-up procedure. For details ask your support personnel.
-
First probes for monitoring IBM BPM were added to the product. These probes are using the REST API.
-
The sidebars are now preserving their horizontal size between view changes and sessions.
-
Closing of the details aka context view area for incidents is now possible without closing the complete view.
-
New wizard to configure subsystems. The new wizard guides through the process of defining a complete set of related subsystems. For details the updated Configuration Guide.
-
Cumulative security update of Apache Karaf and bundles Jetty server.
-
Icc4SapProcess situation no longer fails with the error message The following processes do not have the specified number of instances […].
Created on 2019-10-24 19:06:01 MESZ