Administrator and Notification Email Addresses
Introduction
In ConSol CM, several administrator email addresses (or notification email addresses respectively) can be configured. Here, an overview of all those addresses is provided.
Default Configuration
When you set-up a ConSol CM system, you have to enter one global admin email address.
Figure 632: Admin email address configuration during system set-up
- Login for the CM admin user (1)
- Global email address of the CM administrator (2)
This global email address (system property cmas-core-security, admin.email) will be used for all notifications and will be entered automatically for all subsystem-specific email addresses. This means that this admin email address will initially be set automatically for all system properties which contain admin or notification email addresses. The properties can then be changed using the Admin Tool GUI to configure the specific subsystem, e.g., you can configure a specific notification address for DWH operations in the DWH Configuration section of the Admin Tool.
By configuring different admin/notification email addresses for different subsystems, you can spread responsibilities according to responsibilities and roles within your company. For some notifications, even the From address, text, and the subject can be configured.
Subsystem-Specific Notification Email Addresses
DWH (Data Warehouse) - Specific Notification Email Addresses and Email Configurations
System Properties
- Error
- cmas-dwh-server, notification.error.to
An email will be sent to this address when a DWH operation has failed. If the property is not set, no email will be sent.
- cmas-dwh-server, notification.error.from
An email will be sent with this From address when a DWH operation has failed.
- cmas-dwh-server, notification.error.subject
Subject for error emails from the DWH
- cmas-dwh-server, notification.error.description
Text for error emails from the DWH.
- Successful
- cmas-dwh-server, notification.finished_successfully.to
An email will be sent to this address when a DWH transfer has been completed successfully, e.g., when the transfer has been completed without errors. If the property is not set, no email will be sent.
- cmas-dwh-server, notification.finished_successfully.from
From address for emails from the DWH when a transfer finishes successfully.
- cmas-dwh-server, notification.finished_successfully.subject
Subject for emails from the DWH when a transfer finishes successfully.
- cmas-dwh-server, notification.finished_successfully.description
Text for emails from the DWH when a transfer finishes successfully.
- Unsuccessful
- cmas-dwh-server, notification.finished_unsuccessfully.to
An email will be sent to this address when a DWH transfer has been completed, but not successfully, e.g., when the transfer has been completed with errors. If the property is not set, no email will be sent.
- cmas-dwh-server, notification.finished_unsuccessfully.from
From address for emails from the DWH when a transfer finishes unsuccessfully.
- cmas-dwh-server, notification.finished_unsuccessfully.subject
Subject for emails from the DWH when a transfer finishes unsuccessfully.
- cmas-dwh-server, notification.finished_unsuccessfully.description
Text for emails from the DWH when a transfer finishes unsuccessfully.
- cmas-dwh-server, cmas-dwh-server, notification.error.description
The text for error emails from the DWH
For an overview of all system properties which can be set for DWH notifications, please refer to section CMRF & DWH Configuration of the List of System Properties by Area chapter. All properties which are relevant in this context start with notification.
Graphical Configuration
You reach this screen by opening the navigation item Administration, navigation group Data Warehouse, and clicking the tool icon.
Figure 633: ConSol CM Admin Tool - Data Warehouse, Administration: Notification address for DWH errors
The email addresses are checked when you click Save. If an email address is not valid, a message is displayed. No mails will be sent to this address.
Email - Specific Notification Email Addresses
System Properties (NIMH Mode)
- cmas-nimh-extension, mail.error.to.address
An error email is sent to the address in case an email message could not be processed. Starting with CM version 6.10.5.1, an email to this address is also sent when a mail timeout occurs.
If the value for this property is not set, no email will be sent and an exception will be written into the log file.
- cmas-nimh-extension, mail.attachments.validation.info.sender
Sets the From header of attachments type error notification email.
Please note that the sending is controlled by the system property cmas-nimh-extension, mail.on.error. Only if this property is set to true, an error email is sent to the above configured address in case an email message could not be processed.
System Properties (Mule/ESB Mode)
- cmas-esb-mail, mail.process.error
To address for error emails from Mule/ESB Mail Service. An error email is sent to the address in case an email message could not be processed, there are state problems, or any other problem with the Mule/ESB Mail Service. If the property is not set, the sending of the email will fail and this fact will be logged.
- cmas-esb-mail, mail.mule.service
From address for emails sent by Mule/ESB Mail Service.
Graphical Configuration
The value which is entered here (Error email address) in the graphical user interface is set for NIMH as well as for Mule/ESB.
Figure 634: ConSol CM Admin Tool - Email, Email: Configuration of global admin email address and of notification email address for email processing problems
Do not mix up the two email addresses which can be configured on the tab of the navigation item Email:
- Admin email
is the global administrator email (which has been set during system set-up).
- Error email address
is the address of an email administrator or another person who should receive the error messages if the processing of emails (incoming or outgoing) does not work correctly.
Workflow Engine - Specific Notification Email Addresses
- cmas-workflow-engine, jobExecutor.adminMail
Email address which will get notified about job execution problems (when retry counter is exceeded). If the property is not set, no email will be sent.
- cmas-workflow-engine, jobExecutor.mailFrom
Email address which will be set as From header during admin notifications.