Mail

The computer specified in the EMAIL_SERVER key (TCP/IP network name or IP address) receives the e-mails sent by the PPM server via the SMTP protocol.

The e-mail address specified in the EMAIL_FROM key is used as sender address for the following types of e-mail:

  1. Sender address for e-mails that are generated by automation
  2. Sender address for e-mails that are generated by report automation, if no e-mail address was specified for the executing user or if an e-mail address cannot be determined for any other reason
  3. Sender address for e-mails that are generated from the Actions module, if no e-mail address was specified for the executing user or if an e-mail address cannot be determined for any other reason
  4. Sender address for e-mails that are generated by the runppmanalytics program, if no e-mail address was specified for the executing user or if an e-mail address cannot be determined for any other reason

The FORMAT and STYLE keys specify the formats to be used in the Activities table and Messages table. These formats must be defined in the Mail_settings.properties file.

REPORT_DETAIL_ACTIVITY_STYLE = null

REPORT_DETAIL_ACTIVITY_FORMAT = cpi_detail_html

REPORT_DETAIL_COMMENT_STYLE = null

REPORT_DETAIL_COMMENT_FORMAT = cpi_detail_html

REPORT_EMAIL_ACTIVITY_STYLE = null

REPORT_EMAIL_ACTIVITY_FORMAT = cpi_detail_plaintext

REPORT_EMAIL_COMMENT_STYLE = null

REPORT_EMAIL_COMMENT_FORMAT = cpi_detail_plaintext

The keys REPORT_EMAIL_ACTIVITY_TYPE and REPORT_EMAIL_COMMENT_TYPE indicate the format of the e-mail created. Valid values are text/plain for e-mails in text format and text/html for e-mails in html format.

REPORT_EMAIL_ACTIVITY_TYPE = text/html

REPORT_EMAIL_COMMENT_TYPE = text/html

Use the key EMAIL_ATTACH_RESULT to specify whether and how an analysis linked to a message will be attached. Valid values:

Key value

Description

false

The linked analysis will not be attached to the message.

inline

The linked analysis will be embedded in the message. The message type is automatically set to text/html.

pdf

The linked analysis will be attached to the message as a pdf file.

The analysis linked and attached to a message is created using the styles specified in the keys EMAIL_INLINE_STYLE or EMAIL_PDF_STYLE.

Use the SEND_ANALYTICS_EMAILS key to indicate whether an e-mail will be sent by default (value = true) or not (value = false) in addition to creating a CPI message if unfavorable deviations exist.

SEND_ANALYTICS_EMAILS = false

For each Easy mining message type (Early alert, planned value, alarm value, suspected deviation, and outlier analyses), you can use key values to specify whether you are notified by e-mail (key value EMAIL), by a message in the Improvements module (key value CPI), or both (key value CPI,EMAIL).

TARGETVALUE_BEHAVIOUR=CPI

PROCESSMINING_BEHAVIOUR=CPI

ALARMVALUE_BEHAVIOUR=CPI

EARLYALERT_BEHAVIOUR=CPI

OUTLIER_BEHAVIOUR=CPI

If you do not specify any key value, a message is created in the Improvements module and, depending on the SEND_ANALYTICS_EMAILS key value, an e-mail may also be sent (value = true) or not (value = false). If you specify a key value, the information in the SEND_ANALYTICS_EMAILS key is ignored.

Warning

The values for EMAIL and CPI are case-sensitive. Incorrect data results in the action not being executed.