Planning Analytics Agent: message.log: Email configuration properties missing

Troubleshooting

Problem

After setup the e-mail notification for the Planning Analytics Agent in make the changes in the bootstrap.properties file the following message will occur in the Planning Analytics Agent message log file:

0000007e com.ibm.pa.kate.agent.util.PAKateNotificationEmailUtil E Email configuration properties missing

Symptom

The e-Mail notification of Planning Analytics Agent and Planning Analytics Workspace Administration is not working.

Cause

Not all of the required configuration settings for e-Mail notification are made in the bootstrap.properties file.
Located in ...\ibm\cognos\tm1_64\paa_agent\wlp\usr\servers\kate-agent folder.

Environment

Windows

Linux (RedHat, CentOS)

Resolving The Problem

All entries for the e-mail notification need to be defined/set in the bootstrap.properties file.

The error message in the message.log notice that one or more entries are not defined.

The documentation is talking about a default setting for different options but they need to be defined as well at least with the default parameter.

The required settings for e-mail notification are:

SMTP_EMAIL_PORT=<SMTP port number> -- port number of the SMTP server you are using

SMTP_EMAIL_HOST=<e-Mail server host name | e-Mail server IP address> -- server name or IP address of the SMTP server you plan to use

If a wrong port number and/or SMTP server is used the following message will occur in the message.log file:
0000003c com.ibm.pa.kate.agent.util.PAKateNotificationEmailUtil E Exception occurred while sending smtp email com.sun.mail.util.MailConnectException: Couldn't connect to host, port: <SMTP server name> , <SMTP_EMAIL_PORT number>; timeout -1;
nested exception is:
java.net.ConnectException: Connection timed out: connect

SMTP_EMAIL_AUTH=<TRUE | FALSE> -- To define if a password authentication is required or not

SMTP_EMAIL_START_TLS_ENABLE=<TRUE | FALSE> -- define if the communication with the e-mail server uses SSL/TLS

SMTP_EMAIL_USERNAME=<e-mail address> -- e-mail address of the user to login to the SMTP server>

SMTP_EMAIL_PASSWORD=<password> -- password of the above user account to login to the SMTP server>

If a wrong e-mail address and/or password is used the following message will occur in the message.log file:

0000003d com.ibm.pa.kate.agent.util.PAKateNotificationEmailUtil E Exception occurred while sending smtp email javax.mail.AuthenticationFailedException: 535 Authentication failed. Restarting authentication process.

PAA_EMAIL_ADDRESS=<e-mail address> -- e-mail address with will be placed in the sender field of the e-mail send out by the notification system>

Example for the above settings:
SMTP_EMAIL_PORT=25
SMTP_EMAIL_AUTH=TRUE
SMTP_EMAIL_HOST=9.19.29.39

SMTP_EMAIL_START_TLS_ENABLE=FALSE
SMTP_EMAIL_PASSWORD=Password123
PAA_EMAIL_ADDRESS=test@cloud.com
SMTP_EMAIL_USERNAME=admin@cogsup.frankfurt.de.ibm.com

with an e-mail notification send out as soon as the set entry will fulfill the requirement which is set for it (in this case the memory usage > 0.3):

-----------------------------------------------------------------------------------------------------------------

Subject:    DO NOT RESPOND: Planning Analytics Alert: Memory critical threshold met: 24retail
Date:    Wed, 15 Apr 2020 09:44:51 +0200 (CEST)
From:     test@cloud.com
To:     user1@cogsup.frankfurt.de.ibm.com

Memory threshold set to 0,3 GB.

Current Memory Usage: 0,3 GB.

http://9.19.29.49/monitor/

*To unsubscribe from these alerts, please contact the Planning Analytics Administrator.

-----------------------------------------------------------------------------------------------------------------

Related Information

Planning Analytics Agent - Sample bootstrap.properties file

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"ARM Category":[],"Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"All versions","Edition":"Planning Analytics Agent, Planning Analytics Workspace","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Product Synonym

PAA; PAW; Planning Analytics Agent; IBM Planning Analytics Administration Agent; Planning Analytics Workspace Administration

Tips